agents::tools::WikipediaTool Class Reference

Wikipedia search tool that uses the MediaWiki API. More...

#include <wiki_tool.h>

Inheritance diagram for agents::tools::WikipediaTool:

Public Member Functions
	WikipediaTool ()
	Construct a new Wikipedia Tool object.
ToolResult	execute (const JsonObject &params) const override
	Execute the Wikipedia Tool.
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.
bool	validateParameters (const JsonObject &params) const
	Validate parameters against schema.

Detailed Description

Wikipedia search tool that uses the MediaWiki API.

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::WikipediaTool::execute ( const JsonObject & params ) const

overridevirtual

Execute the Wikipedia Tool.

Parameters

params

The parameters for the Wikipedia Tool

Returns

ToolResult The result of the Wikipedia Tool

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

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