Running into a Keyerror while adding a tools to ReAct agent that am building with external tools

[MeAmarP]

Am learning Llama-Index to build an agent.

To understand the flow, for now am adding a simple tool to get today's date.

I tried FunctionTool and BaseToolSpec class APIs to acheive this. But am running into a KeyError: 'tool name (one of get_today_date)'

• Am Using: Llama-index v0.8.42 with Python(v3.11.6)
• Am using Ollama with Llama2-7B for this.

Below is my source code:

from datetime import datetime

from llama_index.llms import Ollama
from llama_index.agent import ReActAgent
from llama_index.tools.tool_spec.base import BaseToolSpec

class DateToolSpec(BaseToolSpec):
    
    spec_functions = ["get_today_date"]
    
    def get_today_date(self):
        """ Tool Returns today's date in dd-mm-yyyy format
        """
        return datetime.today().strftime('%d-%m-%Y')

def agent(message, history):
    agent = ReActAgent.from_tools(tools=tools, llm=llm, verbose=True)
    response = agent.chat(message)
    return response

if __name__ == "__main__":

    llm = Ollama(model="llama2")
    date_spec = DateToolSpec()
    tools = date_spec.to_tool_list()
    print(agent("Give me todays date", []))

Full Trace of Error:

Thought: I need to use a tool to help me answer the question.
Action: tool name (one of get_today_date)
Action Input: {'title': 'get_today_date', 'type': 'object', 'properties': {}}
Traceback (most recent call last):
  File "/home/c3po/Documents/project/learning/dev-llm/NoProbLlama-Bot/start_samples/llamaindex-agent.py", line 32, in <module>
    print(agent("Give me todays date", []))
          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/c3po/Documents/project/learning/dev-llm/NoProbLlama-Bot/start_samples/llamaindex-agent.py", line 23, in agent
    response = agent.chat(message)
               ^^^^^^^^^^^^^^^^^^^
  File "/home/c3po/mambaforge/envs/dev-llm/lib/python3.11/site-packages/llama_index/callbacks/utils.py", line 39, in wrapper
    return func(self, *args, **kwargs)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/c3po/mambaforge/envs/dev-llm/lib/python3.11/site-packages/llama_index/agent/react/base.py", line 228, in chat
    reasoning_steps, is_done = self._process_actions(output=chat_response)
                               ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/c3po/mambaforge/envs/dev-llm/lib/python3.11/site-packages/llama_index/agent/react/base.py", line 150, in _process_actions
    tool = self._tools_dict[reasoning_step.action]
           ~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^
KeyError: 'tool name (one of get_today_date)'

[dosubot[bot]]

🤖

It seems like you're trying to define a tool using the BaseToolSpec class, which is not the correct way to define tools in the LlamaIndex framework. Tools should be defined as classes that inherit from the BaseTool or AsyncBaseTool abstract base classes.

Here's how you can define your DateTool:

from llama_index.tools import BaseTool, ToolMetadata, ToolOutput

class DateTool(BaseTool):
    @property
    def metadata(self):
        return ToolMetadata(
            description="Tool Returns today's date in dd-mm-yyyy format",
            name="get_today_date",
        )

    def __call__(self, input: Any) -> ToolOutput:
        return ToolOutput(datetime.today().strftime('%d-%m-%Y'))

And here's how you can use it in your agent:

def agent(message, history):
    date_tool = DateTool()
    agent = ReActAgent.from_tools(tools=[date_tool], llm=llm, verbose=True)
    response = agent.chat(message)
    return response

Please note that the BaseToolSpec class and its to_tool_list method are not part of the public API of LlamaIndex and should not be used. Instead, you should directly instantiate your tool classes and pass them to the ReActAgent.from_tools method.

Also, please note that there might have been changes in the tool definition and usage from LlamaIndex v0.8.42 to v0.9.33. I recommend updating to the latest version of LlamaIndex to ensure compatibility with the provided code.

For more information, you can refer to the llama_index/tools/types.py file in the LlamaIndex repository.

I hope this helps! If you have any more questions, feel free to ask.

Sources

• llama_index/tools/types.py

---

This response is meant to be useful and save you time. It is not meant to be a precise solution, but rather a starting point for your own research.

Help me be more useful! Please leave a 👍 if this is helpful and 👎 if it is irrelevant.

If you want to continue the conversation, start your reply with @dosu-bot.

[MeAmarP]

Above provided code snippet does not work. Ran into same error.
Also am not sure if ReAct agent itself is generating right set of intermediate instructions. Refer Below:

Thought: I need to use a tool to help me answer the question.
Action: tool name (one of get_today_date)
Action Input: {'input': {'text': 'hello world'}}

In above Action Input should be None??, since am not passing any values.

KeyError: 'tool name (one of get_today_date)'