com.alibaba.dashscope.api

类 SynchronizeHalfDuplexApi<ParamT extends HalfDuplexParamBase>

java.lang.Object

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

public final class SynchronizeHalfDuplexApi<ParamT extends HalfDuplexParamBase>
extends Object

Dashscope synchronize half duplex request processing, both http and websocket support.

构造器概要

构造器

构造器和说明
SynchronizeHalfDuplexApi(ConnectionOptions connectionOptions, ServiceOption serviceOptions) Create custom client
SynchronizeHalfDuplexApi(ServiceOption serviceOptions) Create default client, http or websocket.

方法概要

限定符和类型	方法和说明
DashScopeResult	call(ParamT param) Call the server to get the whole result.
void	call(ParamT param, ResultCallback<DashScopeResult> callback) Call the server to get the result in the callback function.
boolean	close(int code, String reason)
io.reactivex.Flowable<DashScopeResult>	streamCall(ParamT param) Call the server to get the result by stream.
void	streamCall(ParamT param, ResultCallback<DashScopeResult> callback) Call the server to get the result by stream.

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

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

构造器详细资料

SynchronizeHalfDuplexApi

public SynchronizeHalfDuplexApi(ServiceOption serviceOptions)

Create default client, http or websocket.

参数:

serviceOptions - The service option.

SynchronizeHalfDuplexApi

public SynchronizeHalfDuplexApi(ConnectionOptions connectionOptions,
                                ServiceOption serviceOptions)

Create custom client

参数:

connectionOptions - The client option.

serviceOptions - The api service option.

方法详细资料

call

public DashScopeResult call(ParamT param)
                     throws ApiException,
                            NoApiKeyException

Call the server to get the whole result.

参数:

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

返回:

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

抛出:

NoApiKeyException - Can not find api key

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

call

public void call(ParamT param,
                 ResultCallback<DashScopeResult> callback)
          throws ApiException,
                 NoApiKeyException

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

参数:

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

callback - The callback to receive response, should be the subclass of `Result`.

抛出:

NoApiKeyException - Can not find api key

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

streamCall

public io.reactivex.Flowable<DashScopeResult> streamCall(ParamT param)
                                                  throws ApiException,
                                                         NoApiKeyException

Call the server to get the result by stream.

参数:

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

返回:

A `Flowable` of the output structure, which is the subclass of `Result`.

抛出:

NoApiKeyException - Can not find api key

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

streamCall

public void streamCall(ParamT param,
                       ResultCallback<DashScopeResult> callback)
                throws ApiException,
                       NoApiKeyException

Call the server to get the result by stream.

参数:

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

callback - The result callback.

抛出:

NoApiKeyException - Can not find api key

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

close

public boolean close(int code,
                     String reason)