.NET API
SpeechDialogueRequest
Tracon.Abstractions.dllA request to voice a dialogue.
public sealed record SpeechDialogueRequest : IEquatable<SpeechDialogueRequest>- Inheritance
- object ← SpeechDialogueRequest
- Implements
- IEquatable<SpeechDialogueRequest>
- Inherited Members
- object.GetType(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()
Constructors
Section titled “Constructors”SpeechDialogueRequest()
Section titled “ SpeechDialogueRequest()”public SpeechDialogueRequest()Properties
Section titled “Properties”Credential
Section titled “ Credential”Gets the tenant’s own credential for the provider, or null to use the credential the synthesizer was configured with.
public ModelProviderCredential? Credential { get; init; }Property Value
Section titled “Property Value”Remarks
Section titled “Remarks”Tracon sets it from the tenant’s provider binding, and only for a synthesizer whose ISpeechDialogueSynthesizer.SupportsTenantCredentials is true; a value the caller sets is replaced. It lives in memory for the call and is never persisted; its text form never shows the key.
IncludeTimestamps
Section titled “ IncludeTimestamps”Gets whether each turn’s time range and the character timing are returned with the audio. Default false.
public bool IncludeTimestamps { get; init; }Property Value
Section titled “Property Value”LanguageCode
Section titled “ LanguageCode”Gets the language’s ISO 639-1 code. The provider detects it itself if empty.
public string? LanguageCode { get; init; }Property Value
Section titled “Property Value”ModelId
Section titled “ ModelId”Gets the dialogue model to use. When empty, the synthesizer uses its own default
(the built-in client: VoiceOptions.DialogueModelId, then the provider’s
default).
public string? ModelId { get; init; }Property Value
Section titled “Property Value”Remarks
Section titled “Remarks”The single-voice model (VoiceOptions.SynthesisModelId) is not used here: a
model that speaks one voice need not voice a dialogue.
OutputFormat
Section titled “ OutputFormat”Gets the provider’s output format name (for example, pcm_24000); when empty,
the synthesizer’s default.
public string? OutputFormat { get; init; }Property Value
Section titled “Property Value”Remarks
Section titled “Remarks”Not a MIME type. Raw pcm_* output carries no file header: the caller that
joins several results adds the header itself.
ProviderSettings
Section titled “ ProviderSettings”Gets the provider-specific settings, keyed under the provider’s prefix (for example
elevenlabs.stability). Empty by default.
public IReadOnlyDictionary<string, JsonElement> ProviderSettings { get; init; }Property Value
Section titled “Property Value”IReadOnlyDictionary<string, JsonElement>
Remarks
Section titled “Remarks”A synthesizer refuses an unknown key, another provider’s key, a key that has no effect on a dialogue, and a value of the wrong type, before it calls the service. It never ignores one. The message names the key, never the value.
Gets the turns, in the order they are spoken.
public required IReadOnlyList<SpeechDialogueTurn> Turns { get; init; }Property Value
Section titled “Property Value”IReadOnlyList<SpeechDialogueTurn>
Methods
Section titled “Methods”Equals(object?)
Section titled “ Equals(object?)”public override bool Equals(object? obj)Parameters
Section titled “Parameters”obj object?
Returns
Section titled “Returns”Equals(SpeechDialogueRequest?)
Section titled “ Equals(SpeechDialogueRequest?)”public bool Equals(SpeechDialogueRequest? other)Parameters
Section titled “Parameters”other SpeechDialogueRequest?
Returns
Section titled “Returns”GetHashCode()
Section titled “ GetHashCode()”public override int GetHashCode()Returns
Section titled “Returns”ToString()
Section titled “ ToString()”public override string ToString()Returns
Section titled “Returns”Operators
Section titled “Operators”operator ==(SpeechDialogueRequest?, SpeechDialogueRequest?)
Section titled “ operator ==(SpeechDialogueRequest?, SpeechDialogueRequest?)”public static bool operator ==(SpeechDialogueRequest? left, SpeechDialogueRequest? right)Parameters
Section titled “Parameters”left SpeechDialogueRequest?
right SpeechDialogueRequest?
Returns
Section titled “Returns”operator !=(SpeechDialogueRequest?, SpeechDialogueRequest?)
Section titled “ operator !=(SpeechDialogueRequest?, SpeechDialogueRequest?)”public static bool operator !=(SpeechDialogueRequest? left, SpeechDialogueRequest? right)Parameters
Section titled “Parameters”left SpeechDialogueRequest?
right SpeechDialogueRequest?