imagex

type AIProcess struct{}

type AIProcessBody struct {
	// REQUIRED; 服务 ID。
	// * 您可以在 veImageX 控制台 服务管理 [https://console.volcengine.com/imagex/service_manage/]页面，在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息 [https://www.volcengine.com/docs/508/9360]。
	ServiceID string `json:"ServiceId"`

	// REQUIRED; AI 图像处理模板参数，需要将 JSON 压缩并转义为字符串。根据您需要的图像处理功能，参看 AI 图像处理模板 [https://www.volcengine.com/docs/508/1515840]页面获取模板
	// ID 和参数信息。
	WorkflowParameter string `json:"WorkflowParameter"`

	// REQUIRED; AI 图像处理模板 ID。根据您需要的图像处理功能，参看 AI 图像处理模板 [https://www.volcengine.com/docs/508/1515840]页面获取模板 ID 和参数信息。
	WorkflowTemplateID string `json:"WorkflowTemplateId"`
}

type AIProcessQuery struct{}

type AIProcessReq struct {
	*AIProcessQuery
	*AIProcessBody
}

type AIProcessRes struct {
	// REQUIRED
	ResponseMetadata *AIProcessResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED; 视请求的接口而定
	Result *AIProcessResResult `json:"Result"`
}

type AIProcessResResponseMetadata struct {
	// REQUIRED; 请求的接口名，属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region，例如：cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestId为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务，属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号，属于请求的公共参数。
	Version string `json:"Version"`
}

type AIProcessResResult struct {
	// REQUIRED; AI 图像处理结果，是 JSON 压缩并转义后的字符串。参看 AI 图像处理模板 [https://www.volcengine.com/docs/508/1515840]页面获取模板 ID 和参数信息，根据具体的工作流的说明进行解析。
	Output string `json:"Output"`
}

type AddDomainV1 struct{}

type AddDomainV1Body struct {

	// REQUIRED; 新增域名。
	Domain string `json:"domain"`

	// 访问控制配置。
	AccessControl []*AddDomainV1BodyAccessControlItem `json:"access_control,omitempty"`

	// 证书配置，海外加速或者全球加速为必选，否则审核不通过。
	HTTPS []*AddDomainV1BodyHTTPSItem `json:"https,omitempty"`

	// 请求需要添加的响应头。
	RespHdrs []*AddDomainV1BodyRespHdrsItem `json:"resp_hdrs,omitempty"`
}

type AddDomainV1BodyAccessControlItem struct {

	// Referer 配置。
	ReferLink []*AddDomainV1BodyAccessControlPropertiesItemsItem `json:"refer_link,omitempty"`
}

type AddDomainV1BodyAccessControlPropertiesItemsItem struct {

	// REQUIRED; 是否开启 Referer 防盗链，取值如下所示：
	// * true：开启
	// * false：关闭
	Enabled bool `json:"enabled"`

	// 是否允许空 Referer，取值如下所示：
	// * true：允许空 Referer
	// * false：不允许空 Referer
	AllowEmptyRefer bool `json:"allow_empty_refer,omitempty"`

	// 是否配置白名单，取值如下所示：
	// * true：配置白名单
	// * false：配置黑名单
	IsWhiteMode bool `json:"is_white_mode,omitempty"`

	// 根据是否为白名单，为对应的白/黑名单的值。
	Values []string `json:"values,omitempty"`
}

type AddDomainV1BodyHTTPSItem struct {

	// 证书 ID，若enable_https为true，则为必选。
	CertID string `json:"cert_id,omitempty"`

	// 是否开启 Https，取值如下所示：
	// * true：开启
	// * false：关闭
	EnableHTTPS bool `json:"enable_https,omitempty"`

	// 是否强制使用 Https，取值如下所示：
	// * true：强制
	// * false：不强制
	ForceHTTPS bool `json:"force_https,omitempty"`
}

type AddDomainV1BodyRespHdrsItem struct {

	// REQUIRED; Header Key，请见支持配置的响应头 [https://www.volcengine.com/docs/508/196704#%E6%94%AF%E6%8C%81%E9%85%8D%E7%BD%AE%E7%9A%84%E5%93%8D%E5%BA%94%E5%A4%B4]。
	Key string `json:"key"`

	// Header Value，设置该响应头字段的值。字段值不能超过 1,024 个字符，可以包含除美元符号（$），Delete（ASCII code 127）外的可打印 ASCII 字符。
	Value string `json:"value,omitempty"`
}

type AddDomainV1Query struct {

	// REQUIRED; 服务 ID。
	// * 您可以在veImageX 控制台服务管理 [https://console.volcengine.com/imagex/service_manage/]页面，在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息 [https://www.volcengine.com/docs/508/9360]。
	ServiceID string `json:"ServiceId" query:"ServiceId"`
}

type AddDomainV1Req struct {
	*AddDomainV1Query
	*AddDomainV1Body
}

type AddDomainV1Res struct {

	// REQUIRED
	ResponseMetadata *AddDomainV1ResResponseMetadata `json:"ResponseMetadata"`
	Result           *AddDomainV1ResResult           `json:"Result,omitempty"`
}

type AddDomainV1ResResponseMetadata struct {

	// REQUIRED; 请求的接口名，属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region，例如：cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务，属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号，属于请求的公共参数。
	Version string `json:"Version"`
}

type AddDomainV1ResResult struct {

	// 新增的域名。
	Domain string `json:"Domain,omitempty"`
}

type AddImageBackgroundColors struct{}

type AddImageBackgroundColorsBody struct {

	// REQUIRED; 待添加的颜色列表
	Colors []string `json:"Colors"`
}

type AddImageBackgroundColorsQuery struct{}

type AddImageBackgroundColorsReq struct {
	*AddImageBackgroundColorsQuery
	*AddImageBackgroundColorsBody
}

type AddImageBackgroundColorsRes struct {

	// REQUIRED
	ResponseMetadata *AddImageBackgroundColorsResResponseMetadata `json:"ResponseMetadata"`

	// title
	Result *AddImageBackgroundColorsResResult `json:"Result,omitempty"`
}

type AddImageBackgroundColorsResResponseMetadata struct {

	// REQUIRED; 请求的接口名，属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region，例如：cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务，属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号，属于请求的公共参数。
	Version string `json:"Version"`
}

type AddImageBackgroundColorsResResult struct {

	// REQUIRED; 若全部添加失败，则接口将返回失败
	FailedList []string `json:"FailedList"`
}

type AddImageElements struct{}

type AddImageElementsBody struct {

	// REQUIRED; 待添加的图片 URI 列表。
	Images []string `json:"Images"`

	// REQUIRED; 取值image表示图片要素，background表示背景要素
	Type AddImageElementsBodyType `json:"Type"`
}

type AddImageElementsBodyType string

type AddImageElementsQuery struct{}

type AddImageElementsReq struct {
	*AddImageElementsQuery
	*AddImageElementsBody
}

type AddImageElementsRes struct {

	// REQUIRED
	ResponseMetadata *AddImageElementsResResponseMetadata `json:"ResponseMetadata"`

	// title
	Result *AddImageElementsResResult `json:"Result,omitempty"`
}

type AddImageElementsResResponseMetadata struct {

	// REQUIRED; 请求的接口名，属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region，例如：cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务，属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号，属于请求的公共参数。
	Version string `json:"Version"`
}

type AddImageElementsResResult struct {

	// REQUIRED; 若全部添加失败，则接口将返回失败
	FailedList []string `json:"FailedList"`
}

type ApplyImageUpload struct{}

type ApplyImageUploadBody struct{}

type ApplyImageUploadQuery struct {

	// REQUIRED; 服务 ID。
	// * 您可以在 veImageX 控制台服务管理 [https://console.volcengine.com/imagex/service_manage/]页面，在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息 [https://www.volcengine.com/docs/508/9360]。
	ServiceID string `json:"ServiceId" query:"ServiceId"`

	// 文件扩展名(如：.java, .txt, .go 等)，最大长度限制为 8 个字节。 :::tip 仅当未指定StoreKeys时生效。 :::
	FileExtension string `json:"FileExtension,omitempty" query:"FileExtension"`

	// 是否开启重名文件覆盖上传，取值如下所示：
	// * true：开启
	// * false：（默认）关闭
	// :::warning 在指定Overwrite为true前，请确保您指定的ServiceId对应服务已开启了覆盖上传 [https://www.volcengine.com/docs/508/1119912]能力。 :::
	Overwrite bool `json:"Overwrite,omitempty" query:"Overwrite"`

	// 指定的上传文件路径。
	// * 指定Prefix时，下发的存储 Key 为：Prefix/{随机Key}{FileExtension}，其中Prefix + FileExtension最大长度限制为 145 个字节。
	// * 不支持以/开头或结尾，不支持/连续出现。 :::tip 仅当未指定StoreKeys时生效。 :::
	Prefix string `json:"Prefix,omitempty" query:"Prefix"`

	// 一次上传会话 Key。 :::tip 本接口上一次请求的SessionKey，可在重试时带上，作为服务端的再次选路时的一个参考。 :::
	SessionKey string `json:"SessionKey,omitempty" query:"SessionKey"`

	// 上传文件的存储 Key。默认使用随机生成的字符串作为存储 Key。
	// * 数组长度和UploadNum保持一致。
	// * 存储 Key 详细命名规范请参看 veImageX 存储 Key 通用字符规则 [https://www.volcengine.com/docs/508/1458331]。
	StoreKeys []string `json:"StoreKeys,omitempty" query:"StoreKeys"`

	// 上传文件的数量，将决定下发的 StoreUri 的数量，取值范围为[1,10]，默认为 1。
	UploadNum int `json:"UploadNum,omitempty" query:"UploadNum"`
}

type ApplyImageUploadReq struct {
	*ApplyImageUploadQuery
	*ApplyImageUploadBody
}

type ApplyImageUploadRes struct {

	// REQUIRED
	ResponseMetadata *ApplyImageUploadResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *ApplyImageUploadResResult `json:"Result"`
}

type ApplyImageUploadResResponseMetadata struct {

	// REQUIRED; 请求的接口名，属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region，例如：cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务，属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号，属于请求的公共参数。
	Version string                                    `json:"Version"`
	Error   *ApplyImageUploadResResponseMetadataError `json:"Error,omitempty"`
}

type ApplyImageUploadResResponseMetadataError struct {

	// REQUIRED; 错误码
	Code string `json:"Code"`

	// REQUIRED; 错误信息
	Message string `json:"Message"`
}

type ApplyImageUploadResResult struct {

	// REQUIRED; 请求的唯一标识 ID。
	RequestID string `json:"RequestId"`

	// REQUIRED; 上传地址
	UploadAddress *ApplyImageUploadResResultUploadAddress `json:"UploadAddress"`
}

type ApplyImageUploadResResultUploadAddress struct {

	// REQUIRED; 一次上传会话 Key。 上传完成上报时使用该值，该 Key 可以在解码后提取信息及参数校验。
	SessionKey string `json:"SessionKey"`

	// REQUIRED; 上传 Uri
	// :::tip 数量由请求参数中的 UploadNum 决定。 :::
	StoreInfos []*ApplyImageUploadResResultUploadAddressStoreInfosItem `json:"StoreInfos"`

	// REQUIRED; 上传域名列表，可以用于客户端容灾，并行上传等。
	UploadHosts []string `json:"UploadHosts"`
}

type ApplyImageUploadResResultUploadAddressStoreInfosItem struct {

	// REQUIRED; 上传凭证。
	Auth string `json:"Auth"`

	// REQUIRED; 资源 ID。
	StoreURI string `json:"StoreUri"`
}

type ApplyUploadImageParam struct {
	ServiceId      string
	SessionKey     string
	UploadNum      int
	UploadHost     string
	StoreKeys      []string
	ContentTypes   []string
	StorageClasses []string
	Prefix         string
	FileExtension  string
	CommitParam    *CommitUploadImageParam
	SkipMeta       bool
	SkipCommit     bool
	Overwrite      bool
}

type ApplyUploadImageResult struct {
	UploadAddress UploadAddress `json:"UploadAddress"`
	RequestId     string        `json:"RequestId"`
}

type ApplyVpcUploadInfo struct{}

type ApplyVpcUploadInfoBody struct{}

type ApplyVpcUploadInfoQuery struct {

	// REQUIRED; 服务 ID。
	// * 您可以在 veImageX 控制台服务管理 [https://console.volcengine.com/imagex/service_manage/]页面，在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息 [https://www.volcengine.com/docs/508/9360]。
	ServiceID string `json:"ServiceId" query:"ServiceId"`

	// 上传文件的 Content-Type 值。
	// 需确保指定值在服务维度的白名单内，否则无法成功上传，参看上传 Content-Type 限制 [https://www.volcengine.com/docs/508/1319948]。
	ContentType string `json:"ContentType,omitempty" query:"ContentType"`

	// 文件扩展名，最大长度限制为 8 个字节。
	// :::tip 仅当未指定 StoreKeys 时生效。 :::
	FileExtension string `json:"FileExtension,omitempty" query:"FileExtension"`

	// 文件大小。
	FileSize int `json:"FileSize,omitempty" query:"FileSize"`

	// 是否开启重名文件覆盖上传，取值如下所示：
	// * true：开启
	// * false：（默认）关闭
	// :::tip 在指定Overwrite为true前，请确保您指定的ServiceId对应服务已开启了覆盖上传 [https://www.volcengine.com/docs/508/1119912]能力。 :::
	Overwrite bool `json:"Overwrite,omitempty" query:"Overwrite"`

	// 分片大小，单位为字节，默认值为 200 MB。 当 FileSize 大于 PartSize 时，下发分片上传的 URL。
	PartSize int `json:"PartSize,omitempty" query:"PartSize"`

	// 指定的上传文件路径。指定 Prefix 时，下发的存储 Key 为：Prefix/{随机Key}.{FileExtension}，拼接形成的存储 Key 需满足veImageX 存储 Key 通用字符规则 [https://www.volcengine.com/docs/508/1458331]。
	// :::tip 仅当未指定 StoreKeys 时生效。 :::
	Prefix string `json:"Prefix,omitempty" query:"Prefix"`

	// 存储类型。
	// * STANDARD：标准存储
	// * IA：低频存储
	// * ARCHIVE_FR：归档闪回存储
	// * ARCHIVE：归档存储
	// * COLD_ARCHIVE：冷归档存储
	StorageClass string `json:"StorageClass,omitempty" query:"StorageClass"`

	// 上传文件的存储 Key。默认使用随机生成的字符串作为存储 Key。
	// 存储 Key 详细命名规范请参看veImageX 存储 Key 通用字符规则 [https://www.volcengine.com/docs/508/1458331]。
	StoreKey string `json:"StoreKey,omitempty" query:"StoreKey"`
}

type ApplyVpcUploadInfoReq struct {
	*ApplyVpcUploadInfoQuery
	*ApplyVpcUploadInfoBody
}

type ApplyVpcUploadInfoRes struct {

	// REQUIRED
	ResponseMetadata *ApplyVpcUploadInfoResResponseMetadata `json:"ResponseMetadata"`
	Result           *ApplyVpcUploadInfoResResult           `json:"Result,omitempty"`
}

type ApplyVpcUploadInfoResResponseMetadata struct {

	// REQUIRED; 请求的接口名，属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region，例如：cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestId为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务，属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号，属于请求的公共参数。
	Version string `json:"Version"`
}

type ApplyVpcUploadInfoResResult struct {

	// REQUIRED; 参数的唯一标识符
	Oid string `json:"Oid"`

	// REQUIRED; 分片上传信息。
	PartUploadInfo *ApplyVpcUploadInfoResResultPartUploadInfo `json:"PartUploadInfo"`

	// REQUIRED; 上传URL。
	PutURL string `json:"PutURL"`

	// REQUIRED; 自定义请求头。
	PutURLHeaders []*ApplyVpcUploadInfoResResultPutURLHeadersItem `json:"PutURLHeaders"`

	// REQUIRED; 上传会话
	SessionKey string `json:"SessionKey"`

	// REQUIRED; 上传模式。
	// * direct：直接上传
	// * part：分片上传
	UploadMode string `json:"UploadMode"`
}

type ApplyVpcUploadInfoResResultPartUploadInfo struct {

	// REQUIRED; 完整部分的URL。
	CompletePartURL string `json:"CompletePartURL"`

	// REQUIRED; 合并分片请求头信息，map结构
	CompletePartURLHeaders []*ApplyVpcUploadInfoResResultPartUploadInfoCompletePartURLHeadersItem `json:"CompletePartURLHeaders"`

	// REQUIRED; 分块上传URL列表。
	PartPutURLs []string `json:"PartPutURLs"`

	// REQUIRED; 上传分片大小，默认为 200MB。
	PartSize int `json:"PartSize"`
}

type ApplyVpcUploadInfoResResultPartUploadInfoCompletePartURLHeadersItem struct {

	// REQUIRED; 请提供具体的Key和string值，我将根据这些信息生成参数的一句话描述。
	Key string `json:"Key"`

	// REQUIRED; 请提供参数的名字和类型。
	Value string `json:"Value"`
}

type ApplyVpcUploadInfoResResultPutURLHeadersItem struct {

	// REQUIRED; 请提供具体的Key和string值，我将根据这些信息生成参数描述。
	Key string `json:"Key"`

	// REQUIRED; 参数的值。
	Value string `json:"Value"`
}

type CommitImageUpload struct{}

type CommitImageUploadBody struct {

	// REQUIRED; 一次上传会话 Key。 :::tip 请参考获取文件上传地址 [https://www.volcengine.com/docs/508/9397]获取。 :::
	SessionKey  string   `json:"SessionKey"`
	DecryptKeys []string `json:"DecryptKeys,omitempty"`

	// 上传成功的资源 ID。
	SuccessOids []string `json:"SuccessOids,omitempty"`
}

type CommitImageUploadQuery struct {

	// REQUIRED; 服务 ID。
	// * 您可以在 veImageX 控制台服务管理 [https://console.volcengine.com/imagex/service_manage/]页面，在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息 [https://www.volcengine.com/docs/508/9360]。
	ServiceID string `json:"ServiceId" query:"ServiceId"`

	// 是否返回图片meta信息。默认 false。
	// * true：不返回图片 meta 信息。
	// * false：获取图片 meta 信息并返回对应 meta 信息。
	// * 其中若 meta 获取超时或失败，接口返回成功，但对应 meta 信息将为空。
	// * 如果强依赖 meta 请参考图片Meta信息 [https://www.volcengine.com/docs/508/64085]获取。
	SkipMeta bool `json:"SkipMeta,omitempty" query:"SkipMeta"`
}

type CommitImageUploadReq struct {
	*CommitImageUploadQuery
	*CommitImageUploadBody
}

type CommitImageUploadRes struct {

	// REQUIRED
	ResponseMetadata *CommitImageUploadResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *CommitImageUploadResResult `json:"Result"`
}

type CommitImageUploadResResponseMetadata struct {

	// REQUIRED
	Action string `json:"Action"`

	// REQUIRED
	Region string `json:"Region"`

	// REQUIRED
	RequestID string `json:"RequestId"`

	// REQUIRED
	Service string `json:"Service"`

	// REQUIRED
	Version string `json:"Version"`
}

type CommitImageUploadResResult struct {

	// REQUIRED; 请求的唯一标识 ID。
	RequestID string `json:"RequestId"`

	// REQUIRED; 运行结果，数组长度对应上传的数量。
	Results []*CommitImageUploadResResultResultsItem `json:"Results"`

	// JSON 序列化之后的图片信息，结构体请参考 ImageInfo 的 Array。
	PluginResult []*CommitImageUploadResResultPluginResultItem `json:"PluginResult,omitempty"`
}

type CommitImageUploadResResultPluginResultItem struct {

	// REQUIRED; 图片 Uri。
	ImageURI string `json:"ImageUri"`

	// 图片文件名。
	FileName string `json:"FileName,omitempty"`

	// 图片帧数量
	FrameCnt int `json:"FrameCnt,omitempty"`

	// 图片格式
	ImageFormat string `json:"ImageFormat,omitempty"`

	// 图片的高。
	ImageHeight int `json:"ImageHeight,omitempty"`

	// 图片的 MD5
	ImageMD5 string `json:"ImageMd5,omitempty"`

	// 图片大小
	ImageSize int `json:"ImageSize,omitempty"`

	// 图片的宽。
	ImageWidth int `json:"ImageWidth,omitempty"`
}

type CommitImageUploadResResultResultsItem struct {

	// REQUIRED; 源图片的 Uri。
	URI string `json:"Uri"`

	// REQUIRED; 图片上传结果。
	// * 返回值为 2000，表示上传成功；
	// * 返回值为 2001，表示上传失败。 :::tip 需要传 SuccessOids 才会返回值。 :::
	URIStatus int `json:"UriStatus"`

	// 加密结果。 :::tip 指定了 Encryption Function 时有值 。 :::
	Encryption *CommitImageUploadResResultResultsItemEncryption `json:"Encryption,omitempty"`
	ImageMeta  *CommitImageUploadResResultResultsItemImageMeta  `json:"ImageMeta,omitempty"`
}

type CommitImageUploadResResultResultsItemEncryption struct {

	// REQUIRED; 加密算法。
	Algorithm string `json:"Algorithm"`

	// REQUIRED; 额外信息，键值均为 String。
	Extra map[string]string `json:"Extra"`

	// REQUIRED; 加密私钥。
	SecretKey string `json:"SecretKey"`

	// REQUIRED; 加密源 MD5。
	SourceMD5 string `json:"SourceMd5"`

	// REQUIRED; 加密图片的 Uri。
	URI string `json:"Uri"`

	// REQUIRED; 加密版本。
	Version string `json:"Version"`
}

type CommitImageUploadResResultResultsItemImageMeta struct {

	// REQUIRED
	Field75 int `json:"Field75"`

	// REQUIRED
	Format string `json:"Format"`

	// REQUIRED
	Height int `json:"Height"`

	// REQUIRED
	MD5 string `json:"Md5"`

	// REQUIRED
	Size int `json:"Size"`

	// REQUIRED
	URI string `json:"Uri"`
}

type CommitUploadImageParam struct {
	ServiceId   string     `json:"-"`
	SessionKey  string     `json:"SessionKey"`
	SuccessOids []string   `json:"SuccessOids"`
	Functions   []Function `json:"Functions"`
	SkipMeta    bool       `json:"-"`
}

type CommitUploadImageResult struct {
	Results    []Result    `json:"Results"`
	RequestId  string      `json:"RequestId"`
	ImageInfos []ImageInfo `json:"PluginResult"`
}

type Components10W6HmvSchemasGetimagestyledetailresPropertiesResultPropertiesStylePropertiesElementsItemsPropertiesAttrPropertiesFillptnPropertiesViewpoint struct {
	Height int `json:"height"`

	Width int `json:"width"`

	X int `json:"x"`

	Y int `json:"y"`
}

type Components11LotgnSchemasGetimagestyledetailresPropertiesResultPropertiesStylePropertiesElementsItemsPropertiesAttrPropertiesFillptn struct {
	Name string `json:"name"`

	Param     *ComponentsEyl12ZSchemasGetimagestyledetailresPropertiesResultPropertiesStylePropertiesElementsItemsPropertiesAttrPropertiesFillptnPropertiesParam      `json:"param"`
	BgColor   string                                                                                                                                                  `json:"bgColor,omitempty"`
	Ptn       int                                                                                                                                                     `json:"ptn,omitempty"`
	ViewLoc   int                                                                                                                                                     `json:"viewLoc,omitempty"`
	Viewpoint *Components10W6HmvSchemasGetimagestyledetailresPropertiesResultPropertiesStylePropertiesElementsItemsPropertiesAttrPropertiesFillptnPropertiesViewpoint `json:"viewpoint,omitempty"`
}

type Components16Kv6ElSchemasGetallimageservicesresPropertiesResultPropertiesServicesItemsPropertiesEventrulesItems struct {
	CallbackURL string `json:"CallbackUrl"`

	Enable bool `json:"Enable"`

	EventType []string `json:"EventType"`

	ID string `json:"Id"`

	MatchRule string `json:"MatchRule"`
}

type Components18K1KvdSchemasGetallimageservicesresPropertiesResultPropertiesServicesItemsPropertiesResourcetagsItems struct {
	Key string `json:"Key"`

	Value string `json:"Value"`
}

type Components1AkatydSchemasGetimageserviceresPropertiesResultPropertiesStoragerulesv2ItemsPropertiesNoncurrentversiontransitionsItems struct {
	StorageClass string `json:"StorageClass"`

	NonCurrentDate string `json:"NonCurrentDate,omitempty"`

	NonCurrentDays int `json:"NonCurrentDays,omitempty"`
}

type Components1D40MkcSchemasGetallimageservicesresPropertiesResultPropertiesServicesItemsPropertiesStoragerulesItems struct {
	Enable bool `json:"Enable"`

	Event string `json:"Event"`

	Prefix string `json:"Prefix"`

	Action string `json:"Action,omitempty"`

	Day int `json:"Day,omitempty"`

	NonCurrentAction string `json:"NonCurrentAction,omitempty"`

	NonCurrentDay int `json:"NonCurrentDay,omitempty"`
}

type Components1Muxqr1SchemasGetimagealertrecordsresPropertiesResultPropertiesAlertrecordsItemsPropertiesAlertcondPropertiesAlertcontent struct {
	AggrInterval int `json:"AggrInterval"`

	Dim string `json:"Dim"`

	Func string `json:"Func"`

	Item string `json:"Item"`

	Op string `json:"Op"`

	RepeatCnt int `json:"RepeatCnt"`

	Threshold float64 `json:"Threshold"`

	Vals []*GetImageAlertRecordsResResultAlertRecordsPropertiesItemsItem `json:"Vals"`
}

type Components1T23IneSchemasGetallimagetemplatesresPropertiesResultPropertiesTemplatesItemsPropertiesFiltersItems struct {
	Name string `json:"Name"`

	Param map[string]interface{} `json:"Param"`
}

type Components1WypgicSchemasGetimagemonitorrulesresPropertiesResultPropertiesMonitorrulesItemsPropertiesFilterPropertiesDimfilterItems struct {
	Dim string `json:"Dim"`

	Vals []string `json:"Vals"`

	Not bool `json:"Not,omitempty"`
}

type Components1Xh7Lz4SchemasDescribeimagexcompressusageresPropertiesResultPropertiesCompressdataItemsPropertiesOutsizeItems struct {
	TimeStamp string `json:"TimeStamp"`

	Value float64 `json:"Value"`
}

type Components3Ic6Z9SchemasGetimagemonitorrulesresPropertiesResultPropertiesMonitorrulesItemsPropertiesCondPropertiesItemcondItems struct {
	AggrInterval int `json:"AggrInterval"`

	Func string `json:"Func"`

	Item string `json:"Item"`

	Op string `json:"Op"`

	RepeatCnt int `json:"RepeatCnt"`

	Threshold float64 `json:"Threshold"`

	CntThreshold int `json:"CntThreshold,omitempty"`
}

type Components6Rlnt3SchemasGetimagestyledetailresPropertiesResultPropertiesStylePropertiesElementsItemsPropertiesAttrPropertiesBorder struct {
	Color string `json:"color"`

	Dash int `json:"dash"`

	PaddingBottom int `json:"paddingBottom"`

	PaddingLeft int `json:"paddingLeft"`

	PaddingRight int `json:"paddingRight"`

	PaddingTop int `json:"paddingTop"`

	Radius int `json:"radius"`

	Weight int `json:"weight"`
}

type Components8GbgysSchemasGettemplatesfrombinresPropertiesResultPropertiesTemplatesItemsPropertiesFiltersItems struct {
	Name string `json:"Name"`

	Param map[string]interface{} `json:"Param"`
}

type ComponentsDgbrljSchemasGetimageaudittasksresPropertiesResultPropertiesTasksItemsPropertiesAudittaskPropertiesImageinfosItems struct {
	DataID string `json:"DataId"`

	ImageURI string `json:"ImageUri"`
}

type ComponentsDrd6S5SchemasGetallimageservicesresPropertiesResultPropertiesServicesItemsPropertiesStorageItems struct {
	AllTypes bool `json:"AllTypes"`

	BktName string `json:"BktName"`

	TTL int `json:"TTL"`
}

type ComponentsEyl12ZSchemasGetimagestyledetailresPropertiesResultPropertiesStylePropertiesElementsItemsPropertiesAttrPropertiesFillptnPropertiesParam struct {
	Color string `json:"color"`
}

type ComponentsK7Ou2VSchemasGetimageocrv2ResPropertiesResultPropertiesLicenseresultAdditionalproperties struct {
	Content string `json:"Content"`

	Location []int `json:"Location"`
}

type ComponentsPqmsj3SchemasGetallimageservicesresPropertiesResultPropertiesServicesItemsPropertiesMirrorItems struct {
	Headers map[string]string `json:"Headers"`

	Host string `json:"Host"`

	Hosts map[string]int `json:"Hosts"`

	Origin *GetAllImageServicesResResultServicesItemMirrorItemOrigin `json:"Origin"`

	Schema string `json:"Schema"`

	Source string `json:"Source"`
}

type ComponentsQpab6RSchemasUpdatestoragerulesv2BodyPropertiesStoragerulesItemsPropertiesNoncurrentversiontransitionsItems struct {
	StorageClass string `json:"StorageClass"`

	NonCurrentDate string `json:"NonCurrentDate,omitempty"`

	NonCurrentDays int `json:"NonCurrentDays,omitempty"`
}

type CreateBatchProcessTask struct{}

type CreateBatchProcessTaskBody struct {

	// REQUIRED; 指定服务下待批量处理的资源链接信息
	BatchingInfo []*CreateBatchProcessTaskBodyBatchingInfoItem `json:"BatchingInfo"`

	// 回调地址，用于接收返回的回调信息。
	Callback string `json:"Callback,omitempty"`

	// 自定义回调内容，取值需要符合CallbackBodyType指定格式。
	CallbackBody string `json:"CallbackBody,omitempty"`

	// 回调内容格式。默认为空，若需指定CallbackBody时，也需同时指定CallbackBodyType的值。取值如下所示：
	// * application/json
	// * application/x-www-form-urlencoded
	CallbackBodyType string `json:"CallbackBodyType,omitempty"`
}

type CreateBatchProcessTaskBodyBatchingInfoItem struct {

	// 批处理能力，取值如下所示：
	// * meta：获取资源元信息
	// * preload：源站图片预热 :::warning 如需批量预热源站图片，请提交工单 [https://console.volcengine.com/ticket/createTicketV2/?step=3&Service=rtc&FlowKey=NGnOHeWkbeCrEAkrNvjT]联系技术支持开启。
	// :::
	Action string `json:"Action,omitempty"`

	// 指定服务下待批处理资源的可访问 URL
	URL string `json:"Url,omitempty"`
}

type CreateBatchProcessTaskQuery struct {

	// REQUIRED; 待执行异步批处理的服务 ID。
	// * 您可以在 veImageX 控制台服务管理 [https://console.volcengine.com/imagex/service_manage/]页面，在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息 [https://www.volcengine.com/docs/508/9360]。
	ServiceID string `json:"ServiceId" query:"ServiceId"`
}

type CreateBatchProcessTaskReq struct {
	*CreateBatchProcessTaskQuery
	*CreateBatchProcessTaskBody
}

type CreateBatchProcessTaskRes struct {

	// REQUIRED
	ResponseMetadata *CreateBatchProcessTaskResResponseMetadata `json:"ResponseMetadata"`
	Result           *CreateBatchProcessTaskResResult           `json:"Result,omitempty"`
}

type CreateBatchProcessTaskResResponseMetadata struct {

	// REQUIRED; 请求的接口名，属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region，例如：cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务，属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号，属于请求的公共参数。
	Version string `json:"Version"`
}

type CreateBatchProcessTaskResResult struct {

	// REQUIRED; 任务 ID
	TaskID string `json:"TaskId"`
}

type CreateCVImageGenerateTask struct{}

type CreateCVImageGenerateTaskBody struct {

	// REQUIRED; 服务下绑定的域名，域名状态需正常可用。
	// * 您可以在 veImageX 控制台服务管理 [https://console.volcengine.com/imagex/service_manage/]页面，在创建好的图片服务中获取绑定的域名信息。
	// * 您也可以通过 OpenAPI 的方式获取域名，具体请参考获取服务下全部域名 [https://www.volcengine.com/docs/508/9379]。
	Domain string `json:"Domain"`

	// REQUIRED; 模型接口action
	ModelAction string `json:"ModelAction"`

	// REQUIRED; 文生图系列模型的接口 Version 名称。
	// 例如，使用通用 2.0S-文生图异步 [https://www.volcengine.com/docs/6791/1347773]，则 ModelVersion 需要取值为 2022-08-31。
	ModelVersion string `json:"ModelVersion"`

	// REQUIRED; 参数输出。
	Outputs []string `json:"Outputs"`

	// REQUIRED; 请求的JSON字符串。
	ReqJSON map[string]interface{} `json:"ReqJson"`

	// REQUIRED; 服务下创建的图片处理模板名称，指定后，将按照模板中的处理配置对生成的原始图片进行图片处理。
	// 您可在 veImageX 控制台的处理配置页面，参考新建模板 [https://www.volcengine.com/docs/508/8087]配置模板并获取模版名称，例如 tplv-f0****5k-test。
	Template string `json:"Template"`

	// 是否覆盖现有内容。 * false：不覆盖；
	// * true：覆盖。
	// 默认值为false。
	Overwrite bool `json:"Overwrite,omitempty"`
}

type CreateCVImageGenerateTaskQuery struct {

	// REQUIRED; 指定存储结果图并计量计费的服务 ID。
	// * 您可以在 veImageX 控制台服务管理 [https://console.volcengine.com/imagex/service_manage/]页面，在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息 [https://www.volcengine.com/docs/508/9360]。
	ServiceID string `json:"ServiceId" query:"ServiceId"`
}

type CreateCVImageGenerateTaskReq struct {
	*CreateCVImageGenerateTaskQuery
	*CreateCVImageGenerateTaskBody
}

type CreateCVImageGenerateTaskRes struct {

	// REQUIRED
	ResponseMetadata *CreateCVImageGenerateTaskResResponseMetadata `json:"ResponseMetadata"`

	// 视请求的接口而定
	Result *CreateCVImageGenerateTaskResResult `json:"Result,omitempty"`
}

type CreateCVImageGenerateTaskResResponseMetadata struct {

	// REQUIRED; 请求的接口名，属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region，例如：cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestId为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务，属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号，属于请求的公共参数。
	Version string `json:"Version"`
}

type CreateCVImageGenerateTaskResResult struct {

	// REQUIRED; 响应的JSON数据。
	RespJSON map[string]interface{} `json:"RespJson"`

	// REQUIRED; 任务 ID，用于查询结果。
	TaskID string `json:"TaskId"`
}

type CreateFileRestore struct{}

type CreateFileRestoreBody struct {

	// REQUIRED; 恢复时长，取值范围为[1,365]，单位为天。
	Duration int `json:"Duration"`

	// REQUIRED; 文件存储 URI。
	// * 您可以在 veImageX 控制台资源管理 [https://console.volcengine.com/imagex/resource_manage/]页面，在已上传文件的名称列获取资源 URI。
	// * 您也可以通过 OpenAPI 的方式获取 URI，具体请参考获取服务下全部上传文件 [https://www.volcengine.com/docs/508/9393]。
	StoreURI string `json:"StoreUri"`

	// 取回方式： Expedited：快速取回 Standard：标准取回 Bulk：批量取回；不设置默认standard
	Tier string `json:"Tier,omitempty"`
}

type CreateFileRestoreQuery struct {

	// REQUIRED; 服务 ID。
	// * 您可以在 veImageX 控制台服务管理 [https://console.volcengine.com/imagex/service_manage/]页面，在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息 [https://www.volcengine.com/docs/508/9360]。
	ServiceID string `json:"ServiceId" query:"ServiceId"`
}

type CreateFileRestoreReq struct {
	*CreateFileRestoreQuery
	*CreateFileRestoreBody
}

type CreateFileRestoreRes struct {

	// REQUIRED
	ResponseMetadata *CreateFileRestoreResResponseMetadata `json:"ResponseMetadata"`

	// 视请求的接口而定
	Result interface{} `json:"Result,omitempty"`
}

type CreateFileRestoreResResponseMetadata struct {

	// REQUIRED; 请求的接口名，属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region，例如：cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务，属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号，属于请求的公共参数。
	Version string `json:"Version"`
}

type CreateHiddenWatermarkImage struct{}

type CreateHiddenWatermarkImageBody struct {

	// REQUIRED; 盲水印模型，取值如下所示：
	// * tracev1：前景图层水印模型（纯色背景适用）。
	//
	// 该模型可以生成带有水印的透明图像，但仅适用于纯色网页泄露溯源场景。该模型可有效抵抗常见的社交软件传播。然而，该算法对页面背景色的影响相对较大，因此不适合用于保护多彩页面或图片，例如商品页面。
	//
	//
	// * tracev2：前景图层水印模型（彩色背景通用）
	//
	// 该模型可以生成含水印的透明图像，主要应用在前端页面截图泄露溯源场景。该模型生成的水印纹理密集，在正常界面添加后肉眼基本不可见（截图放大后存在肉眼可见的水印纹理），可抵抗常见的社交软件传播。
	Algorithm string `json:"Algorithm"`

	// REQUIRED; 自定义盲水印文本信息，最多支持 128 个字符。
	Info string `json:"Info"`

	// REQUIRED; 盲水印强度，取值如下所示：
	// * low：低强度，适用于对图像质量要求高。
	// * medium：中强度
	// * strong：高强度，适合图像纹理丰富时使用。
	Strength string `json:"Strength"`
}

type CreateHiddenWatermarkImageQuery struct {

	// REQUIRED; 用于存储结果图和计量计费的服务 ID。
	// * 您可以在 veImageX 控制台服务管理 [https://console.volcengine.com/imagex/service_manage/]页面，在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息 [https://www.volcengine.com/docs/508/9360]。
	ServiceID string `json:"ServiceId" query:"ServiceId"`
}

type CreateHiddenWatermarkImageReq struct {
	*CreateHiddenWatermarkImageQuery
	*CreateHiddenWatermarkImageBody
}

type CreateHiddenWatermarkImageRes struct {

	// REQUIRED
	ResponseMetadata *CreateHiddenWatermarkImageResResponseMetadata `json:"ResponseMetadata"`

	// 视请求的接口而定
	Result *CreateHiddenWatermarkImageResResult `json:"Result,omitempty"`
}

type CreateHiddenWatermarkImageResResponseMetadata struct {

	// REQUIRED; 请求的接口名，属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region，例如：cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务，属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号，属于请求的公共参数。
	Version string `json:"Version"`
}

type CreateHiddenWatermarkImageResResult struct {

	// REQUIRED; 盲水印图片 Uri，当前仅支持输出 png 格式。
	StoreURI string `json:"StoreUri"`
}

type CreateImageAITask struct{}

type CreateImageAITaskBody struct {

	// REQUIRED; 待进行 AI 处理的图片 URI 或 URL 列表，其中 URI 不需要带 tos-cn-i-*** 前缀。传入图片的短边不小于 256 px，长边不大于 2048 px，大小不超过 10 MB。
	// :::warning 若 DataType 取值 uri，则待转码图片 URI 必须为指定服务 ID 下的存储 URI。您可通过调用GetImageUploadFiles [https://www.volcengine.com/docs/508/9392]获取指定服务下全部的上传文件存储
	// URI。 :::
	DataList []string `json:"DataList"`

	// REQUIRED; 需要提交的图片数据类型，取值如下所示：
	// * uri：指定 ServiceId 下存储 URI。
	// * url：公网可访问的 URL。
	DataType string `json:"DataType"`

	// REQUIRED; 服务 ID。若 DataType 取值 uri，则提交的图片 URI 列表需在该服务内。
	// * 您可以在 veImageX 控制台服务管理 [https://console.volcengine.com/imagex/service_manage/]页面，在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息 [https://www.volcengine.com/docs/508/9360]。
	ServiceID string `json:"ServiceId"`

	// REQUIRED; AI 图像处理模板参数，需要将 JSON 压缩并转义为字符串。根据您需要的图像处理功能，参看AI 图像处理模板 [https://www.volcengine.com/docs/508/1515840]页面获取模板 ID
	// 和参数信息。
	WorkflowParameter string `json:"WorkflowParameter"`

	// REQUIRED; AI 图像处理模板 ID。根据您需要的图像处理功能，参看 AI 图像处理模板 [https://www.volcengine.com/docs/508/1515840]页面获取模板 ID 和参数信息。
	WorkflowTemplateID string `json:"WorkflowTemplateId"`

	// 任务回调配置。
	CallbackConf *CreateImageAITaskBodyCallbackConf `json:"CallbackConf,omitempty"`
}

type CreateImageAITaskBodyCallbackConf struct {

	// REQUIRED; 回调 HTTP 请求地址，用于接收转码结果详情。支持使用 https 和 http 协议。
	Endpoint string `json:"Endpoint"`

	// REQUIRED; 回调方式，仅支持取值 HTTP。
	Method string `json:"Method"`

	// 业务自定义回调参数，将在回调消息的 callback_args 中透传。具体回调参数请参考 AI 图像处理回调 [https://www.volcengine.com/docs/508/1526662]。
	Args string `json:"Args,omitempty"`

	// 回调数据格式，仅支持取值 JSON。
	DataFormat string `json:"DataFormat,omitempty"`

	// 回调的维度类型，缺省情况下按照条目级别进行回调。取值如下所示：
	// * task：将按照任务级别进行回调。可分批回调，一个批次内最多一次性可回调 5000 条图片转码条目执行信息。
	// * entry：将按照条目级别进行回调。当该条目执行完毕，将立即产生回调。
	Type string `json:"Type,omitempty"`
}

type CreateImageAITaskQuery struct{}

type CreateImageAITaskReq struct {
	*CreateImageAITaskQuery
	*CreateImageAITaskBody
}

type CreateImageAITaskRes struct {

	// REQUIRED
	ResponseMetadata *CreateImageAITaskResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *CreateImageAITaskResResult `json:"Result"`
}

type CreateImageAITaskResResponseMetadata struct {

	// REQUIRED
	Action string `json:"Action"`

	// REQUIRED
	Region string `json:"Region"`

	// REQUIRED
	RequestID string `json:"RequestId"`

	// REQUIRED
	Service string `json:"Service"`

	// REQUIRED
	Version string `json:"Version"`
}

type CreateImageAITaskResResult struct {

	// REQUIRED; 队列 ID。查询接口需要使用，请注意保存。
	QueueID string `json:"QueueId"`

	// REQUIRED; 任务 ID。查询接口需要使用，请注意保存。
	TaskID string `json:"TaskId"`
}

type CreateImageAnalyzeTask struct{}

type CreateImageAnalyzeTaskBody struct {

	// REQUIRED; 自定义离线评估任务名称
	Name string `json:"Name"`

	// REQUIRED; 任务地区。当前仅支持取值 cn，表示国内。
	Region string `json:"Region"`

	// REQUIRED; 服务 ID。
	// * 您可以在 veImageX 控制台服务管理 [https://console.volcengine.com/imagex/service_manage/]页面，在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息 [https://www.volcengine.com/docs/508/9360]。
	ServiceID string `json:"ServiceId"`

	// REQUIRED; 任务类型。取值如下所示：
	// * OnlineUrl（暂不支持）
	// * SdkUrl（暂不支持）
	// * UrlFile：在线提交 URL 离线评估，即在.txt 文件（评估文件）内填写了待评估图片文件 URL，并将该 txt 文件上传至指定服务后获取并传入该文件的 StoreUri。
	// * UriFile：在线提交 URI 离线评估，即在.txt 文件（评估文件）内填写了待评估图片文件 URI，并将该 txt 文件上传至指定服务后获取并传入该文件的 StoreUri。
	Type string `json:"Type"`

	// 任务描述，可作为该条任务的备注信息。
	Desc string `json:"Desc,omitempty"`

	// txt 评估文件的 Store URI，该文件需上传至指定服务对应存储中。
	// * Type 取值 UrlFile 时，填写合法 URL
	// * Type 取值 UriFile 时，填写指定服务的存储 URI
	ResURI []string `json:"ResUri,omitempty"`

	// 仅当Type 取值 UriFile 时，配置有效。 模板名称，您可通过调用 GetAllImageTemplates [https://www.volcengine.com/docs/508/9386] 获取服务下所有已创建的 TemplateName。
	Tpl string `json:"Tpl,omitempty"`
}

type CreateImageAnalyzeTaskQuery struct{}

type CreateImageAnalyzeTaskReq struct {
	*CreateImageAnalyzeTaskQuery
	*CreateImageAnalyzeTaskBody
}

type CreateImageAnalyzeTaskRes struct {

	// REQUIRED
	ResponseMetadata *CreateImageAnalyzeTaskResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *CreateImageAnalyzeTaskResResult `json:"Result"`
}

type CreateImageAnalyzeTaskResResponseMetadata struct {

	// REQUIRED
	Action string `json:"Action"`

	// REQUIRED
	Region string `json:"Region"`

	// REQUIRED
	RequestID string `json:"RequestId"`

	// REQUIRED
	Service string `json:"Service"`

	// REQUIRED
	Version string `json:"Version"`
}

type CreateImageAnalyzeTaskResResult struct {

	// REQUIRED; 任务 ID
	TaskID string `json:"TaskId"`
}

type CreateImageAuditTask struct{}

type CreateImageAuditTaskBody struct {

	// REQUIRED; 审核能力，取值如下所示：
	// * 0：基础审核能力
	// * 1：智能审核能力
	AuditAbility int `json:"AuditAbility"`

	// REQUIRED; "porn" // 涉黄 "govern" // 涉政 "terror" // 涉恐 "illegal" // 违法违规 "sensitive1" // 涉敏1 "sensitive2" // 涉敏2 "forbidden"
	// // 违禁 "uncomfortable" // 引人不适 "qrcode" // 二维码 "badpicture" // 不良画面 "sexy" // 性感低俗 "age"
	// // 年龄 "underage" // 未成年 "quality" // 图片质量
	AuditDimensions []string `json:"AuditDimensions"`

	// REQUIRED; 任务地区。当前仅支持取值 cn，表示国内。
	Region string `json:"Region"`

	// REQUIRED; 服务 ID。
	// * 您可以在 veImageX 控制台服务管理 [https://console.volcengine.com/imagex/service_manage/]页面，在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息 [https://www.volcengine.com/docs/508/9360]。
	ServiceID string `json:"ServiceId"`

	// REQUIRED; 任务类型，当前仅支持取值为 audit。
	TaskType string `json:"TaskType"`

	// REQUIRED; 图片审核任务场景。取值如下所示：
	// * UrlFile：存量图片处理，进针对已有存储内的图片请求获取审核结果。传入方式是 ResUri方式，即在.txt 文件（审核文件）内填写了待审核图片文件 URL，并将该 txt 文件上传至指定服务后获取并传入该文件的 StoreUri。
	// * Url：URL 直传场景。传入方式为 ImageInfos 方式，即可直接传入待审核图片的 URL 及区分标识。
	// * Upload：图片上传场景，针对上传图片到指定服务下的场景。可在 EnableAuditRange下指定审核的范围，例如对指定上传到某目录下的图片进行审核。
	Type string `json:"Type"`

	// 仅当 EnableAuditRange 取值 1 时，配置生效。 指定前缀审核，若你希望对某个目录进行审核，请设置路径为对应的目录名，以/结尾。例如123/test/
	AuditPrefix []string `json:"AuditPrefix,omitempty"`

	// "ad" // 广告 "defraud" // 诈骗 "charillegal" // 文字违规
	AuditTextDimensions []string `json:"AuditTextDimensions,omitempty"`

	// 回调类型，取值需要与 AuditDimensions 审核维度保持一致或少于 AuditDimensions。
	// 例如，AuditDimensions 取值 ["pron","sexy"]，AuditTextDimensions 取值 ["ad"]，支持您将 FreezeDimensions 取值 ["pron","sexy","ad"] 、 ["pron","sexy"]、["pron","ad"]
	// 和 ["sexy","ad"] 任意一种。
	CallbackDimensions []string `json:"CallbackDimensions,omitempty"`

	// 回调图片类型，取值如下所示：
	// * normal：正常图片
	//
	//
	// * problem：问题图片
	//
	//
	// * frozen：冻结图片
	//
	//
	// * fail：审核失败图片
	CallbackImageTypes []string `json:"CallbackImageTypes,omitempty"`

	// 回调 URL，veImageX 以 Post 方式向业务服务器发送 JSON 格式回调数据。具体回调参数请参考回调内容 [https://www.volcengine.com/docs/508/134676#%E5%9B%9E%E8%B0%83%E5%86%85%E5%AE%B9]。
	CallbackURL string `json:"CallbackUrl,omitempty"`

	// 默认0
	EnableAuditRange int `json:"EnableAuditRange,omitempty"`

	// 是否开启回调，取值如下所示：
	// * true：开启
	// * false：（默认）不开启
	EnableCallback bool `json:"EnableCallback,omitempty"`

	// 是否开启冻结，取值如下所示：
	// * true：开启
	// * false：（默认）不开启
	EnableFreeze bool `json:"EnableFreeze,omitempty"`

	// 图片审核仅支持审核 5MB 以下的图片，若您的图片大小在 5MB~32MB，您可以开启大图审核功能，veImageX 会对图片压缩后再进行审核。开启后，将对压缩能力按照基础图片处理
	// [https://www.volcengine.com/docs/508/65935#%E5%9F%BA%E7%A1%80%E5%9B%BE%E5%83%8F%E5%A4%84%E7%90%86%E6%9C%8D%E5%8A%A1]进行计费。（您每月可使用
	// 20TB 的免费额度） 取值如下所示：
	// * true：开启
	// * false：（默认）不开启
	// :::tip
	// * 若未开启大图审核且图片大小 ≥ 5 MB，可能会导致系统超时报错；
	// * 若已开启大图审核但图片大小 ≥ 32 MB，可能会导致系统超时报错。 :::
	EnableLargeImageDetect bool `json:"EnableLargeImageDetect,omitempty"`

	// 若开启冻结，则不可为空
	FreezeDimensions []string `json:"FreezeDimensions,omitempty"`

	// 若开启冻结，则不可为空
	FreezeStrategy int `json:"FreezeStrategy,omitempty"`

	// 若开启冻结，则不可为空
	FreezeType []string `json:"FreezeType,omitempty"`

	// 仅当 Type 为 Url 时，配置生效。
	// 批量提交图片 URL 列表
	ImageInfos []*CreateImageAuditTaskBodyImageInfosItem `json:"ImageInfos,omitempty"`

	// 仅当 EnableAuditRange 取值 1 时，配置生效。 指定前缀不审核，若你希望对某个目录不进行审核，请设置路径为对应的目录名，以/结尾。例如123/test/
	NoAuditPrefix []string `json:"NoAuditPrefix,omitempty"`

	// 仅当 Type 为 UrlFile 时，配置生效。
	// 审核文件的 StoreUri，为 .txt 文件，该文件需上传至指定服务对应存储中。该 txt 文件内需填写待审核图片文件的 URL，每行填写一个，最多可填写 10000 行。
	ResURI []string `json:"ResUri,omitempty"`
}

type CreateImageAuditTaskBodyImageInfosItem struct {

	// 建议您根据实际业务情况，将该参数作为可区分审核图片 ImageUri 的自定义标识。
	DataID string `json:"DataId,omitempty"`

	// 待审核图片 URL，需满足公网可访问。
	ImageURI string `json:"ImageUri,omitempty"`
}

type CreateImageAuditTaskQuery struct{}

type CreateImageAuditTaskReq struct {
	*CreateImageAuditTaskQuery
	*CreateImageAuditTaskBody
}

type CreateImageAuditTaskRes struct {

	// REQUIRED
	ResponseMetadata *CreateImageAuditTaskResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *CreateImageAuditTaskResResult `json:"Result"`
}

type CreateImageAuditTaskResResponseMetadata struct {

	// REQUIRED
	Action string `json:"Action"`

	// REQUIRED
	Region string `json:"Region"`

	// REQUIRED
	RequestID string `json:"RequestId"`

	// REQUIRED
	Service string `json:"Service"`

	// REQUIRED
	Version string `json:"Version"`
}

type CreateImageAuditTaskResResult struct {

	// REQUIRED; 任务 ID
	TaskID string `json:"TaskId"`
}

type CreateImageCompressTask struct{}

type CreateImageCompressTaskBody struct {

	// REQUIRED; 文件的处理方式，取值如下所示：
	// * 0：使用 ZIP DEFLATE 压缩方法，将文件进行压缩并打包为 ZIP 包。该方式适用于需要长期存储大量未经压缩的文件的场景，以节省存储空间。但需注意的是，若文件本身已经过压缩处理，将会因为文件的可压缩空间有限，导致该方式的压缩效果不明显。
	// * 1：仅将文件打包为 ZIP 包，但不执行压缩操作。该方式适用于快速整理文件而无需节省存储空间的场景。例如已经过压缩的文件的打包存储，以便于传输或归档。
	ZipMode int `json:"ZipMode"`

	// POST 类型的回调 URL，用于接收相关回调 JSON 类型数据。回调参数请参考回调内容。
	Callback string `json:"Callback,omitempty"`

	// 与IndexFile为二选一，必填。
	// 压缩文件列表配置，最多可支持 3000 个文件，压缩前文件的总大小不得超过 45000 MB。若超出限制，则取消压缩打包操作，致使打包任务失败。
	FileList []*CreateImageCompressTaskBodyFileListItem `json:"FileList,omitempty"`

	// 与FileList为二选一，必填。
	// 索引文件的 StoreUri，为 .txt 文件，该索引文件需上传至指定服务对应存储中。
	// 该索引文件内需填写待压缩文件的地址，每行填写一个，最多可填写 3000 行。压缩前文件的总大小不超过 45000 MB。若超出限制，则取消压缩打包操作，致使打包任务失败。
	IndexFile string `json:"IndexFile,omitempty"`

	// 压缩后文件压缩包的指定名称，默认为随机 Key。
	Output string `json:"Output,omitempty"`
}

type CreateImageCompressTaskBodyFileListItem struct {

	// REQUIRED; 公网可访问的待压缩文件 URL
	URL string `json:"Url"`

	// * 指定时，为 URL 文件所在压缩包中的别名。输入规则如下所示： * 支持汉字、字母、数字及符号-、_和.；
	// * 不能以-、_和.开头；
	// * 长度不得超过 100 个字符。
	//
	//
	// * 不指定时，若能提取原文件名称时，则以 URL 原文件名称；否则，使用随机名称。
	Alias string `json:"Alias,omitempty"`

	// 指定源文件在压缩包中的文件夹，不传时则将该资源存储至一级目录下。输入规则如下所示：
	// * 支持汉字、字母、数字及符号-、_和.；
	// * 不能以-、_和.开头；
	// * 不能以/结尾。
	// :::warning
	// * 建议命名长度不超过 256 个字节。
	// * 建议您在命名中仅使用-、_和.这三种符号。如果您使用了其他符号，可能因操作系统不支持导致处理异常。 :::
	Folder string `json:"Folder,omitempty"`
}

type CreateImageCompressTaskQuery struct {

	// REQUIRED; 压缩文件存储的目标服务 ID。
	// * 您可以在 veImageX 控制台服务管理 [https://console.volcengine.com/imagex/service_manage/]页面，在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息 [https://www.volcengine.com/docs/508/9360]。
	ServiceID string `json:"ServiceId" query:"ServiceId"`
}

type CreateImageCompressTaskReq struct {
	*CreateImageCompressTaskQuery
	*CreateImageCompressTaskBody
}

type CreateImageCompressTaskRes struct {

	// REQUIRED
	ResponseMetadata *CreateImageCompressTaskResResponseMetadata `json:"ResponseMetadata"`

	// 视请求的接口而定
	Result *CreateImageCompressTaskResResult `json:"Result,omitempty"`
}

type CreateImageCompressTaskResResponseMetadata struct {

	// REQUIRED; 请求的接口名，属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region，例如：cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务，属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号，属于请求的公共参数。
	Version string `json:"Version"`
}

type CreateImageCompressTaskResResult struct {

	// REQUIRED; 压缩任务 ID
	TaskID string `json:"TaskId"`
}

type CreateImageContentTask struct{}

type CreateImageContentTaskBody struct {

	// REQUIRED; 操作类型。取值如下所示：
	// * refresh_url：刷新 URL
	// * refresh_dir：目录刷新（支持根目录刷新）
	// * preload_url：预热 URL
	// * block_url：禁用 URL
	// * unblock_url：解禁 URL
	TaskType string `json:"TaskType"`

	// REQUIRED; 资源 URL 或者目录。
	// * 当TaskType取值refresh_url，一次可提交的最大限额为 2000 个；
	// * 当TaskType取值refresh_dir，一次可提交的最大限额为 50 个；
	// * 当TaskType取值preload_url，一次可提交的最大限额为 2000 个；
	// * 当TaskType取值block_url，一次可提交的最大限额为 2000 个；
	// * 当TaskType取值unblock_url，一次可提交的最大限额为 2000 个。
	Urls []string `json:"Urls"`

	// 仅当 TaskType 为 refresh_dir 使用目录刷新时，可通过此配置开启前缀刷新。取值如下所示： true：开启前缀刷新 false：（默认）关闭前缀刷新，进行标准的目录匹配刷新。
	PrefixRefreshDir bool `json:"PrefixRefreshDir,omitempty"`
}

type CreateImageContentTaskQuery struct{}

type CreateImageContentTaskReq struct {
	*CreateImageContentTaskQuery
	*CreateImageContentTaskBody
}

type CreateImageContentTaskRes struct {

	// REQUIRED
	ResponseMetadata *CreateImageContentTaskResResponseMetadata `json:"ResponseMetadata"`

	// 视请求的接口而定
	Result *CreateImageContentTaskResResult `json:"Result,omitempty"`
}

type CreateImageContentTaskResResponseMetadata struct {

	// REQUIRED; 请求的接口名，属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region，例如：cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务，属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号，属于请求的公共参数。
	Version string `json:"Version"`
}

type CreateImageContentTaskResResult struct {

	// REQUIRED; 完成结果提示信息
	Msg string `json:"Msg"`

	// REQUIRED; 对应的任务 ID
	TaskID string `json:"TaskId"`
}

type CreateImageFromURI struct{}

type CreateImageFromURIBody struct {

	// REQUIRED; 待复制资源对应的存储 URI。您可在控制台的资源管理页面，获取上传文件的存储 URI [https://www.volcengine.com/docs/508/1205054]；或者调用 GetImageStorageFiles
	// [https://www.volcengine.com/docs/508/1158308] 获取指定服务下的存储 URI。
	StoreURI string `json:"StoreUri"`

	// 复制后资源的存储 Key。缺省情况下与源存储的资源存储 Key 相同。自定义规则如下所示：
	// * 不支持空格。
	// * 不支持以/开头或结尾，不支持/连续出现，Key 值最大长度限制为 180 个字节。
	DstKey string `json:"DstKey,omitempty"`

	// 待复制资源对应的服务 ID
	OriServiceID string `json:"OriServiceId,omitempty"`

	// 是否保留目标存储中的同名文件。False：不保留目标存储中的同名文件直接覆盖。True：保留目标存储中的同名文件，不覆盖。
	SkipDuplicate bool `json:"SkipDuplicate,omitempty"`
}

type CreateImageFromURIQuery struct {

	// REQUIRED; 复制目标对应的服务 ID。
	// * 您可以在 veImageX 控制台服务管理 [https://console.volcengine.com/imagex/service_manage/]页面，在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息 [https://www.volcengine.com/docs/508/9360]。
	ServiceID string `json:"ServiceId" query:"ServiceId"`
}

type CreateImageFromURIReq struct {
	*CreateImageFromURIQuery
	*CreateImageFromURIBody
}

type CreateImageFromURIRes struct {

	// REQUIRED
	ResponseMetadata *CreateImageFromURIResResponseMetadata `json:"ResponseMetadata"`

	// 视请求的接口而定
	Result *CreateImageFromURIResResult `json:"Result,omitempty"`
}

type CreateImageFromURIResResponseMetadata struct {

	// REQUIRED; 请求的接口名，属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region，例如：cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务，属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号，属于请求的公共参数。
	Version string `json:"Version"`
}