Package com.tnsai.planning.llm

Record Class CapabilityDescriptor

java.lang.Object

java.lang.Record

com.tnsai.planning.llm.CapabilityDescriptor

Record Components:

name - unique capability identifier

description - human-readable description of what this capability does

parameters - expected parameter names and their descriptions

tags - tags for categorization

public record CapabilityDescriptor(String name, String description, Map<String,String> parameters, Set<String> tags)
extends Record

Describes an available capability (tool or action) for the LLM planner.

The LLM uses these descriptors to understand what actions are available when decomposing a goal into executable steps.

Since:

0.3.0

See Also:

• LLMDynamicPlanner

Constructor Summary

Constructors

Constructor	Description
CapabilityDescriptor(String name, String description, Map<String,String> parameters, Set<String> tags)	Creates an instance of a CapabilityDescriptor record class.

Method Summary

Modifier and Type	Method	Description
String	description()	Returns the value of the description record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
String	name()	Returns the value of the name record component.
static CapabilityDescriptor	of(String name, String description)	Creates a simple capability with name and description only.
static CapabilityDescriptor	of(String name, String description, Map<String,String> parameters)	Creates a capability with parameters.
Map<String,String>	parameters()	Returns the value of the parameters record component.
Set<String>	tags()	Returns the value of the tags record component.
String	toPromptString()	Formats this capability for inclusion in an LLM prompt.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

CapabilityDescriptor

public CapabilityDescriptor(String name,
 String description,
 Map<String,String> parameters,
 Set<String> tags)

Creates an instance of a CapabilityDescriptor record class.

Parameters:

name - the value for the name record component

description - the value for the description record component

parameters - the value for the parameters record component

tags - the value for the tags record component

Method Details

of

public static CapabilityDescriptor of(String name,
 String description)

Creates a simple capability with name and description only.

of

public static CapabilityDescriptor of(String name,
 String description,
 Map<String,String> parameters)

Creates a capability with parameters.

toPromptString

public String toPromptString()

Formats this capability for inclusion in an LLM prompt.

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

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 with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

name

public String name()

Returns the value of the name record component.

Returns:

the value of the name record component

description

public String description()

Returns the value of the description record component.

Returns:

the value of the description record component

parameters

public Map<String,String> parameters()

Returns the value of the parameters record component.

Returns:

the value of the parameters record component

tags

public Set<String> tags()

Returns the value of the tags record component.

Returns:

the value of the tags record component