com.oracle.bmc.generativeaiinference.model

Class Logprobs

java.lang.Object

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

com.oracle.bmc.generativeaiinference.model.Logprobs

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

Includes the logarithmic probabilities for the most likely output tokens and the chosen tokens.

For example, if the log probability is 5, the API returns a list of the 5 most likely tokens. The API returns the log probability of the sampled token, so there might be up to logprobs+1 elements in the response.
Note: Objects should always be created or deserialized using the Logprobs.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 Logprobs.Builder, which maintain a set of all explicitly set fields called Logprobs.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	Logprobs.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
Logprobs(List<Integer> textOffset, List<Double> tokenLogprobs, List<String> tokens, List<Map<String,String>> topLogprobs) Deprecated.

Method Summary

Modifier and Type	Method and Description
static Logprobs.Builder	builder() Create a new builder.
boolean	equals(Object o)
List<Integer>	getTextOffset() The text offset.
List<Double>	getTokenLogprobs() The logarithmic probabilites of the output token.
List<String>	getTokens() The list of output tokens.
List<Map<String,String>>	getTopLogprobs() The logarithmic probabilities of each of the top k tokens.
int	hashCode()
Logprobs.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

Logprobs

@Deprecated
 @ConstructorProperties(value={"textOffset","tokenLogprobs","tokens","topLogprobs"})
public Logprobs(List<Integer> textOffset,
                                                                                                                 List<Double> tokenLogprobs,
                                                                                                                 List<String> tokens,
                                                                                                                 List<Map<String,String>> topLogprobs)

Deprecated.

Method Detail

builder

public static Logprobs.Builder builder()

Create a new builder.

toBuilder

public Logprobs.Builder toBuilder()

getTextOffset

public List<Integer> getTextOffset()

The text offset.

Returns:

the value

getTokenLogprobs

public List<Double> getTokenLogprobs()

The logarithmic probabilites of the output token.

Returns:

the value

getTokens

public List<String> getTokens()

The list of output tokens.

Returns:

the value

getTopLogprobs

public List<Map<String,String>> getTopLogprobs()

The logarithmic probabilities of each of the top k tokens.

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