com.oracle.bmc.generativeaiagent.model

Class SqlToolConfig

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.generativeaiagent.model.ToolConfig

com.oracle.bmc.generativeaiagent.model.SqlToolConfig

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20240531")
public final class SqlToolConfig
extends ToolConfig

The configuration for SQL Tool.
Note: Objects should always be created or deserialized using the SqlToolConfig.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the SqlToolConfig.Builder, which maintain a set of all explicitly set fields called SqlToolConfig.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SqlToolConfig.Builder
static class	SqlToolConfig.Dialect Dialect to be used for SQL generation.
static class	SqlToolConfig.ModelSize Size of the model.

Nested classes/interfaces inherited from class com.oracle.bmc.generativeaiagent.model.ToolConfig

ToolConfig.ToolConfigType

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor and Description
SqlToolConfig(InputLocation iclExamples, InputLocation databaseSchema, Boolean shouldEnableSqlExecution, SqlToolConfig.Dialect dialect, SqlToolConfig.ModelSize modelSize, Boolean shouldEnableSelfCorrection, InputLocation tableAndColumnDescription, LlmCustomization generationLlmCustomization, DatabaseConnection databaseConnection) Deprecated.

Method Summary

Modifier and Type	Method and Description
static SqlToolConfig.Builder	builder() Create a new builder.
boolean	equals(Object o)
DatabaseConnection	getDatabaseConnection()
InputLocation	getDatabaseSchema()
SqlToolConfig.Dialect	getDialect() Dialect to be used for SQL generation.
LlmCustomization	getGenerationLlmCustomization()
InputLocation	getIclExamples()
SqlToolConfig.ModelSize	getModelSize() Size of the model.
Boolean	getShouldEnableSelfCorrection() To enable/disable self correction.
Boolean	getShouldEnableSqlExecution() To enable/disable SQL execution.
InputLocation	getTableAndColumnDescription()
int	hashCode()
SqlToolConfig.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents) Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SqlToolConfig

@Deprecated
public SqlToolConfig(InputLocation iclExamples,
                                 InputLocation databaseSchema,
                                 Boolean shouldEnableSqlExecution,
                                 SqlToolConfig.Dialect dialect,
                                 SqlToolConfig.ModelSize modelSize,
                                 Boolean shouldEnableSelfCorrection,
                                 InputLocation tableAndColumnDescription,
                                 LlmCustomization generationLlmCustomization,
                                 DatabaseConnection databaseConnection)

Deprecated.

Method Detail

builder

public static SqlToolConfig.Builder builder()

Create a new builder.

toBuilder

public SqlToolConfig.Builder toBuilder()

getIclExamples

public InputLocation getIclExamples()

getDatabaseSchema

public InputLocation getDatabaseSchema()

getShouldEnableSqlExecution

public Boolean getShouldEnableSqlExecution()

To enable/disable SQL execution.

Returns:

the value

getDialect

public SqlToolConfig.Dialect getDialect()

Dialect to be used for SQL generation.

Returns:

the value

getModelSize

public SqlToolConfig.ModelSize getModelSize()

Size of the model.

Returns:

the value

getShouldEnableSelfCorrection

public Boolean getShouldEnableSelfCorrection()

To enable/disable self correction.

Returns:

the value

getTableAndColumnDescription

public InputLocation getTableAndColumnDescription()

getGenerationLlmCustomization

public LlmCustomization getGenerationLlmCustomization()

getDatabaseConnection

public DatabaseConnection getDatabaseConnection()

toString

public String toString()

Overrides:

toString in class ToolConfig

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Overrides:

toString in class ToolConfig

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class ToolConfig

hashCode

public int hashCode()

Overrides:

hashCode in class ToolConfig