Class ModuleAgent (1.122.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 agentfrom that module. It also allows to register operations that are defined inthe 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
NameDescription
module_namestr

Required. The name of the module to import.

agent_namestr

Required. The name of the agent in the module to instantiate.

register_operationsDict[str, Sequence[str]]

Required. A dictionary of API modes to a list of method names.

sys_pathsSequence[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 toextra_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]]

Register the user provided operations (modes and methods).

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 theoperations of the agent.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-10-30 UTC.