水墨风--图像技术-火山引擎

文档中心

导航

水墨风

最近更新时间：2024.09.26 16:28:33首次发布时间：2024.08.26 15:51:09

接口简介

基于图生图技术，将输入图进行水墨风的风格化，为用户生成具有艺术美感的高质量图片。
此接口在人像、风景、宠物等各场景均有较好效果。

限制条件

名称	内容
图片要求	图片格式：仅支持JPG、JPEG、PNG格式，建议使用JPG格式。图片文件大小：最大 5 MB。图片分辨率：最小600 * 800，最大 4096 * 4096

Demo展示

水墨风.zip

未知大小

请求说明

名称	内容
接口地址	https://visual.volcengineapi.com
请求方式	POST
Content-Type	application/json

请求参数
（1）header请求参数
以下请求参数列表仅列出了接口请求参数和必要公共参数，完整公共参数列表见公共参数

名称	类型	是否必填	描述
X-Date	String	是	使用UTC时间，精确到秒。请使用格式：`YYYYMMDD'T'HHMMSS'Z'` ，例如：`20201103T104027Z`
Authorization	String	是	HMAC-SHA256：签名方法 -Credential为签名凭证，其中: -AccessKeyId为访问密钥ID，可在访问密钥（Access Key）获取； -ShortDate为请求的短时间，使用UTC时间，精确到日。请使用格式：`YYYYMMDD`，例如：`20180201`； -Region为请求地区，国内一般为为`cn-north-1`； -Service为请求的服务，一般为`cv`； -SignedHeaders为参与签名计算的头部信息，`content-type` 和 `host` 为必选头部； -Signature为签名，可在签名方法获取。注：我们提供了SDK及签名示例供您实现服务快速接入，具体可参考快速接入例如：`HMAC-SHA256 Credential={AccessKeyId}/{ShortDate}/{Region}/{Service}/request, SignedHeaders={SignedHeaders}, Signature={Signature}`
X-Security-Token	String	否	指安全令牌服务（Security Token Service，STS）颁发的临时安全凭证中的SessionToken，使用长期密钥时无需填写该参数。

（2）Query参数
业务请求参数

参数	可选/必选	类型	说明
Action	必选	String	接口名，取值：CVProcess
Version	必选	String	版本号，取值：2022-08-31

（3）Body参数
业务请求参数
注：建议使用「建议参数」进行测试，如有需要可微调prompt、sub_prompts等参数，其他参数不建议变更，否则对效果影响较大。

参数	可选/必选	类型	说明	备注	建议值
req_key	必选	String	取值: img2img_water_ink_style_usage
binary_data_base64	必选（二选一）	Array of String	输入图片base64数组，仅支持一张图
image_urls	必选（二选一）	Array of String	输入图片url数组，仅支持一张图
prompt	必选	String	用于生成图像的提示词	用户输入		无
sub_prompts	必选	array[string]	用于生成图像的提示词	业务输入
strength	可选	float	输入图加噪程度。越小加噪越少，越接近原图；越大越接近文生图	默认值：0.6 取值范围：(0,1]	1	无
seed	可选	int	在其他参数一致的情况下负整数：每次测试效果随机。正整数：每次测试效果固定	默认值：-1	-1	无
scale	可选	float	影响文本描述的程度	默认值：8 取值范围：[1,10]	5
ddim_steps	可选	int	生成图像的步数	默认值：20 取值范围：[10,20]	20	修改值超过20不报错，但需周知，影响性能
lora_map	可选	dict	多个lora 权重控制	默认值：{} 示例：{'Cateye_AT45': {'strength_model': 0.2, 'strength_clip': 0.2},'CATSEYEcp001': {'strength_model': 0.2, 'strength_clip': 0.2}}	{ "0107inkman": { "strength_model": 0.7000000000000001, "strength_clip": 0.7000000000000001 }, "1228ink": { "strength_model": 0.1, "strength_clip": 0.1 }, "add_detail": { "strength_model": -0.5, "strength_clip": -0.5 } }	可选调节lora的key：1228ink、1228ink_02、0107inkman、0104inkmix、0110ink02PETS、3dSlider_v2、animeoutlineV4_16、add_detail
clip_skip	可选	int	clip输出层选择	默认值：1，取值范围[1,2]	2	无
controlnet_weight	可选	float	与输入图姿态相似度（controlnet（pose））	默认值：1，取值范围[0,1]	0.7000000000000001	无
sampler_name	可选	str	采样方式	默认值：'dpmpp_2m'。	dpmpp_2m	可选采样有：
scheduler	可选	str	调度器	默认值：'karras'	karras
long_resolution	可选	int	图生图前处理逻辑。长边按long_resolution Resize，短边根据长宽比Resize	默认值：832 取值范围：[128,960]	832
cn_mode	可选	int	controlnet的使用模式，分三种	默认值：0 取值范围：0, 1, 2	1	0代表"balanced"模式 1代表"prompt is important"模式 2代表"controlnet is important"模式
id_weight	可选	float	人脸id注入的程度	默认值：1.0 取值范围：[0, 2]	1	无
apply_id_layer	可选	string	人脸ID注入的网络结构位置	默认值："2,3,4,5,6,7,8,9,10,11,12" 取值范围: 0-15中的若干整数值构成的字符串数列	"0,1,2,3,4,5,6,7,8,9,10"	无
tagger_settings	可选	dict	反推设置	默认值：{"switch": False} 示例：{ switch": True, "tagger_types": ["tops", "bottoms", "hair"], "only_need_color": False, "color_types":["red", "pink", "orange", "brown", "yellow", "blonde", "golden", "green", "blue", "cyan", "purple", "white", "gray", "black", "aqua","colorless"] "tagger_req_key": "image2text-tagger-pet-test" }	{ "switch": True, "general_threshold": 0.35, "only_need_color": False, "color_types": [ "colorless" ], "people_types": [ "tops", "hair" ] }	switch 是否使用tagger tagger_types 需要筛选的tagger类型 only_need_color是否只选取颜色 color_types 需要筛选的颜色类型 tagger_req_key 特殊指明下游tagger服务，不指明时使用服务配置tagger
vae_choice	可选	int	使用vae	默认值：1	1	1用于除猫狗以外的场景 2用于猫狗场景
return_url	可选	bool	输出是否返回图片链接
logo_info	可选	LogoInfo	水印信息

LogoInfo
水印相关信息。

名称	类型	必选	描述
add_logo	Boolean	否	是否添加水印。True为添加，False不添加。默认不添加
position	Int	否	水印的位置，取值如下： 0-右下角 1-左下角 2-左上角 3-右上角默认0
language	Int	否	水印的语言，取值如下： 0-中文（AI生成） 1-英文（Generated by AI）默认0
opacity	Float	否	水印的不透明度，取值范围0-1，1表示完全不透明，默认0.3

（4）请求示例

{
    "req_key": "img2img_water_ink_style_usage",
    # "binary_data_base64":[],
    "image_urls": [
        "https://"],
    "prompt": "",
    "sub_prompts": [""],
    "strength": 0.6,
    "seed": -1,
    "scale": 8,
    "ddim_steps": 20,
    "lora_map": {'Cateye_AT45': {'strength_model': 0.2, 'strength_clip': 0.2},'CATSEYEcp001': {'strength_model': 0.2, 'strength_clip': 0.2}},
    "clip_skip": 1,
    "controlnet_weight": 1,
    "sampler_name": "dpmpp_2m",
    "scheduler": "karras",
    "long_resolution": 832,
    "cn_mode": 0,
    "id_weight": 1.0,
    "apply_id_layer": "2,3,4,5,6,7,8,9,10,11,12",
    "tagger_settings": {"switch": False},
    "vae_choice": 1,
    "return_url": True,
    "logo_info": {
        "add_logo": False,
        "position": 0,
        "language": 0,
        "opacity": 0.3
    }
}

输出说明

（1）通用输出参数
请参考通用返回字段及错误码
（2）业务输出参数
data 字段说明

字段	类型	说明	备注
binary_data_base64	Array of String	输出处理过的图片Base64数组（单张图）
image_urls	Array of String	输出处理过的图片url 数组（单张图）

（3）输出示例

{
        "code": 10000,
        "data": {
                "binary_data_base64": ["1P/2Q=="]
        },
        "message": "Success",
        "request_id": "202405202027492F3E60D731916A00055C",
        "time_elapsed": "3.741738182s"
}

错误码

（1）通用错误码
请参考通用返回字段及错误码
（2）业务错误码