提取盲水印

最近更新时间：2023.05.19 15:49:37

首次发布时间：2022.09.14 20:06:00

本接口支持指定服务以及提取源图片，获取该图片中的盲水印信息。

请求说明

接口名称：CreateImageHmExtract
请求方式：POST
接口地址示例：https://imagex.volcengineapi.com/?Action=CreateImageHmExtract&Version=2018-08-01
请求频率限制：100 次/秒
超时时间：50 秒

说明

veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求参数

以下请求参数列表仅列出了该接口的部分公共参数，完整公共参数列表见公共请求参数。

Query

参数	类型	是否必填	备注
Action	String	是	接口名称。
Version	String	是	接口版本。veImageX 当前 API 的版本为`2018-08-01`。
ServiceId	String	是	服务 ID。您可以在 veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。
StoreUri	String	是	待提取盲水印的图片 Uri。
Algorithm	String	否	算法模型，取值如下所示： default：文本嵌入模型，默认文本嵌入模型； adapt_resize：画质自适应文本嵌入模型。

返回参数

字段类型描述

字段	类型	描述
StatusCode	Integer	响应码，具体取值如下所示： -1：盲水印为空； 0：`info`不为空时表示盲水印提取成功。说明提取失败时显示接口错误。
Info	String	提取出的盲水印文本信息。

StatusCode

Integer

响应码，具体取值如下所示：

-1：盲水印为空；
0：info不为空时表示盲水印提取成功。

说明

提取失败时显示接口错误。

Info String 提取出的盲水印文本信息。

示例

请求示例

POST https://imagex.volcengineapi.com/?Action=CreateImageHmExtract&Version=2018-08-01&ServiceId=oz**y2&StoreUri=tos-boe-i-oz**y2/9b**76

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "2022082317022201017425518102AA654C",
        "Action": "CreateImageHmExtract",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1"
    },
    "Result": {
        "StatusCode": 0,
        "Info": "你好 abc123%^$%"
    }
}

异常返回示例

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
        "Action": "CreateImageHmExtract",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1"
        "Error": {
            "Code": "",
            "Message": ""
        }
    }
}

错误码

访问错误码获取详细信息。