agents::tools::BraveSearchTool Class Reference

Web search tool backed by the Brave Search API. More...

#include <brave_search_tool.h>

Inheritance diagram for agents::tools::BraveSearchTool:

Public Member Functions
ToolResult	execute (const JsonObject &params) const override
	Execute the tool with the given parameters.
const std::string &	getName () const
	Get the name of the tool.
const std::string &	getDescription () const
	Get the description of the tool.
const ParameterMap &	getParameters () const
	Get the parameters of the tool.
const JsonObject &	getSchema () const
	Get the schema of the tool.
void	addParameter (const Parameter &param)
	Add a parameter to the tool.
void	addParametersFromJson (const JsonObject &params)
	Add tool parameters from json definition.
void	setCallback (ToolCallback callback)
	Set the execution callback.
virtual double	scoreRelevance (const std::string &query) const
	Score the relevance of this tool to a given query.
bool	validateParameters (const JsonObject &params) const
	Validate parameters against schema.

Detailed Description

Web search tool backed by the Brave Search API.

Significantly faster than SerpAPI — direct index, single HTTP round-trip, no intermediate proxy. Set WEBSEARCH_API_KEY to your Brave API key.

Member Function Documentation

addParameter()

void agents::Tool::addParameter ( const Parameter & param )

inherited

Add a parameter to the tool.

Parameters

param

The parameter to add

addParametersFromJson()

void agents::Tool::addParametersFromJson ( const JsonObject & params )

inherited

Add tool parameters from json definition.

Parameters

params

The parameters to add

execute()

ToolResult agents::tools::BraveSearchTool::execute ( const JsonObject & params ) const

overridevirtual

Execute the tool with the given parameters.

Parameters

params

The parameters to execute the tool with

Returns

The result of the tool execution

Reimplemented from agents::Tool.

getDescription()

const std::string & agents::Tool::getDescription ( ) const

inherited

Get the description of the tool.

Returns

The description of the tool

getName()

const std::string & agents::Tool::getName ( ) const

inherited

Get the name of the tool.

Returns

The name of the tool

getParameters()

const ParameterMap & agents::Tool::getParameters ( ) const

inherited

Get the parameters of the tool.

Returns

The parameters of the tool

getSchema()

const JsonObject & agents::Tool::getSchema ( ) const

inherited

Get the schema of the tool.

Returns

The schema of the tool

scoreRelevance()

virtual double agents::Tool::scoreRelevance ( const std::string & query ) const

virtualinherited

Score the relevance of this tool to a given query.

Parameters

query

The query to score against

Returns

double Relevance score (0.0 to 1.0)

Reimplemented in agents::skills::MarkdownSkillTool.

setCallback()

void agents::Tool::setCallback ( ToolCallback callback )

inherited

Set the execution callback.

Parameters

callback

The callback to set

validateParameters()

bool agents::Tool::validateParameters ( const JsonObject & params ) const

inherited

Validate parameters against schema.

Parameters

params

The parameters to validate

Returns

true of valid, otherwise false