Skip to content

Fixed the issue where tool call information was lost when using DefaultChatOptions. #3417

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fixed the issue where tool call information was lost when using DefaultChatOptions. #3417

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions ...-client-chat/src/main/java/org/springframework/ai/chat/client/DefaultChatClientUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,10 @@
import org.springframework.ai.chat.messages.SystemMessage;
import org.springframework.ai.chat.messages.UserMessage;
import org.springframework.ai.chat.prompt.ChatOptions;
import org.springframework.ai.chat.prompt.DefaultChatOptions;
import org.springframework.ai.chat.prompt.Prompt;
import org.springframework.ai.chat.prompt.PromptTemplate;
import org.springframework.ai.model.tool.DefaultToolCallingChatOptions;
import org.springframework.ai.model.tool.ToolCallingChatOptions;
import org.springframework.ai.tool.ToolCallback;
import org.springframework.util.Assert;
Expand All @@ -39,6 +41,7 @@
* Utilities for supporting the {@link DefaultChatClient} implementation.
*
* @author Thomas Vitale
* @author Sun Yuhan
* @since 1.0.0
*/
final class DefaultChatClientUtils {
Expand Down Expand Up @@ -94,6 +97,23 @@ static ChatClientRequest toChatClientRequest(DefaultChatClient.DefaultChatClient
*/

ChatOptions processedChatOptions = inputRequest.getChatOptions();

if (processedChatOptions instanceof DefaultChatOptions defaultChatOptions) {
if (!inputRequest.getToolNames().isEmpty() || !inputRequest.getToolCallbacks().isEmpty()
|| !CollectionUtils.isEmpty(inputRequest.getToolContext())) {
processedChatOptions = DefaultToolCallingChatOptions.builder()
.model(defaultChatOptions.getModel())
.frequencyPenalty(defaultChatOptions.getFrequencyPenalty())
.maxTokens(defaultChatOptions.getMaxTokens())
.presencePenalty(defaultChatOptions.getPresencePenalty())
.stopSequences(defaultChatOptions.getStopSequences())
.temperature(defaultChatOptions.getTemperature())
.topK(defaultChatOptions.getTopK())
.topP(defaultChatOptions.getTopP())
.build();
}
}

if (processedChatOptions instanceof ToolCallingChatOptions toolCallingChatOptions) {
if (!inputRequest.getToolNames().isEmpty()) {
Set<String> toolNames = ToolCallingChatOptions
Expand Down
60 changes: 60 additions & 0 deletions ...nt-chat/src/test/java/org/springframework/ai/chat/client/DefaultChatClientUtilsTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
import org.springframework.ai.chat.messages.SystemMessage;
import org.springframework.ai.chat.messages.UserMessage;
import org.springframework.ai.chat.model.ChatModel;
import org.springframework.ai.chat.prompt.DefaultChatOptions;
import org.springframework.ai.content.Media;
import org.springframework.ai.model.tool.ToolCallingChatOptions;
import org.springframework.ai.template.TemplateRenderer;
Expand All @@ -43,6 +44,7 @@
* Unit tests for {@link DefaultChatClientUtils}.
*
* @author Thomas Vitale
* @author Sun Yuhan
*/
class DefaultChatClientUtilsTests {

Expand Down Expand Up @@ -322,6 +324,64 @@ void whenToolContextAndChatOptionsAreProvidedThenTheValuesAreMerged() {
.containsAllEntriesOf(toolContext2);
}

@Test
void whenToolNamesAndChatOptionsAreDefaultChatOptions() {
Set<String> toolNames1 = Set.of("toolA", "toolB");
DefaultChatOptions chatOptions = new DefaultChatOptions();
ChatModel chatModel = mock(ChatModel.class);
DefaultChatClient.DefaultChatClientRequestSpec inputRequest = (DefaultChatClient.DefaultChatClientRequestSpec) ChatClient
.create(chatModel)
.prompt()
.options(chatOptions)
.toolNames(toolNames1.toArray(new String[0]));

ChatClientRequest result = DefaultChatClientUtils.toChatClientRequest(inputRequest);

assertThat(result).isNotNull();
assertThat(result.prompt().getOptions()).isInstanceOf(ToolCallingChatOptions.class);
ToolCallingChatOptions resultOptions = (ToolCallingChatOptions) result.prompt().getOptions();
assertThat(resultOptions).isNotNull();
assertThat(resultOptions.getToolNames()).containsExactlyInAnyOrderElementsOf(toolNames1);
}

@Test
void whenToolCallbacksAndChatOptionsAreDefaultChatOptions() {
ToolCallback toolCallback1 = new TestToolCallback("tool1");
DefaultChatOptions chatOptions = new DefaultChatOptions();
ChatModel chatModel = mock(ChatModel.class);
DefaultChatClient.DefaultChatClientRequestSpec inputRequest = (DefaultChatClient.DefaultChatClientRequestSpec) ChatClient
.create(chatModel)
.prompt()
.options(chatOptions)
.toolCallbacks(toolCallback1);

ChatClientRequest result = DefaultChatClientUtils.toChatClientRequest(inputRequest);

assertThat(result).isNotNull();
assertThat(result.prompt().getOptions()).isInstanceOf(ToolCallingChatOptions.class);
ToolCallingChatOptions resultOptions = (ToolCallingChatOptions) result.prompt().getOptions();
assertThat(resultOptions).isNotNull();
assertThat(resultOptions.getToolCallbacks()).containsExactlyInAnyOrder(toolCallback1);
}

@Test
void whenToolContextAndChatOptionsAreDefaultChatOptions() {
Map<String, Object> toolContext1 = Map.of("key1", "value1");
DefaultChatOptions chatOptions = new DefaultChatOptions();
ChatModel chatModel = mock(ChatModel.class);
DefaultChatClient.DefaultChatClientRequestSpec inputRequest = (DefaultChatClient.DefaultChatClientRequestSpec) ChatClient
.create(chatModel)
.prompt()
.options(chatOptions)
.toolContext(toolContext1);

ChatClientRequest result = DefaultChatClientUtils.toChatClientRequest(inputRequest);
assertThat(result.prompt().getOptions()).isInstanceOf(ToolCallingChatOptions.class);
ToolCallingChatOptions resultOptions = (ToolCallingChatOptions) result.prompt().getOptions();
assertThat(resultOptions).isNotNull();
assertThat(resultOptions.getToolContext()).containsAllEntriesOf(toolContext1);
}

@Test
void whenAdvisorParamsAreProvidedThenTheyAreAddedToContext() {
Map<String, Object> advisorParams = Map.of("key1", "value1", "key2", "value2");
Expand Down