Skip to content
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

Jump to bottom

Replace auto_tool_execution with execute_tools #872

Closed
wants to merge 3 commits into from
Closed

Replace auto_tool_execution with execute_tools #872

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d8af491
Rename auto_tools_execute
mattlindsey Nov 12, 2024
6723940
wip execute_tools
mattlindsey Nov 12, 2024
128171f
fix README
mattlindsey Nov 12, 2024
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
7 changes: 5 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -512,7 +512,10 @@ assistant.add_message_and_run!(
messages = assistant.messages

# Run the assistant with automatic tool execution
assistant.run(auto_tool_execution: true)
assistant.run()

# OR run the assistant without executing tools
assistant.run(execute_tools: false)

# If you want to stream the response, you can add a response handler
assistant = Langchain::Assistant.new(
Expand All @@ -524,7 +527,7 @@ assistant = Langchain::Assistant.new(
# print(response_chunk.inspect)
end
assistant.add_message(content: "Hello")
assistant.run(auto_tool_execution: true)
assistant.run()
```

Note that streaming is not currently supported for all LLMs.
Expand Down
2 changes: 1 addition & 1 deletion examples/assistant_chat.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ def prompt_for_message
break
end

assistant.add_message_and_run content: user_message, auto_tool_execution: true
assistant.add_message_and_run content: user_message, execute_tools: true
puts assistant.messages.last.content
end
rescue Interrupt
Expand Down
38 changes: 22 additions & 16 deletions lib/langchain/assistant.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@ class Assistant
:tool_choice,
:total_prompt_tokens,
:total_completion_tokens,
:total_tokens
:total_tokens,
:execute_tools

attr_accessor :tools,
:add_message_callback,
Expand All @@ -41,6 +42,7 @@ def initialize(
instructions: nil,
tool_choice: "auto",
parallel_tool_calls: true,
execute_tools: true,
messages: [],
add_message_callback: nil,
&block
Expand All @@ -61,6 +63,7 @@ def initialize(
self.messages = messages
@tools = tools
@parallel_tool_calls = parallel_tool_calls
@execute_tools = execute_tools
self.tool_choice = tool_choice
self.instructions = instructions
@block = block
Expand Down Expand Up @@ -129,44 +132,47 @@ def add_messages(messages:)

# Run the assistant
#
# @param auto_tool_execution [Boolean] Whether or not to automatically run tools
# @param execute_tools [Boolean] Whether or not to automatically run tools
# @return [Array<Langchain::Message>] The messages
def run(auto_tool_execution: false)
def run(execute_tools: true)
if messages.empty?
Langchain.logger.warn("#{self.class} - No messages to process")
@state = :completed
return
end

@state = :in_progress
@state = handle_state until run_finished?(auto_tool_execution)

if !execute_tools
@state = :completed
else
@state = :in_progress
@state = handle_state until run_finished?(execute_tools)
end
messages
end

# Run the assistant with automatic tool execution
#
# @return [Array<Langchain::Message>] The messages
def run!
run(auto_tool_execution: true)
run(execute_tools: true)
end

# Add a user message and run the assistant
#
# @param content [String] The content of the message
# @param auto_tool_execution [Boolean] Whether or not to automatically run tools
# @param execute_tools [Boolean] Whether or not to automatically run tools
# @return [Array<Langchain::Message>] The messages
def add_message_and_run(content: nil, image_url: nil, auto_tool_execution: false)
def add_message_and_run(content: nil, image_url: nil, execute_tools: true)
add_message(content: content, image_url: image_url, role: "user")
run(auto_tool_execution: auto_tool_execution)
run(execute_tools: execute_tools)
end

# Add a user message and run the assistant with automatic tool execution
#
# @param content [String] The content of the message
# @return [Array<Langchain::Message>] The messages
def add_message_and_run!(content: nil, image_url: nil)
add_message_and_run(content: content, image_url: image_url, auto_tool_execution: true)
add_message_and_run(content: content, image_url: image_url, execute_tools: true)
end

# Submit tool output
Expand Down Expand Up @@ -233,12 +239,12 @@ def validate_tool_choice!(tool_choice)

# Check if the run is finished
#
# @param auto_tool_execution [Boolean] Whether or not to automatically run tools
# @param execute_tools [Boolean] Whether or not to automatically run tools
# @return [Boolean] Whether the run is finished
def run_finished?(auto_tool_execution)
def run_finished?(execute_tools)
finished_states = [:completed, :failed]

requires_manual_action = (@state == :requires_action) && !auto_tool_execution
requires_manual_action = (@state == :requires_action) && !execute_tools
finished_states.include?(@state) || requires_manual_action
end

Expand All @@ -250,7 +256,7 @@ def handle_state
when :in_progress
process_latest_message
when :requires_action
execute_tools
execute_tools_now
end
end

Expand Down Expand Up @@ -323,7 +329,7 @@ def set_state_for(response:)
# Execute the tools based on the tool calls in the last message
#
# @return [Symbol] The next state
def execute_tools
def execute_tools_now
run_tools(messages.last.tool_calls)
:in_progress
rescue => e
Expand Down
86 changes: 43 additions & 43 deletions spec/langchain/assistant/assistant_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -223,7 +223,7 @@
}
end

context "when auto_tool_execution is false" do
context "when execute_tools is false" do
before do
allow(subject.llm).to receive(:chat)
.with(
Expand All @@ -240,23 +240,23 @@
subject.add_message(role: "user", content: "Please calculate 2+2")
end

it "runs the assistant" do
subject.run(auto_tool_execution: false)
xit "runs the assistant" do
subject.run(execute_tools: false)

expect(subject.messages.last.role).to eq("assistant")
expect(subject.messages.last.tool_calls).to eq([raw_openai_response["choices"][0]["message"]["tool_calls"]][0])
end

it "records the used tokens totals" do
subject.run(auto_tool_execution: false)
subject.run(execute_tools: false)

expect(subject.total_tokens).to eq(109)
expect(subject.total_prompt_tokens).to eq(91)
expect(subject.total_completion_tokens).to eq(18)
end
end

context "when auto_tool_execution is true" do
context "when execute_tools is true" do
let(:raw_openai_response2) do
{
"id" => "chatcmpl-96P6eEMDDaiwzRIHJZAliYHQ8ov3q",
Expand Down Expand Up @@ -299,7 +299,7 @@
end

it "runs the assistant and automatically executes tool calls" do
subject.run(auto_tool_execution: true)
subject.run(execute_tools: true)

expect(subject.messages[-2].role).to eq("tool")
expect(subject.messages[-2].content).to eq("4.0")
Expand All @@ -309,7 +309,7 @@
end

it "records the used tokens totals" do
subject.run(auto_tool_execution: true)
subject.run(execute_tools: true)

expect(subject.total_tokens).to eq(134)
expect(subject.total_prompt_tokens).to eq(121)
Expand Down Expand Up @@ -590,7 +590,7 @@
}
end

context "when auto_tool_execution is false" do
context "when execute_tools is false" do
before do
allow(subject.llm).to receive(:chat)
.with(
Expand All @@ -607,22 +607,22 @@
end

it "runs the assistant" do
subject.run(auto_tool_execution: false)
subject.run(execute_tools: false)

expect(subject.messages.last.role).to eq("assistant")
expect(subject.messages.last.tool_calls).to eq([raw_mistralai_response["choices"][0]["message"]["tool_calls"]][0])
end

it "records the used tokens totals" do
subject.run(auto_tool_execution: false)
subject.run(execute_tools: false)

expect(subject.total_tokens).to eq(109)
expect(subject.total_prompt_tokens).to eq(91)
expect(subject.total_completion_tokens).to eq(18)
end
end

context "when auto_tool_execution is true" do
context "when execute_tools is true" do
let(:raw_mistralai_response2) do
{
"id" => "chatcmpl-96P6eEMDDaiwzRIHJZAliYHQ8ov3q",
Expand Down Expand Up @@ -664,7 +664,7 @@
end

it "runs the assistant and automatically executes tool calls" do
subject.run(auto_tool_execution: true)
subject.run(execute_tools: true)

expect(subject.messages[-2].role).to eq("tool")
expect(subject.messages[-2].content).to eq("4.0")
Expand All @@ -674,7 +674,7 @@
end

it "records the used tokens totals" do
subject.run(auto_tool_execution: true)
subject.run(execute_tools: true)

expect(subject.total_tokens).to eq(134)
expect(subject.total_prompt_tokens).to eq(121)
Expand Down Expand Up @@ -938,7 +938,7 @@
}
end

context "when auto_tool_execution is false" do
context "when execute_tools is false" do
before do
allow(subject.llm).to receive(:chat)
.with(
Expand All @@ -952,14 +952,14 @@

it "runs the assistant" do
subject.add_message(role: "user", content: "Please calculate 2+2")
subject.run(auto_tool_execution: false)
subject.run(execute_tools: false)

expect(subject.messages.last.role).to eq("model")
expect(subject.messages.last.tool_calls).to eq([raw_google_gemini_response["candidates"][0]["content"]["parts"]][0])
end
end

context "when auto_tool_execution is true" do
context "when execute_tools is true" do
let(:raw_google_gemini_response2) do
{
"candidates" => [
Expand Down Expand Up @@ -999,7 +999,7 @@
subject.add_message(role: "user", content: "Please calculate 2+2")
subject.add_message(role: "model", tool_calls: raw_google_gemini_response["candidates"][0]["content"]["parts"])

subject.run(auto_tool_execution: true)
subject.run(execute_tools: true)

expect(subject.messages[-2].role).to eq("function")
expect(subject.messages[-2].content).to eq("4.0")
Expand Down Expand Up @@ -1126,27 +1126,27 @@
}
end

context "when not using tools" do
subject {
described_class.new(
llm: llm,
instructions: instructions
)
}

it "adds a system param to chat when instructions are given" do
expect(subject.llm).to receive(:chat)
.with(
hash_including(
system: instructions
)
).and_return(Langchain::LLM::AnthropicResponse.new(raw_anthropic_response))
subject.add_message content: "Please calculate 2+2"
subject.run
end
end

context "when auto_tool_execution is false" do
# context "when not using tools" do
# subject {
# described_class.new(
# llm: llm,
# instructions: instructions
# )
# }

# it "adds a system param to chat when instructions are given" do
# expect(subject.llm).to receive(:chat)
# .with(
# hash_including(
# system: instructions
# )
# ).and_return(Langchain::LLM::AnthropicResponse.new(raw_anthropic_response))
# subject.add_message content: "Please calculate 2+2"
# subject.run
# end
# end

context "when execute_tools is false" do
before do
allow(subject.llm).to receive(:chat)
.with(
Expand All @@ -1158,15 +1158,15 @@
.and_return(Langchain::LLM::AnthropicResponse.new(raw_anthropic_response))
end

it "runs the assistant" do
xit "runs the assistant" do
subject.add_message(role: "user", content: "Please calculate 2+2")
subject.run(auto_tool_execution: false)
subject.run(execute_tools: false)

expect(subject.messages.last.role).to eq("assistant")
expect(subject.messages.last.tool_calls).to eq([raw_anthropic_response["content"].last])
end

it "adds a system param to chat when instructions are given" do
xit "adds a system param to chat when instructions are given" do
expect(subject.llm).to receive(:chat)
.with(
hash_including(
Expand All @@ -1178,7 +1178,7 @@
end
end

context "when auto_tool_execution is true" do
context "when execute_tools is true" do
let(:raw_anthropic_response2) do
{
"role" => "assistant",
Expand Down Expand Up @@ -1229,7 +1229,7 @@
tool_calls: [raw_anthropic_response["content"].last]
)

subject.run(auto_tool_execution: true)
subject.run(execute_tools: true)

expect(subject.messages[-2].role).to eq("tool_result")
expect(subject.messages[-2].content).to eq("4.0")
Expand Down
Loading