com.oracle.bmc.generativeaiinference.model

Class SummarizeTextDetails

java.lang.Object

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

com.oracle.bmc.generativeaiinference.model.SummarizeTextDetails

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20231130")
public final class SummarizeTextDetails
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Details for the request to summarize text.
Note: Objects should always be created or deserialized using the SummarizeTextDetails.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 SummarizeTextDetails.Builder, which maintain a set of all explicitly set fields called SummarizeTextDetails.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	SummarizeTextDetails.Builder
static class	SummarizeTextDetails.Extractiveness Controls how close to the original text the summary is.
static class	SummarizeTextDetails.Format Indicates the style in which the summary will be delivered - in a free form paragraph or in bullet points.
static class	SummarizeTextDetails.Length Indicates the approximate length of the summary.

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
SummarizeTextDetails(String input, ServingMode servingMode, String compartmentId, Boolean isEcho, Double temperature, String additionalCommand, SummarizeTextDetails.Length length, SummarizeTextDetails.Format format, SummarizeTextDetails.Extractiveness extractiveness) Deprecated.

Method Summary

Modifier and Type	Method and Description
static SummarizeTextDetails.Builder	builder() Create a new builder.
boolean	equals(Object o)
String	getAdditionalCommand() A free-form instruction for modifying how the summaries get generated.
String	getCompartmentId() The OCID of compartment that the user is authorized to use to call into the Generative AI service.
SummarizeTextDetails.Extractiveness	getExtractiveness() Controls how close to the original text the summary is.
SummarizeTextDetails.Format	getFormat() Indicates the style in which the summary will be delivered - in a free form paragraph or in bullet points.
String	getInput() The input string to be summarized.
Boolean	getIsEcho() Whether or not to include the original inputs in the response.
SummarizeTextDetails.Length	getLength() Indicates the approximate length of the summary.
ServingMode	getServingMode()
Double	getTemperature() A number that sets the randomness of the generated output.
int	hashCode()
SummarizeTextDetails.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

SummarizeTextDetails

@Deprecated
 @ConstructorProperties(value={"input","servingMode","compartmentId","isEcho","temperature","additionalCommand","length","format","extractiveness"})
public SummarizeTextDetails(String input,
                                                                                                                                                                                             ServingMode servingMode,
                                                                                                                                                                                             String compartmentId,
                                                                                                                                                                                             Boolean isEcho,
                                                                                                                                                                                             Double temperature,
                                                                                                                                                                                             String additionalCommand,
                                                                                                                                                                                             SummarizeTextDetails.Length length,
                                                                                                                                                                                             SummarizeTextDetails.Format format,
                                                                                                                                                                                             SummarizeTextDetails.Extractiveness extractiveness)

Deprecated.

Method Detail

builder

public static SummarizeTextDetails.Builder builder()

Create a new builder.

toBuilder

public SummarizeTextDetails.Builder toBuilder()

getInput

public String getInput()

The input string to be summarized.

Returns:

the value

getServingMode

public ServingMode getServingMode()

getCompartmentId

public String getCompartmentId()

The OCID of compartment that the user is authorized to use to call into the Generative AI service.

Returns:

the value

getIsEcho

public Boolean getIsEcho()

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

Returns:

the value

getTemperature

public Double getTemperature()

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.

Returns:

the value

getAdditionalCommand

public String getAdditionalCommand()

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”.

Returns:

the value

getLength

public SummarizeTextDetails.Length getLength()

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

Returns:

the value

getFormat

public SummarizeTextDetails.Format getFormat()

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.

Returns:

the value

getExtractiveness

public SummarizeTextDetails.Extractiveness getExtractiveness()

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.

Returns:

the value

toString

public String toString()

Overrides:

toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel