Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.inference.results

Record Class StreamingUnifiedChatCompletionResults.ChatCompletionChunk.Usage

java.lang.Object

java.lang.Record

org.elasticsearch.xpack.core.inference.results.StreamingUnifiedChatCompletionResults.ChatCompletionChunk.Usage

All Implemented Interfaces:

Writeable

Enclosing class:

StreamingUnifiedChatCompletionResults.ChatCompletionChunk

public static record StreamingUnifiedChatCompletionResults.ChatCompletionChunk.Usage(int completionTokens, int promptTokens, int totalTokens, Integer cachedTokens, StreamingUnifiedChatCompletionResults.ChatCompletionChunk.Usage.CompletionTokenDetails completionTokenDetails)
extends Record
implements Writeable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	StreamingUnifiedChatCompletionResults.ChatCompletionChunk.Usage.CompletionTokenDetails

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Constructor Summary

Constructors

Constructor	Description
Usage(int completionTokens, int promptTokens, int totalTokens)
Usage(int completionTokens, int promptTokens, int totalTokens, Integer cachedTokens)
Usage(int completionTokens, int promptTokens, int totalTokens, Integer cachedTokens, StreamingUnifiedChatCompletionResults.ChatCompletionChunk.Usage.CompletionTokenDetails completionTokenDetails)	Creates an instance of a Usage record class.

Method Summary

Modifier and Type	Method	Description
Integer	cachedTokens()	Returns the value of the cachedTokens record component.
StreamingUnifiedChatCompletionResults.ChatCompletionChunk.Usage.CompletionTokenDetails	completionTokenDetails()	Returns the value of the completionTokenDetails record component.
int	completionTokens()	Returns the value of the completionTokens record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
int	promptTokens()	Returns the value of the promptTokens record component.
final String	toString()	Returns a string representation of this record class.
int	totalTokens()	Returns the value of the totalTokens record component.
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Usage

public Usage(int completionTokens,
 int promptTokens,
 int totalTokens,
 @Nullable
 Integer cachedTokens)

Usage

public Usage(int completionTokens,
 int promptTokens,
 int totalTokens)

Usage

public Usage(int completionTokens,
 int promptTokens,
 int totalTokens,
 @Nullable
 Integer cachedTokens,
 @Nullable
 StreamingUnifiedChatCompletionResults.ChatCompletionChunk.Usage.CompletionTokenDetails completionTokenDetails)

Creates an instance of a Usage record class.

Parameters:

completionTokens - the value for the completionTokens record component

promptTokens - the value for the promptTokens record component

totalTokens - the value for the totalTokens record component

cachedTokens - the value for the cachedTokens record component

completionTokenDetails - the value for the completionTokenDetails record component

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

completionTokens

public int completionTokens()

Returns the value of the completionTokens record component.

Returns:

the value of the completionTokens record component

promptTokens

public int promptTokens()

Returns the value of the promptTokens record component.

Returns:

the value of the promptTokens record component

totalTokens

public int totalTokens()

Returns the value of the totalTokens record component.

Returns:

the value of the totalTokens record component

cachedTokens

@Nullable
public Integer cachedTokens()

Returns the value of the cachedTokens record component.

Returns:

the value of the cachedTokens record component

completionTokenDetails

@Nullable
public StreamingUnifiedChatCompletionResults.ChatCompletionChunk.Usage.CompletionTokenDetails completionTokenDetails()

Returns the value of the completionTokenDetails record component.

Returns:

the value of the completionTokenDetails record component