com.alibaba.dashscope.aigc.imagegeneration

类 ImageGeneration

java.lang.Object

com.alibaba.dashscope.aigc.imagegeneration.ImageGeneration

public final class ImageGeneration
extends Object

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	ImageGeneration.Models

构造器概要

构造器

构造器和说明
ImageGeneration()
ImageGeneration(String protocol)
ImageGeneration(String protocol, String baseUrl)
ImageGeneration(String protocol, String baseUrl, ConnectionOptions connectionOptions)

方法概要

限定符和类型	方法和说明
ImageGenerationResult	asyncCall(ImageGenerationParam param) Call the server to get the whole result.
ImageGenerationResult	call(ImageGenerationParam param) Call the server to get the whole result.
void	call(ImageGenerationParam param, ResultCallback<ImageGenerationResult> callback) Call the server to get the result in the callback function.
ImageGenerationResult	cancel(ImageGenerationResult taskInfo, String apiKey)
ImageGenerationResult	cancel(String taskId, String apiKey)
ImageGenerationResult	fetch(ImageGenerationResult taskInfo, String apiKey)
ImageGenerationResult	fetch(String taskId, String apiKey)
ImageGenerationListResult	list(AsyncTaskListParam param)
ImageGenerationListResult	list(String startTime, String endTime, String modelName, String apiKeyId, String region, String status, Integer pageNo, Integer pageSize)
io.reactivex.Flowable<ImageGenerationResult>	streamCall(ImageGenerationParam param) Call the server to get the result by stream.
void	streamCall(ImageGenerationParam param, ResultCallback<ImageGenerationResult> callback) Call the server to get the result by stream.
ImageGenerationResult	wait(ImageGenerationResult taskInfo, String apiKey)
ImageGenerationResult	wait(String taskId, String apiKey)

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

ImageGeneration

public ImageGeneration()

ImageGeneration

public ImageGeneration(String protocol)

ImageGeneration

public ImageGeneration(String protocol,
                       String baseUrl)

ImageGeneration

public ImageGeneration(String protocol,
                       String baseUrl,
                       ConnectionOptions connectionOptions)

方法详细资料

call

public ImageGenerationResult call(ImageGenerationParam param)
                           throws ApiException,
                                  NoApiKeyException,
                                  UploadFileException

Call the server to get the whole result.

参数:

param - The input param of class `ImageGenerationParam`.

返回:

The output structure of `ImageGenerationResult`.

抛出:

NoApiKeyException - Can not find api key

UploadFileException - Fail upload failed.

ApiException

call

public void call(ImageGenerationParam param,
                 ResultCallback<ImageGenerationResult> callback)
          throws ApiException,
                 NoApiKeyException,
                 UploadFileException

Call the server to get the result in the callback function.

参数:

param - The input param of class `ImageGenerationParam`.

callback - The callback to receive response, the template class is `ImageGenerationResult`.

抛出:

NoApiKeyException - Can not find api key

ApiException - The request failed, possibly due to a network or data error.

UploadFileException - File upload failed.

asyncCall

public ImageGenerationResult asyncCall(ImageGenerationParam param)
                                throws ApiException,
                                       NoApiKeyException,
                                       UploadFileException

Call the server to get the whole result.

参数:

param - The input param of class `ImageGenerationParam`.

返回:

The output structure of `ImageGenerationResult`.

抛出:

NoApiKeyException - Can not find api key

UploadFileException - Fail upload failed.

ApiException

list

public ImageGenerationListResult list(AsyncTaskListParam param)
                               throws ApiException,
                                      NoApiKeyException

抛出:

ApiException

NoApiKeyException

list

public ImageGenerationListResult list(String startTime,
                                      String endTime,
                                      String modelName,
                                      String apiKeyId,
                                      String region,
                                      String status,
                                      Integer pageNo,
                                      Integer pageSize)
                               throws ApiException,
                                      NoApiKeyException

抛出:

ApiException

NoApiKeyException

fetch

public ImageGenerationResult fetch(String taskId,
                                   String apiKey)
                            throws ApiException,
                                   NoApiKeyException

抛出:

ApiException

NoApiKeyException

fetch

public ImageGenerationResult fetch(ImageGenerationResult taskInfo,
                                   String apiKey)
                            throws ApiException,
                                   NoApiKeyException

抛出:

ApiException

NoApiKeyException

cancel

public ImageGenerationResult cancel(String taskId,
                                    String apiKey)
                             throws ApiException,
                                    NoApiKeyException

抛出:

ApiException

NoApiKeyException

cancel

public ImageGenerationResult cancel(ImageGenerationResult taskInfo,
                                    String apiKey)
                             throws ApiException,
                                    NoApiKeyException

抛出:

ApiException

NoApiKeyException

wait

public ImageGenerationResult wait(String taskId,
                                  String apiKey)
                           throws ApiException,
                                  NoApiKeyException

抛出:

ApiException

NoApiKeyException

wait

public ImageGenerationResult wait(ImageGenerationResult taskInfo,
                                  String apiKey)
                           throws ApiException,
                                  NoApiKeyException

抛出:

ApiException

NoApiKeyException

streamCall

public io.reactivex.Flowable<ImageGenerationResult> streamCall(ImageGenerationParam param)
                                                        throws ApiException,
                                                               NoApiKeyException,
                                                               UploadFileException

Call the server to get the result by stream.

参数:

param - The input param of class `ImageGenerationParam`.

返回:

A `Flowable` of the output structure.

抛出:

NoApiKeyException - Can not find api key

ApiException - The request failed, possibly due to a network or data error.

UploadFileException - File upload failed.

streamCall

public void streamCall(ImageGenerationParam param,
                       ResultCallback<ImageGenerationResult> callback)
                throws ApiException,
                       NoApiKeyException,
                       InputRequiredException,
                       UploadFileException

Call the server to get the result by stream.

参数:

param - The input param of class `ImageGenerationParam`.

callback - The result callback.

抛出:

NoApiKeyException - Can not find api key

ApiException - The request failed, possibly due to a network or data error.

InputRequiredException - The input field is missing.

UploadFileException - File upload failed.