react-native-executorch/lib/module/modules/computer_vision/OCRModule.js

An easy way to run AI models in React Native with ExecuTorch

"use strict";

import { OCRController } from '../../controllers/OCRController';
import { Logger } from '../../common/Logger';
import { parseUnknownError } from '../../errors/errorUtils';

/**
 * Module for Optical Character Recognition (OCR) tasks.
 * @category Typescript API
 */
export class OCRModule {
  constructor(controller) {
    this.controller = controller;
  }

  /**
   * Creates an OCR instance for a built-in model.
   * @param namedSources - An object specifying the model name, detector source, recognizer source, and language.
   * @param onDownloadProgress - Optional callback to monitor download progress, receiving a value between 0 and 1.
   * @returns A Promise resolving to an `OCRModule` instance.
   * @example
   * ```ts
   * import { OCRModule, OCR_ENGLISH } from 'react-native-executorch';
   * const ocr = await OCRModule.fromModelName(OCR_ENGLISH);
   * ```
   */
  static async fromModelName(namedSources, onDownloadProgress = () => {}) {
    try {
      const controller = new OCRController();
      await controller.load(namedSources.detectorSource, namedSources.recognizerSource, namedSources.language, onDownloadProgress);
      return new OCRModule(controller);
    } catch (error) {
      Logger.error('Load failed:', error);
      throw parseUnknownError(error);
    }
  }

  /**
   * Creates an OCR instance with a user-provided model binary.
   * Use this when working with a custom-exported OCR model.
   * Internally uses `'custom'` as the model name for telemetry.
   * @remarks The native model contract for this method is not formally defined and may change
   * between releases. Refer to the native source code for the current expected tensor interface.
   * @param detectorSource - A fetchable resource pointing to the text detector model binary.
   * @param recognizerSource - A fetchable resource pointing to the text recognizer model binary.
   * @param language - The language for the OCR model.
   * @param onDownloadProgress - Optional callback to monitor download progress, receiving a value between 0 and 1.
   * @returns A Promise resolving to an `OCRModule` instance.
   */
  static fromCustomModel(detectorSource, recognizerSource, language, onDownloadProgress = () => {}) {
    return OCRModule.fromModelName({
      modelName: `ocr-${language}`,
      detectorSource,
      recognizerSource,
      language
    }, onDownloadProgress);
  }

  /**
   * Executes the model's forward pass, where `imageSource` can be a fetchable resource or a Base64-encoded string.
   * @param imageSource - The image source to be processed.
   * @returns The OCR result as a `OCRDetection[]`.
   */
  async forward(imageSource) {
    return await this.controller.forward(imageSource);
  }

  /**
   * Release the memory held by the module. Calling `forward` afterwards is invalid.
   * Note that you cannot delete model while it's generating.
   */
  delete() {
    this.controller.delete();
  }
}
//# sourceMappingURL=OCRModule.js.map