com.volcengine.service.imagex

Interface IImageXService

All Superinterfaces:

IBaseService

All Known Implementing Classes:

ImageXServiceImpl

public interface IImageXService
extends IBaseService

The interface ImageX service.

Method Summary

Modifier and Type	Method and Description
ApplyImageUploadResponse	applyImageUpload(ApplyImageUploadRequest applyUploadRequest) Apply upload image.
CommitImageUploadResponse	commitImageUpload(CommitImageUploadRequest commitUploadRequest) Commit upload image.
DeleteImageResp	deleteImages(DeleteImageReq req) Delete images.
EmbedImageHmResponse	embedImageHm(EmbedImageHmRequest req) Request ImageX api with method POST.
ExtractImageHmResponse	extractImageHm(ExtractImageHmRequest req) Request ImageX api with method POST.
FetchImageUrlResponse	fetchImageUrl(FetchImageUrlRequest request) Fetch Image
GetDeduplicateTaskStatusResponse	getDeduplicateTaskStatus(GetDeduplicateTaskStatusRequest req) Retrieve duplicate detection task status
GetDenoisingImageResponse	getDenoisingImage(GetDenoisingImageRequest req) Noise reduction
GetImageBgFillResultResponse	getImageBgFillResult(GetImageBgFillResultRequest req) Extend image
GetImageComicResultResponse	getImageComicResult(GetImageComicResultRequest req) Comicize an image
GetImageDuplicateDetectionAsyncResponse	getImageDuplicateDetectionAsync(GetImageDuplicateDetectionAsyncRequest req) Detect duplicate image
GetImageDuplicateDetectionSyncResponse	getImageDuplicateDetectionSync(GetImageDuplicateDetectionSyncRequest req) Detect duplicate image
GetImageEnhanceResultResponse	getImageEnhanceResult(GetImageEnhanceResultRequest req) Enhance image
GetImageEraseModelsResponse	getImageEraseModels(GetImageEraseModelsRequest req) Request ImageX api with method GET.
GetImageEraseResultResponse	getImageEraseResult(GetImageEraseResultRequest req) Request ImageX api with method POST.
GetImageOCRResponse<?>	getImageOCR(GetImageOCRRequest param) Request ImageX api with method POST.
GetImagePSDetectionResponse	getImagePSDetection(GetImagePSDetectionRequest req) Image modified detection
GetImageQualityResponse	getImageQuality(GetImageQualityRequest req) Get image quality
GetImageSegmentResponse	getImageSegment(GetImageSegmentRequest req) Request ImageX api with method POST.
GetImageSmartCropResultResponse	getImageSmartCropResult(GetImageSmartCropResultRequest req) Smart crop
GetImageStyleResultResponse	getImageStyleResult(GetImageStyleResultRequest req) Image style
GetImageSuperResolutionResultResponse	getImageSuperResolutionResult(GetImageSuperResolutionResultRequest req) Super resolution
GetImageUploadFileResponse	getImageUploadFile(GetImageUploadFileRequest req) Resource a file
GetImageUploadFilesResponse	getImageUploadFiles(GetImageUploadFilesRequest req) List files
CommonResponse	getImageX(String action, Map<String,String> param) Request ImageX api with method GET.
GetLicensePlateDetectionResponse	getLicensePlateDetection(GetLicensePlateDetectionRequest req) License plate detection
GetPrivateImageTypeResponse	getPrivateImageType(GetPrivateImageTypeRequest req) Private content detection
SecurityToken2	getUploadSts2(List<String> serviceIds) Get image upload sts2 auth with default expire time (1 hour).
SecurityToken2	getUploadSts2WithExpire(List<String> serviceIds, long expire) Get image upload sts2 auth.
SecurityToken2	getUploadSts2WithKeyPtn(List<String> serviceIds, long expire, String keyPtn) Get image upload sts2 auth.
String	getUploadToken(Map<String,String> params) Get image upload token.
CommonResponse	postImageX(String action, Map<String,String> param, Object req) Request ImageX api with method POST.
UpdateImageFilesResponse	updateImageUrls(UpdateImageFilesRequest req) Update image urls.
CommitImageUploadResponse	uploadImages(ApplyImageUploadRequest request, List<byte[]> imageDatas) Upload image data.
CommitImageUploadResponse	uploadImages(ApplyImageUploadRequest request, List<InputStream> content, List<Long> size) Upload image data.

Methods inherited from interface com.volcengine.service.IBaseService

destroy, getAccessKey, getRegion, getSecretKey, getSessionToken, getSignUrl, json, post, proto, put, putData, query, setAccessKey, setClientNoReuse, setConnectionTimeout, setHost, setHttpClient, setRegion, setScheme, setSecretKey, setServiceInfo, setSessionToken, setSocketTimeout, signSts2

Method Detail

applyImageUpload

ApplyImageUploadResponse applyImageUpload(ApplyImageUploadRequest applyUploadRequest)
                                   throws Exception

Apply upload image.

Parameters:

applyUploadRequest - the apply upload request

Returns:

the apply upload response

Throws:

Exception - the exception

commitImageUpload

CommitImageUploadResponse commitImageUpload(CommitImageUploadRequest commitUploadRequest)
                                     throws Exception

Commit upload image.

Parameters:

commitUploadRequest - the commit upload request

Returns:

the commit upload response

Throws:

Exception - the exception

uploadImages

CommitImageUploadResponse uploadImages(ApplyImageUploadRequest request,
                                       List<byte[]> imageDatas)
                                throws Exception

Upload image data.

Parameters:

request - the apply upload request

imageDatas - image data array

Returns:

the commit upload response

Throws:

Exception - the exception

uploadImages

CommitImageUploadResponse uploadImages(ApplyImageUploadRequest request,
                                       List<InputStream> content,
                                       List<Long> size)
                                throws Exception

Upload image data.

Parameters:

request - upload request

content - image data

size - image size

Returns:

the commit upload response

Throws:

Exception - the exception

fetchImageUrl

FetchImageUrlResponse fetchImageUrl(FetchImageUrlRequest request)
                             throws Exception

Fetch Image

Parameters:

request - url to fetch

Returns:

result

Throws:

Exception - the exception

getUploadToken

String getUploadToken(Map<String,String> params)
               throws Exception

Get image upload token.

Parameters:

params - the params

Returns:

the upload token

Throws:

Exception - the exception

getUploadSts2

SecurityToken2 getUploadSts2(List<String> serviceIds)
                      throws Exception

Get image upload sts2 auth with default expire time (1 hour).

Parameters:

serviceIds - service id list allowed to upload image to

Returns:

the upload sts2 auth

Throws:

Exception - the exception

getUploadSts2WithExpire

SecurityToken2 getUploadSts2WithExpire(List<String> serviceIds,
                                       long expire)
                                throws Exception

Get image upload sts2 auth.

Parameters:

serviceIds - service id list allowed to upload image to

expire - expire time in milliseconds

Returns:

the upload sts2 auth

Throws:

Exception - the exception

getUploadSts2WithKeyPtn

SecurityToken2 getUploadSts2WithKeyPtn(List<String> serviceIds,
                                       long expire,
                                       String keyPtn)
                                throws Exception

Get image upload sts2 auth.

Parameters:

serviceIds - service id list allowed to upload image to

expire - expire time in milliseconds

keyPtn - upload store key pattern, * for no restriction. default to empty.

Returns:

the upload sts2 auth

Throws:

Exception - the exception

deleteImages

DeleteImageResp deleteImages(DeleteImageReq req)
                      throws Exception

Delete images.

Parameters:

req - delete image req

Returns:

delete image resp

Throws:

Exception - the exception

getImageUploadFile

GetImageUploadFileResponse getImageUploadFile(GetImageUploadFileRequest req)
                                       throws Exception

Resource a file

Parameters:

req - args

Returns:

file info

Throws:

Exception - the exception

getImageUploadFiles

GetImageUploadFilesResponse getImageUploadFiles(GetImageUploadFilesRequest req)
                                         throws Exception

List files

Parameters:

req - args

Returns:

files info

Throws:

Exception - the exception

updateImageUrls

UpdateImageFilesResponse updateImageUrls(UpdateImageFilesRequest req)
                                  throws Exception

Update image urls.

Parameters:

req - update image urls req

Returns:

udpate image urls resp

Throws:

Exception - the exception

getImageX

CommonResponse getImageX(String action,
                         Map<String,String> param)
                  throws Exception

Request ImageX api with method GET.

Parameters:

action - api action name

param - api query param

Returns:

api response

Throws:

Exception - the exception

postImageX

CommonResponse postImageX(String action,
                          Map<String,String> param,
                          Object req)
                   throws Exception

Request ImageX api with method POST.

Parameters:

action - api action name

param - api query param

req - api json param

Returns:

api response

Throws:

Exception - the exception

getImageOCR

GetImageOCRResponse<?> getImageOCR(GetImageOCRRequest param)
                            throws Exception

Request ImageX api with method POST.

Parameters:

param - api query param

Returns:

api response

Throws:

Exception - the exception

embedImageHm

EmbedImageHmResponse embedImageHm(EmbedImageHmRequest req)
                           throws Exception

Request ImageX api with method POST.

Parameters:

req - embed image hm request

Returns:

image store uri

Throws:

Exception - the exception

extractImageHm

ExtractImageHmResponse extractImageHm(ExtractImageHmRequest req)
                               throws Exception

Request ImageX api with method POST.

Parameters:

req - extract hidden mark from image

Returns:

embedded info

Throws:

Exception - the exception

getImageSegment

GetImageSegmentResponse getImageSegment(GetImageSegmentRequest req)
                                 throws Exception

Request ImageX api with method POST.

Parameters:

req - get image segment request

Returns:

image store uri

Throws:

Exception - the exception

getImageEraseModels

GetImageEraseModelsResponse getImageEraseModels(GetImageEraseModelsRequest req)
                                         throws Exception

Request ImageX api with method GET.

Parameters:

req - get image erase models request

Returns:

models array

Throws:

Exception - the exception

getImageEraseResult

GetImageEraseResultResponse getImageEraseResult(GetImageEraseResultRequest req)
                                         throws Exception

Request ImageX api with method POST.

Parameters:

req - get image erase result

Returns:

image store uri

Throws:

Exception - the exception

getImageQuality

GetImageQualityResponse getImageQuality(GetImageQualityRequest req)
                                 throws Exception

Get image quality

Parameters:

req - request args

Returns:

image quality metrics

Throws:

Exception - the exception

getImageBgFillResult

GetImageBgFillResultResponse getImageBgFillResult(GetImageBgFillResultRequest req)
                                           throws Exception

Extend image

Parameters:

req - request args

Returns:

extended image

Throws:

Exception - the exception

getImageDuplicateDetectionSync

GetImageDuplicateDetectionSyncResponse getImageDuplicateDetectionSync(GetImageDuplicateDetectionSyncRequest req)
                                                               throws Exception

Detect duplicate image

Parameters:

req - request args

Returns:

detection result

Throws:

Exception - the exception

getImageDuplicateDetectionAsync

GetImageDuplicateDetectionAsyncResponse getImageDuplicateDetectionAsync(GetImageDuplicateDetectionAsyncRequest req)
                                                                 throws Exception

Detect duplicate image

Parameters:

req - request args

Returns:

detection task id

Throws:

Exception - the exception

getDeduplicateTaskStatus

GetDeduplicateTaskStatusResponse getDeduplicateTaskStatus(GetDeduplicateTaskStatusRequest req)
                                                   throws Exception

Retrieve duplicate detection task status

Parameters:

req - request args

Returns:

detection status and result

Throws:

Exception - the exception

getDenoisingImage

GetDenoisingImageResponse getDenoisingImage(GetDenoisingImageRequest req)
                                     throws Exception

Noise reduction

Parameters:

req - request args

Returns:

result

Throws:

Exception - the exception

getImageComicResult

GetImageComicResultResponse getImageComicResult(GetImageComicResultRequest req)
                                         throws Exception

Comicize an image

Parameters:

req - request args

Returns:

result

Throws:

Exception - the exception

getImageSuperResolutionResult

GetImageSuperResolutionResultResponse getImageSuperResolutionResult(GetImageSuperResolutionResultRequest req)
                                                             throws Exception

Super resolution

Parameters:

req - request args

Returns:

result

Throws:

Exception - the exception

getImageSmartCropResult

GetImageSmartCropResultResponse getImageSmartCropResult(GetImageSmartCropResultRequest req)
                                                 throws Exception

Smart crop

Parameters:

req - request args

Returns:

result

Throws:

Exception - the exception

getLicensePlateDetection

GetLicensePlateDetectionResponse getLicensePlateDetection(GetLicensePlateDetectionRequest req)
                                                   throws Exception

License plate detection

Parameters:

req - request args

Returns:

result

Throws:

Exception - the exception

getImagePSDetection

GetImagePSDetectionResponse getImagePSDetection(GetImagePSDetectionRequest req)
                                         throws Exception

Image modified detection

Parameters:

req - request args

Returns:

result

Throws:

Exception - the exception

getPrivateImageType

GetPrivateImageTypeResponse getPrivateImageType(GetPrivateImageTypeRequest req)
                                         throws Exception

Private content detection

Parameters:

req - request args

Returns:

result

Throws:

Exception - the exception

getImageEnhanceResult

GetImageEnhanceResultResponse getImageEnhanceResult(GetImageEnhanceResultRequest req)
                                             throws Exception

Enhance image

Parameters:

req - request args

Returns:

result

Throws:

Exception - the exception

getImageStyleResult

GetImageStyleResultResponse getImageStyleResult(GetImageStyleResultRequest req)
                                         throws Exception

Image style

Parameters:

req - request args

Returns:

result

Throws:

Exception - the exception