Record Class CompletionPrediction

java.lang.Object

java.lang.Record

smile.llm.CompletionPrediction

Record Components:

model - the model used for the chat completion.

content - the generated text completion.

promptTokens - the list of prompt tokens.

completionTokens - the list of generated tokens.

reason - the finish reason.

logprobs - the optional list of log probabilities of generated tokens.

public record CompletionPrediction(String model, String content, int[] promptTokens, int[] completionTokens, FinishReason reason, float[] logprobs)
extends Record

Prompt completion prediction.

Constructor Summary

Constructors

Constructor	Description
CompletionPrediction(String model, String content, int[] promptTokens, int[] completionTokens, FinishReason reason, float[] logprobs)	Creates an instance of a CompletionPrediction record class.

Method Summary

Modifier and Type	Method	Description
int[]	completionTokens()	Returns the value of the completionTokens record component.
String	content()	Returns the value of the content 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.
float[]	logprobs()	Returns the value of the logprobs record component.
String	model()	Returns the value of the model record component.
int[]	promptTokens()	Returns the value of the promptTokens record component.
FinishReason	reason()	Returns the value of the reason record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Constructor Details

CompletionPrediction

public CompletionPrediction(String model,
 String content,
 int[] promptTokens,
 int[] completionTokens,
 FinishReason reason,
 float[] logprobs)

Creates an instance of a CompletionPrediction record class.

Parameters:

model - the value for the model record component

content - the value for the content record component

promptTokens - the value for the promptTokens record component

completionTokens - the value for the completionTokens record component

reason - the value for the reason record component

logprobs - the value for the logprobs record component

Method Details

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. All components in this record class are compared with Objects::equals(Object,Object).

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.

model

public String model()

Returns the value of the model record component.

Returns:

the value of the model record component

content

public String content()

Returns the value of the content record component.

Returns:

the value of the content record component

promptTokens

public int[] promptTokens()

Returns the value of the promptTokens record component.

Returns:

the value of the promptTokens record component

completionTokens

public int[] completionTokens()

Returns the value of the completionTokens record component.

Returns:

the value of the completionTokens record component

reason

public FinishReason reason()

Returns the value of the reason record component.

Returns:

the value of the reason record component

logprobs

public float[] logprobs()

Returns the value of the logprobs record component.

Returns:

the value of the logprobs record component