Package com.oracle.database.selectai.model.agent

Class ToolInput

java.lang.Object

com.oracle.database.selectai.model.agent.ToolInput

public final class ToolInput
extends Object

Immutable metadata for one entry in a tool's tool_inputs array.

The name identifies the tool input; the optional description provides instructions to the model. Describing supported values does not enforce those values in Java. The database validates input names and their compatibility with the configured tool. This model describes an input, not the input value passed to Tool.run(...).

Since:

1.1.0

See Also:

• ToolAttributes
• ToolInputSample source
• CreateToolWithInputsSample source
• SetToolInputsSample source

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ToolInput.Builder	Builder for ToolInput; semantic validation is delegated to the database.

Method Summary

Modifier and Type	Method	Description
static ToolInput.Builder	builder()	Creates a builder for tool input metadata.
String	getDescription()	Returns the description supplied to the model, not a validation rule.
String	getName()	Returns the input name without accessing the database.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

getName

public String getName()

Returns the input name without accessing the database.

Returns:

input name, or null when unset

See Also:

• ToolInputSample source

getDescription

public String getDescription()

Returns the description supplied to the model, not a validation rule.

Returns:

input description, or null when unset

See Also:

• ToolInputSample source

builder

public static ToolInput.Builder builder()

Creates a builder for tool input metadata.

Returns:

mutable tool input builder

See Also:

• ToolInputSample source