com.alibaba.dashscope.threads.runs

类 Runs

java.lang.Object

com.alibaba.dashscope.threads.runs.Runs

public final class Runs
extends Object

构造器概要

构造器

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

方法概要

限定符和类型	方法和说明
Run	create(String threadId, RunParam param) Create a thread run.
io.reactivex.Flowable<AssistantStreamMessage>	createStream(String threadId, RunParam param) Create stream run, return Flowable of StreamMessage.
void	createStream(String threadId, RunParam param, AssistantEventHandler handler) Create stream run, with event handler.
io.reactivex.Flowable<AssistantStreamMessage>	createStreamThreadAndRun(ThreadAndRunParam param) Create stream output and run.
void	createStreamThreadAndRun(ThreadAndRunParam param, AssistantEventHandler handler) Create stream output and run.
Run	createThreadAndRun(ThreadAndRunParam param) Create thread and run.
ListResult<Run>	list(String threadId, GeneralListParam listParam) List the run of thread id.
ListResult<RunStep>	listSteps(String threadId, String runId, GeneralListParam listParam) List the run step of the run id.
Run	retrieve(String threadId, String runId) Retrieve the run.
Run	retrieve(String threadId, String runId, String apiKey) Retrieve the run.
Run	retrieve(String threadId, String runId, String apiKey, Map<String,String> headers)
RunStep	retrieveStep(String threadId, String runId, String stepId) Retrieve the run step.
RunStep	retrieveStep(String threadId, String runId, String stepId, String apiKey) Retrieve the run step.
RunStep	retrieveStep(String threadId, String runId, String stepId, String apiKey, Map<String,String> headers)
io.reactivex.Flowable<AssistantStreamMessage>	submitStreamToolOutputs(String threadId, String runId, SubmitToolOutputsParam param) Submit tool outputs, and return stream result.
void	submitStreamToolOutputs(String threadId, String runId, SubmitToolOutputsParam param, AssistantEventHandler handler) Submit tool outputs, and return stream result.
Run	submitToolOutputs(String threadId, String runId, SubmitToolOutputsParam param) Submit tool outputs.
Run	update(String threadId, String runId, UpdateMetadataParam param) Update the run.

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

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

构造器详细资料

Runs

public Runs()

Runs

public Runs(String baseUrl,
            ConnectionOptions connectionOptions)

方法详细资料

create

public Run create(String threadId,
                  RunParam param)
           throws ApiException,
                  NoApiKeyException,
                  InputRequiredException,
                  InvalidateParameter

Create a thread run.

参数:

threadId - The thread id.

param - The `RunParam`

返回:

The `Run` object.

抛出:

ApiException - The request exception, if network connection issue etc.

NoApiKeyException - Can not find a valid api key

InputRequiredException - The threadId must input.

InvalidateParameter - The input parameter is invalid.

createStream

public io.reactivex.Flowable<AssistantStreamMessage> createStream(String threadId,
                                                                  RunParam param)
                                                           throws ApiException,
                                                                  NoApiKeyException,
                                                                  InputRequiredException,
                                                                  InvalidateParameter

Create stream run, return Flowable of StreamMessage.

参数:

threadId - The run thread id

param - The run parameters.

返回:

The StreamMessage flowable.

抛出:

ApiException - The request failed.

NoApiKeyException - No api key found.

InputRequiredException - The threadId is null or empty.

InvalidateParameter - The stream in param is false.

createStream

public void createStream(String threadId,
                         RunParam param,
                         AssistantEventHandler handler)
                  throws ApiException,
                         NoApiKeyException,
                         InputRequiredException,
                         InvalidateParameter

Create stream run, with event handler.

参数:

threadId - The run thread id

param - The run parameters.

handler - The assistant event handler.

抛出:

ApiException - The request failed.

NoApiKeyException - No api key found.

InputRequiredException - The threadId is null or empty.

InvalidateParameter - The stream in param is false.

createThreadAndRun

public Run createThreadAndRun(ThreadAndRunParam param)
                       throws ApiException,
                              NoApiKeyException,
                              InvalidateParameter

Create thread and run.

参数:

param - The `ThreadAndRunParam` object.

返回:

The `Run` object.

抛出:

ApiException - The request exception, if network connection issue etc.

NoApiKeyException - Can not find a valid api key

InvalidateParameter - The input parameter is invalid.

createStreamThreadAndRun

public io.reactivex.Flowable<AssistantStreamMessage> createStreamThreadAndRun(ThreadAndRunParam param)
                                                                       throws ApiException,
                                                                              NoApiKeyException,
                                                                              InvalidateParameter

Create stream output and run.

参数:

param - The `ThreadAndRunParam` object with stream=true.

返回:

Flowable of AssistantStreamMessage you can iterator the result.

抛出:

ApiException - The request exception, if network connection issue etc.

NoApiKeyException - Can not find a valid api key

InvalidateParameter - The input parameter is invalid.

createStreamThreadAndRun

public void createStreamThreadAndRun(ThreadAndRunParam param,
                                     AssistantEventHandler handler)
                              throws ApiException,
                                     NoApiKeyException,
                                     InvalidateParameter

Create stream output and run.

参数:

param - The `ThreadAndRunParam` object with stream=true.

handler - The stream event handler callback.

抛出:

ApiException - The request exception, if network connection issue etc.

NoApiKeyException - Can not find a valid api key

InvalidateParameter - The input parameter is invalid.

update

public Run update(String threadId,
                  String runId,
                  UpdateMetadataParam param)
           throws ApiException,
                  NoApiKeyException,
                  InputRequiredException

Update the run.

参数:

threadId - The thread id.

runId - The run id.

param - The parameter.

返回:

The updated `Run` object.

抛出:

ApiException - The request exception, if network connection issue etc.

NoApiKeyException - Can not find a valid api key

InputRequiredException - The thread id and run id are required.

list

public ListResult<Run> list(String threadId,
                            GeneralListParam listParam)
                     throws ApiException,
                            NoApiKeyException

List the run of thread id.

参数:

threadId - the thread id.

listParam - The list parameter.

返回:

The list of `Run`.

抛出:

ApiException - The request exception, if network connection issue etc.

NoApiKeyException - Can not find a valid api key

listSteps

public ListResult<RunStep> listSteps(String threadId,
                                     String runId,
                                     GeneralListParam listParam)
                              throws ApiException,
                                     NoApiKeyException

List the run step of the run id.

参数:

threadId - The thread id

runId - The run id.

listParam - The list parameter.

返回:

The list of 'RunStep'

抛出:

ApiException - The request exception, if network connection issue etc.

NoApiKeyException - Can not find a valid api key

retrieve

public Run retrieve(String threadId,
                    String runId)
             throws ApiException,
                    NoApiKeyException

Retrieve the run.

参数:

threadId - The thread id.

runId - The run id.

返回:

The `Run` object.

抛出:

ApiException - The request exception, if network connection issue etc.

NoApiKeyException - Can not find a valid api key

retrieve

public Run retrieve(String threadId,
                    String runId,
                    String apiKey)
             throws ApiException,
                    NoApiKeyException

Retrieve the run.

参数:

threadId - The thread id.

runId - The run id.

apiKey - The request api key.

返回:

The `Run` object.

抛出:

ApiException - The request exception, if network connection issue etc.

NoApiKeyException - Can not find a valid api key

retrieve

public Run retrieve(String threadId,
                    String runId,
                    String apiKey,
                    Map<String,String> headers)
             throws ApiException,
                    NoApiKeyException

抛出:

ApiException

NoApiKeyException

retrieveStep

public RunStep retrieveStep(String threadId,
                            String runId,
                            String stepId)
                     throws ApiException,
                            NoApiKeyException

Retrieve the run step.

参数:

threadId - The thread id.

runId - The run id.

stepId - the run step id.

返回:

The `RunStep` object.

抛出:

ApiException - The request exception, if network connection issue etc.

NoApiKeyException - Can not find a valid api key

retrieveStep

public RunStep retrieveStep(String threadId,
                            String runId,
                            String stepId,
                            String apiKey)
                     throws ApiException,
                            NoApiKeyException

Retrieve the run step.

参数:

threadId - The thread id.

runId - The run id.

stepId - the run step id.

apiKey - The request api key.

返回:

The `RunStep` object.

抛出:

ApiException - The request exception, if network connection issue etc.

NoApiKeyException - Can not find a valid api key

retrieveStep

public RunStep retrieveStep(String threadId,
                            String runId,
                            String stepId,
                            String apiKey,
                            Map<String,String> headers)
                     throws ApiException,
                            NoApiKeyException

抛出:

ApiException

NoApiKeyException

submitToolOutputs

public Run submitToolOutputs(String threadId,
                             String runId,
                             SubmitToolOutputsParam param)
                      throws ApiException,
                             NoApiKeyException,
                             InputRequiredException

Submit tool outputs.

参数:

threadId - The thread id.

runId - The run id.

param - The output parameters.

返回:

The `Run` object.

抛出:

ApiException - The request exception, if network connection issue etc.

NoApiKeyException - Can not find a valid api key

InputRequiredException - The thread id and run id must input.

submitStreamToolOutputs

public io.reactivex.Flowable<AssistantStreamMessage> submitStreamToolOutputs(String threadId,
                                                                             String runId,
                                                                             SubmitToolOutputsParam param)
                                                                      throws ApiException,
                                                                             NoApiKeyException,
                                                                             InputRequiredException

Submit tool outputs, and return stream result.

参数:

threadId - The thread id.

runId - The run id.

param - The output parameters.

返回:

The stream assistant stream messages.

抛出:

ApiException - The request exception, if network connection issue etc.

NoApiKeyException - Can not find a valid api key

InputRequiredException - The thread id and run id must input.

submitStreamToolOutputs

public void submitStreamToolOutputs(String threadId,
                                    String runId,
                                    SubmitToolOutputsParam param,
                                    AssistantEventHandler handler)
                             throws ApiException,
                                    NoApiKeyException,
                                    InputRequiredException

Submit tool outputs, and return stream result.

参数:

threadId - The thread id.

runId - The run id.

param - The output parameters.

handler - The stream event handler callback.

抛出:

ApiException - The request exception, if network connection issue etc.

NoApiKeyException - Can not find a valid api key

InputRequiredException - The thread id and run id must input.