Record Class ToolDescription
java.lang.Object
java.lang.Record
com.inductiveautomation.ignition.common.ai.ToolDescription
- Record Components:
name- the tool name shown to the model; must be unique within an agent.description- a human-readable explanation the model uses to decide when to call the tool.parameters- a JSON Schema object fragment describing the tool's argument shape, with top-level{"type": "object", ...}; pass{"type": "object"}for tools that take no arguments.
public record ToolDescription(String name, String description, com.inductiveautomation.ignition.common.gson.JsonObject parameters)
extends Record
Declarative metadata for a tool: how it's identified to the model. Paired with a
CallableTool.invoke(Map) method to form a callable tool.
Tools.fromAnnotated(Object...) builds these from Tool-annotated methods; build
one directly only when implementing CallableTool by hand.
-
Constructor Summary
ConstructorsConstructorDescriptionToolDescription(String name, String description, com.inductiveautomation.ignition.common.gson.JsonObject parameters) Creates an instance of aToolDescriptionrecord class. -
Method Summary
Modifier and TypeMethodDescriptionReturns the value of thedescriptionrecord component.final booleanIndicates whether some other object is "equal to" this one.final inthashCode()Returns a hash code value for this object.name()Returns the value of thenamerecord component.com.inductiveautomation.ignition.common.gson.JsonObjectReturns the value of theparametersrecord component.final StringtoString()Returns a string representation of this record class.
-
Constructor Details
-
ToolDescription
public ToolDescription(String name, String description, com.inductiveautomation.ignition.common.gson.JsonObject parameters) Creates an instance of aToolDescriptionrecord class.- Parameters:
name- the value for thenamerecord componentdescription- the value for thedescriptionrecord componentparameters- the value for theparametersrecord component
-
-
Method Details
-
toString
-
hashCode
-
equals
Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared withObjects::equals(Object,Object). -
name
-
description
Returns the value of thedescriptionrecord component.- Returns:
- the value of the
descriptionrecord component
-
parameters
public com.inductiveautomation.ignition.common.gson.JsonObject parameters()Returns the value of theparametersrecord component.- Returns:
- the value of the
parametersrecord component
-