Class OfflineRecognizer

constructor

• new OfflineRecognizer(configOrInternal: any): OfflineRecognizer

  Constructor (SYNC path).

  Users call: new OfflineRecognizer(config)

  Async factory calls this with an internal descriptor.

  Parameters

  • configOrInternal: any

  Returns OfflineRecognizer

config

handle

createStream

• createStream(hotwords?: string): OfflineStream

  Create a new OfflineStream bound to this recognizer.

  The optional hotwords argument enables contextual biasing for this stream only. Hotwords are supported only by transducer models decoded with decodingMethod 'modified_beam_search'. Separate multiple phrases with '/', and optionally append a per-phrase boosting score, e.g. 'PHOEBE :2.0/DON QUIXOTE'. When modelConfig.modelingUnit and modelConfig.bpeVocab are set, phrases are given as normal words; otherwise each phrase must be a sequence of tokens from tokens.txt separated by spaces. See also https://k2-fsa.github.io/sherpa/onnx/hotwords/index.html

  Parameters

  • Optionalhotwords: string

    Optional hotwords for this stream.

  Returns OfflineStream

decode

• decode(stream: OfflineStream): void

  Decode an offline stream (synchronous).

  Parameters

  • stream: OfflineStream

  Returns void

decodeAsync

• decodeAsync(stream: OfflineStream): Promise<OfflineRecognizerResult>

  Decode an offline stream asynchronously (non-blocking).

  Parameters

  • stream: OfflineStream

  Returns Promise<OfflineRecognizerResult>

getResult

• getResult(stream: OfflineStream): OfflineRecognizerResult

  Get recognition result for a stream.

  Parameters

  • stream: OfflineStream

  Returns OfflineRecognizerResult

setConfig

• setConfig(config: OfflineRecognizerConfig): void

  Replace the recognizer config at runtime.

  Parameters

  • config: OfflineRecognizerConfig

  Returns void

StaticcreateAsync

• createAsync(config: OfflineRecognizerConfig): Promise<OfflineRecognizer>

  Create an OfflineRecognizer asynchronously (non-blocking).

  Parameters

  • config: OfflineRecognizerConfig

  Returns Promise<OfflineRecognizer>