You need to enable JavaScript to run this app.
导航
通用2.0-角色特征保持
最近更新时间:2024.12.19 16:38:31首次发布时间:2024.11.05 17:40:37

接口简介

通用2.0-角色特征保持(历史名称:通用2.0S-主体保持)集成了自研的主体保持能力,包含主体外观保持和面部特征保持。其中主体外观信息包含人/动物/物体等各类主体。主体外观和面部特征,两者在生图过程中跟输入文本共同起作用,生成外观跟输入参考图中的主体一致又符合文本描述的图片。

限制条件

名称

内容

图片要求

  1. 图片格式:JPG(JPEG), PNG, JFIF 等常见格式, 建议使用JPG格式
  2. 图片要求:小于5 MB,小于4096*4096。
  3. 输入图建议包含人/动物/物体等各类主体,不包含上述信息不会报错,但会输出普通文生图

请求说明

名称

内容

接口地址

https://visual.volcengineapi.com

请求方式

POST

Content-Type

application/json

Header参数

完整公共参数列表见 公共参数
本服务Region为cn-north-1; Service为cv

Query参数

拼接到url后的参数,示例:https://visual.volcengineapi.com?Action=CVProcess&Version=2022-08-31

参数

可选/必选

类型

说明

Action

必选

String

接口名,取固定值:CVProcess

Version

必选

String

版本号,取固定值:2022-08-31

Body参数

业务请求参数,放到request.body中,MIME-Type为application/json

参数

可选/必选

类型

说明

备注

req_key

必选

String

算法名称,取固定值为high_aes_ip_v20

binary_data_base64

必选(二选一,优先生效)

array of string

图片文件,base64编码。此算法需输入1张图片

image_urls

必选(二选一)

array of string

图片文件URL。此算法需输入1张图片

prompt

必选

String

用于生成图像的提示词 ,中英文均可输入

desc_pushback

可选

bool

针对输入图内容进行反推,可使生成图片效果更稳定
默认值:true

seed

可选

int

随机种子,-1为不随机种子;其他为指定随机种子
默认值:-1

scale

可选

float

影响文本描述的程度
默认值:3.5
取值范围:[1, 10]

ddim_steps

可选

int

生成图像的步数
默认值:9
取值范围:[1, 200]

width

可选

int

生成图像的宽(超分前大小)
默认值:512
取值范围:[256, 768]

宽、高与512差距过大,则出图效果不佳、延迟过长概率显著增加。
超分前建议比例及对应宽高:width*height

  • 1:1:512*512
  • 4:3:512*384
  • 3:4:384*512
  • 3:2:512*341
  • 2:3:341*512
  • 16:9:512*288
  • 9:16:288*512

height

可选

int

生成图像的高(超分前大小)
默认值:512
取值范围:[256, 768]

cfg_rescale

可选

float

默认值:0.7

ref_ip_weight

可选

float

参考图主体外观的权重,越大生成结果和参考图中主体的相似度越高
默认值:0.7
取值范围:[0, 1]

ref_id_weight

可选

float

参考图人脸特征的权重,越大生成结果和参考图中人脸的相似度越高
默认值:0.36
取值范围:[0, 1]
推荐取值范围:[0.2, 0.4]

use_sr

可选

bool

true:文生图+AIGC超分
false:文生图
默认值:true

return_url

可选

bool

输出是否返回图片链接 (链接有效期为24小时)

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

logo_text_content

String

明水印自定义内容

输出说明

通用输出参数

请参考通用返回字段及错误码

业务输出参数

重点关注data 字段,其他字段为公共返回

字段

类型

说明

binary_data_base64

array of string

返回图片的base64数组。

image_urls

array of string

输出处理过的图片url
数组(单张图)

请求&返回完整示例

请求示例

{
    "req_key": "high_aes_ip_v20",
    // "binary_data_base64": [],
    "image_urls": ["https://xxx"],
    "prompt": "千军万马",
    "desc_pushback": true,
    "seed": -1,
    "scale": 3.5,
    "ddim_steps": 9,
    "width": 512,
    "height": 512,
    "cfg_rescale": 0.7,
    "ref_ip_weight": 0.7,
    "ref_id_weight": 0.36,
    "use_sr": true,
    "return_url": true,
    "logo_info": {
        "add_logo": false,
        "position": 0,
        "language": 0,
        "opacity": 0.3,
        "logo_text_content": "这里是明水印内容"
    }
}

输出示例

{
    "code": 10000,
    "data": {
        "algorithm_base_resp": {
            "status_code": 0,
            "status_message": "Success"
        },
        "binary_data_base64": [],
        "image_urls": [
            "https://xxx"
        ],
        "pe_result": "",
        "predict_tags_result": "",
        "rephraser_result": "",
        "request_id": "cece14795209cf7e39a9d3060c02e28542d96808f7413e2e7d2fdb86510655d5"
    },
    "message": "Success",
    "request_id": "2024110517020569520218533D2EA96060",
    "status": 10000,
    "time_elapsed": "7.545501615s"
}

错误码

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

HttpCode

错误码

错误消息

描述

200

10000

请求成功

400

50411

Pre Img Risk Not Pass

输入图片前审核未通过

400

50511

Post Img Risk Not Pass

输出图片后审核未通过

400

50412

Text Risk Not Pass

输入文本前审核未通过

400

50512

Post Text Risk Not Pass

输出文本后审核未通过

400

50413

Post Text Risk Not Pass

输入文本NER、IP、Blocklist等拦截

SDK使用说明

请参考SDK使用说明