提取盲水印--veImageX-火山引擎

文档中心

立即注册

导航

veImageX

提取盲水印

最近更新时间：2024.06.28 10:47:34首次发布时间：2024.04.26 11:06:58

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

注意

对同一张图片，请确保在提取水印时指定的模型，与添加水印时指定的模型为同一种，以免无法正常提取水印。
在诸如电子邮件附件、社交媒体平台（如 Facebook、Instagram）、实时通讯应用（如微信）等传输媒介中传输图片时往往会自动压缩图片的分辨率，此时，图片水印也可能无法正常提取。

注意事项

计费说明：盲水印功能属于附加组件下智能处理模块，属于后付费计费，使用后会产生附加组件智能处理费用。
前提条件：请确保已开通智能处理计费配置。
使用限制：提取水印前，请先确认盲水印使用限制。
请求频率：
- 前景图层水印模型（彩色背景通用）：单用户请求频率限制为 3 次/秒。
- 其他模型：单用户请求频率限制为 5 次/秒。
超时时间：约为 50 秒。
服务地址：veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`CreateImageHmExtract`	接口名称。当前 API 的名称为 `CreateImageHmExtract`。
Version	String	是	`2023-05-01`	接口版本。当前 API 的版本为 `2023-05-01`。
ServiceId	String	是	`97**sh`	待提取水印图对应的服务 ID。您可以在 veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。
StoreUri	String	是	`tos-cn-i-97**sh/example`	待提取盲水印的图片的 URI。`StoreUri` 和 `ImageUrl` 都不为空时，以 `StoreUri` 为准。
ImageUrl	String	是	`https://test.com/example.png`	待提取盲水印图片的 URL。`StoreUri` 和 `ImageUrl` 都不为空时，以 `StoreUri` 为准。
Algorithm	String	是	`default`	算法模型，取值如下所示： `default`：文本嵌入基础模型 `adapt_resize`：画质自适应文本嵌入模型。 `adapt`: 文本嵌入自适应模型（AIGC 适用） `natural`：文本嵌入基础模型（彩色图片通用） `tracev1`：前景图层水印模型（纯色背景适用） `tracev2`：前景图层水印模型（彩色背景通用）注意指定 `tracev1` 或 `tracev2` 模型时，请传入已添加对应模型水印的背景网页的截图。若模型错误，则无法提取水印。

返回参数

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

参数类型示例值描述

参数	类型	示例值	描述
StatusCode	Integer	`0`	响应码，具体取值如下所示： `-1`：盲水印为空； `0`：`info`不为空时表示盲水印提取成功。说明提取失败时显示接口错误。
Info	String	`你好 abc123%^$%`	提取出的盲水印文本信息。
AdditionInfo	Object of AdditionInfo	`-`	仅当 `Algorithm` 取值为 `tracev2` 时，有返回值。编码附加信息。

StatusCode

Integer

0

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

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

说明

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

Info String 你好 abc123%^$% 提取出的盲水印文本信息。

AdditionInfo

Object of AdditionInfo

-

仅当 Algorithm 取值为 tracev2 时，有返回值。
编码附加信息。

AdditionInfo

参数	类型	示例值	描述
HmType	String	`date`	水印类型，返回值固定为 `date`，表示日期。
HmCode	Integer	`1`	所提取的水印背景图层的生成周期，从 0 开始，表示处于生成的第一周内。
HmDateInfo	Object of HmDateInfo	`-`	生成周期所对应的起始与结束时间段，固定为 7 天。

HmDateInfo

参数	类型	示例值	描述
StartDate	Integer	`1718640000`	使用 `tracev2` 模型生成背景水印图层的生成周期的开始时间，Unix 时间戳，精度为秒。说明例如：您于 6 月 5 日上午 9 时许调用 CreateHiddenWatermarkImage 接口生成 `tracev2` 模型的水印图层，在 6 月 10 日提取该模型网页截图的水印时，API 将会返回自生成时刻起至当前提取时刻所处的一个时间区间（无法精准至时分秒），该时间区间长度固定为 7 天。返回值如下所示： `HmCode` 为 `0`，表示处于生成的第一周内 `StartDate` 为 `1717516800`，表示 2024 年 6 月 5 日 00:00:00 `EndDate` 为 `1718121600`，表示 2024 年 6 月 12 日 00:00:00
EndDate	Integer	`1719244800`	使用 `tracev2` 模型生成背景水印图层的生成周期的结束时间，Unix 时间戳，精度为秒。

请求示例

POST https://imagex.volcengineapi.com/?Action=CreateImageHmExtract&Version=2023-05-01&ServiceId=97**sh&StoreUri=tos-cn-i-97**sh/example&Algorithm=tracev2

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "CreateImageHmExtract",
        "Version": "2023-05-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": {
        "StatusCode": 0,
        "Info": "你好 abc123%^$%",
        "AdditionInfo": {
            "HmType": "date",
            "HmDateInfo": {
                "StartDate": 1718640000,
                "EndDate": 1719244800
            },
            "HmCode": 1
        }
    }
}

错误码

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

服务端 SDK

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