文档中心

使用PS检测获取结果值

最近更新时间：2024.04.26 11:06:58

首次发布时间：2024.04.26 11:06:58

本接口支持通过指定服务 ID 以及原图 URI，检测图片是否被人为的 PS 修改，获取图片检测分值以及是否为正常图片。

说明

当前仅适用于营业执照类图像检测场景，其他图像检测类型还在持续开发中，敬请期待。

注意事项

请求频率：单用户请求频率限制为 5 次/秒。
超时时间：超时时间约为 10 秒。
前提条件：已开通 PS 检测组件能力。
计费说明：PS 检测功能属于增值服务项，故使用后会产生增值服务费用，当前支持后付费的计费方式，具体请参见增值服务。
服务地址：veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求说明

请求方式：POST
请求地址：https://imagex.volcengineapi.com/?Action=GetImagePSDetection&Version=2023-05-01

调试

API Explorer

您可以通过API Explorer在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。

Query

参数类型是否必选示例值描述

Action String 是 GetImagePSDetection 接口名称。当前 API 的名称为 GetImagePSDetection。

Version String 是 2023-05-01 接口版本。当前 API 的版本为 2023-05-01。

参数	类型	是否必选	示例值	描述
Action	String	是	`GetImagePSDetection`	接口名称。当前 API 的名称为 `GetImagePSDetection`。
Version	String	是	`2023-05-01`	接口版本。当前 API 的版本为 `2023-05-01`。
ServiceId	String	是	`91**sh`	待检测图片对应的服务 ID。您可以在 veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。

ServiceId

String

是

91**sh

待检测图片对应的服务 ID。

您可以在 veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。
您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。

Body

参数类型是否必选示例值描述

ImageUri String 是 test.jpeg 待检测原图的存储 URI，您可在控制台资源管理获取图片的存储 URI。

参数	类型	是否必选	示例值	描述
ImageUri	String	是	`test.jpeg`	待检测原图的存储 URI，您可在控制台资源管理获取图片的存储 URI。
Method	String	否	`all`	调用方法，取值如下所示： `all`：（默认）调用所有方法 `ela`：误差水平分析方法 `na`：噪声分析方法 `he`：基于颜色分布直方图均化的图像增强分析方法

Method

String

否

all

调用方法，取值如下所示：

all：（默认）调用所有方法
ela：误差水平分析方法
na：噪声分析方法
he：基于颜色分布直方图均化的图像增强分析方法

返回参数

下表仅列出本接口特有的返回参数。更多信息请见公共返回参数。

参数	类型	示例值	描述
ElaImage	String	`test1.jpeg`	误差水平分析方法对应的图片。
NaImage	String	`test2.jpeg`	噪声分析方法对应的图片。
HeImage	String	`test3.jpeg`	基于颜色分布直方图均化的图像增强方法对应的图片。
Score	Double		置信度，取值范围为[0,1]。小于 0.3 为 PS 处理图；大于 0.7 为真图；取值范围为[0.3,0.7]之间的图片则为模型无法判断。
Label	Integer	`1`	置信度标签，取值如下所示： `1`：正常 `0`：高风险

请求示例

POST https://imagex.volcengineapi.com/?Action=GetImagePSDetection&Version=2023-05-01&ServiceId=91**sh
{
  "ImageUri": "test.jpeg",
  "Method": "all"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "201806041104200100100232280022D30",
    "Action": "GetImagePSDetection",
    "Version": "2023-05-01",
    "Service": "imagex",
    "Region": "cn-north-1"
  },
  "Result": {
    "ElaImage": "*******",
    "NaImage": "",
    "HeImage": "",
    "Score": 0.99,
    "Label": 1
  }
}

错误码

本接口无特有的错误码。更多信息请见公共错误码和 veImageX 错误码。

服务端 SDK

为了方便您快速开发，veImageX 提供了配套的服务端 SDK，同时支持多种编程语言。建议您使用服务端 SDK 来调用 API，参考文档如下所示：