Package com.oracle.database.selectai.model

Class SummaryParams

java.lang.Object

com.oracle.database.selectai.model.SummaryParams

public final class SummaryParams
extends Object

Typed parameters payload for DBMS_CLOUD_AI.SUMMARIZE.

This model lets Java callers configure summarization without manually constructing JSON. It serializes to the snake_case names expected by DBMS_CLOUD_AI.SUMMARIZE.

This model represents the JSON payload supplied to the params argument of DBMS_CLOUD_AI.SUMMARIZE. It serializes Java fields to the snake_case names expected by the database, such as min_words, max_words, summary_style, chunk_processing_method, and extractiveness_level.

See Also:

• DBMS_CLOUD_AI summarize parameters

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	SummaryParams.Builder	Builder for SummaryParams.
static enum	SummaryParams.ChunkProcessingMethod	Method used when the source content must be split into chunks.
static enum	SummaryParams.ExtractivenessLevel	Degree to which the generated summary follows source wording.
static enum	SummaryParams.Style	Output format style for the generated summary.

Method Summary

Modifier and Type	Method	Description
static SummaryParams.Builder	builder()	Creates a builder for summarize parameters.
String	getChunkProcessingMethod()	Returns the chunk processing method.
SummaryParams.ChunkProcessingMethod	getChunkProcessingMethodEnum()	Returns the chunk processing method enum.
String	getExtractivenessLevel()	Returns the extractiveness level.
SummaryParams.ExtractivenessLevel	getExtractivenessLevelEnum()	Returns the extractiveness level enum.
Integer	getMaxWords()	Returns the approximate maximum word count.
Integer	getMinWords()	Returns the approximate minimum word count.
String	getSummaryStyle()	Returns the requested summary style.
SummaryParams.Style	getSummaryStyleEnum()	Returns the requested summary style enum.
String	toJson()	Serializes the parameters using DBMS_CLOUD_AI snake_case JSON names.

Methods inherited from class java.lang.Object

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

Method Details

builder

public static SummaryParams.Builder builder()

Creates a builder for summarize parameters.

Returns:

new builder

getMinWords

public Integer getMinWords()

Returns the approximate minimum word count.

Returns:

minimum word count, or null when unset

getMaxWords

public Integer getMaxWords()

Returns the approximate maximum word count.

Returns:

maximum word count, or null when unset

getSummaryStyle

public String getSummaryStyle()

Returns the requested summary style.

Returns:

summary style, or null when unset

getSummaryStyleEnum

public SummaryParams.Style getSummaryStyleEnum()

Returns the requested summary style enum.

Returns:

summary style enum, or null when unset

getChunkProcessingMethod

public String getChunkProcessingMethod()

Returns the chunk processing method.

Returns:

chunk processing method, or null when unset

getChunkProcessingMethodEnum

public SummaryParams.ChunkProcessingMethod getChunkProcessingMethodEnum()

Returns the chunk processing method enum.

Returns:

chunk processing method enum, or null when unset

getExtractivenessLevel

public String getExtractivenessLevel()

Returns the extractiveness level.

Returns:

extractiveness level, or null when unset

getExtractivenessLevelEnum

public SummaryParams.ExtractivenessLevel getExtractivenessLevelEnum()

Returns the extractiveness level enum.

Returns:

extractiveness level enum, or null when unset

toJson

public String toJson()

Serializes the parameters using DBMS_CLOUD_AI snake_case JSON names.

Returns:

JSON representation of this SummaryParams instance