textRecognition（文字识别）

导入模块

import { textRecognition } from '@kit.CoreVisionKit';

TextRecognitionConfiguration

通用文本识别的配置项，用于配置是否支持朝向检测。

系统能力： SystemCapability.AI.OCR.TextRecognition

模型约束： 此接口仅可在Stage模型下使用。

起始版本： 4.0.0(10)

VisionInfo

待识别的视觉信息，目前仅支持颜色数据格式为RGBA_8888的PixelMap类型的视觉信息。

系统能力： SystemCapability.AI.OCR.TextRecognition

模型约束： 此接口仅可在Stage模型下使用。

起始版本： 4.0.0(10)

PixelPoint

指示像素点的位置。

系统能力： SystemCapability.AI.OCR.TextRecognition

模型约束： 此接口仅可在Stage模型下使用。

起始版本： 4.0.0(10)

TextWord

描述一个单词的信息，包括内容，以及外框的坐标。

系统能力： SystemCapability.AI.OCR.TextRecognition

模型约束： 此接口仅可在Stage模型下使用。

起始版本： 4.0.0(10)

TextLine

描述图像中的一行文本。

系统能力： SystemCapability.AI.OCR.TextRecognition

模型约束： 此接口仅可在Stage模型下使用。

起始版本： 4.0.0(10)

TextBlock

描述图像中的文本块。

系统能力： SystemCapability.AI.OCR.TextRecognition

模型约束： 此接口仅可在Stage模型下使用。

起始版本： 4.0.0(10)

TextRecognitionResult

文本识别的结果信息，包括文本内容和坐标信息。

系统能力： SystemCapability.AI.OCR.TextRecognition

模型约束： 此接口仅可在Stage模型下使用。

起始版本： 4.0.0(10)

textRecognition.init

init(): Promise<boolean>

初始化文字识别服务。使用Promise异步回调。

系统能力： SystemCapability.AI.OCR.TextRecognition

模型约束： 此接口仅可在Stage模型下使用。

起始版本： 5.0.0(12)

返回值：

示例：

import { textRecognition } from '@kit.CoreVisionKit';
import { hilog } from '@kit.PerformanceAnalysisKit';

async function initAndReleaseOCR() {
  // 初始化 OCR 服务
  const initResult = await textRecognition.init();
  hilog.info(0x0000, 'textRecognitionSample', `OCR service initialization result:${initResult}`);

  if (initResult) {
    hilog.info(0x0000, 'textRecognitionSample', 'OCR service initialized successfully');

    // 这里可以添加使用 OCR 服务的代码
    // 例如：await textRecognition.recognizeText(...);

    // 使用完毕后，释放 OCR 服务
    await textRecognition.release();
    hilog.info(0x0000, 'textRecognitionSample', 'OCR service released successfully');
  } else {
    hilog.error(0x0000, 'textRecognitionSample', 'Failed to initialize OCR service');
  }
}

@Entry
@Component
struct Page {

  build() {
    Column(){
      Button('initAndReleaseOCR').onClick(() => {
        // 调用函数
        void initAndReleaseOCR();
      })
    }
  }
}

textRecognition.release

release(): Promise<void>

释放文字识别服务。使用Promise异步回调。

系统能力： SystemCapability.AI.OCR.TextRecognition

模型约束： 此接口仅可在Stage模型下使用。

起始版本： 5.0.0(12)

返回值：

示例：

import { textRecognition } from '@kit.CoreVisionKit';
import { hilog } from '@kit.PerformanceAnalysisKit';

async function initAndReleaseOCR() {
  // 初始化 OCR 服务
  const initResult = await textRecognition.init();
  hilog.info(0x0000, 'textRecognitionSample', `OCR service initialization result:${initResult}`);

  if (initResult) {
    hilog.info(0x0000, 'textRecognitionSample', 'OCR service initialized successfully');

    // 这里可以添加使用 OCR 服务的代码
    // 例如：await textRecognition.recognizeText(...);

    // 使用完毕后，释放 OCR 服务
    await textRecognition.release();
    hilog.info(0x0000, 'textRecognitionSample', 'OCR service released successfully');
  } else {
    hilog.error(0x0000, 'textRecognitionSample', 'Failed to initialize OCR service');
  }
}

@Entry
@Component
struct Page {

  build() {
    Column(){
      Button('initAndReleaseOCR').onClick(() => {
        // 调用函数
        void initAndReleaseOCR();
      })
    }
  }
}

textRecognition.recognizeText

recognizeText(visionInfo: VisionInfo, callback: AsyncCallback<TextRecognitionResult>): void

识别视觉信息内包含的文本。当识别完成时，回调函数会被自动调用并返回识别结果。使用Callback异步回调。

系统能力： SystemCapability.AI.OCR.TextRecognition

模型约束： 此接口仅可在Stage模型下使用。

起始版本： 4.0.0(10)

参数：

错误码：

以下错误码的详细介绍请参见Core Vision Kit错误码。

示例：

import { textRecognition } from '@kit.CoreVisionKit';
import { image } from '@kit.ImageKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
import { BusinessError } from '@kit.BasicServicesKit';
import { fileIo } from '@kit.CoreFileKit';
import { photoAccessHelper } from '@kit.MediaLibraryKit';

async function recognizeTextTest() {
  let imageSource: image.ImageSource | undefined = undefined;
  let chooseImage: PixelMap | undefined = undefined;

  // 通过图库选择一张图片
  let photoSelectOptions = new photoAccessHelper.PhotoSelectOptions();
  photoSelectOptions.MIMEType = photoAccessHelper.PhotoViewMIMETypes.IMAGE_TYPE;
  photoSelectOptions.maxSelectNumber = 1;
  let photoPicker: photoAccessHelper.PhotoViewPicker = new photoAccessHelper.PhotoViewPicker();
  let photoSelectResult = await photoPicker.select(photoSelectOptions);
  let uri = photoSelectResult.photoUris[0];
  if (uri === undefined) {
    hilog.error(0x0000, 'OCRDemo', 'Failed to get uri.');
    return;
  }

  // 将图片转换为PixelMap
  let fileSource = await fileIo.open(uri, fileIo.OpenMode.READ_ONLY);
  imageSource = image.createImageSource(fileSource.fd);
  chooseImage = await imageSource.createPixelMap();
  if (!chooseImage) {
    return;
  }

  // 调用文本识别接口
  let visionInfo: textRecognition.VisionInfo = {
    pixelMap: chooseImage
  };
  textRecognition.recognizeText(visionInfo, (error: BusinessError, data: textRecognition.TextRecognitionResult) => {
    if (error.code !== 0) {
      hilog.error(0x0000, 'OCRDemo', `Failed to recognize text. Code: ${error.code}, message: ${error.message}`);
      return;
    }
    // 识别成功，获取对应的结果
    let recognitionString = JSON.stringify(data);
    hilog.info(0x0000, 'OCRDemo', `Succeeded in recognizing text: ${recognitionString}`);

    if (chooseImage && imageSource) {
      void chooseImage.release();
      void imageSource.release();
    }
  });
  if (fileSource) {
    await fileIo.close(fileSource);
  }
}

@Entry
@Component
struct Page {

  build() {
    Column(){
      Button('recognizeTextTest').onClick(() => {
        // 调用函数
        void recognizeTextTest();
      })
    }
  }
}

textRecognition.recognizeText

recognizeText(visionInfo: VisionInfo, configuration ?: TextRecognitionConfiguration): Promise<TextRecognitionResult>

识别视觉信息内包含的文本。可以通过自定义配置项（如是否支持朝向检测）进行更详细的设置。使用Promise异步回调。

系统能力： SystemCapability.AI.OCR.TextRecognition

模型约束： 此接口仅可在Stage模型下使用。

起始版本： 4.0.0(10)

参数：

返回值：

错误码：

以下错误码的详细介绍请参见Core Vision Kit错误码。

示例：

import { textRecognition } from '@kit.CoreVisionKit';
import { image } from '@kit.ImageKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
import { fileIo } from '@kit.CoreFileKit';
import { photoAccessHelper } from '@kit.MediaLibraryKit';

async function recognizeTextTest() {
  let imageSource: image.ImageSource | undefined = undefined;
  let chooseImage: PixelMap | undefined = undefined;

  // 通过图库选择一张图片
  let photoSelectOptions = new photoAccessHelper.PhotoSelectOptions();
  photoSelectOptions.MIMEType = photoAccessHelper.PhotoViewMIMETypes.IMAGE_TYPE;
  photoSelectOptions.maxSelectNumber = 1;
  let photoPicker: photoAccessHelper.PhotoViewPicker = new photoAccessHelper.PhotoViewPicker();
  let photoSelectResult = await photoPicker.select(photoSelectOptions);
  let uri = photoSelectResult.photoUris[0];
  if (uri === undefined) {
    hilog.error(0x0000, 'OCRDemo', 'Failed to get uri.');
    return;
  }

  // 将图片转换为PixelMap
  let fileSource = await fileIo.open(uri, fileIo.OpenMode.READ_ONLY);
  imageSource = image.createImageSource(fileSource.fd);
  chooseImage = await imageSource.createPixelMap();
  if (!chooseImage) {
    return;
  }

  // 调用文本识别接口
  let visionInfo: textRecognition.VisionInfo = {
    pixelMap: chooseImage
  };
  let recognitionResult = await textRecognition.recognizeText(visionInfo);

  // 识别成功，获取对应的结果
  let recognitionString = JSON.stringify(recognitionResult);
  hilog.info(0x0000, 'OCRDemo', `Succeeded in recognizing text: ${recognitionString}`);

  if (chooseImage && imageSource) {
    void chooseImage.release();
    void imageSource.release();
  }
  if (fileSource) {
    await fileIo.close(fileSource);
  }
}

@Entry
@Component
struct Page {

  build() {
    Column(){
      Button('recognizeTextTest').onClick(() => {
        // 调用函数
        void recognizeTextTest();
      })
    }
  }
}

textRecognition.recognizeText

recognizeText(visionInfo: VisionInfo, configuration: TextRecognitionConfiguration, callback: AsyncCallback<TextRecognitionResult>): void

通过自定义配置项对识别能力进行更详细的设置，识别视觉信息内包含的文本。当识别完成时，回调函数会被自动调用并返回识别结果。使用Callback异步回调。

系统能力： SystemCapability.AI.OCR.TextRecognition

模型约束： 此接口仅可在Stage模型下使用。

起始版本： 4.0.0(10)

参数：

错误码：

以下错误码的详细介绍请参见Core Vision Kit错误码。

示例：

import { textRecognition } from '@kit.CoreVisionKit';
import { image } from '@kit.ImageKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
import { BusinessError } from '@kit.BasicServicesKit';
import { fileIo } from '@kit.CoreFileKit';
import { photoAccessHelper } from '@kit.MediaLibraryKit';

async function recognizeTextTest() {
  let imageSource: image.ImageSource | undefined = undefined;
  let chooseImage: PixelMap | undefined = undefined;

  // 通过图库选择一张图片
  let photoSelectOptions = new photoAccessHelper.PhotoSelectOptions();
  photoSelectOptions.MIMEType = photoAccessHelper.PhotoViewMIMETypes.IMAGE_TYPE;
  photoSelectOptions.maxSelectNumber = 1;
  let photoPicker: photoAccessHelper.PhotoViewPicker = new photoAccessHelper.PhotoViewPicker();
  let photoSelectResult = await photoPicker.select(photoSelectOptions);
  let uri = photoSelectResult.photoUris[0];
  if (uri === undefined) {
    hilog.error(0x0000, 'OCRDemo', 'Failed to get uri.');
    return;
  }

  // 将图片转换为PixelMap
  let fileSource = await fileIo.open(uri, fileIo.OpenMode.READ_ONLY);
  imageSource = image.createImageSource(fileSource.fd);
  chooseImage = await imageSource.createPixelMap();
  if (!chooseImage) {
    return;
  }

  // 调用文本识别接口
  let visionInfo: textRecognition.VisionInfo = {
    pixelMap: chooseImage
  };
  let textConfiguration: textRecognition.TextRecognitionConfiguration = {
    isDirectionDetectionSupported: false
  };
  textRecognition.recognizeText(
    visionInfo,
    textConfiguration,
    (error: BusinessError, data: textRecognition.TextRecognitionResult) => {
      if (error.code !== 0) {
        hilog.error(0x0000, 'OCRDemo', `Failed to recognize text. Code: ${error.code}, message: ${error.message}`);
        return;
      }
      // 识别成功，获取对应的结果
      let recognitionString = JSON.stringify(data);
      hilog.info(0x0000, 'OCRDemo', `Succeeded in recognizing text: ${recognitionString}`);

      if (chooseImage && imageSource) {
        void chooseImage.release();
        void imageSource.release();
      }
    }
  );
  if (fileSource) {
    await fileIo.close(fileSource);
  }
}

@Entry
@Component
struct Page {

  build() {
    Column(){
      Button('recognizeTextTest').onClick(() => {
        // 调用函数
        void recognizeTextTest();
      })
    }
  }
}

textRecognition.getSupportedLanguages

getSupportedLanguages(): Promise<Array<string>>

获取当前文本识别所支持的语言类型列表。使用Promise异步回调。

系统能力： SystemCapability.AI.OCR.TextRecognition

模型约束： 此接口仅可在Stage模型下使用。

起始版本： 4.0.0(10)

返回值：

错误码：

以下错误码的详细介绍请参见Core Vision Kit错误码。

示例：

import { textRecognition } from '@kit.CoreVisionKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
import { BusinessError } from '@kit.BasicServicesKit';

@Entry
@Component
struct Page {
  @State supportedLanguages: string[] = [];

  aboutToAppear() {
    // 获取支持的语言类型列表
    textRecognition.getSupportedLanguages().then((data: Array<string>) => {
      this.supportedLanguages = data;
      let languageString = data.join(', ');
      hilog.info(0x0000, 'OCRDemo', `Succeeded in obtaining the language: ${languageString}`);
    }, (err: BusinessError) => {
      hilog.error(0x0000, 'OCRDemo', `Failed to obtain the language. Code: ${err.code}, message: ${err.message}`);
    });
  }

  build() {
    Column() {
      Text(this.supportedLanguages.join(', '))
    }
  }
}

textRecognition.getSupportedLanguages

getSupportedLanguages(callback: AsyncCallback<Array<string>>): void

获取当前文本识别所支持的语言类型列表。使用Callback异步回调。

系统能力： SystemCapability.AI.OCR.TextRecognition

模型约束： 此接口仅可在Stage模型下使用。

起始版本： 4.0.0(10)

参数：

错误码：

以下错误码的详细介绍请参见Core Vision Kit错误码。

示例：

import { textRecognition } from '@kit.CoreVisionKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
import { BusinessError } from '@kit.BasicServicesKit';

@Entry
@Component
struct Page {
  @State supportedLanguages: string[] = [];

  aboutToAppear() {
    // 获取支持的语言类型列表
    textRecognition.getSupportedLanguages((error: BusinessError, data: Array<string>) => {
      if (!error) {
        this.supportedLanguages = data;
        hilog.info(0x0000, 'OCRDemo', `Succeeded in obtaining the language: ${data}`);
      } else {
        hilog.error(0x0000, 'OCRDemo', `Failed to obtain the language. Code: ${error.code}, message: ${error.message}`);
      }
    });
  }

  build() {
    Column() {
      Text(this.supportedLanguages.join(', '))
    }
  }
}

语言类型列表