You need to enable JavaScript to run this app.
导航
图片检测与识别
最近更新时间:2024.08.12 15:33:26首次发布时间:2024.06.03 19:02:00

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

说明

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

调用说明

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

前提条件

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

调用示例

本节为您介绍图片检测与识别相关接口的功能和调用示例。

使用图片检测与识别获取图片人脸坐标

您可以调用 GetImageDetectResult 接口使用图片检测与识别获取图片人脸坐标。详细的参数说明可参见 GetImageDetectResult 接口文档。

接口调用示例如下所示。

import { imagex } from "@volcengine/openapi";

export async function GetImageDetectResultDemo() {
  try {
    const imagexService = new imagex.ImagexService({
      // 强烈建议不要把 VOLC_ACCESSKEY 和 VOLC_SECRETKEY 保存到工程代码里,否则可能导致 AccessKey 泄露,威胁您账号下所有资源的安全。
      // 本示例通过从环境变量中读取 VOLC_ACCESSKEY 和 VOLC_SECRETKEY,来实现 API 访问的身份验证。运行代码示例前,请配置环境变量 VOLC_ACCESSKEY 和 VOLC_SECRETKEY
      accessKeyId: process.env.VOLC_ACCESSKEY,
      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: "serviceid1",
      // 指定服务下的待检测图片的 StoreUri 或者公网可访问 Url。
      ImageUri: "tos-serviceid1/demo.png",
      // 检测类型,取值仅支持 face,表示检测图片中人脸所在坐标。
      DetectType: "face",
      // 当 DetectType 取值 face 时,为必填。
      // 人脸检测阈值,默认值为 0.52,取值范围为 (0,1)。值越高,对检测结果过滤越严格,召回率越低,精确率越高。
      // note:
      // <li> 阈值过低,表示图片中的检测样本较多,可能会导致非人脸样本被纳入检测范围,从而降低精确率。 </li>
      // <li> 阈值过高,表示图片中的检测样本较少,可能导致样本漏检。 </li>
      FaceDetectThresh: 0.52,
    };

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

使用隐私分类获取分类信息

您可以调用 GetPrivateImageType 接口使用隐私分类获取分类信息。详细的参数说明可参见 GetPrivateImageType 接口文档。

接口调用示例如下所示。

import { imagex } from "@volcengine/openapi";

export async function GetPrivateImageTypeDemo() {
  try {
    const imagexService = new imagex.ImagexService({
      // 强烈建议不要把 VOLC_ACCESSKEY 和 VOLC_SECRETKEY 保存到工程代码里,否则可能导致 AccessKey 泄露,威胁您账号下所有资源的安全。
      // 本示例通过从环境变量中读取 VOLC_ACCESSKEY 和 VOLC_SECRETKEY,来实现 API 访问的身份验证。运行代码示例前,请配置环境变量 VOLC_ACCESSKEY 和 VOLC_SECRETKEY
      accessKeyId: process.env.VOLC_ACCESSKEY,
      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: "89**0j",
      // 原图的存储 URI。
      ImageUri: "imagex-common/b9***77",
      // 检测内容,默认为all,取值如下所示:
      // <li> face:图片内人脸检测 </li>
      // <li> cloth:图片内衣物检测 </li>
      // <li> all:图片内人脸和衣物均检测 </li>
      Method: "all",
      // 人脸置信度,取值范围为[0, 1], 默认值为 0.52,表示高于 0.52 即为有效检测。
      ThresFace: 0.52,
      // 衣物置信度,取值范围为[0, 1], 默认值为 0.8,表示高于 0.8 即为有效检测。
      ThresCloth: 0.8,
    };

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