局部重绘

Action ModifyMaskedPixels

简介

此接口用于重绘图片部分区域

请求

参数名	类型	描述信息	必填
Action	`String`	对应的 API 指令名称	✓
PublicKey	`String`	用户公钥，可从 PICPIK用户中心 (opens in a new tab) 获取	✓
Signature	`String`	根据公钥及 API 指令生成的用户签名，参见签名算法	✓
request_uuid	`String`	请求uuid，采用uuid生成方式随机生成，可用于管理您业务和客户的请求

参数名	类型	描述信息	必填
MainModel	`Model`	主模型	✓
SubModelList	`[]Model`	子模型列表，包含LoRA、Embedding和HyperNetwork
PositivePrompts	`[]String`	希望在画面中出现的内容描述
NegativePrompts	`[]String`	不希望在画面中出现的内容描述
TranslatePrompts	`Bool`	是否将内容描述翻译成英文，支持的语言列表见此处。默认值：true
Seed	`Int`	种子编号（-1~2147483647），-1代表随机种子，默认值：-1
Width	`Int`	图片宽度（64~2560），默认值：1024
Height	`Int`	图片高度（64~2560），默认值：1024
BatchSize	`Int`	批量生图的数量（1~16），默认值：1
UseMainModelVAE	`Bool`	是否使用主模型自带的编解码器，默认值：false

参数名	类型	描述信息	必填
Image2Image	`Image2Image`	生成时额外使用的参考图的相关参数
Masked	`Mask`	遮罩，代表重绘区域的相关参数	✓
ImageAndMaskList	`[]Base64`	Base64编码的图片和蒙版遮罩列表	✓

复杂数据类型说明

`Model`

字段名	类型	描述信息	必填
Name	`String`	模型名称
ModelCode	`String`	模型编码	✓
IsOfficial	`Bool`	是否为官方模型
TriggerWordList	`[]String`	触发词列表（仅模型为lora时生效）
InferenceParams	`InferenceParams`	推理用的参数

`Image2Image`

参数名	类型	描述信息	默认值	范围	步长	必填
ImageIndex	`Int`	图片在`ImageAndMaskList`或`ImageList`中的索引编号，从0开始				✓
ReferStrength	`Float`	参考强度(0~1) 默认值: 0.5	0.5	0~1	0.01

`Mask`

参数名	类型	描述信息	必填
ImageIndex	`Int`	原始图片在`ImageAndMaskList`或`ImageList`中的索引，从0开始	✓
MaskIndex	`Int`	蒙版在`ImageAndMaskList`或`MaskList`中的索引，从0开始。蒙版是一张黑白图片，其中白色部分是重绘部分。蒙版可独立绘制或通过去背景和内容提取API获得。	✓
ReferStrength	`Float`	蒙版区域的参考强度(0~2)，默认值: 1
InvertMask	`Bool`	是否反转蒙版，默认值: false
MaskBlur	`Int`	蒙版边缘模糊半径(0~64)，默认值: 12
PromptsMoreImportant	`Bool`	是否强化提示词的作用，默认值: false

`InferenceParams`

注意：特定参数仅对某个特定的模型数据类型（父级）生效，并不通用。

参数名	类型	有效的父级类型	描述信息	默认值	范围	步长
LoraWeight	`Float`	`Model`	推理时的模型权重，仅对 LoRA模型生效	1	-1～2	0.01
Resolution	`Int`	`PreProcessor`	Controlnet预处理器的生成分辨率	512	64~2048	64
ControlWeight	`Float`	`ControlModel`	ControlNet模型的推理权重	1	0~2	0.01
StartingStep	`Float`	`ControlModel`	ControlNet模型开始介入推理的时机（比率）	0	0~1	0.01
EndingStep	`Float`	`ControlModel`	ControlNet模型退出推理过程的时机（比率）	1	0~1	0.01

简单示例

{
	"Action": "ModifyMaskedPixels",
	"PublicKey": "ALLak9M4cNdHXKOJAJJ4k8Hh1hZS2EgJF1D0FlPwfl",
	"Signature": "a44f6dc64600d7580211c50e4e8e2ebfe07123c6",
	"TranslatePrompts": true,
	"request_uuid": "5ae03609-451b-44d7-a351-c72904df881b",
	"MainModel": {
		"InferenceParams": {
			"Steps": 25
		},
		"ModelCode": "PICPIK General"
	},
	"Masked": {
		"ImageIndex": 0,
		"MaskIndex": 1
	},
	"NegativePrompts": [],
	"PositivePrompts": [],
 
	"ImageAndMaskList": [
		"data:image/jpeg;base64,img1",
		"data:image/jpeg;base64,img2"
	]
}

响应

字段名	类型	描述信息	必填
RetCode	`Int`	返回状态码，为 0 则为成功返回，非 0 为失败	✓
Action	`String`	操作指令名称	✓
Message	`String`	返回错误消息，当 `RetCode` 非 0 时提供详细的描述信息
request_uuid	`String`	返回请求时填写的uuid

参数名	类型	描述信息	必填
TaskUID	`String`	任务UID，用于查询任务详情与获取结果	✓

响应示例

{
	"Action": "ModifyMaskedPixels",
	"RetCode": 0,
	"Message": "",
	"request_uuid": "432c57d3-102b-4817-9e98-28054b33db8e",
	"TaskUID": "ckt3uqlrh4miq8mr9lgg"
}

图片生成（SDXL）添加背景（商品图）