Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/TencentCloudBase/image-node-sdk

智能图像服务 node sdk
https://github.com/TencentCloudBase/image-node-sdk

Last synced: about 1 month ago
JSON representation

智能图像服务 node sdk

Host: GitHub
URL: https://github.com/TencentCloudBase/image-node-sdk
Owner: TencentCloudBase
Archived: true
Created: 2018-06-30T02:07:44.000Z (over 6 years ago)
Default Branch: master
Last Pushed: 2022-04-28T13:51:53.000Z (over 2 years ago)
Last Synced: 2024-10-08T00:49:05.604Z (3 months ago)
Language: JavaScript
Homepage: https://cloud.tencent.com/document/product/864/18708
Size: 1.62 MB
Stars: 100
Watchers: 46
Forks: 25
Open Issues: 8
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        # 腾讯云 - 智能图像服务

[![NPM Version](https://img.shields.io/npm/v/image-node-sdk.svg?style=flat)](https://www.npmjs.com/package/image-node-sdk)

[![Travis](https://img.shields.io/travis/TencentCloudBase/image-node-sdk.svg)](https://travis-ci.org/TencentCloudBase/image-node-sdk)

[![Deps](https://david-dm.org/TencentCloudBase/image-node-sdk.svg)](https://david-dm.org/TencentCloudBase/image-node-sdk)

## 安装

```javascript

npm i --save image-node-sdk

```

## 配置

可以设置以下环境变量，这样就不需要传入 `AppId`, `SecretID` 和 `SecretKey` 了。

```javascript

process.env.TENCENTCLOUD_APPID

process.env.TENCENTCLOUD_SECRETID

process.env.TENCENTCLOUD_SECRETKEY

// 或

process.env.APPID

process.env.SECRETID

process.env.SECRETKEY

```

## 使用

以 OCR-身份证识别 为例，一般支持外链 url 或者本地读取图片文件，两种方式。

* 外链 url

```javascript

const {

    ImageClient

} = require('image-node-sdk');

let AppId = ''; // 腾讯云 AppId

let SecretId = ''; // 腾讯云 SecretId

let SecretKey = ''; // 腾讯云 SecretKey

let idCardImageUrl = 'http://images.cnitblog.com/blog/454646/201306/07090518-029ff26fac014d72a7786937e8319c78.jpg';

let imgClient = new ImageClient({ AppId, SecretId, SecretKey });

imgClient.ocrIdCard({

    data: {

        url_list: [idCardImageUrl]

    }

}).then((result) => {

    console.log(result.body)

}).catch((e) => {

    console.log(e);

});

```

* 读取本地文件

```javascript

const fs = require('fs');

const path = require('path');

const {

    ImageClient

} = require('image-node-sdk');

let AppId = ''; // 腾讯云 AppId

let SecretId = ''; // 腾讯云 SecretId

let SecretKey = ''; // 腾讯云 SecretKey

let imgClient = new ImageClient({ AppId, SecretId, SecretKey });

imgClient.ocrIdCard({

    formData: {

        card_type: 0,

        image: fs.createReadStream(path.join(__dirname, './idcard.jpg'))

    },

    headers: {

        'content-type': 'multipart/form-data'

    }

}).then((result) => {

    console.log(result.body)

}).catch((e) => {

    console.log(e);

});

```

如果想运行，[example/index.js](./example/index.js) 下面的例子，请先在项目根目录新建 config/index.js 文件，并按以下格式写下配置

```javascript

const ProxyUrl = ''; // 可填公司代理

const AppId = ''; // 腾讯云 AppId

const SecretId = ''; // 腾讯云  SecretId

const SecretKey = ''; // 腾讯云 SecretKey

const IdCard = ''; // 身份证号码，用于人脸核身

const Name = ''; // 身份证姓名，用于人脸核身

exports.ProxyUrl = ProxyUrl;

exports.AppId = AppId;

exports.SecretId = SecretId;

exports.SecretKey = SecretKey;

exports.IdCard = IdCard;

exports.Name = Name;

```

然后运行

```javascript

npm run example

```

## 支持功能

* 信息认证

    - [x] [身份证信息认证](https://cloud.tencent.com/document/product/641/13391) - authIdCard

* 人脸识别

    - [x] [多脸检索](https://cloud.tencent.com/document/product/641/14349) - faceMultiple

    - [x] [人脸检测与分析](https://cloud.tencent.com/document/product/641/12415) - faceDetect

    - [x] [五官定位](https://cloud.tencent.com/document/product/641/12416) - faceShape

    - [x] [个体信息管理-个体创建](https://cloud.tencent.com/document/product/641/12417#.E4.B8.AA.E4.BD.93.E5.88.9B.E5.BB.BA) - faceNewPerson

    - [x] [个体信息管理-删除个体](https://cloud.tencent.com/document/product/641/12417#.E5.88.A0.E9.99.A4.E4.B8.AA.E4.BD.93) - faceDelPerson

    - [x] [个体信息管理-增加人脸](https://cloud.tencent.com/document/product/641/12417#.E5.A2.9E.E5.8A.A0.E4.BA.BA.E8.84.B8) - faceAddFace

    - [x] [个体信息管理-删除人脸](https://cloud.tencent.com/document/product/641/12417#.E5.88.A0.E9.99.A4.E4.BA.BA.E8.84.B8) - faceDelFace

    - [x] [个体信息管理-设置信息](https://cloud.tencent.com/document/product/641/12417#.E8.AE.BE.E7.BD.AE.E4.BF.A1.E6.81.AF) - faceSetInfo

    - [x] [个体信息管理-获取信息](https://cloud.tencent.com/document/product/641/12417#.E8.8E.B7.E5.8F.96.E4.BF.A1.E6.81.AF) - faceGetInfo

    - [x] [个体信息管理-获取组列表](https://cloud.tencent.com/document/product/641/12417#.E8.8E.B7.E5.8F.96.E7.BB.84.E5.88.97.E8.A1.A8) - faceGetGpIds

    - [x] [个体信息管理-获取人列表](https://cloud.tencent.com/document/product/641/12417#.E8.8E.B7.E5.8F.96.E4.BA.BA.E5.88.97.E8.A1.A8) - faceGetPersonIds

    - [x] [个体信息管理-获取人脸列表](https://cloud.tencent.com/document/product/641/12417#.E8.8E.B7.E5.8F.96.E4.BA.BA.E8.84.B8.E5.88.97.E8.A1.A8) - faceGetFaceIds

    - [x] [个体信息管理-获取人脸信息](https://cloud.tencent.com/document/product/641/12417#.E8.8E.B7.E5.8F.96.E4.BA.BA.E8.84.B8.E4.BF.A1.E6.81.AF) - faceGetFaceInfo

    - [x] [个体信息管理-新增组信息](https://cloud.tencent.com/document/product/641/12417#person.E6.96.B0.E5.A2.9E.E7.BB.84.E4.BF.A1.E6.81.AF) - faceAddGPIds

    - [x] [个体信息管理-删除组信息](https://cloud.tencent.com/document/product/641/12417#person.E5.88.A0.E9.99.A4.E7.BB.84.E4.BF.A1.E6.81.AF) - faceDelGPIds

    - [x] [人脸验证](https://cloud.tencent.com/document/product/641/12418) - faceVerify

    - [x] [人脸检索](https://cloud.tencent.com/document/product/641/12419) - faceIdentify

    - [x] [人脸对比](https://cloud.tencent.com/document/product/641/12420) - faceCompare

* 文字识别OCR

    - [x] [手写体识别](https://cloud.tencent.com/document/product/641/12838) - ocrHandWriting

    - [x] [身份证识别](https://cloud.tencent.com/document/product/641/12424) - ocrIdCard

    - [x] [营业执照识别](https://cloud.tencent.com/document/product/641/12425) - ocrBizLicense

    - [x] [行驶证驾驶证识别](https://cloud.tencent.com/document/product/641/12426) - ocrDrivingLicence

    - [x] [车牌号识别](https://cloud.tencent.com/document/product/641/12427) - ocrPlate

    - [x] [通用印刷体识别](https://cloud.tencent.com/document/product/641/12428) - ocrGeneral

    - [x] [银行卡识别](https://cloud.tencent.com/document/product/641/12429) - ocrBankCard

    - [x] [名片识别（V2)](https://cloud.tencent.com/document/product/641/13209) - ocrBizCard

* 图片识别

    - [x] [图片标签](https://cloud.tencent.com/document/product/641/12421) - imgTagDetect

    - [x] [图片鉴黄](https://cloud.tencent.com/document/product/641/12422) - imgPornDetect

* 人脸核身

    - [x] [人脸静态活体检测](https://cloud.tencent.com/document/product/641/12558) - faceLiveDetectPic

    - [x] [唇语活体检测视频身份信息核验](https://cloud.tencent.com/document/product/641/12430) - faceIdCardLiveDetectFour

    - [x] [活体检测—获取唇语验证码](https://cloud.tencent.com/document/product/641/12431) - faceLiveGetFour

    - [x] [活体检测视频与用户照片的对比](https://cloud.tencent.com/document/product/641/12432) - faceLiveDetectFour

    - [x] [用户上传照片身份信息核验](https://cloud.tencent.com/document/product/641/12433) - faceIdCardCompare

* 人脸融合

    - [x] [人脸融合](https://cloud.tencent.com/document/api/670/31061) - faceFuse

* 注意事项

人脸核身的相关接口，于2019年起全部需要申请新的[人脸核身-云智慧眼](https://console.cloud.tencent.com/ai/facein/cloud-godident-logic)，这样旧版接口也会同时开通。目前本 `SDK` 依旧是使用旧版的接口，新版接口有待后续更新。

## 更新日志

[日志](./CHANGELOG.md)

## 声明

测试用的身份证源于[该文章](https://blog.csdn.net/kaka20080622/article/details/50563069)的实验身份证，如有侵权，请联系作者删除。