Package com.alibaba.cloud.ai.dashscope.api

Class DashScopeAiStreamFunctionCallingHelper

java.lang.Object

com.alibaba.cloud.ai.dashscope.api.DashScopeAiStreamFunctionCallingHelper

public class DashScopeAiStreamFunctionCallingHelper
extends Object

Helper class to support Streaming function calling. It can merge the streamed ChatCompletionChunk in case of function calling message.

Author:

Ken

Constructor Summary

Constructors

Constructor	Description
DashScopeAiStreamFunctionCallingHelper()
DashScopeAiStreamFunctionCallingHelper(Boolean incrementalOutput)

Method Summary

Modifier and Type	Method	Description
DashScopeApiSpec.ChatCompletion	chunkToChatCompletion(DashScopeApiSpec.ChatCompletionChunk chunk)	Convert the ChatCompletionChunk into a ChatCompletion.
boolean	isStreamingToolFunctionCall(DashScopeApiSpec.ChatCompletionChunk chatCompletion)
boolean	isStreamingToolFunctionCallFinish(DashScopeApiSpec.ChatCompletionChunk chatCompletion)
DashScopeApiSpec.ChatCompletionChunk	merge(DashScopeApiSpec.ChatCompletionChunk previous, DashScopeApiSpec.ChatCompletionChunk current)	Merge the previous and current ChatCompletionChunk into a single one.

Methods inherited from class java.lang.Object

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

Constructor Details

DashScopeAiStreamFunctionCallingHelper

public DashScopeAiStreamFunctionCallingHelper()

DashScopeAiStreamFunctionCallingHelper

public DashScopeAiStreamFunctionCallingHelper(Boolean incrementalOutput)

Method Details

merge

public DashScopeApiSpec.ChatCompletionChunk merge(DashScopeApiSpec.ChatCompletionChunk previous,
 DashScopeApiSpec.ChatCompletionChunk current)

Merge the previous and current ChatCompletionChunk into a single one.

Parameters:

previous - the previous ChatCompletionChunk

current - the current ChatCompletionChunk

Returns:

the merged ChatCompletionChunk

isStreamingToolFunctionCall

public boolean isStreamingToolFunctionCall(DashScopeApiSpec.ChatCompletionChunk chatCompletion)

Parameters:

chatCompletion - the ChatCompletionChunk to check

Returns:

true if the ChatCompletionChunk is a streaming tool function call.

isStreamingToolFunctionCallFinish

public boolean isStreamingToolFunctionCallFinish(DashScopeApiSpec.ChatCompletionChunk chatCompletion)

Parameters:

chatCompletion - the ChatCompletionChunk to check

Returns:

true if the ChatCompletionChunk is a streaming tool function call and it is the last one.

chunkToChatCompletion

public DashScopeApiSpec.ChatCompletion chunkToChatCompletion(DashScopeApiSpec.ChatCompletionChunk chunk)

Convert the ChatCompletionChunk into a ChatCompletion. The Usage is set to null.

Parameters:

chunk - the ChatCompletionChunk to convert

Returns:

the ChatCompletion