com.oracle.bmc.generativeaiinference.model

Class GeneratedText

java.lang.Object

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

com.oracle.bmc.generativeaiinference.model.GeneratedText

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

The text generated during each run.
Note: Objects should always be created or deserialized using the GeneratedText.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 GeneratedText.Builder, which maintain a set of all explicitly set fields called GeneratedText.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	GeneratedText.Builder

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
GeneratedText(String id, String text, Double likelihood, String finishReason, List<TokenLikelihood> tokenLikelihoods) Deprecated.

Method Summary

Modifier and Type	Method and Description
static GeneratedText.Builder	builder() Create a new builder.
boolean	equals(Object o)
String	getFinishReason() The reason why the model stopped generating tokens.
String	getId() A unique identifier for this text generation.
Double	getLikelihood() The overall likelihood of the generated text.
String	getText() The generated text.
List<TokenLikelihood>	getTokenLikelihoods() A collection of generated tokens and their corresponding likelihoods.
int	hashCode()
GeneratedText.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

GeneratedText

@Deprecated
 @ConstructorProperties(value={"id","text","likelihood","finishReason","tokenLikelihoods"})
public GeneratedText(String id,
                                                                                                                             String text,
                                                                                                                             Double likelihood,
                                                                                                                             String finishReason,
                                                                                                                             List<TokenLikelihood> tokenLikelihoods)

Deprecated.

Method Detail

builder

public static GeneratedText.Builder builder()

Create a new builder.

toBuilder

public GeneratedText.Builder toBuilder()

getId

public String getId()

A unique identifier for this text generation.

Returns:

the value

getText

public String getText()

The generated text.

Returns:

the value

getLikelihood

public Double getLikelihood()

The overall likelihood of the generated text.

When a large language model generates a new token for the output text, a likelihood is assigned to all tokens, where tokens with higher likelihoods are more likely to follow the current token. For example, it's more likely that the word favorite is followed by the word food or book rather than the word zebra. A lower likelihood means that it's less likely that token follows the current token.

Returns:

the value

getFinishReason

public String getFinishReason()

The reason why the model stopped generating tokens.

A model stops generating tokens if the model hits a natural stop point or reaches a provided stop sequence.

Returns:

the value

getTokenLikelihoods

public List<TokenLikelihood> getTokenLikelihoods()

A collection of generated tokens and their corresponding likelihoods.

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