网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts 盘古助手
华为云Astro大屏应用
计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
云手机服务器 CPH
专属主机 DeH
弹性伸缩 AS
镜像服务 IMS
函数工作流 FunctionGraph
云耀云服务器(旧版)
VR云渲游平台 CVR
Huawei Cloud EulerOS
网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
CDN与智能边缘
内容分发网络 CDN
智能边缘云 IEC
智能边缘平台 IEF
CloudPond云服务
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
可信智能计算服务 TICS
推荐系统 RES
云搜索服务 CSS
数据可视化 DLV
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
湖仓构建 LakeFormation
智能数据洞察 DataArts Insight
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
开天aPaaS
应用平台 AppStage
开天企业工作台 MSSE
开天集成工作台 MSSI
API中心 API Hub
云消息服务 KooMessage
交换数据空间 EDS
云地图服务 KooMap
云手机服务 KooPhone
组织成员账号 OrgID
云空间服务 KooDrive
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
区块链
区块链服务 BCS
数字资产链 DAC
华为云区块链引擎服务 HBS
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
价格
成本优化最佳实践
专属云商业逻辑
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
其他
管理控制台
消息中心
产品价格详情
系统权限
客户关联华为云合作伙伴须知
公共问题
宽限期保留期
奖励推广计划
活动
云服务信任体系能力说明
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts 盘古助手
华为云Astro大屏应用
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
存储容灾服务 SDRS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
云存储网关 CSG
专属分布式存储服务 DSS
数据工坊 DWR
地图数据 MapDS
键值存储服务 KVS
容器
云容器引擎 CCE
云容器实例 CCI
容器镜像服务 SWR
云原生服务中心 OSC
应用服务网格 ASM
华为云UCS
数据库
云数据库 RDS
数据复制服务 DRS
文档数据库服务 DDS
分布式数据库中间件 DDM
云数据库 GaussDB
云数据库 GeminiDB
数据管理服务 DAS
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
AI开发平台ModelArts
华为HiLens
图引擎服务 GES
图像识别 Image
文字识别 OCR
自然语言处理 NLP
内容审核 Moderation
图像搜索 ImageSearch
医疗智能体 EIHealth
企业级AI应用开发专业套件 ModelArts Pro
人脸识别服务 FRS
对话机器人服务 CBS
语音交互服务 SIS
人证核身服务 IVS
视频智能分析服务 VIAS
城市智能体
自动驾驶云服务 Octopus
盘古大模型 PanguLargeModels
IoT物联网
设备接入 IoTDA
全球SIM联接 GSL
IoT数据分析 IoTA
路网数字化服务 DRIS
IoT边缘 IoTEdge
设备发放 IoTDP
企业应用
域名注册服务 Domains
云解析服务 DNS
企业门户 EWP
ICP备案
商标注册
华为云WeLink
华为云会议 Meeting
隐私保护通话 PrivateNumber
语音通话 VoiceCall
消息&短信 MSGSMS
云管理网络
SD-WAN 云服务
边缘数据中心管理 EDCM
云桌面 Workspace
应用与数据集成平台 ROMA Connect
ROMA资产中心 ROMA Exchange
API全生命周期管理 ROMA API
政企自服务管理 ESM
视频
实时音视频 SparkRTC
视频直播 Live
视频点播 VOD
媒体处理 MPC
视频接入服务 VIS
数字内容生产线 MetaStudio
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
专属云
专属计算集群 DCC
开发者工具
SDK开发指南
API签名指南
DevStar
华为云命令行工具服务 KooCLI
Huawei Cloud Toolkit
CodeArts API
云化转型
云架构中心
云采用框架
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
客户运营能力
国际站常见问题
支持计划
专业服务
合作伙伴支持计划
我的凭证
华为云公共事业服务云平台
工业软件
工业数字模型驱动引擎
硬件开发工具链平台云服务
工业数据转换引擎云服务
更新时间:2024-10-17 GMT+08:00
分享

Python SDK

本章节介绍人脸识别服务Python SDK,您可以参考本章节进行快速集成开发。

准备工作

  • 注册华为账号并开通华为云,并完成实名认证,账号不能处于欠费或冻结状态。
  • 已开通人脸识别服务。如未开通,请登录人脸识别管理控制台人脸识别管理控制台开通所需服务。
  • 已具备开发环境,支持Python3及以上版本。
  • 登录“我的凭证 > 访问秘钥”页面,获取Access Key(AK)和Secret Access Key(SK)。
    图1 获取AK、SK
  • 登录“我的凭证”页面,获取“IAM用户名”“账号名”以及待使用区域的“项目ID”。调用服务时会用到这些信息,请提前保存。

    本样例以“华北-北京四”区域为例,获取对应的项目ID(project_id)。

    图2 我的凭证

安装SDK

支持Python3及以上版本,执行python --version检查当前Python的版本信息。

使用SDK前,需要安装“huaweicloudsdkcore”和“huaweicloudsdkfrs”。

# 安装核心库
pip install huaweicloudsdkcore
# 安装FRS服务库
pip install huaweicloudsdkfrs

开始使用

在开始使用之前,请确保您安装的是最新版本的SDK。使用过时的版本可能会导致兼容性问题或无法使用最新功能。您可以通过运行以下命令来检查并更新SDK至最新版本。

pip show huaweicloudsdkcore
pip show huaweicloudsdkfrs
pip install --upgrade huaweicloudsdkcore
pip install --upgrade huaweicloudsdkfrs

详细的SDK介绍,使用异步客户端,配置日志等操作请参见SDK中心Python SDK使用指导Python SDK使用视频

  1. 导入依赖模块
    from huaweicloudsdkcore.auth.credentials import BasicCredentials
    from huaweicloudsdkcore.exceptions import exceptions
    
    # 导入v2版本sdk
    from huaweicloudsdkfrs.v2.region.frs_region import FrsRegion
    from huaweicloudsdkfrs.v2 import *
    
    import os
  2. 配置认证信息
    配置AK、SK信息。华为云通过AK识别用户的身份,通过SK对请求数据进行签名验证,用于确保请求的机密性、完整性和请求者身份的正确性。AK、SK获取方法请参见准备工作
    def GetCredential(ak, sk):
        return BasicCredentials(ak, sk)

    初始化认证信息:

    ak = os.environ.get("HUAWEICLOUD_SDK_AK")
    sk = os.environ.get("HUAWEICLOUD_SDK_SK")
    credentials = GetCredential(ak, sk)
    • 认证用的 ak 和sk 硬编码到代码中或者明文存储都有很大的安全风险,建议在配置文件或者环境变量中密文存放,使用时解密,确保安全。
    • 本示例以 ak 和 sk 保存在环境变量中来实现身份验证为例,运行本示例前请先在本地环境中设置环境变量HUAWEICLOUD_SDK_AK和HUAWEICLOUD_SDK_SK。
    图3 Windows环境新建环境变量
  3. 初始化客户端
    指定region方式
    # 初始化人脸识别服务的客户端,并选择服务部署区域
    def GetClient():
        client =  FrsClient.new_builder(FrsClient) \
             .with_credentials(credentials) \
             .with_region(FrsRegion.value_of("cn-north-4")) \
             .build()
        return client

    服务部署区域请参见终端节点

  4. 发送请求并查看响应
    # 以调用人脸检测 DetectFaceByBase64 接口为例
    request = DetectFaceByBase64Request()
    request.body = FaceDetectBase64Req(
        image_base64="/9j/4AAQSkZJRgABAQAAAQABAAD..."
    )
    response = client.detect_face_by_base64(request)
    print(response)

    使用人脸比对SDK时,image1、image2参数需为相同类型,即同为url、base64或file。

  5. 异常处理
    表1 异常处理

    一级分类

    一级分类说明

    二级分类

    二级分类说明

    ConnectionException

    连接类异常

    HostUnreachableException

    网络不可达、被拒绝。

    SslHandShakeException

    SSL认证异常。

    RequestTimeoutException

    响应超时异常

    CallTimeoutException

    单次请求,服务器处理超时未返回。

    RetryOutageException

    在重试策略消耗完成后,仍无有效的响应。

    ServiceResponseException

    服务器响应异常

    ServerResponseException

    服务端内部错误,Http响应码:[500,]。

    ClientRequestException

    请求参数不合法,Http响应码:[400, 500)

    // 捕获和处理不同类型的异常
    try:
        request = DetectFaceByBase64Request()
        request.body = FaceDetectBase64Req(
            image_base64="/9j/4AAQSkZJRgABAQAAAQABAAD..."
        )
        response = client.detect_face_by_base64(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

SDK代码解析

  • 人脸检测
    # detect face by base64
    def detectFaceByBase64():
        try:
            request = DetectFaceByBase64Request()
            request.body = FaceDetectBase64Req(
                image_base64="/9j/4AAQSkZJRgABAQAAAQABAAD...",
                attributes="2,4"
            )
            response = client.detect_face_by_base64(request)
            print(response)
        except exceptions.ClientRequestException as e:
            print(e.status_code)
            print(e.request_id)
            print(e.error_code)
            print(e.error_msg)
    
    # detect face by file
    def detectFaceByFile():
        try:
            request = DetectFaceByFileRequest()
            with open("/root/picture.jpg", "rb") as f:
                request.body = DetectFaceByFileRequestBody(image_file=FormFile(f))
                response = client.detect_face_by_file(request)
                print(response)
        except exceptions.ClientRequestException as e:
            print(e.status_code)
            print(e.request_id)
            print(e.error_code)
            print(e.error_msg)
  • 人脸比对
    # compare face by base64
    def compareFaceByBase64():
        try:
            request = CompareFaceByBase64Request()
            request.body = FaceCompareBase64Req(
                image1_base64="/9j/4AAQSkZJRgABAQAAAQABAAD...",
                image2_base64="/9j/4AAQSkZJRgABAQAAAQABAAD..."
            )
            response = client.compare_face_by_base64(request)
            print(response)
        except exceptions.ClientRequestException as e:
            print(e.status_code)
            print(e.request_id)
            print(e.error_code)
            print(e.error_msg)
    
    # compare face by file
    def compareFaceByFile():
        try:
            request = CompareFaceByFileRequest()
            with open("/root/picture1.jpg", "rb") as f1:
                with open("/root/picture2.jpg", "rb") as f2:
                    request.body = CompareFaceByFileRequestBody(image1_file=FormFile(f1),
                                                                image2_file=FormFile(f2))
                    response = client.compare_face_by_file(request)
                    print(response)
        except exceptions.ClientRequestException as e:
            print(e.status_code)
            print(e.request_id)
            print(e.error_code)
            print(e.error_msg)
    
  • 人脸搜索
    # search face by base64
    def searchFaceByBase64():
        try:
            request = SearchFaceByBase64Request()
            request.face_set_name = "face_set_name"
            listFaceSearchBase64ReqReturnFieldsbody = [
                "timestamp"
            ]
            request.body = FaceSearchBase64Req(
                return_fields=listFaceSearchBase64ReqReturnFieldsbody,
                image_base64="/9j/4AAQSkZJRgABAQAAAQABAAD..."
            )
            response = client.search_face_by_base64(request)
            print(response)
        except exceptions.ClientRequestException as e:
            print(e.status_code)
            print(e.request_id)
            print(e.error_code)
            print(e.error_msg)
    
    # search face by file
    def searchFaceByFile():
        try:
            request = SearchFaceByFileRequest()
            request.face_set_name = "face_set_name"
            with open("/root/picture.jpg", "rb") as f:
                    request.body = SearchFaceByFileRequestBody(
                    return_fields="[\"timestamp\"]",
                    filter="timestamp:10",
                    top_n=10,
                    image_file=FormFile(f)
                )
                response = client.search_face_by_file(request)
                print(response)
        except exceptions.ClientRequestException as e:
            print(e.status_code)
            print(e.request_id)
            print(e.error_code)
            print(e.error_msg)
    
  • 创建人脸库
    def createFaceSet():
        try:
            request = CreateFaceSetRequest()
            request.body = CreateFaceSetReq(
                face_set_name="face_set_name",
                external_fields={"timestamp": {"type": "long"}}
            )
            response = client.create_face_set(request)
            print(response)
        except exceptions.ClientRequestException as e:
            print(e.status_code)
            print(e.request_id)
            print(e.error_code)
            print(e.error_msg)
  • 查询人脸库
    def showFaceSet():
        try:
            request = ShowFaceSetRequest()
            request.face_set_name = "face_set_name"
            response = client.show_face_set(request)
            print(response)
        except exceptions.ClientRequestException as e:
            print(e.status_code)
            print(e.request_id)
            print(e.error_code)
            print(e.error_msg)
  • 查询所有人脸库
    def showAllFaceSet():
        try:
            request = ShowAllFaceSetsRequest()
            response = client.show_all_face_sets(request)
            print(response)
        except exceptions.ClientRequestException as e:
            print(e.status_code)
            print(e.request_id)
            print(e.error_code)
            print(e.error_msg)
  • 删除人脸库
    def deleteFaceSet():
        try:
            request = DeleteFaceSetRequest()
            request.face_set_name = "face_set_name"
            response = client.delete_face_set(request)
            print(response)
        except exceptions.ClientRequestException as e:
            print(e.status_code)
            print(e.request_id)
            print(e.error_code)
            print(e.error_msg)
  • 添加人脸
    # add face by base64
    def addFacesByBase64():
        try:
            request = AddFacesByBase64Request()
            request.face_set_name = "face_set_name"
            request.body = AddFacesBase64Req(
                external_fields="{\"timestamp\":12}",
                image_base64="/9j/4AAQSkZJRgABAQAAAQABAAD..."
            )
            response = client.add_faces_by_base64(request)
            print(response)
        except exceptions.ClientRequestException as e:
            print(e.status_code)
            print(e.request_id)
            print(e.error_code)
            print(e.error_msg)
    
    # add face by file
    def addFacesByFile():
        try:
            request = AddFacesByFileRequest()
            request.face_set_name = "face_set_name"
            with open("/root/picture.jpg", "rb") as f:
                request.body = AddFacesByFileRequestBody(
                    external_fields="{\"timestamp\":12}",
                    image_file=FormFile(f)
                )
                response = client.add_faces_by_file(request)
                print(response)
        except exceptions.ClientRequestException as e:
            print(e.status_code)
            print(e.request_id)
            print(e.error_code)
            print(e.error_msg)
  • 删除人脸
    def deleteFace():
        # Delete Face By FaceId
        try:
            request = DeleteFaceByFaceIdRequest()
            request.face_set_name = "face_set_name"
            request.face_id = "LkPJblq6"
            response = client.delete_face_by_face_id(request)
            print(response)
        except exceptions.ClientRequestException as e:
            print(e.status_code)
            print(e.request_id)
            print(e.error_code)
            print(e.error_msg)
    
        # Delete Face By ExternalImageId
        try:
            request = DeleteFaceByExternalImageIdRequest()
            request.face_set_name = "face_set_name"
            request.external_image_id = "external_image_id"
            response = client.delete_face_by_external_image_id(request)
            print(response)
        except exceptions.ClientRequestException as e:
            print(e.status_code)
            print(e.request_id)
            print(e.error_code)
            print(e.error_msg)
  • 批量删除人脸
    def batchDeleteFaces():
        try:
            request = BatchDeleteFacesRequest()
            request.face_set_name = "face_set_name"
            request.body = DeleteFacesBatchReq(
                filter="age:[20 TO 30]"
            )
            response = client.batch_delete_faces(request)
            print(response)
        except exceptions.ClientRequestException as e:
            print(e.status_code)
            print(e.request_id)
            print(e.error_code)
            print(e.error_msg)
  • 更新人脸
    def updateFace():
        try:
            request = UpdateFaceRequest()
            request.face_set_name = "face_set_name"
            request.body = UpdateFaceReq(face_id="LkPJblq6")
            response = client.update_face(request)
            print(response)
        except exceptions.ClientRequestException as e:
            print(e.status_code)
            print(e.request_id)
            print(e.error_code)
            print(e.error_msg)
  • 查询人脸
    def showFaces():
        # Show Faces By FaceId
        try:
            request = ShowFacesByFaceIdRequest()
            request.face_set_name = "face_set_name"
            request.face_id = "LkPJblq6"
            response = client.show_faces_by_face_id(request)
            print(response)
        except exceptions.ClientRequestException as e:
            print(e.status_code)
            print(e.request_id)
            print(e.error_code)
            print(e.error_msg)
    
        # Show Faces By Limit
        try:
            request = ShowFacesByLimitRequest()
            request.face_set_name = "face_set_name"
            request.offset = 0
            request.limit = 10
            response = client.show_faces_by_limit(request)
            print(response)
        except exceptions.ClientRequestException as e:
            print(e.status_code)
            print(e.request_id)
            print(e.error_code)
            print(e.error_msg)
  • 动作活体检测
    # detect live by base64
    def detectLiveByBase64():
        try:
            request = DetectLiveByBase64Request()
            request.body = LiveDetectBase64Req(
                actions="1,2,3,4",
                video_base64="/9j/4AAQSkZJRgABAQAAAQABAAD..."
            )
            response = client.detect_live_by_base64(request)
            print(response)
        except exceptions.ClientRequestException as e:
            print(e.status_code)
            print(e.request_id)
            print(e.error_code)
            print(e.error_msg)
    
    # detect live by file
    def detectLiveByFile():
        try:
            request = DetectLiveByFileRequest()
            with open("/root/video.mp4", "rb") as f:
                request.body = DetectLiveByFileRequestBody(
                    video_file=FormFile(f),
                    actions="1,2,3,4"
                )
                response = client.detect_live_by_file(request)
                print(response)
        except exceptions.ClientRequestException as e:
            print(e.status_code)
            print(e.request_id)
            print(e.error_code)
            print(e.error_msg)
  • 静默活体检测
    # detect live face by base64
    def detectLiveFaceByBase64():
        try:
            request = DetectLiveFaceByBase64Request()
            request.body = LiveDetectFaceBase64Req(
                image_base64="/9j/4AAQSkZJRgABAQAAAQABAAD..."
            )
            response = client.detect_live_face_by_base64(request)
            print(response)
        except exceptions.ClientRequestException as e:
            print(e.status_code)
            print(e.request_id)
            print(e.error_code)
            print(e.error_msg)
    
    # detect live face by file
    def detectLiveFaceByFile():
        try:
            request = DetectLiveFaceByFileRequest()
            with open("/root/picture.jpg", "rb") as f:
                request.body = DetectLiveFaceByFileRequestBody(
                    image_file=FormFile(f)
                )
                response = client.detect_live_face_by_file(request)
                print(response)
        except exceptions.ClientRequestException as e:
            print(e.status_code)
            print(e.request_id)
            print(e.error_code)
            print(e.error_msg)

SDK代码自动生成

API Explorer提供API检索及平台调试,支持全量快速检索、可视化调试、帮助文档查看和在线咨询。

您只需要在API Explorer中修改接口参数,即可自动生成对应的代码示例。同时,可在集成开发环境CloudIDE中完成代码的构建、调试和运行等操作。

图4 API Explorer

相关文档