Skip to main content

Interface: StreamingSpeechGenerationModel<SETTINGS>

Type parameters

NameType
SETTINGSextends SpeechGenerationModelSettings = SpeechGenerationModelSettings

Hierarchy

Implemented by

Accessors

settingsForEvent

get settingsForEvent(): Partial<SETTINGS>

Returns settings that should be recorded in observability events. Security-related settings (e.g. API keys) should not be included here.

Returns

Partial<SETTINGS>

Inherited from

SpeechGenerationModel.settingsForEvent

Defined in

packages/modelfusion/src/model-function/Model.ts:19

Methods

doGenerateSpeechStandard

doGenerateSpeechStandard(text, options): PromiseLike<Uint8Array>

Generates an mp3 audio Uint8Array that contains the speech for the given text.

Parameters

NameType
textstring
optionsFunctionCallOptions

Returns

PromiseLike<Uint8Array>

Inherited from

SpeechGenerationModel.doGenerateSpeechStandard

Defined in

packages/modelfusion/src/model-function/generate-speech/SpeechGenerationModel.ts:14


doGenerateSpeechStreamDuplex

doGenerateSpeechStreamDuplex(textStream, options): PromiseLike<AsyncIterable<Delta<Uint8Array>>>

Parameters

NameType
textStreamAsyncIterable<string>
optionsFunctionCallOptions

Returns

PromiseLike<AsyncIterable<Delta<Uint8Array>>>

Defined in

packages/modelfusion/src/model-function/generate-speech/SpeechGenerationModel.ts:24


withSettings

withSettings(additionalSettings): this

The withSettings method creates a new model with the same configuration as the original model, but with the specified settings changed.

Parameters

NameType
additionalSettingsPartial<SETTINGS>

Returns

this

Example

const model = new OpenAICompletionModel({
model: "gpt-3.5-turbo-instruct",
maxGenerationTokens: 500,
});

const modelWithMoreTokens = model.withSettings({
maxGenerationTokens: 1000,
});

Inherited from

SpeechGenerationModel.withSettings

Defined in

packages/modelfusion/src/model-function/Model.ts:34

Properties

modelInformation

modelInformation: ModelInformation

Inherited from

SpeechGenerationModel.modelInformation

Defined in

packages/modelfusion/src/model-function/Model.ts:12


settings

Readonly settings: SETTINGS

Inherited from

SpeechGenerationModel.settings

Defined in

packages/modelfusion/src/model-function/Model.ts:13