Package com.oracle.bmc.generativeaiinference.model

Class Usage

java.lang.Object

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

com.oracle.bmc.generativeaiinference.model.Usage

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

Usage statistics for the completion request.
Note: Objects should always be created or deserialized using the Usage.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 Usage.Builder, which maintain a set of all explicitly set fields called Usage.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	Usage.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
Usage(Integer completionTokens, Integer promptTokens, Integer totalTokens, CompletionTokensDetails completionTokensDetails, PromptTokensDetails promptTokensDetails)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static Usage.Builder	builder()	Create a new builder.
boolean	equals(Object o)
Integer	getCompletionTokens()	Number of tokens in the generated completion.
CompletionTokensDetails	getCompletionTokensDetails()
Integer	getPromptTokens()	Number of tokens in the prompt.
PromptTokensDetails	getPromptTokensDetails()
Integer	getTotalTokens()	Total number of tokens used in the request (prompt + completion).
int	hashCode()
Usage.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

Usage

@Deprecated
@ConstructorProperties({"completionTokens","promptTokens","totalTokens","completionTokensDetails","promptTokensDetails"})
public Usage(Integer completionTokens,
             Integer promptTokens,
             Integer totalTokens,
             CompletionTokensDetails completionTokensDetails,
             PromptTokensDetails promptTokensDetails)

Deprecated.

Method Detail

builder

public static Usage.Builder builder()

Create a new builder.

toBuilder

public Usage.Builder toBuilder()

getCompletionTokens

public Integer getCompletionTokens()

Number of tokens in the generated completion.

Returns:

the value

getPromptTokens

public Integer getPromptTokens()

Number of tokens in the prompt.

Returns:

the value

getTotalTokens

public Integer getTotalTokens()

Total number of tokens used in the request (prompt + completion).

Returns:

the value

getCompletionTokensDetails

public CompletionTokensDetails getCompletionTokensDetails()

getPromptTokensDetails

public PromptTokensDetails getPromptTokensDetails()

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