Package com.oracle.database.selectai.model

Class SyntheticDataParams

java.lang.Object

com.oracle.database.selectai.model.SyntheticDataParams

public final class SyntheticDataParams
extends Object

Parameters for DBMS_CLOUD_AI.GENERATE_SYNTHETIC_DATA.

These parameters control how Select AI samples source table data, uses table statistics, and schedules parallel requests when generating synthetic data.

The SDK performs basic, deterministic validation for values that can be validated independently of Oracle Database. In particular, sampleRows must be between 0 and 100, inclusive, when specified, and priority must be one of HIGH, MEDIUM, or LOW. Invalid values detected by the SDK result in an IllegalArgumentException.

Database-specific, database-version-specific, and other semantic validation is delegated to DBMS_CLOUD_AI and Oracle Database. Therefore, a parameter value that passes SDK validation may still be rejected by the database based on the requested synthetic-data operation or other database-side requirements.

See Also:

• DBMS_CLOUD_AI synthetic data parameters

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	SyntheticDataParams.Builder	Builder for SyntheticDataParams.
static enum	SyntheticDataParams.Priority	Priority values accepted by synthetic data generation parameters.

Method Summary

Modifier and Type	Method	Description
static SyntheticDataParams.Builder	builder()	Creates a builder for synthetic data generation parameters.
Boolean	getComments()	Returns whether table comments are used as generation context.
String	getPriority()	Returns the priority used for synthetic data generation.
Integer	getSampleRows()	Returns the number of table rows sampled to guide synthetic data generation.
Boolean	getTableStatistics()	Returns whether table statistics are used during synthetic data generation.
String	toJson()	Serializes the parameter payload using the snake_case names expected by DBMS_CLOUD_AI.

Methods inherited from class java.lang.Object

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

Method Details

getSampleRows

public Integer getSampleRows()

Returns the number of table rows sampled to guide synthetic data generation.

Returns:

sample-rows value, or null when unset

getTableStatistics

public Boolean getTableStatistics()

Returns whether table statistics are used during synthetic data generation.

Returns:

table-statistics flag, or null when unset

getPriority

public String getPriority()

Returns the priority used for synthetic data generation.

Returns:

priority value (HIGH, MEDIUM, or LOW), or null when unset

getComments

public Boolean getComments()

Returns whether table comments are used as generation context.

Returns:

comments flag, or null when unset

toJson

public String toJson()

Serializes the parameter payload using the snake_case names expected by DBMS_CLOUD_AI.

Returns:

JSON representation of this SyntheticDataParams

Throws:

IllegalStateException - if serialization fails

builder

public static SyntheticDataParams.Builder builder()

Creates a builder for synthetic data generation parameters.

Returns:

new builder for constructing SyntheticDataParams