Skip to content

Fix ToolCallback overload selection in ChatClient #6141

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
juanjuandog wants to merge 1 commit into
base: main
Choose a base branch
from
+48 −0
Open

Fix ToolCallback overload selection in ChatClient #6141

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
16 changes: 16 additions & 0 deletions spring-ai-client-chat/src/main/java/org/springframework/ai/chat/client/ChatClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -223,6 +223,14 @@ interface ChatClientRequestSpec {

ChatClientRequestSpec tools(Consumer<ToolSpec> consumer);

default ChatClientRequestSpec tools(ToolCallback... toolCallbacks) {
return tools(t -> t.callbacks(toolCallbacks));
}

default ChatClientRequestSpec tools(ToolCallbackProvider... toolCallbackProviders) {
return tools(t -> t.callbacks(toolCallbackProviders));
}

ChatClientRequestSpec tools(Object... toolObjects);

/**
Expand Down Expand Up @@ -337,6 +345,14 @@ interface Builder {

Builder defaultTools(Consumer<ToolSpec> consumer);

default Builder defaultTools(ToolCallback... toolCallbacks) {
return defaultTools(t -> t.callbacks(toolCallbacks));
}

default Builder defaultTools(ToolCallbackProvider... toolCallbackProviders) {
return defaultTools(t -> t.callbacks(toolCallbackProviders));
}

Builder defaultTools(Object... toolObjects);

/**
Expand Down
17 changes: 17 additions & 0 deletions ...-chat/src/test/java/org/springframework/ai/chat/client/DefaultChatClientBuilderTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@
import org.springframework.ai.chat.client.advisor.ToolCallAdvisor;
import org.springframework.ai.chat.model.ChatModel;
import org.springframework.ai.model.tool.ToolCallingManager;
import org.springframework.ai.tool.ToolCallback;
import org.springframework.ai.tool.function.FunctionToolCallback;
import org.springframework.core.io.ClassPathResource;
import org.springframework.test.util.ReflectionTestUtils;

Expand Down Expand Up @@ -86,6 +88,21 @@ void whenToolCallingManagerThenPropagatedToRequestSpec() {
assertThat(ReflectionTestUtils.getField(advisorBuilder, "toolCallingManager")).isSameAs(manager);
}

@Test
void whenToolCallbackPassedDirectlyToDefaultToolsThenReturn() {
ToolCallback toolCallback = FunctionToolCallback.builder("directDefaultTool", input -> "hello")
.description("description")
.inputType(String.class)
.build();

var builder = new DefaultChatClientBuilder(mock(ChatModel.class));
builder.defaultTools(toolCallback);

var defaultRequest = (DefaultChatClient.DefaultChatClientRequestSpec) ReflectionTestUtils.getField(builder,
"defaultRequest");
assertThat(defaultRequest.getToolCallbacks()).containsExactly(toolCallback);
}

@Test
void whenUserResourceIsNullThenThrows() {
DefaultChatClientBuilder builder = new DefaultChatClientBuilder(mock(ChatModel.class));
Expand Down
15 changes: 15 additions & 0 deletions ...-client-chat/src/test/java/org/springframework/ai/chat/client/DefaultChatClientTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1787,6 +1787,21 @@ void whenToolCallbacksThenReturn() {
assertThat(defaultSpec.getToolCallbacks()).contains(toolCallback);
}

@Test
void whenToolCallbackPassedDirectlyToToolsThenReturn() {
ChatClient chatClient = new DefaultChatClientBuilder(mockChatModel()).build();
ChatClient.ChatClientRequestSpec spec = chatClient.prompt();
ToolCallback toolCallback = FunctionToolCallback.builder("directTool", input -> "hello")
.description("description")
.inputType(String.class)
.build();

spec = spec.tools(toolCallback);

DefaultChatClient.DefaultChatClientRequestSpec defaultSpec = (DefaultChatClient.DefaultChatClientRequestSpec) spec;
assertThat(defaultSpec.getToolCallbacks()).containsExactly(toolCallback);
}

@Test
void whenFunctionNameIsNullThenThrow() {
ChatClient chatClient = new DefaultChatClientBuilder(mockChatModel()).build();
Expand Down