neuralplus::Tool Class Reference

#include <tool.hpp>

Inheritance diagram for neuralplus::Tool:

Public Member Functions
virtual const ToolSpec &	spec () const noexcept=0
	Returns the immutable declaration advertised to providers.
virtual ToolOutput	invoke (ToolContext &context, const JsonValue &arguments)=0
	Executes the tool with validated JSON arguments.

Friends
class	AIClient

Detailed Description

Type-safe extension point for application tools.

AIClient serializes invocations of the same Tool object, including when that shared instance is installed in more than one client. Different Tool objects may still execute concurrently.

Member Function Documentation

invoke()

virtual ToolOutput neuralplus::Tool::invoke ( ToolContext &  context, const JsonValue &  arguments  )

pure virtual

Executes the tool with validated JSON arguments.

Implemented in neuralplus::FunctionTool.

spec()

virtual const ToolSpec & neuralplus::Tool::spec ( ) const

pure virtualnoexcept

Returns the immutable declaration advertised to providers.

Implemented in neuralplus::FunctionTool.

---

The documentation for this class was generated from the following file:

• include/neuralplus/tool.hpp