Class RealtimeModel

constructor

• new RealtimeModel(__namedParameters): RealtimeModel

• Parameters

  • __namedParameters: {
        apiKey?: string;
        apiVersion?: string;
        baseURL?: string;
        entraToken?: string;
        inputAudioFormat?: "pcm16";
        inputAudioTranscription?: InputAudioTranscription;
        instructions?: string;
        isAzure?: boolean;
        maxResponseOutputTokens?: number;
        modalities?: ["text", "audio"] | ["text"];
        model?: string;
        outputAudioFormat?: "pcm16";
        temperature?: number;
        turnDetection?: TurnDetectionType;
        voice?: string;
    }

    • Optional apiKey?: string

    • Optional apiVersion?: string

    • Optional baseURL?: string

    • Optional entraToken?: string

    • Optional inputAudioFormat?: "pcm16"

    • Optional inputAudioTranscription?: InputAudioTranscription

    • Optional instructions?: string

    • Optional isAzure?: boolean

    • Optional maxResponseOutputTokens?: number

    • Optional modalities?: ["text", "audio"] | ["text"]

    • Optional model?: string

    • Optional outputAudioFormat?: "pcm16"

    • Optional temperature?: number

    • Optional turnDetection?: TurnDetectionType

    • Optional voice?: string

  Returns RealtimeModel

inFrameSize

numChannels

outFrameSize

sampleRate

sessions

• get sessions(): RealtimeSession[]

• Returns RealtimeSession[]

close

• close(): Promise<void>

• Returns Promise<void>

session

• session(__namedParameters): RealtimeSession

• Parameters

  • __namedParameters: {
        chatCtx?: ChatContext;
        fncCtx?: FunctionContext;
        inputAudioFormat?: "pcm16";
        inputAudioTranscription?: null | InputAudioTranscription;
        instructions?: string;
        maxResponseOutputTokens?: number;
        modalities?: ["text", "audio"] | ["text"];
        outputAudioFormat?: "pcm16";
        temperature?: number;
        turnDetection?: null | TurnDetectionType;
        voice?: string;
    }

    • Optional chatCtx?: ChatContext

    • Optional fncCtx?: FunctionContext

    • Optional inputAudioFormat?: "pcm16"

    • Optional inputAudioTranscription?: null | InputAudioTranscription

    • Optional instructions?: string

    • Optional maxResponseOutputTokens?: number

    • Optional modalities?: ["text", "audio"] | ["text"]

    • Optional outputAudioFormat?: "pcm16"

    • Optional temperature?: number

    • Optional turnDetection?: null | TurnDetectionType

    • Optional voice?: string

  Returns RealtimeSession

Static withAzure

• withAzure(__namedParameters): RealtimeModel

• Parameters

  • __namedParameters: {
        apiKey?: string;
        apiVersion?: string;
        azureDeployment: string;
        baseURL: string;
        entraToken?: string;
        inputAudioFormat?: "pcm16";
        inputAudioTranscription?: InputAudioTranscription;
        instructions?: string;
        maxResponseOutputTokens?: number;
        modalities?: ["text", "audio"] | ["text"];
        outputAudioFormat?: "pcm16";
        temperature?: number;
        turnDetection?: TurnDetectionType;
        voice?: string;
    }

    • Optional apiKey?: string

    • Optional apiVersion?: string

    • azureDeployment: string

    • baseURL: string

    • Optional entraToken?: string

    • Optional inputAudioFormat?: "pcm16"

    • Optional inputAudioTranscription?: InputAudioTranscription

    • Optional instructions?: string

    • Optional maxResponseOutputTokens?: number

    • Optional modalities?: ["text", "audio"] | ["text"]

    • Optional outputAudioFormat?: "pcm16"

    • Optional temperature?: number

    • Optional turnDetection?: TurnDetectionType

    • Optional voice?: string

  Returns RealtimeModel