You need to enable JavaScript to run this app.
导航
文字识别 OCR
最近更新时间:2024.06.03 19:02:00首次发布时间:2024.06.03 19:02:00

阅读本文,您可以获取 Node SDK 文字识别 OCR的接口调用示例,实现快速开发。

说明

本文的调用示例包含接口的部分参数。由于参数间可能存在互斥关系,在调用时,请您参考注释,进行调整。

调用说明

  • 本文提供的接口调用示例均通过 AK 和 SK 初始化实例。
  • 接口的参数说明和错误码等信息可通过接口文档查看。

前提条件

调用接口前,请先完成 Node SDK 的安装及初始化操作。

调用示例

本节为您介绍文字识别 OCR相关接口的功能和调用示例。

使用文字识别 OCR 获取识别信息

您可以调用 GetImageOCRV2 接口使用文字识别 OCR 获取识别信息。详细的参数说明可参见 GetImageOCRV2 接口文档。

接口调用示例如下所示。

import { imagex } from "@volcengine/openapi";
  
  export async function GetImageOCRV2Demo () {
    try {
      const imagexService = new imagex.ImagexService({
        // 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里,否则可能导致 AccessKey 泄露,威胁您账号下所有资源的安全。
        accessKeyId: process.env.VOLC_ACCESSKEY,
        // 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret,来实现 API 访问的身份验证。运行代码示例前,请配置环境变量 VOLC_ACCESSKEY 和 VOLC_SECRETKEY
        secretKey: process.env.VOLC_SECRETKEY,
      });
      const requestParam = {
      // 服务 ID。
      // <li> 您可以在 veImageX 控制台 [服务管理](https://console.volcengine.com/imagex/service_manage/)页面,在创建好的图片服务中获取服务 ID。 </li>
      // <li> 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考[获取所有服务信息](https://www.volcengine.com/docs/508/9360)。 </li>
      "ServiceId": "0j**2h",
      // 待识别的图片 URL,满足公网可访问。仅当 `StoreUri` 为空时取值有效,两者都为空时报错。
      "ImageUrl": "http://test.com/example.png",
      // 待识别图片文件的存储 URI。
      "StoreUri": "test.com/example.png",
      // 图片OCR识别场景,取值如下所示:
      // <li> `general`:通用场景,用于通用印刷体场景识别文本信息。 </li>
      // <li> `license`:营业执照场景,用于识别营业执照中社会信用代码等文本信息。 </li>
      // <li> `instrument`:设备识别场景,用于一些设备显示文字识别。 </li>
      // <li> `defect`:缺陷检测场景 </li>
      // warning
      // 当前仅支持识别图片中**简体中文**和**简体英文**这两种文本信息。
      "Scene": "defect",
      // 待识别的设备名称,仅当 `Scene` 为 `Instrument` 时,配置有效。取值如下所示:
      // <li> `freezing-point-tester`:冰点仪 </li>
      // <li> `brake-fluid-tester`:制动液测试仪 </li>
      // <li> `thermometer`: 温度计 </li>
      // <li> `oil-tester`:机油仪 </li>
      "InstrumentName": "thermometer",
      // 定制化保留字段,如果是正常调用忽略该字段,若为定制化需求则需要和算法开发者对齐调用方式
      "Extra" : {
        // 默认为False,不开启Extra
        "Enable": false,
        // 算子名称
        "MMServiceName": "ocr",
        // 算子版本
        "MMServiceVersion": "v4",
        // 算子的输入参数
        "MMServiceInput": '{\"scene\":1}',
      }, 
    }

      const res = await imagexService.GetImageOCRV2(requestParam);
      console.log('res',res)
    } catch (err) {
      console.error(err);
    }
  }