Package com.embabel.agent.api.tool
Class Tool.Parameter
-
- All Implemented Interfaces:
public final class Tool.ParameterA single parameter for a tool.
-
-
Field Summary
Fields Modifier and Type Field Description private final Stringnameprivate final Tool.ParameterTypetypeprivate final Stringdescriptionprivate final Booleanrequiredprivate final List<String>enumValuesprivate final List<Tool.Parameter>propertiesprivate final Tool.ParameterTypeitemType
-
Constructor Summary
Constructors Constructor Description Tool.Parameter(String name, Tool.ParameterType type, String description, Boolean required, List<String> enumValues, List<Tool.Parameter> properties, Tool.ParameterType itemType)Tool.Parameter(String name, Tool.ParameterType type, String description, Boolean required, List<String> enumValues, List<Tool.Parameter> properties)Tool.Parameter(String name, Tool.ParameterType type, String description, Boolean required, List<String> enumValues)Tool.Parameter(String name, Tool.ParameterType type, String description, Boolean required)Tool.Parameter(String name, Tool.ParameterType type, String description)Tool.Parameter(String name, Tool.ParameterType type)
-
Method Summary
Modifier and Type Method Description final StringgetName()final Tool.ParameterTypegetType()final StringgetDescription()final BooleangetRequired()final List<String>getEnumValues()final List<Tool.Parameter>getProperties()final Tool.ParameterTypegetItemType()final static Tool.Parameterstring(String name, String description, Boolean required, List<String> enumValues)final static Tool.Parameterstring(String name, String description, Boolean required)final static Tool.Parameterstring(String name, String description)final static Tool.Parameterstring(String name)final static Tool.Parameterinteger(String name, String description, Boolean required, List<String> enumValues)final static Tool.Parameterinteger(String name, String description, Boolean required)final static Tool.Parameterinteger(String name, String description)final static Tool.Parameterinteger(String name)final static Tool.Parameterdouble(String name, String description, Boolean required, List<String> enumValues)final static Tool.Parameterdouble(String name, String description, Boolean required)final static Tool.Parameterdouble(String name, String description)final static Tool.Parameterdouble(String name)-
-
Constructor Detail
-
Tool.Parameter
Tool.Parameter(String name, Tool.ParameterType type, String description, Boolean required, List<String> enumValues, List<Tool.Parameter> properties, Tool.ParameterType itemType)
- Parameters:
name- Parameter nametype- Parameter typedescription- Parameter description.required- Whether the parameter is required.enumValues- Optional list of allowed values (for enum parameters)properties- Nested properties for OBJECT type parametersitemType- Element type for ARRAY type parameters (e.g.
-
Tool.Parameter
Tool.Parameter(String name, Tool.ParameterType type, String description, Boolean required, List<String> enumValues, List<Tool.Parameter> properties)
- Parameters:
name- Parameter nametype- Parameter typedescription- Parameter description.required- Whether the parameter is required.enumValues- Optional list of allowed values (for enum parameters)properties- Nested properties for OBJECT type parameters
-
Tool.Parameter
Tool.Parameter(String name, Tool.ParameterType type, String description, Boolean required, List<String> enumValues)
- Parameters:
name- Parameter nametype- Parameter typedescription- Parameter description.required- Whether the parameter is required.enumValues- Optional list of allowed values (for enum parameters)
-
Tool.Parameter
Tool.Parameter(String name, Tool.ParameterType type, String description, Boolean required)
- Parameters:
name- Parameter nametype- Parameter typedescription- Parameter description.required- Whether the parameter is required.
-
Tool.Parameter
Tool.Parameter(String name, Tool.ParameterType type, String description)
- Parameters:
name- Parameter nametype- Parameter typedescription- Parameter description.
-
Tool.Parameter
Tool.Parameter(String name, Tool.ParameterType type)
- Parameters:
name- Parameter nametype- Parameter type
-
-
Method Detail
-
getType
final Tool.ParameterType getType()
-
getDescription
final String getDescription()
-
getRequired
final Boolean getRequired()
-
getEnumValues
final List<String> getEnumValues()
-
getProperties
final List<Tool.Parameter> getProperties()
-
getItemType
final Tool.ParameterType getItemType()
-
string
@JvmOverloads() final static Tool.Parameter string(String name, String description, Boolean required, List<String> enumValues)
-
string
@JvmOverloads() final static Tool.Parameter string(String name, String description, Boolean required)
-
string
@JvmOverloads() final static Tool.Parameter string(String name, String description)
-
string
@JvmOverloads() final static Tool.Parameter string(String name)
-
integer
@JvmOverloads() final static Tool.Parameter integer(String name, String description, Boolean required, List<String> enumValues)
-
integer
@JvmOverloads() final static Tool.Parameter integer(String name, String description, Boolean required)
-
integer
@JvmOverloads() final static Tool.Parameter integer(String name, String description)
-
integer
@JvmOverloads() final static Tool.Parameter integer(String name)
-
double
@JvmOverloads() final static Tool.Parameter double(String name, String description, Boolean required, List<String> enumValues)
-
double
@JvmOverloads() final static Tool.Parameter double(String name, String description, Boolean required)
-
double
@JvmOverloads() final static Tool.Parameter double(String name, String description)
-
double
@JvmOverloads() final static Tool.Parameter double(String name)
-
-
-
-