com.alibaba.dashscope.api

类 SynchronizeFullDuplexApi<ParamT extends FullDuplexServiceParam>

java.lang.Object

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

public final class SynchronizeFullDuplexApi<ParamT extends FullDuplexServiceParam>
extends Object

DashScope synchronize full duplex request processing, only websocket support.

构造器概要

构造器

构造器和说明
SynchronizeFullDuplexApi(ApiServiceOption serviceOptions) Create default http client.
SynchronizeFullDuplexApi(ConnectionOptions connectionOptions, ApiServiceOption serviceOptions) Create custom http client

方法概要

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

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

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

构造器详细资料

SynchronizeFullDuplexApi

public SynchronizeFullDuplexApi(ApiServiceOption serviceOptions)

Create default http client.

参数:

serviceOptions - The service option.

SynchronizeFullDuplexApi

public SynchronizeFullDuplexApi(ConnectionOptions connectionOptions,
                                ApiServiceOption serviceOptions)

Create custom http client

参数:

connectionOptions - The client option.

serviceOptions - The service option.

方法详细资料

close

public boolean close(int code,
                     String reason)

cancel

public void cancel()

streamIn

public DashScopeResult streamIn(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.

streamIn

public void streamIn(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.

duplexCall

public io.reactivex.Flowable<DashScopeResult> duplexCall(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.

duplexCall

public void duplexCall(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.