Class ModuleAgent (1.121.0)

ModuleAgent(
    *,
    module_name: str,
    agent_name: str,
    register_operations: typing.Dict[str, typing.Sequence[str]],
    sys_paths: typing.Optional[typing.Sequence[str]] = None,
    agent_framework: typing.Optional[str] = None
)

Agent that is defined by a module and an agent name.

This agent is instantiated by importing a module and instantiating an agent from that module. It also allows to register operations that are defined in the agent.

Methods

ModuleAgent

ModuleAgent(
    *,
    module_name: str,
    agent_name: str,
    register_operations: typing.Dict[str, typing.Sequence[str]],
    sys_paths: typing.Optional[typing.Sequence[str]] = None,
    agent_framework: typing.Optional[str] = None
)

Initializes a module-based agent.

Parameters
Name	Description
`module_name`	`str` Required. The name of the module to import.
`agent_name`	`str` Required. The name of the agent in the module to instantiate.
`register_operations`	`Dict[str, Sequence[str]]` Required. A dictionary of API modes to a list of method names.
`sys_paths`	`Sequence[str]` Optional. The system paths to search for the module. It should be relative to the directory where the code will be running. I.e. it should correspond to the directory being passed to `extra_packages=...` in the create method. It will be appended to the system path in the sequence being specified here, and only be appended if it is not already in the system path.

clone

clone()

Return a clone of the agent.

register_operations

register_operations(**kwargs) -> typing.Dict[str, typing.Sequence[str]]

set_up

set_up() -> None

Sets up the agent for execution of queries at runtime.

It runs the code to import the agent from the module, and registers the operations of the agent.