Skip to content

Create new ToolChatOptions if input request has tool configuration without options #3397

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

Create new ToolChatOptions if input request has tool configuration without options #3397

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: 14 additions & 6 deletions ...ng-ai-client-chat/src/main/java/org/springframework/ai/chat/client/DefaultChatClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,14 @@
import java.nio.charset.Charset;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.Set;
import java.util.function.Consumer;

import io.micrometer.observation.Observation;
Expand Down Expand Up @@ -570,7 +574,7 @@ public static class DefaultChatClientRequestSpec implements ChatClientRequestSpe

private final List<Media> media = new ArrayList<>();

private final List<String> toolNames = new ArrayList<>();
private final Set<String> toolNames = new LinkedHashSet<>();

private final List<ToolCallback> toolCallbacks = new ArrayList<>();

Expand Down Expand Up @@ -606,9 +610,9 @@ public static class DefaultChatClientRequestSpec implements ChatClientRequestSpe

public DefaultChatClientRequestSpec(ChatModel chatModel, @Nullable String userText,
Map<String, Object> userParams, @Nullable String systemText, Map<String, Object> systemParams,
List<ToolCallback> toolCallbacks, List<Message> messages, List<String> toolNames, List<Media> media,
@Nullable ChatOptions chatOptions, List<Advisor> advisors, Map<String, Object> advisorParams,
ObservationRegistry observationRegistry,
List<ToolCallback> toolCallbacks, List<Message> messages, Collection<String> toolNames,
List<Media> media, @Nullable ChatOptions chatOptions, List<Advisor> advisors,
Map<String, Object> advisorParams, ObservationRegistry observationRegistry,
@Nullable ChatClientObservationConvention observationConvention, Map<String, Object> toolContext,
@Nullable TemplateRenderer templateRenderer) {

Expand Down Expand Up @@ -685,7 +689,7 @@ public List<Media> getMedia() {
return this.media;
}

public List<String> getToolNames() {
public Set<String> getToolNames() {
return this.toolNames;
}

Expand All @@ -701,6 +705,10 @@ public TemplateRenderer getTemplateRenderer() {
return this.templateRenderer;
}

public boolean hasToolConfiguration() {
return !this.toolNames.isEmpty() || !this.toolCallbacks.isEmpty() || !this.toolContext.isEmpty();
}

/**
* Return a {@code ChatClient2Builder} to create a new {@code ChatClient2} whose
* settings are replicated from this {@code ChatClientRequest}.
Expand Down Expand Up @@ -778,7 +786,7 @@ public <T extends ChatOptions> ChatClientRequestSpec options(T options) {
public ChatClientRequestSpec toolNames(String... toolNames) {
Assert.notNull(toolNames, "toolNames cannot be null");
Assert.noNullElements(toolNames, "toolNames cannot contain null elements");
this.toolNames.addAll(List.of(toolNames));
Collections.addAll(this.toolNames, toolNames);
return this;
}

Expand Down
48 changes: 33 additions & 15 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 @@ -94,22 +94,40 @@ static ChatClientRequest toChatClientRequest(DefaultChatClient.DefaultChatClient
*/

ChatOptions processedChatOptions = inputRequest.getChatOptions();
if (processedChatOptions instanceof ToolCallingChatOptions toolCallingChatOptions) {
if (!inputRequest.getToolNames().isEmpty()) {
Set<String> toolNames = ToolCallingChatOptions
.mergeToolNames(new HashSet<>(inputRequest.getToolNames()), toolCallingChatOptions.getToolNames());
toolCallingChatOptions.setToolNames(toolNames);
if (inputRequest.hasToolConfiguration()) {
if (processedChatOptions == null) {
ToolCallingChatOptions.Builder builder = ToolCallingChatOptions.builder();
if (!inputRequest.getToolNames().isEmpty()) {
builder.toolNames(inputRequest.getToolNames());
}
if (!inputRequest.getToolCallbacks().isEmpty()) {
List<ToolCallback> toolCallbacks = inputRequest.getToolCallbacks();
ToolCallingChatOptions.validateToolCallbacks(toolCallbacks);
builder.toolCallbacks(inputRequest.getToolCallbacks());
}
if (!CollectionUtils.isEmpty(inputRequest.getToolContext())) {
builder.toolContext(inputRequest.getToolContext());
}

processedChatOptions = builder.build();
}
if (!inputRequest.getToolCallbacks().isEmpty()) {
List<ToolCallback> toolCallbacks = ToolCallingChatOptions
.mergeToolCallbacks(inputRequest.getToolCallbacks(), toolCallingChatOptions.getToolCallbacks());
ToolCallingChatOptions.validateToolCallbacks(toolCallbacks);
toolCallingChatOptions.setToolCallbacks(toolCallbacks);
}
if (!CollectionUtils.isEmpty(inputRequest.getToolContext())) {
Map<String, Object> toolContext = ToolCallingChatOptions.mergeToolContext(inputRequest.getToolContext(),
toolCallingChatOptions.getToolContext());
toolCallingChatOptions.setToolContext(toolContext);
else if (processedChatOptions instanceof ToolCallingChatOptions toolCallingChatOptions) {
if (!inputRequest.getToolNames().isEmpty()) {
Set<String> toolNames = ToolCallingChatOptions.mergeToolNames(
new HashSet<>(inputRequest.getToolNames()), toolCallingChatOptions.getToolNames());
toolCallingChatOptions.setToolNames(toolNames);
}
if (!inputRequest.getToolCallbacks().isEmpty()) {
List<ToolCallback> toolCallbacks = ToolCallingChatOptions
.mergeToolCallbacks(inputRequest.getToolCallbacks(), toolCallingChatOptions.getToolCallbacks());
ToolCallingChatOptions.validateToolCallbacks(toolCallbacks);
toolCallingChatOptions.setToolCallbacks(toolCallbacks);
}
if (!CollectionUtils.isEmpty(inputRequest.getToolContext())) {
Map<String, Object> toolContext = ToolCallingChatOptions
.mergeToolContext(inputRequest.getToolContext(), toolCallingChatOptions.getToolContext());
toolCallingChatOptions.setToolContext(toolContext);
}
}
}

Expand Down
54 changes: 54 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 @@ -322,6 +322,60 @@ void whenToolContextAndChatOptionsAreProvidedThenTheValuesAreMerged() {
.containsAllEntriesOf(toolContext2);
}

@Test
void whenToolNamesWithoutChatOptionsAreProvidedThenToolCallingChatOptionsAreSet() {
List<String> toolNames = List.of("tool1", "tool2");
ChatModel chatModel = mock(ChatModel.class);
DefaultChatClient.DefaultChatClientRequestSpec inputRequest = (DefaultChatClient.DefaultChatClientRequestSpec) ChatClient
.create(chatModel)
.prompt()
.toolNames(toolNames.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(toolNames);
}

@Test
void whenToolCallbacksWithoutChatOptionsAreProvidedThenToolCallingChatOptionsAreSet() {
ToolCallback toolCallback = new TestToolCallback("tool1");
ChatModel chatModel = mock(ChatModel.class);
DefaultChatClient.DefaultChatClientRequestSpec inputRequest = (DefaultChatClient.DefaultChatClientRequestSpec) ChatClient
.create(chatModel)
.prompt()
.toolCallbacks(toolCallback);

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()).contains(toolCallback);
}

@Test
void whenToolContextWithoutChatOptionsIsProvidedThenToolCallingChatOptionsAreSet() {
Map<String, Object> toolContext = Map.of("key", "value");
ChatModel chatModel = mock(ChatModel.class);
DefaultChatClient.DefaultChatClientRequestSpec inputRequest = (DefaultChatClient.DefaultChatClientRequestSpec) ChatClient
.create(chatModel)
.prompt()
.toolContext(toolContext);

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.getToolContext()).containsAllEntriesOf(toolContext);
}

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