Class ChatTool

Base class for AI-invokable plugin operations in Developer Mode that execute on demand and return a Result.

Hierarchy (View Summary)

IPlugin
- ChatTool

Index

Constructors

Properties

id pluginSystem

Methods

execute getTypeName isOfType isSame

Constructors

constructor

new ChatTool(pluginSystem: PluginSystem, descriptor?: Descriptor): ChatTool
Constructs a ChatTool plugin instance with the given plugin system and optional descriptor.
Parameters
- pluginSystem: PluginSystem
- Optionaldescriptor: Descriptor
Returns ChatTool
Overrides IPlugin.constructor

Properties

`Readonly`id

id: string

`Readonly`pluginSystem

pluginSystem: PluginSystem

The PluginSystem instance used to access shared Editor interfaces via findInterface().

Methods

execute

execute(parameters: Parameters): Promise<Result>
Executes the tool with the given parameters and returns a Result containing output data or an error string.
Parameters
- parameters: Parameters
Returns Promise<Result>

getTypeName

getTypeName(): string
Returns the name of this object's type.

Returns string
Inherited from IPlugin.getTypeName

isOfType

isOfType(type: string): boolean
Returns true if the object is of the specified type.
Parameters
- type: string
Returns boolean
Inherited from IPlugin.isOfType

isSame

isSame(other: ScriptObject): boolean
Returns true if this object refers to the same instance as the given object.
Parameters
- other: ScriptObject
Returns boolean
Inherited from IPlugin.isSame