Package com.oracle.bmc.generativeaiinference.model

Class CompletionTokensDetails

java.lang.Object

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

com.oracle.bmc.generativeaiinference.model.CompletionTokensDetails

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

Breakdown of tokens used in a completion.
Note: Objects should always be created or deserialized using the CompletionTokensDetails.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 CompletionTokensDetails.Builder, which maintain a set of all explicitly set fields called CompletionTokensDetails.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	CompletionTokensDetails.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
CompletionTokensDetails(Integer acceptedPredictionTokens, Integer reasoningTokens, Integer rejectedPredictionTokens)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static CompletionTokensDetails.Builder	builder()	Create a new builder.
boolean	equals(Object o)
Integer	getAcceptedPredictionTokens()	When using Predicted Outputs, the number of tokens in the prediction that appeared in the completion.
Integer	getReasoningTokens()	Tokens generated by the model for reasoning.
Integer	getRejectedPredictionTokens()	When using Predicted Outputs, the number of tokens in the prediction that did not appear in the completion.
int	hashCode()
CompletionTokensDetails.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

CompletionTokensDetails

@Deprecated
@ConstructorProperties({"acceptedPredictionTokens","reasoningTokens","rejectedPredictionTokens"})
public CompletionTokensDetails(Integer acceptedPredictionTokens,
                               Integer reasoningTokens,
                               Integer rejectedPredictionTokens)

Deprecated.

Method Detail

builder

public static CompletionTokensDetails.Builder builder()

Create a new builder.

toBuilder

public CompletionTokensDetails.Builder toBuilder()

getAcceptedPredictionTokens

public Integer getAcceptedPredictionTokens()

When using Predicted Outputs, the number of tokens in the prediction that appeared in the completion.

Returns:

the value

getReasoningTokens

public Integer getReasoningTokens()

Tokens generated by the model for reasoning.

Returns:

the value

getRejectedPredictionTokens

public Integer getRejectedPredictionTokens()

When using Predicted Outputs, the number of tokens in the prediction that did not appear in the completion.

However, like reasoning tokens, these tokens are still counted in the total completion tokens for purposes of billing, output, and context window limits.

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