TypeScript SDK

前提条件

• 已下载并安装TypeScript的开发环境。

• 已创建并获取AccessKey。具体操作，请参见创建AccessKey。
• 已开通OSS服务、创建存储空间并上传文件到存储空间。具体操作，请参见上传文件。
• 已开通智能媒体管理服务。具体操作，请参见开通产品。
• 已调用CreateProject - 创建项目接口创建项目。
  说明

  • 您也可以通过智能媒体管理控制台创建项目。具体操作，请参见创建项目。
  • 您可以调用ListProjects - 列出所有项目信息的列表接口列出指定地域下已创建的所有项目信息。

安装SDK

使用智能媒体管理TypeScript SDK的操作步骤如下：

1. 使用npm添加智能媒体管理TypeScript SDK。

   npm install @alicloud/imm20200930

2. 开始一个TypeScript项目。

   调用TypeScript SDK的主要步骤如下：

   1. 创建Client实例。

      在创建Client实例时，您需要获取并配置Region ID、AccessKey ID和AccessKey Secret。

   2. 创建API请求并设置参数。

   3. 发起请求并处理应答或异常。

使用方法

如下以使用1.27.5版本的TypeScript SDK在华东1（杭州）地域中检测图片中的人脸及人脸信息为例介绍如何使用智能媒体管理TypeScript SDK。

1. 创建demo.ts文件并写入如下内容。

   说明

   复制使用如下示例代码时请将访问域名换成您的IMM项目所在Region的域名，并且IMM项目和OSS文件Region需要保持一致。

   import imm20200930, * as $imm20200930 from '@alicloud/imm20200930';
   import OpenApi, * as $OpenApi from '@alicloud/openapi-client';
   import Util, * as $Util from '@alicloud/tea-util';
   import * as $tea from '@alicloud/tea-typescript';
   
   
   export default class Client {
   
     /**
      * 使用AccessKey ID和AccessKey Secret初始化账号Client。
      * @param accessKeyId
      * @param accessKeySecret
      * @return Client
      * @throws Exception
      */
     static createClient(accessKeyId: string, accessKeySecret: string): imm20200930 {
       let config = new $OpenApi.Config({
         // 填写您的AccessKey ID。
         accessKeyId: accessKeyId,
         // 填写您的AccessKey Secret。
         accessKeySecret: accessKeySecret,
       });
       // 填写访问域名。
       config.endpoint = `imm.cn-hangzhou.aliyuncs.com`;
       return new imm20200930(config);
     }
   
     static async main(args: string[]): Promise<void> {
       // 填写IMM的AccessKey ID、AccessKey Secret，建议从配置中读取。
       // 创建Client。
       let client = Client.createClient("accessKeyId", "accessKeySecret");
       // 创建API请求并设置参数。
       let detectImageFacesRequest = new $imm20200930.DetectImageFacesRequest({
         // 填写IMM项目名称。
         projectName: "immtest",
         sourceURI: "oss://your-bucket-name/your-path/your-image.jpg"
       });
       let runtime = new $Util.RuntimeOptions({ });
       try {
         // 打印API的返回值。
         let response = await client.detectImageFacesWithOptions(detectImageFacesRequest, runtime);
         console.log(JSON.stringify(response.body));
       } catch (error) {
         // 如有需要，请打印错误信息。
         Util.assertAsString(error.message);
         console.log(error);
       }    
     }
   
   }
   
   Client.main(process.argv.slice(2));

2. 执行如下命令将demo.ts转换为JavaScript代码，转换完生成demo.js文件。

   tsc demo.ts

3. 执行node demo.js命令，控制台输出结果如下。

   {
     "faces": [
       {
         "attractive": 0.9810000061988831,
         "beard": "none",
         "beardConfidence": 0.9990000128746033,
         "boundary": {
           "height": 320,
           "left": 217,
           "top": 169,
           "width": 226
         },
         "emotion": "happiness",
         "emotionConfidence": 1,
         "faceQuality": 0.9869999885559082,
         "figureClusterId": "figure-cluster-id-unavailable",
         "figureConfidence": 1,
         "figureId": "92b7ed67-6344-4410-b5ed-****",
         "figureType": "face",
         "glasses": "none",
         "glassesConfidence": 0.9990000128746033,
         "hat": "none",
         "hatConfidence": 1,
         "headPose": {
           "pitch": -17.742000579833984,
           "roll": 3.2850000858306885,
           "yaw": -0.7279999852180481
         },
         "mask": "none",
         "maskConfidence": 0.7559999823570251,
         "mouth": "open",
         "mouthConfidence": 1,
         "sharpness": 1,
         ...
       }
     ],
     "requestId": "5BE08720-554C-566F-A642-****"
   }