文档中心

通用文字识别服务提供图像信息转换为字符信息的能力。通过拍照、扫描等光学输入方式，把各种票据、卡证、表格、报刊、书籍等印刷品文字转化为图像信息，再利用文字识别技术将图像信息转化为计算机等设备可以使用的字符信息，便于用户提取字符内容、屏幕坐标及外框。目前本服务支持识别的语言有：简体中文、英文、日文、韩文、繁体中文五种语言。

起始版本：4.0.0(10)

导入模块

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

TextRecognitionConfiguration

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

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

起始版本：4.0.0(10)

名称	类型	只读	可选	说明
isDirectionDetectionSupported	boolean	否	是	表示是否支持文字朝向检测。 true：表示支持朝向检测；false：表示不支持朝向检测。默认是true，支持朝向检测。如果能判断当前图片是正向的，则可考虑将该属性设置为false，以提升性能。

名称

类型

只读

可选

说明

isDirectionDetectionSupported

boolean

否

是

表示是否支持文字朝向检测。

true：表示支持朝向检测；false：表示不支持朝向检测。

默认是true，支持朝向检测。如果能判断当前图片是正向的，则可考虑将该属性设置为false，以提升性能。

VisionInfo

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

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

起始版本：4.0.0(10)

名称	类型	只读	可选	说明
pixelMap	image.PixelMap	是	否	待识别的图片。

PixelPoint

指示像素点的位置。

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

起始版本：4.0.0(10)

名称	类型	只读	可选	说明
x	number	是	否	像素点横向x坐标。
y	number	是	否	像素点纵向y坐标。

TextWord

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

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

起始版本：4.0.0(10)

名称	类型	只读	可选	说明
value	string	是	否	单词的文本内容。
cornerPoints	Array<PixelPoint>	是	否	以顺时针返回的单词外框位置点列表。

TextLine

描述图像中的一行文本。

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

起始版本：4.0.0(10)

名称	类型	只读	可选	说明
value	string	是	否	文本行的文本内容。
cornerPoints	Array<PixelPoint>	是	否	以顺时针返回该文本行的外框位置点列表。
words	Array<TextWord>	是	否	该行包含的单词信息。

TextBlock

描述图像中的文本块。

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

起始版本：4.0.0(10)

名称	类型	只读	可选	说明
value	string	是	否	段落的文本内容。
lines	Array<TextLine>	是	否	该段落包含的文本行内容。

TextRecognitionResult

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

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

起始版本：4.0.0(10)

名称	类型	只读	可选	说明
value	string	是	否	所识别的文本内容。
blocks	Array<TextBlock>	是	否	文本内容中的具体段落信息。

textRecognition.init

init(): Promise<boolean>

初始化文字识别服务。使用Promise方式异步返回结果。

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

起始版本：5.0.0(12)

返回值：

类型	说明
Promise<boolean>	Promise对象，返回初始化是否成功。 true：初始化成功；false：初始化失败。

类型

说明

Promise<boolean>

Promise对象，返回初始化是否成功。

true：初始化成功；false：初始化失败。

示例：

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(() => {
        // 调用函数
        initAndReleaseOCR();
      })
    }
  }
}

textRecognition.release

release(): Promise<void>

释放文字识别服务。返回一个空的Promise对象。

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

起始版本：5.0.0(12)

返回值：

类型	说明
Promise<void>	Promise对象，释放接口无返回值。

示例：

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(() => {
        // 调用函数
        initAndReleaseOCR();
      })
    }
  }
}

textRecognition.recognizeText

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

识别视觉信息内包含的文本。使用Callback方式异步返回结果。

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

起始版本：4.0.0(10)

参数：

参数名	类型	必填	说明
visionInfo	VisionInfo	是	待识别的视觉信息。
callback	AsyncCallback<TextRecognitionResult>	是	回调函数，返回文字识别的对象。

错误码：

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

错误码ID	错误信息
200	Run timed out, please try again later.
401	The parameter check failed.
1001400001	Failed to run, please try again.
1001400002	The service is abnormal.

示例：

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';

let imageSource: image.ImageSource | undefined = undefined;
let chooseImage: PixelMap | undefined = undefined;
// 将图片转换为PixelMap，可以通过图库获取
let photoPicker: photoAccessHelper.PhotoViewPicker = new photoAccessHelper.PhotoViewPicker();
photoPicker.select({
  MIMEType: photoAccessHelper.PhotoViewMIMETypes.IMAGE_TYPE, maxSelectNumber: 1
}).then((res: photoAccessHelper.PhotoSelectResult) => {
  let uri = res.photoUris[0];
  if (uri === undefined) {
    hilog.error(0x0000, 'OCRDemo', "Failed to get uri.");
    return;
  }
  setTimeout(async () => {
    let fileSource = await fileIo.open(uri, fileIo.OpenMode.READ_ONLY);
    imageSource = image.createImageSource(fileSource.fd);
    chooseImage = await imageSource.createPixelMap();
    hilog.info(0x0000, 'OCRDemo', `chooseImage：${chooseImage.toString()}`);
    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 = data.toString();
      hilog.info(0x0000, 'OCRDemo', `Succeeded in recognizing text：${recognitionString}`);

      if(chooseImage && imageSource) {
        chooseImage.release();
        imageSource.release();
      }
    });
  }, 100)
}).catch((err: BusinessError) => {
  hilog.error(0x0000, 'OCRDemo', `Failed to get photo image uri. Code：${err.code}，message：${err.message}`);
})

@Entry
@Component
struct Page {

  build() {
    Column(){
    }
  }
}

textRecognition.recognizeText

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

识别视觉信息内包含的文本，可以通过自定义配置项进行更详细的设置。使用Promise方式异步返回结果。

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

起始版本：4.0.0(10)

参数：

参数名	类型	必填	说明
visionInfo	VisionInfo	是	待识别的视觉信息。
configuration	TextRecognitionConfiguration	否	识别的配置项。

返回值：

类型	说明
Promise<TextRecognitionResult>	Promise对象，返回文字识别的结果对象。

错误码：

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

错误码ID	错误信息
200	Run timed out, please try again later.
401	The parameter check failed.
1001400001	Failed to run, please try again.
1001400002	The service is abnormal.

示例：

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';

let imageSource: image.ImageSource | undefined = undefined;
let chooseImage: PixelMap | undefined = undefined;
// 将图片转换为PixelMap，可以通过图库获取
let photoPicker: photoAccessHelper.PhotoViewPicker = new photoAccessHelper.PhotoViewPicker();
photoPicker.select({
  MIMEType: photoAccessHelper.PhotoViewMIMETypes.IMAGE_TYPE, maxSelectNumber: 1
}).then((res: photoAccessHelper.PhotoSelectResult) => {
  let uri = res.photoUris[0];
  if (uri === undefined) {
    hilog.error(0x0000, 'OCRDemo', "Failed to get uri.");
    return;
  }
  setTimeout(async () => {
    let fileSource = await fileIo.open(uri, fileIo.OpenMode.READ_ONLY);
    imageSource = image.createImageSource(fileSource.fd);
    chooseImage = await imageSource.createPixelMap();
    hilog.info(0x0000, 'OCRDemo', `chooseImage：${chooseImage.toString()}`);
    if (!chooseImage) {
      return;
    }

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

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

    if(chooseImage && imageSource) {
      chooseImage.release();
      imageSource.release();
    }
  }, 100)
}).catch((err: BusinessError) => {
  hilog.error(0x0000, 'OCRDemo', `Failed to get photo image uri. Code：${err.code}，message：${err.message}`);
})

@Entry
@Component
struct Page {

  build() {
    Column(){
    }
  }
}

textRecognition.recognizeText

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

通过自定义配置项对识别能力进行更详细的设置，识别视觉信息内包含的文本。使用Callback方式异步返回结果。

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

起始版本：4.0.0(10)

参数：

参数名	类型	必填	说明
visionInfo	VisionInfo	是	待识别的视觉信息。
configuration	TextRecognitionConfiguration	是	识别的配置项。
callback	AsyncCallback<TextRecognitionResult>	是	识别结果的回调，可以用于界面显示或交互。

错误码：

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

错误码ID	错误信息
200	Run timed out, please try again later.
401	The parameter check failed.
1001400001	Failed to run, please try again.
1001400002	The service is abnormal.

示例：

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';

let imageSource: image.ImageSource | undefined = undefined;
let chooseImage: PixelMap | undefined = undefined;
// 将图片转换为PixelMap，可以通过图库获取
let photoPicker: photoAccessHelper.PhotoViewPicker = new photoAccessHelper.PhotoViewPicker();
photoPicker.select({
  MIMEType: photoAccessHelper.PhotoViewMIMETypes.IMAGE_TYPE, maxSelectNumber: 1
}).then((res: photoAccessHelper.PhotoSelectResult) => {
  let uri = res.photoUris[0];
  if (uri === undefined) {
    hilog.error(0x0000, 'OCRDemo', "Failed to get uri.");
    return;
  }
  setTimeout(async () => {
    let fileSource = await fileIo.open(uri, fileIo.OpenMode.READ_ONLY);
    imageSource = image.createImageSource(fileSource.fd);
    chooseImage = await imageSource.createPixelMap();
    hilog.info(0x0000, 'OCRDemo', `chooseImage：${chooseImage.toString()}`);
    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 = data.toString();
      hilog.info(0x0000, 'OCRDemo', `Succeeded in obtaining the language：${recognitionString}`);

      if(chooseImage && imageSource) {
        chooseImage.release();
        imageSource.release();
      }
    });
  }, 100)
}).catch((err: BusinessError) => {
  hilog.error(0x0000, 'OCRDemo', `Failed to get photo image uri. Code：${err.code}，message：${err.message}`);
})

@Entry
@Component
struct Page {

  build() {
    Column(){
    }
  }
}

textRecognition.getSupportedLanguages

getSupportedLanguages(): Promise<Array<string>>

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

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

起始版本：4.0.0(10)

返回值：

类型	说明
Promise<Array<string>>	Promise对象，返回所支持的语言类型列表。

错误码：

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

错误码ID	错误信息
1001400001	Failed to run, please try again.
1001400002	The service is abnormal.

示例：

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

textRecognition.getSupportedLanguages().then((data: Array<string>) => {
  let languageString = data.join(', ');
  hilog.info(0x0000, 'OCRDemo', `Succeeded in obtaining the language：${languageString}`);
}, (err: BusinessError) => {
  hilog.error(0x0000, 'OCRDemo', `Failed to obtaining the language. Code：${err.code}, message：${err.message}`);
});

@Entry
@Component
struct Page {

  build() {
    Column(){
    }
  }
}

textRecognition.getSupportedLanguages

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

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

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

起始版本：4.0.0(10)

参数：

参数名	类型	必填	说明
callback	AsyncCallback<Array<string>>	是	所支持的语言类型列表。

错误码：

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

错误码ID	错误信息
1001400001	Failed to run, please try again.
1001400002	The service is abnormal.

示例：

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

textRecognition.getSupportedLanguages((error: BusinessError, data: Array<string>) => {
  if (!error) {
    hilog.info(0x0000, 'OCRDemo', `Succeeded in obtaining the language：${data}`);
  } else {
    hilog.error(0x0000, 'OCRDemo', `Failed to obtaining the language. Code：${error.code}, message：${error.message}`);
  }
});

@Entry
@Component
struct Page {

  build() {
    Column(){
    }
  }
}

语言类型列表

语言（英）	语言（中）
zh-CN	简体中文
en	英文
ja	日文
ko	韩文
zh-TW	繁体中文

textRecognition（文字识别）

导入模块

TextRecognitionConfiguration

VisionInfo

PixelPoint

TextWord

TextLine

TextBlock

TextRecognitionResult

textRecognition.init

textRecognition.release

textRecognition.recognizeText

textRecognition.recognizeText

textRecognition.recognizeText

textRecognition.getSupportedLanguages

textRecognition.getSupportedLanguages

语言类型列表