ToolDetail.ToolParameterDetail

public final class ToolDetail.ToolParameterDetail


Details of a single parameter of a tool method.

Summary

Public constructors

ToolParameterDetail(
    @NonNull String name,
    @NonNull KClass<@NonNull ?> type,
    String description,
    boolean required
)

Public methods

final String

Description of the parameter.

final @NonNull String

The name of the parameter.

final boolean

Whether the parameter is required.

final @NonNull KClass<@NonNull ?>

The class type of the parameter.

Public constructors

ToolParameterDetail

public ToolParameterDetail(
    @NonNull String name,
    @NonNull KClass<@NonNull ?> type,
    String description,
    boolean required
)

Public methods

getDescription

public final String getDescription()

Description of the parameter.

getName

public final @NonNull String getName()

The name of the parameter.

getRequired

public final boolean getRequired()

Whether the parameter is required.

getType

public final @NonNull KClass<@NonNull ?> getType()

The class type of the parameter.