AxTranscriptionRequest Generated TypeScript API reference. typescript api api/reference build/apidocs/TypeAlias.AxTranscriptionRequest.md type AxTranscriptionRequest

AxTranscriptionRequest

TypeScript
type AxTranscriptionRequest<TModel> = object;

Defined in: https://github.com/ax-llm/ax/blob/e690b4823b8309e258594064abe941d4cff6ef89/src/ax/ai/audio/types.ts#L59

Type Parameters

Type ParameterDefault type
TModelstring

Properties

audio

TypeScript
audio: AxAudioInput;

Defined in: https://github.com/ax-llm/ax/blob/e690b4823b8309e258594064abe941d4cff6ef89/src/ax/ai/audio/types.ts#L60


emitAudioProgress?

TypeScript
optional emitAudioProgress: boolean;

Defined in: https://github.com/ax-llm/ax/blob/e690b4823b8309e258594064abe941d4cff6ef89/src/ax/ai/audio/types.ts#L75

Ask the provider to emit audio processing progress when supported.


keywords?

TypeScript
optional keywords: string[];

Defined in: https://github.com/ax-llm/ax/blob/e690b4823b8309e258594064abe941d4cff6ef89/src/ax/ai/audio/types.ts#L71

Domain words and names used to bias recognition.


language?

TypeScript
optional language: string;

Defined in: https://github.com/ax-llm/ax/blob/e690b4823b8309e258594064abe941d4cff6ef89/src/ax/ai/audio/types.ts#L62


languageBias?

TypeScript
optional languageBias: string[];

Defined in: https://github.com/ax-llm/ax/blob/e690b4823b8309e258594064abe941d4cff6ef89/src/ax/ai/audio/types.ts#L69

Expected spoken languages used to bias recognition without forcing one language.


mode?

TypeScript
optional mode: "push_to_talk" | "endpointing" | "diarization";

Defined in: https://github.com/ax-llm/ax/blob/e690b4823b8309e258594064abe941d4cff6ef89/src/ax/ai/audio/types.ts#L67

Portable speech-turn behavior for providers that support it.


model?

TypeScript
optional model: TModel;

Defined in: https://github.com/ax-llm/ax/blob/e690b4823b8309e258594064abe941d4cff6ef89/src/ax/ai/audio/types.ts#L61


partialMode?

TypeScript
optional partialMode: "cumulative" | "delta";

Defined in: https://github.com/ax-llm/ax/blob/e690b4823b8309e258594064abe941d4cff6ef89/src/ax/ai/audio/types.ts#L73

Shape of partial transcript events when a provider offers streaming transcription.


prompt?

TypeScript
optional prompt: string;

Defined in: https://github.com/ax-llm/ax/blob/e690b4823b8309e258594064abe941d4cff6ef89/src/ax/ai/audio/types.ts#L63


responseFormat?

TypeScript
optional responseFormat: "json" | "verbose_json" | "text";

Defined in: https://github.com/ax-llm/ax/blob/e690b4823b8309e258594064abe941d4cff6ef89/src/ax/ai/audio/types.ts#L65


sessionId?

TypeScript
optional sessionId: string;

Defined in: https://github.com/ax-llm/ax/blob/e690b4823b8309e258594064abe941d4cff6ef89/src/ax/ai/audio/types.ts#L77

Optional caller correlation identifier.


temperature?

TypeScript
optional temperature: number;

Defined in: https://github.com/ax-llm/ax/blob/e690b4823b8309e258594064abe941d4cff6ef89/src/ax/ai/audio/types.ts#L64

Docs