Class SpeechGenerationRequest

Task for generating synthetic speech (text-to-speech) using the specified model.

Inheritance
object
UnifiedApiRequestBase<SpeechGenerationRequest, Generated<IAudioAsset>, IAudioRequestOptions>
GenerativeRequest<SpeechGenerationRequest, Prompt, IAudioAsset, IAudioRequestOptions>
StreamingGenerativeRequest<SpeechGenerationRequest, Prompt, IAudioAsset, Delta<IAudioChunk>, IAudioRequestOptions>
GenerativeAudioRequest<SpeechGenerationRequest, Prompt, IAudioRequestOptions>
SpeechGenerationRequestBase<SpeechGenerationRequest, Prompt, IAudioRequestOptions>
SpeechGenerationRequest
Implements
Inherited Members
Namespace: Glitch9.AIDevKit
Assembly: Glitch9.AIDevKit.dll
Syntax
public class SpeechGenerationRequest : SpeechGenerationRequestBase<SpeechGenerationRequest, Prompt, IAudioRequestOptions>, IGenerativeRequest, IStreamingGenerativeRequest<Delta<IAudioChunk>, IAudioAsset>

Constructors

| Edit this page View Source

SpeechGenerationRequest(Prompt)

Declaration
public SpeechGenerationRequest(Prompt prompt)
Parameters
Type Name Description
Prompt prompt

Properties

| Edit this page View Source

FileNameKey

Declaration
protected override string FileNameKey { get; }
Property Value
Type Description
string
Overrides
| Edit this page View Source

Locale

Declaration
public Locale? Locale { get; set; }
Property Value
Type Description
Locale?
| Edit this page View Source

ModelType

Declaration
public override ModelType ModelType { get; }
Property Value
Type Description
ModelType
Overrides
| Edit this page View Source

RequestType

The endpoint type for this

Declaration
public override RequestType RequestType { get; }
Property Value
Type Description
RequestType
Overrides
| Edit this page View Source

ResponseType

MIME type for the response. Defaults to JSON.

Declaration
public override MimeType ResponseType { get; set; }
Property Value
Type Description
MimeType
Overrides
| Edit this page View Source

Speed

Declaration
public float? Speed { get; set; }
Property Value
Type Description
float?
| Edit this page View Source

SupportedEngines

Provider-specific hint for supported synthesis engines (e.g. Amazon Polly). Used when the Voice ScriptableObject is not in the catalog and engine metadata cannot be retrieved from it directly.

Declaration
public string SupportedEngines { get; set; }
Property Value
Type Description
string

Methods

| Edit this page View Source

ExecuteAsyncInternal()

Executes the actual task logic. Must be implemented in derived classes.

Declaration
protected override UniTask<Generated<IAudioAsset>> ExecuteAsyncInternal()
Returns
Type Description
UniTask<Generated<IAudioAsset>>
Overrides
| Edit this page View Source

SetLanguage(SystemLanguage)

Sets the language of the synthesized speech. This can improve pronunciation and accuracy for non-English languages.

Declaration
public SpeechGenerationRequest SetLanguage(SystemLanguage language)
Parameters
Type Name Description
SystemLanguage language
Returns
Type Description
SpeechGenerationRequest
| Edit this page View Source

SetLocale(Locale)

Declaration
public SpeechGenerationRequest SetLocale(Locale locale)
Parameters
Type Name Description
Locale locale
Returns
Type Description
SpeechGenerationRequest
| Edit this page View Source

SetSpeed(float)

Sets the playback speed of the synthesized voice.

Declaration
public SpeechGenerationRequest SetSpeed(float speed)
Parameters
Type Name Description
float speed
Returns
Type Description
SpeechGenerationRequest
| Edit this page View Source

SetSupportedEngines(string)

Declaration
public SpeechGenerationRequest SetSupportedEngines(string engines)
Parameters
Type Name Description
string engines
Returns
Type Description
SpeechGenerationRequest
| Edit this page View Source

StreamAsyncInternal()

Declaration
protected override IGenerativeStream<Delta<IAudioChunk>, IAudioAsset> StreamAsyncInternal()
Returns
Type Description
IGenerativeStream<Delta<IAudioChunk>, IAudioAsset>
Overrides

Implements

Extension Methods