Skip to content

TimeTool

autogen.tools.contrib.TimeTool #

TimeTool(*, date_time_format='%Y-%m-%d %H:%M:%S')

Bases: Tool

Outputs the current date and time of the computer.

Get the date and time of the computer.

PARAMETER DESCRIPTION
date_time_format

The format of the date and time. Defaults to "%Y-%m-%d %H:%M:%S".

TYPE: str DEFAULT: '%Y-%m-%d %H:%M:%S'

Source code in autogen/tools/contrib/time/time.py 
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
def __init__(
    self,
    *,
    date_time_format: str = "%Y-%m-%d %H:%M:%S",  # This is a parameter that is unique to this tool
):
    """Get the date and time of the computer.

    Args:
        date_time_format (str, optional): The format of the date and time. Defaults to "%Y-%m-%d %H:%M:%S".
    """

    self._date_time_format = date_time_format

    async def get_date_and_time(
        date_time_format: Annotated[str, "date/time Python format"] = self._date_time_format,
    ) -> str:
        return datetime.now().strftime(date_time_format)

    super().__init__(
        name="date_time",
        description="Get the current computer's date and time.",
        func_or_tool=get_date_and_time,
    )

name property #

name

description property #

description

func property #

func

tool_schema property #

tool_schema

Get the schema for the tool.

This is the preferred way of handling function calls with OpeaAI and compatible frameworks.

function_schema property #

function_schema

Get the schema for the function.

This is the old way of handling function calls with OpenAI and compatible frameworks. It is provided for backward compatibility.

realtime_tool_schema property #

realtime_tool_schema

Get the schema for the tool.

This is the preferred way of handling function calls with OpeaAI and compatible frameworks.

register_for_llm #

register_for_llm(agent)

Registers the tool for use with a ConversableAgent's language model (LLM).

This method registers the tool so that it can be invoked by the agent during interactions with the language model.

PARAMETER DESCRIPTION
agent

The agent to which the tool will be registered.

TYPE: ConversableAgent

Source code in autogen/tools/tool.py 
72
73
74
75
76
77
78
79
80
81
def register_for_llm(self, agent: "ConversableAgent") -> None:
    """Registers the tool for use with a ConversableAgent's language model (LLM).

    This method registers the tool so that it can be invoked by the agent during
    interactions with the language model.

    Args:
        agent (ConversableAgent): The agent to which the tool will be registered.
    """
    agent.register_for_llm()(self)

register_for_execution #

register_for_execution(agent)

Registers the tool for direct execution by a ConversableAgent.

This method registers the tool so that it can be executed by the agent, typically outside of the context of an LLM interaction.

PARAMETER DESCRIPTION
agent

The agent to which the tool will be registered.

TYPE: ConversableAgent

Source code in autogen/tools/tool.py 
83
84
85
86
87
88
89
90
91
92
def register_for_execution(self, agent: "ConversableAgent") -> None:
    """Registers the tool for direct execution by a ConversableAgent.

    This method registers the tool so that it can be executed by the agent,
    typically outside of the context of an LLM interaction.

    Args:
        agent (ConversableAgent): The agent to which the tool will be registered.
    """
    agent.register_for_execution()(self)

register_tool #

register_tool(agent)

Register a tool to be both proposed and executed by an agent.

Equivalent to calling both register_for_llm and register_for_execution with the same agent.

Note: This will not make the agent recommend and execute the call in the one step. If the agent recommends the tool, it will need to be the next agent to speak in order to execute the tool.

PARAMETER DESCRIPTION
agent

The agent to which the tool will be registered.

TYPE: ConversableAgent

Source code in autogen/tools/tool.py 
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
def register_tool(self, agent: "ConversableAgent") -> None:
    """Register a tool to be both proposed and executed by an agent.

    Equivalent to calling both `register_for_llm` and `register_for_execution` with the same agent.

    Note: This will not make the agent recommend and execute the call in the one step. If the agent
    recommends the tool, it will need to be the next agent to speak in order to execute the tool.

    Args:
        agent (ConversableAgent): The agent to which the tool will be registered.
    """
    self.register_for_llm(agent)
    self.register_for_execution(agent)