Class RealtimeModel

constructor

• new RealtimeModel(options?): realtime.RealtimeModel

• Parameters

  • options: {
        apiKey?: string;
        apiVersion?: string;
        azureDeployment?: string;
        baseURL?: string;
        connOptions?: APIConnectOptions;
        entraToken?: string;
        inputAudioNoiseReduction?: null | NoiseReduction;
        inputAudioTranscription?: null | InputAudioTranscription;
        maxSessionDuration?: number;
        modalities?: Modality[];
        model?: string;
        speed?: number;
        temperature?: number;
        toolChoice?: llm.ToolChoice;
        tracing?: null | TracingConfig;
        turnDetection?: null | TurnDetectionType;
        voice?: string;
    } = {}

    • Optional apiKey?: string

    • Optional apiVersion?: string

    • Optional azureDeployment?: string

    • Optional baseURL?: string

    • Optional connOptions?: APIConnectOptions

    • Optional entraToken?: string

    • Optional inputAudioNoiseReduction?: null | NoiseReduction

    • Optional inputAudioTranscription?: null | InputAudioTranscription

    • Optional maxSessionDuration?: number

    • Optional modalities?: Modality[]

    • Optional model?: string

    • Optional speed?: number

    • Optional temperature?: number

      Deprecated

      Unused in GA API (v1). Temperature is no longer supported.

    • Optional toolChoice?: llm.ToolChoice

    • Optional tracing?: null | TracingConfig

    • Optional turnDetection?: null | TurnDetectionType

    • Optional voice?: string

  Returns realtime.RealtimeModel

_options

inFrameSize

numChannels

outFrameSize

sampleRate

model

• get model(): string

• The model name/identifier used by this realtime model

  Returns string

close

• close(): Promise<void>

• Returns Promise<void>

session

• session(): realtime.RealtimeSession

• Returns realtime.RealtimeSession

Static withAzure

• withAzure(__namedParameters): realtime.RealtimeModel

• Create a RealtimeModel instance configured for Azure OpenAI Service.

  Parameters

  • __namedParameters: {
        apiKey?: string;
        apiVersion?: string;
        azureDeployment: string;
        azureEndpoint?: string;
        baseURL?: string;
        entraToken?: string;
        inputAudioNoiseReduction?: NoiseReduction;
        inputAudioTranscription?: InputAudioTranscription;
        speed?: number;
        temperature?: number;
        tracing?: TracingConfig;
        turnDetection?: TurnDetectionType;
        voice?: string;
    }

    • Optional apiKey?: string

    • Optional apiVersion?: string

    • azureDeployment: string

    • Optional azureEndpoint?: string

    • Optional baseURL?: string

    • Optional entraToken?: string

    • Optional inputAudioNoiseReduction?: NoiseReduction

    • Optional inputAudioTranscription?: InputAudioTranscription

    • Optional speed?: number

    • Optional temperature?: number

      Deprecated

      Unused in GA API (v1). Temperature is no longer supported.

    • Optional tracing?: TracingConfig

    • Optional turnDetection?: TurnDetectionType

    • Optional voice?: string

  Returns realtime.RealtimeModel

  A RealtimeModel instance configured for Azure OpenAI Service.

  See

  • DEFAULT_INPUT_AUDIO_TRANSCRIPTION.
  • DEFAULT_SERVER_VAD_OPTIONS.

  Throws

  Error if required Azure parameters are missing or invalid.