Skip to content

TTSAdapter.md

Latest commit

 

History

History
105 lines (62 loc) · 2.43 KB

TTSAdapter.md

File metadata and controls

105 lines (62 loc) · 2.43 KB
id TTSAdapter
title TTSAdapter

Interface: TTSAdapter<TModel, TProviderOptions>

Defined in: packages/typescript/ai/src/activities/generateSpeech/adapter.ts:24

TTS adapter interface with pre-resolved generics.

An adapter is created by a provider function: provider('model') → adapter All type resolution happens at the provider call site, not in this interface.

Generic parameters:

  • TModel: The specific model name (e.g., 'tts-1')
  • TProviderOptions: Provider-specific options (already resolved)

Type Parameters

TModel

TModel extends string = string

TProviderOptions

TProviderOptions extends object = Record<string, unknown>

Properties

~types

~types: object;

Defined in: packages/typescript/ai/src/activities/generateSpeech/adapter.ts:38

Internal

Type-only properties for inference. Not assigned at runtime.

providerOptions

providerOptions: TProviderOptions;

generateSpeech()

generateSpeech: (options) => Promise<TTSResult>;

Defined in: packages/typescript/ai/src/activities/generateSpeech/adapter.ts:45

Generate speech from text

Parameters

options

TTSOptions<TProviderOptions>

Returns

Promise<TTSResult>

kind

readonly kind: "tts";

Defined in: packages/typescript/ai/src/activities/generateSpeech/adapter.ts:29

Discriminator for adapter kind - used to determine API shape

model

readonly model: TModel;

Defined in: packages/typescript/ai/src/activities/generateSpeech/adapter.ts:33

The model this adapter is configured for

name

readonly name: string;

Defined in: packages/typescript/ai/src/activities/generateSpeech/adapter.ts:31

Adapter name identifier