com.oracle.bmc.generativeaiinference.model

Class SummarizeTextDetails.Builder

java.lang.Object

com.oracle.bmc.generativeaiinference.model.SummarizeTextDetails.Builder

Enclosing class:

SummarizeTextDetails

public static class SummarizeTextDetails.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
SummarizeTextDetails.Builder	additionalCommand(String additionalCommand) A free-form instruction for modifying how the summaries get generated.
SummarizeTextDetails	build()
SummarizeTextDetails.Builder	compartmentId(String compartmentId) The OCID of compartment in which to call the Generative AI service to summarize text.
SummarizeTextDetails.Builder	copy(SummarizeTextDetails model)
SummarizeTextDetails.Builder	extractiveness(SummarizeTextDetails.Extractiveness extractiveness) Controls how close to the original text the summary is.
SummarizeTextDetails.Builder	format(SummarizeTextDetails.Format format) Indicates the style in which the summary will be delivered - in a free form paragraph or in bullet points.
SummarizeTextDetails.Builder	input(String input) The input string to be summarized.
SummarizeTextDetails.Builder	isEcho(Boolean isEcho) Whether or not to include the original inputs in the response.
SummarizeTextDetails.Builder	length(SummarizeTextDetails.Length length) Indicates the approximate length of the summary.
SummarizeTextDetails.Builder	servingMode(ServingMode servingMode)
SummarizeTextDetails.Builder	temperature(Double temperature) A number that sets the randomness of the generated output.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

input

public SummarizeTextDetails.Builder input(String input)

The input string to be summarized.

Parameters:

input - the value to set

Returns:

this builder

servingMode

public SummarizeTextDetails.Builder servingMode(ServingMode servingMode)

compartmentId

public SummarizeTextDetails.Builder compartmentId(String compartmentId)

The OCID of compartment in which to call the Generative AI service to summarize text.

Parameters:

compartmentId - the value to set

Returns:

this builder

isEcho

public SummarizeTextDetails.Builder isEcho(Boolean isEcho)

Whether or not to include the original inputs in the response.

Parameters:

isEcho - the value to set

Returns:

this builder

temperature

public SummarizeTextDetails.Builder temperature(Double temperature)

A number that sets the randomness of the generated output. Lower temperatures mean less random generations.

Use lower numbers for tasks with a correct answer such as question answering or summarizing. High temperatures can generate hallucinations or factually incorrect information. Start with temperatures lower than 1.0, and increase the temperature for more creative outputs, as you regenerate the prompts to refine the outputs.

Parameters:

temperature - the value to set

Returns:

this builder

additionalCommand

public SummarizeTextDetails.Builder additionalCommand(String additionalCommand)

A free-form instruction for modifying how the summaries get generated. Should complete the sentence “Generate a summary _”. For example, “focusing on the next steps” or “written by Yoda”.

Parameters:

additionalCommand - the value to set

Returns:

this builder

length

public SummarizeTextDetails.Builder length(SummarizeTextDetails.Length length)

Indicates the approximate length of the summary. If “AUTO” is selected, the best option will be picked based on the input text.

Parameters:

length - the value to set

Returns:

this builder

format

public SummarizeTextDetails.Builder format(SummarizeTextDetails.Format format)

Indicates the style in which the summary will be delivered - in a free form paragraph or in bullet points. If “AUTO” is selected, the best option will be picked based on the input text.

Parameters:

format - the value to set

Returns:

this builder

extractiveness

public SummarizeTextDetails.Builder extractiveness(SummarizeTextDetails.Extractiveness extractiveness)

Controls how close to the original text the summary is. High extractiveness summaries will lean towards reusing sentences verbatim, while low extractiveness summaries will tend to paraphrase more.

Parameters:

extractiveness - the value to set

Returns:

this builder

build

public SummarizeTextDetails build()

copy

public SummarizeTextDetails.Builder copy(SummarizeTextDetails model)