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

Class ToolAttributes

java.lang.Object

com.oracle.database.selectai.model.agent.ToolAttributes

public final class ToolAttributes
extends Object

Attributes used to create or update a Select AI Agent tool.

toolParams uses immutable ToolParams models, such as SqlToolParams. toolInputs uses an immutable list of ToolInput entries containing input names and descriptions. The builder snapshots both when supplied, so later changes to caller-owned collections cannot change the configuration or JSON sent to the database. Additional tool parameters are preserved when loading database metadata; unrecognized parameter schemas use GenericToolParams. The database validates whether the attributes are semantically valid for the selected tool type and database release.

Since:

1.1.0

See Also:

• CreateToolSample source
• SetToolAttributesSample source
• ToolParamsSample source
• ToolInputSample source
• CreateToolWithInputsSample source
• SetToolInputsSample source

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ToolAttributes.Builder	Builder for ToolAttributes.

Method Summary

Modifier and Type	Method	Description
static ToolAttributes.Builder	builder()	Creates a builder for tool attributes.
String	getFunction()	Returns the custom PL/SQL function or procedure name.
String	getInstruction()	Returns the tool instruction.
List<ToolInput>	getToolInputs()	Returns immutable tool input metadata in the supplied or database order.
ToolParams	getToolParams()	Returns typed built-in tool parameters, including additional database fields.
ToolType	getToolType()	Returns the built-in or database-defined tool type.
String	getToolTypeValue()	Returns the raw database tool type value.
String	toJson()	Serializes attributes using the snake-case names expected by DBMS_CLOUD_AI_AGENT.

Methods inherited from class java.lang.Object

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

Method Details

getInstruction

public String getInstruction()

Returns the tool instruction.

Returns:

tool instruction, or null when unset

See Also:

• LoadToolSample source

getFunction

public String getFunction()

Returns the custom PL/SQL function or procedure name.

Returns:

function or procedure name, or null when unset

See Also:

• LoadToolSample source

getToolType

public ToolType getToolType()

Returns the built-in or database-defined tool type.

The returned ToolType preserves a value introduced by a newer database release, even when this SDK does not yet define a named constant for it.

Returns:

tool type, or null when unset

See Also:

• LoadToolSample source

getToolTypeValue

public String getToolTypeValue()

Returns the raw database tool type value.

Returns:

database tool type value, or null when unset

See Also:

• LoadToolSample source

getToolParams

public ToolParams getToolParams()

Returns typed built-in tool parameters, including additional database fields. Use ToolParams.toMap() for a complete immutable parameter map.

Returns:

immutable tool parameters, or null when unset

See Also:

• LoadToolSample source

getToolInputs

public List<ToolInput> getToolInputs()

Returns immutable tool input metadata in the supplied or database order.

Returns:

immutable tool input metadata, or null when unset

See Also:

• LoadToolSample source
• ToolInputSample source

builder

public static ToolAttributes.Builder builder()

Creates a builder for tool attributes.

Returns:

mutable builder for tool attributes

See Also:

• CreateToolWithInputsSample source

toJson

public String toJson()

Serializes attributes using the snake-case names expected by DBMS_CLOUD_AI_AGENT. Null attributes and unset input fields are omitted; explicit null values inside parameter maps are retained.

Returns:

JSON object containing non-null attributes

Throws:

IllegalStateException - when the attributes cannot be serialized

See Also:

• ToolInputSample source
• ToolParamsSample source