steamship.agents.tools.search package#

Submodules#

steamship.agents.tools.search.search module#

Tool for searching the web for answers.

class steamship.agents.tools.search.search.SearchTool(*, name: str = 'SearchTool', agent_description: str = 'Used to search the web for new information.', human_description: str = 'Searches the web.', is_final: bool = False, cacheable: bool = True, cache: bool = False, cache_store: KeyValueStore | None = None)[source]#

Bases: Tool

Tool which uses Steamship’s managed SERP API client to search Google.

class Config[source]#

Bases: object

arbitrary_types_allowed = True#

agent_description: str#: Description for use in an agent in order to enable Action selection. It should include a short summary of what the Tool does, what the inputs to the Tool should be, and what the outputs of the tool are.

cache: bool#

cache_store: KeyValueStore | None#

human_description: str#: Human-friendly description. Used for logging, tool indices, etc.

name: str#: The short name for the tool. This will be used by Agents to refer to this tool during action selection.

run(tool_input: List[Block], context: AgentContext) → List[Block] | Task[Any][source]#: Execute a search using the Steamship plugin.

Module contents#

class steamship.agents.tools.search.SearchTool(*, name: str = 'SearchTool', agent_description: str = 'Used to search the web for new information.', human_description: str = 'Searches the web.', is_final: bool = False, cacheable: bool = True, cache: bool = False, cache_store: KeyValueStore | None = None)[source]#

Bases: Tool

Tool which uses Steamship’s managed SERP API client to search Google.

class Config[source]#

Bases: object

arbitrary_types_allowed = True#

agent_description: str#: Description for use in an agent in order to enable Action selection. It should include a short summary of what the Tool does, what the inputs to the Tool should be, and what the outputs of the tool are.

cache: bool#

cache_store: KeyValueStore | None#

cacheable: bool#: Whether runs of this Tool should be cached based on inputs (if caching is enabled in the AgentContext for a run). Setting this to False will make prevent any Actions that involve this tool from being cached, meaning that every Action using this Tool will result in a call to run. By default, Tools are considered cacheable.

human_description: str#: Human-friendly description. Used for logging, tool indices, etc.

is_final: bool#

Whether actions performed by this tool should have their is_final bit marked.

Setting this to True means that the output of this tool will halt the reasoning loop. Its output will be returned directly to the user.

name: str#: The short name for the tool. This will be used by Agents to refer to this tool during action selection.

run(tool_input: List[Block], context: AgentContext) → List[Block] | Task[Any][source]#: Execute a search using the Steamship plugin.