Hierarchy (view full)

Constructors

Properties

_options: RealtimeOptions
inFrameSize: number = api_proto.IN_FRAME_SIZE
numChannels: number = api_proto.NUM_CHANNELS
outFrameSize: number = api_proto.OUT_FRAME_SIZE
sampleRate: number = api_proto.SAMPLE_RATE

Accessors

Methods

  • 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.