Class STT

constructor

• new STT(opts?): STT

• Create a new instance of OpenAI STT.

  Parameters

  • opts: Partial<STTOptions> = defaultSTTOptions

  Returns STT

  Remarks

  apiKey must be set to your OpenAI API key, either using the argument or by setting the OPENAI_API_KEY environment variable.

label

model

• get model(): string

• Get the model name/identifier for this STT instance.

  Returns string

  The model name if available, "unknown" otherwise.

  Remarks

  Plugins should override this property to provide their model information.

provider

• get provider(): string

• Get the provider name for this STT instance.

  Returns string

  The provider name if available, "unknown" otherwise.

  Remarks

  Plugins should override this property to provide their provider information.

_recognize

• _recognize(buffer, abortSignal?): Promise<SpeechEvent>

• Parameters

  • buffer: AudioBuffer
  • Optional abortSignal: AbortSignal

  Returns Promise<SpeechEvent>

stream

• stream(): stt.SpeechStream

• This method throws an error; streaming is unsupported on OpenAI STT.

  Returns stt.SpeechStream

Static withGroq

• withGroq(opts?): STT

• Create a new instance of Groq STT.

  Parameters

  • opts: Partial<{
        apiKey?: string;
        baseURL?: string;
        client: OpenAI;
        detectLanguage: boolean;
        language: string;
        model: string;
    }> = {}

  Returns STT

  Remarks

  apiKey must be set to your Groq API key, either using the argument or by setting the GROQ_API_KEY environment variable.

Static withOVHcloud

• withOVHcloud(opts?): STT

• Create a new instance of OVHcloud AI Endpoints STT.

  Parameters

  • opts: Partial<{
        apiKey?: string;
        baseURL?: string;
        client: OpenAI;
        detectLanguage: boolean;
        language: string;
        model: string;
    }> = {}

  Returns STT

  Remarks

  apiKey must be set to your OVHcloud AI Endpoints API key, either using the argument or by setting the OVHCLOUD_API_KEY environment variable.