# @capacitor-mlkit/text-recognition 中文文档

规范地址：https://npmcn.com/package/%40capacitor-mlkit/text-recognition/

版本：8\.2\.2
npm 元数据更新时间：2026-10-31T07:04:10.457Z
中文译文更新时间：2026-11-09T03:27:15.716Z
软件包许可：Apache-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40capacitor-mlkit/text-recognition
原文对照：https://npmcn.com/package/%40capacitor-mlkit/text-recognition/?lang=original
项目主页：https://capawesome.io/docs/sdks/capacitor/mlkit/text-recognition/
源码仓库：https://github.com/capawesome-team/capacitor-mlkit

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：88.4 kB，37 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：@capacitor/core \>=8\.0\.0
- 首次发布：2026-07-11T08:03:02.116Z
- 最新版本发布：2026-10-31T07:04:10.148Z
- 近 30 天下载量：49275（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：4（近 12 个月 4 个）

## 中文简介

在Android和iOS上为ML Kit文本识别的电容插件.

## 安装

```sh
npm install @capacitor-mlkit/text-recognition
```

也可以使用：`pnpm add @capacitor-mlkit/text-recognition`、`yarn add @capacitor-mlkit/text-recognition`、`bun add @capacitor-mlkit/text-recognition`

## README

# ML Kit 文本识别插件

非官方电容插件 [ML Kit 文本识别](https://developers.google.com/ml-kit/vision/text-recognition/v2)\[^1\]

[![Thousands of teams ship faster with Capawesome Cloud Native Builds and Live Updates](https://capawesome.io/assets/banners/cloud-teams-ship-faster-with-capacitor.png)](https://capawesome.io/)

## 使用大小写

当应用程序需要从图像中取出文本时,通常会使用文本识别插件,例如:

-   **文件数字化**: 将印刷的文档、收据或名片转换为机器可读文本.
-   **数据输入自动化**:从表格或标签中取出文本来预填入字段并减少手动打字.
-   **无障碍**: 高声读取图像中发现的文本以支持屏幕读取器和其他辅助技术.
-   **笔译管道**:在将文本传送给翻译服务之前,先以图像识别文本.

## 兼容性

| 插件版本 | 电容版本 | 状态 |
| --- | --- | --- |
| 8.x.x (英语) | \>=8.x.x | 积极支持 |

## 安装

你可以用我们的 **AI 辅助设置** 以安装插件. 添加数据 [超级技能](https://github.com/capawesome-team/skills) 至您的 AI 工具,使用以下命令:

```bash
npx skills add capawesome-team/skills --skill capacitor-plugins
```

然后使用下列提示:

```
Use the `capacitor-plugins` skill from `capawesome-team/skills` to install the `@capacitor-mlkit/text-recognition` plugin in my project.
```

如果你喜欢 **手动设置**,通过运行以下命令来安装插件,并遵循下面的平台特定指令:

```bash
npm install @capacitor-mlkit/text-recognition
npx cap sync
```

**请注意**: 此插件 **只支持可口可乐Pods** iOS的依赖性管理。 Swift 软件包管理器( SPM) 不支持 ML Kit SDK, 参见 [本评论](https://github.com/googlesamples/mlkit/issues/180#issuecomment-1298964099)。 。 。 .

### App 大小影响

此插件为每个支持的脚本(拉丁文、中文、德瓦纳加里文、日文和韩文)装入一个单独的模型。 每个模型都会使您的应用程序大小增加数兆字节. 在决定您的应用程序实际需要的脚本时记住这一点.

### 机器人

#### 变量

如果需要, 您可以在您的应用中定义以下工程变量 `variables.gradle` 更改依赖关系的默认版本的文件 :

-   `$mlkitTextRecognitionVersion` 版本 `com.google.mlkit:text-recognition` (默认 : `16.0.1`(中文(简体) )
-   `$mlkitTextRecognitionChineseVersion` 版本 `com.google.mlkit:text-recognition-chinese` (默认 : `16.0.1`(中文(简体) )
-   `$mlkitTextRecognitionDevanagariVersion` 版本 `com.google.mlkit:text-recognition-devanagari` (默认 : `16.0.1`(中文(简体) )
-   `$mlkitTextRecognitionJapaneseVersion` 版本 `com.google.mlkit:text-recognition-japanese` (默认 : `16.0.1`(中文(简体) )
-   `$mlkitTextRecognitionKoreanVersion` 版本 `com.google.mlkit:text-recognition-korean` (默认 : `16.0.1`(中文(简体) )

如果您在工程中遇到其它插件的依赖性冲突, 这会有所帮助 .

### iOS系统

#### 最低部署目标

确定部署目标 `ios/App/Podfile` 至少改为 `15.5`数字 :

```ruby
platform :ios, '15.5'
```

## 配置

此插件不需要配置 .

## 演示

这里有一个实例: [robingenz/电容-mlkit-plugin-demo](https://github.com/robingenz/capacitor-mlkit-plugin-demo)

## 使用量

以下例子说明如何在图像中识别文本.

### 在图像中识别文本

在本地路径的图像中识别文本 。 您可以选择要识别的文本脚本 。 仅在Android和iOS上提供:

```typescript
import { Script, TextRecognition } from '@capacitor-mlkit/text-recognition';

const processImage = async () => {
  const { text, blocks } = await TextRecognition.processImage({
    path: 'path/to/image.jpg',
    script: Script.Latin,
  });
  return { text, blocks };
};
```

## API 密码

-   [`processImage(...)`](https://npmcn.com/package/%40capacitor-mlkit/text-recognition/#readme-processimage)
-   [接口](https://npmcn.com/package/%40capacitor-mlkit/text-recognition/#readme-interfaces)
-   [数字](https://npmcn.com/package/%40capacitor-mlkit/text-recognition/#readme-enums)

### 进程图像(...)

```typescript
processImage(options: ProcessImageOptions) => Promise<ProcessImageResult>
```

识别图像中的文本 .

仅在Android和iOS上提供.

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[ProcessImageOptions](https://npmcn.com/package/%40capacitor-mlkit/text-recognition/#readme-processimageoptions)` |

**回返情况:** `Promise<[ProcessImageResult](https://npmcn.com/package/%40capacitor-mlkit/text-recognition/#readme-processimageresult)>`

**自:** 8.2.0 (中文(简体) )

* * *

### 接口

#### 进程图像结果

| Prop | 类型 | 说明 | 自兹 |
| --- | --- | --- | --- |
| **`text`** | `string` | 全文. | 8.2.0 (中文(简体) ) |
| **`blocks`** | `TextBlock[]` | 公认的文本块. | 8.2.0 (中文(简体) ) |

#### 文本锁定

代表一个文本块.

块是一组相接的文本行,如段落或一列.

| Prop | 类型 | 说明 | 自兹 |
| --- | --- | --- | --- |
| **`text`** | `string` | 区块的公认文字. | 8.2.0 (中文(简体) ) |
| **`boundingBox`** | `[Rect](https://npmcn.com/package/%40capacitor-mlkit/text-recognition/#readme-rect)` | 街区的边界箱. | 8.2.0 (中文(简体) ) |
| **`cornerPoints`** | `Point[]` | 按顺时针顺序排列的块的四个角点,从左上角点相对于图像开始. | 8.2.0 (中文(简体) ) |
| **`recognizedLanguage`** | `string` | BCP-47区被确认为区块语言的语言代码. | 8.2.0 (中文(简体) ) |
| **`lines`** | `TextLine[]` | 区块内公认的文字行. | 8.2.0 (中文(简体) ) |

#### 矩形

代表一个矩形.

| Prop | 类型 | 说明 | 自兹 |
| --- | --- | --- | --- |
| **`left`** | `number` | 长方形的左坐标. | 8.2.0 (中文(简体) ) |
| **`top`** | `number` | 长方形上部坐标. | 8.2.0 (中文(简体) ) |
| **`right`** | `number` | 矩形的右坐标. | 8.2.0 (中文(简体) ) |
| **`bottom`** | `number` | 矩形的下部坐标. | 8.2.0 (中文(简体) ) |

#### 点

代表一个点.

| Prop | 类型 | 说明 | 自兹 |
| --- | --- | --- | --- |
| **`x`** | `number` | 点的x坐标. | 8.2.0 (中文(简体) ) |
| **`y`** | `number` | 点的Y坐标. | 8.2.0 (中文(简体) ) |

#### 文本行

代表一行文字.

| Prop | 类型 | 说明 | 自兹 |
| --- | --- | --- | --- |
| **`text`** | `string` | 该行的公认文字. | 8.2.0 (中文(简体) ) |
| **`boundingBox`** | `[Rect](https://npmcn.com/package/%40capacitor-mlkit/text-recognition/#readme-rect)` | 入行相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相. | 8.2.0 (中文(简体) ) |
| **`cornerPoints`** | `Point[]` | 以顺时针顺序排列的行中四个角点,从左上角点相对图像开始. | 8.2.0 (中文(简体) ) |
| **`recognizedLanguage`** | `string` | 该行公认语言的BCP-47语言代码. | 8.2.0 (中文(简体) ) |
| **`elements`** | `TextElement[]` | 线内文字的公认要素. | 8.2.0 (中文(简体) ) |

#### 文本元素

代表文本的一个要素.

一个元素是一组相接的字符,比如一个单词.

| Prop | 类型 | 说明 | 自兹 |
| --- | --- | --- | --- |
| **`text`** | `string` | 元素的公认文本. | 8.2.0 (中文(简体) ) |
| **`boundingBox`** | `[Rect](https://npmcn.com/package/%40capacitor-mlkit/text-recognition/#readme-rect)` | 元素的边框 . | 8.2.0 (中文(简体) ) |
| **`cornerPoints`** | `Point[]` | 元素以顺时针顺序排列的四个角点,从左上角点相对图像开始. | 8.2.0 (中文(简体) ) |
| **`recognizedLanguage`** | `string` | 元素识别语言的BCP-47语言代码. | 8.2.0 (中文(简体) ) |

#### 进程图像选项

| Prop | 类型 | 说明 | 默认 | 自兹 |
| --- | --- | --- | --- | --- |
| **`path`** | `string` | 图像文件的本地路径 . |  | 8.2.0 (中文(简体) ) |
| **`script`** | `[Script](https://npmcn.com/package/%40capacitor-mlkit/text-recognition/#readme-script)` | 文字以辨之. 每个脚本都需要一个与应用程序相捆绑的单独的模型. | `Script.Latin` | 8.2.0 (中文(简体) ) |

### 数字

#### 脚本

| 成员 | 数值 | 说明 | 自兹 |
| --- | --- | --- | --- |
| **`Latin`** | `'LATIN'` | 拉丁文剧本. | 8.2.0 (中文(简体) ) |
| **`Chinese`** | `'CHINESE'` | 中国剧本. | 8.2.0 (中文(简体) ) |
| **`Devanagari`** | `'DEVANAGARI'` | 德瓦纳加里剧本. | 8.2.0 (中文(简体) ) |
| **`Japanese`** | `'JAPANESE'` | 日本剧本. | 8.2.0 (中文(简体) ) |
| **`Korean`** | `'KOREAN'` | 韩剧本. | 8.2.0 (中文(简体) ) |

## 财务问题

### 此插件支持哪些平台 ?

这个 `processImage(...)` 方法只在Android和iOS上可用. 网络平台不为基础的ML Kit文本识别SDK所支持.

### 支持哪些脚本 ?

该插件支持拉丁文,中文,德瓦纳加里文,日文,韩文等文字. 使用 `script` 选项来选择要识别的文本的脚本。 每个脚本都使用与您的应用程序相捆绑的单独模型.

### 捆绑所有的脚本会增加应用大小吗?

对 每个脚本模型都为您的应用程序添加了数兆字节. 所有5个模型都被捆绑起来,这样每个脚本都可以在运行时使用而无需额外的下载.

### 我要以何种格式提供图像路径 ?

这个 `path` 必须是本地文件路径(例如). `file:///path/to/image.jpg`。远程 URL 不支持.

### 我能用这个插件吗? 有Ionic、React、Vue或Angular?

是的,插件是框架不可知的。 它在任意网络框架的Capacitor app中工作,包括有Angular,React,或Vue的Ionic,以及平版JavaScript等项目.

## 相关插件

-   [ML Kit 条码扫描](https://capawesome.io/docs/sdks/capacitor/mlkit/barcode-scanning/):用ML Kit条码扫描条码.
-   [ML Kit 图像标签](https://capawesome.io/docs/sdks/capacitor/mlkit/image-labeling/):用 ML Kit 图像标签在图像中检测标签.
-   [ML Kit 面部检测](https://capawesome.io/docs/sdks/capacitor/mlkit/face-detection/):用 ML Kit Face 检测图像中的检测面孔.

## 术语和隐私

此插件使用 [Google ML Kit (Google ML Kit) 页面存档备份,存于互联网档案馆](https://developers.google.com/ml-kit)数字 :

-   [术语和隐私](https://developers.google.com/ml-kit/terms)
-   [Android 数据披露](https://developers.google.com/ml-kit/android-data-disclosure)
-   [iOS 数据披露](https://developers.google.com/ml-kit/ios-data-disclosure)

## 通讯

随时更新有关卡帕韦索姆、Capacitor和Ionic生态系统的最新消息和最新消息,因为我们 [《卡帕索克通讯》](https://cloud.capawesome.io/newsletter/)。 。 。 .

## 更改日志

见 [变动情况](https://github.com/capawesome-team/capacitor-mlkit/blob/main/packages/text-recognition/CHANGELOG.md)。 。 。 .

## 许可证

见 [自由主义](https://github.com/capawesome-team/capacitor-mlkit/blob/main/packages/text-recognition/LICENSE)。 。 。 .

\[^1\]: 这个项目不附属于Google LLC或其任何子公司或子公司,也不获得其认可、支持、赞助或批准.

## 常见问题

### @capacitor-mlkit/text-recognition 是什么？

在Android和iOS上为ML Kit文本识别的电容插件\.

### 如何安装 @capacitor-mlkit/text-recognition？

在项目目录运行 npm install @capacitor-mlkit/text-recognition，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@capacitor/core（\>=8\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @capacitor-mlkit/text-recognition 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @capacitor-mlkit/text-recognition 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @capacitor-mlkit/text-recognition 可以商用吗？

@capacitor-mlkit/text-recognition 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @capacitor-mlkit/text-recognition 的下载量有多少？

根据 npm 官方下载统计，@capacitor-mlkit/text-recognition 在 2026/10/09 – 2026/11/07 这 30 天内被下载 49,275 次，日均约 1,643 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @capacitor-mlkit/text-recognition 还在维护吗？

最新版本 8\.2\.2 发布于 2026/10/31（9 天前）；至今共发布 4 个版本，其中过去 12 个月发布了 4 个；首次发布于 2026/07/11。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。