com.alibaba.dashscope.api

类 AsynchronousApi<ParamT extends HalfDuplexParamBase>

java.lang.Object

com.alibaba.dashscope.api.AsynchronousApi<ParamT>

public final class AsynchronousApi<ParamT extends HalfDuplexParamBase>
extends Object

Support DashScope async task CRUD.

构造器概要

构造器

构造器和说明
AsynchronousApi() Create default http client.
AsynchronousApi(ConnectionOptions connectionOptions) Create custom http client

方法概要

限定符和类型	方法和说明
DashScopeResult	asyncCall(ParamT param, ServiceOption serviceOption) Call async interface and return async task info.
DashScopeResult	call(ParamT param, ServiceOption serviceOption) Call the server to get the whole result.
DashScopeResult	cancel(DashScopeResult taskInfo, String apiKey, String baseUrl)
DashScopeResult	cancel(String taskId, String apiKey, String baseUrl)
DashScopeResult	fetch(DashScopeResult taskInfo, String apiKey, String baseUrl)
DashScopeResult	fetch(String taskId, String apiKey, String baseUrl) Get the async task information, if the is completed will return the result, otherwise return task status.
DashScopeResult	fetch(String taskId, String apiKey, String baseUrl, Map<String,String> customHeaders) Get the async task information, if the is completed will return the result, otherwise return task status.
String	getTaskId(DashScopeResult task)
DashScopeResult	list(AsyncTaskListParam param, String baseUrl)
DashScopeResult	list(String startTime, String endTime, String modelName, String apiKeyId, String region, String status, Integer pageNo, Integer pageSize, String baseUrl)
DashScopeResult	wait(DashScopeResult taskInfo, String apiKey, String baseUrl)
DashScopeResult	wait(String taskId, String apiKey, String baseUrl) Wait for async task completed and return task result.
DashScopeResult	wait(String taskId, String apiKey, String baseUrl, Map<String,String> customHeaders) Wait for async task completed and return task result.

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

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

构造器详细资料

AsynchronousApi

public AsynchronousApi()

Create default http client.

AsynchronousApi

public AsynchronousApi(ConnectionOptions connectionOptions)

Create custom http client

参数:

connectionOptions - The client option.

方法详细资料

call

public DashScopeResult call(ParamT param,
                            ServiceOption serviceOption)
                     throws ApiException,
                            NoApiKeyException

Call the server to get the whole result.

参数:

param - The input param, should be the subclass of `Param`.

serviceOption - The service option.

返回:

The output structure, should be the subclass of `Result`.

抛出:

NoApiKeyException - Can not find api key

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

asyncCall

public DashScopeResult asyncCall(ParamT param,
                                 ServiceOption serviceOption)
                          throws ApiException,
                                 NoApiKeyException

Call async interface and return async task info.

参数:

param - The input param, should be the subclass of `Param`

serviceOption - The service option.

返回:

The output task information, should be the subclass of `Result`

抛出:

NoApiKeyException - Can not find api key

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

wait

public DashScopeResult wait(String taskId,
                            String apiKey,
                            String baseUrl,
                            Map<String,String> customHeaders)
                     throws ApiException,
                            NoApiKeyException

Wait for async task completed and return task result.

参数:

taskId - The async task id.

apiKey - The api-key.

baseUrl - The base http url.

customHeaders - The custom headers.

返回:

The task result.

抛出:

NoApiKeyException - Can not find api key

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

wait

public DashScopeResult wait(String taskId,
                            String apiKey,
                            String baseUrl)
                     throws ApiException,
                            NoApiKeyException

Wait for async task completed and return task result.

参数:

taskId - The async task id.

apiKey - The api-key.

返回:

The task result.

抛出:

NoApiKeyException - Can not find api key

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

wait

public DashScopeResult wait(DashScopeResult taskInfo,
                            String apiKey,
                            String baseUrl)
                     throws ApiException,
                            NoApiKeyException

抛出:

ApiException

NoApiKeyException

fetch

public DashScopeResult fetch(String taskId,
                             String apiKey,
                             String baseUrl,
                             Map<String,String> customHeaders)
                      throws ApiException,
                             NoApiKeyException

Get the async task information, if the is completed will return the result, otherwise return task status.

参数:

taskId - The async task id.

apiKey - The api key.

baseUrl - The base http url.

customHeaders - The custom headers.

返回:

The task result or status information.

抛出:

NoApiKeyException - Can not find api key

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

fetch

public DashScopeResult fetch(String taskId,
                             String apiKey,
                             String baseUrl)
                      throws ApiException,
                             NoApiKeyException

Get the async task information, if the is completed will return the result, otherwise return task status.

参数:

taskId - The async task id.

apiKey - The api key.

返回:

The task result or status information.

抛出:

NoApiKeyException - Can not find api key

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

fetch

public DashScopeResult fetch(DashScopeResult taskInfo,
                             String apiKey,
                             String baseUrl)
                      throws ApiException,
                             NoApiKeyException

抛出:

ApiException

NoApiKeyException

cancel

public DashScopeResult cancel(String taskId,
                              String apiKey,
                              String baseUrl)
                       throws ApiException,
                              NoApiKeyException

抛出:

ApiException

NoApiKeyException

cancel

public DashScopeResult cancel(DashScopeResult taskInfo,
                              String apiKey,
                              String baseUrl)
                       throws ApiException,
                              NoApiKeyException

抛出:

ApiException

NoApiKeyException

list

public DashScopeResult list(AsyncTaskListParam param,
                            String baseUrl)
                     throws ApiException,
                            NoApiKeyException

抛出:

ApiException

NoApiKeyException

list

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

抛出:

ApiException

NoApiKeyException

getTaskId

public String getTaskId(DashScopeResult task)