Package com.oracle.bmc.generativeaiinference.model

Class TokenLikelihood

java.lang.Object

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

com.oracle.bmc.generativeaiinference.model.TokenLikelihood

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

An object that contains the returned token and its corresponding likelihood.
Note: Objects should always be created or deserialized using the TokenLikelihood.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 TokenLikelihood.Builder, which maintain a set of all explicitly set fields called TokenLikelihood.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	Description
static class	TokenLikelihood.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	Description
TokenLikelihood(String token, Double likelihood)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static TokenLikelihood.Builder	builder()	Create a new builder.
boolean	equals(Object o)
Double	getLikelihood()	The likelihood of this token during generation.
String	getToken()	A word, part of a word, or a punctuation.
int	hashCode()
TokenLikelihood.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

TokenLikelihood

@Deprecated
@ConstructorProperties({"token","likelihood"})
public TokenLikelihood(String token,
                       Double likelihood)

Deprecated.

Method Detail

builder

public static TokenLikelihood.Builder builder()

Create a new builder.

toBuilder

public TokenLikelihood.Builder toBuilder()

getToken

public String getToken()

A word, part of a word, or a punctuation.

For example, apple is a token and friendship is made up of two tokens, friend and ship. When you run a model, you can set the maximum number of output tokens. Estimate three tokens per word.

Returns:

the value

getLikelihood

public Double getLikelihood()

The likelihood of this token during generation.

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