SummarizerOptions.Builder

  • SummarizerOptions.Builder is a builder class for SummarizerOptions objects.

  • You can use the build() method to create a SummarizerOptions object with the configured parameters.

  • This builder allows setting the input type, language, output type, and whether long input auto truncation is enabled.
public static abstract class SummarizerOptions.Builder extends Object

Builder class for SummarizerOptions objects.

Public Method Summary

abstract SummarizerOptions
build()
Creates a SummarizerOptions with the configured parameters.
abstract SummarizerOptions.Builder
setInputType(int inputType)
Sets the SummarizerOptions.InputType.
abstract SummarizerOptions.Builder
setLanguage(int language)
Sets the SummarizerOptions.Language.
abstract SummarizerOptions.Builder
setLongInputAutoTruncationEnabled(boolean autoTruncationEnabled)
Sets whether auto truncation is enabled for input text.
abstract SummarizerOptions.Builder
setOutputType(int outputType)
Sets the SummarizerOptions.OutputType.

Inherited Method Summary

Public Methods

public abstract SummarizerOptions build ()

Creates a SummarizerOptions with the configured parameters.

public abstract SummarizerOptions.Builder setInputType (int inputType)

Sets the SummarizerOptions.InputType.

The default value is SummarizerOptions.InputType.ARTICLE.

public abstract SummarizerOptions.Builder setLanguage (int language)

Sets the SummarizerOptions.Language.

The default value is SummarizerOptions.Language.ENGLISH.

public abstract SummarizerOptions.Builder setLongInputAutoTruncationEnabled (boolean autoTruncationEnabled)

Sets whether auto truncation is enabled for input text.

When enabled, it automatically shortens the input text, keeping the prefix, if the input exceeds the maximum length allowed for the given combination of input type, output type and language.

By default, auto truncation is disabled. In such case, if input text exceeds limit, an GenAiException with GenAiException.ErrorCode.REQUEST_TOO_LARGE error code is thrown.

public abstract SummarizerOptions.Builder setOutputType (int outputType)

Sets the SummarizerOptions.OutputType.

The default value is SummarizerOptions.OutputType.ONE_BULLET.