Package org.springframework.ai.openai.api

Record Class OpenAiApi.LogProbs

java.lang.Object

java.lang.Record

org.springframework.ai.openai.api.OpenAiApi.LogProbs

Record Components:

content - A list of message content tokens with log probability information.

refusal - A list of message refusal tokens with log probability information.

Enclosing class:

OpenAiApi

public static record OpenAiApi.LogProbs(List<OpenAiApi.LogProbs.Content> content, List<OpenAiApi.LogProbs.Content> refusal)
extends Record

Log probability information for the choice.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	OpenAiApi.LogProbs.Content	Message content tokens with log probability information.

Constructor Summary

Constructors

Constructor	Description
LogProbs(List<OpenAiApi.LogProbs.Content> content, List<OpenAiApi.LogProbs.Content> refusal)	Creates an instance of a LogProbs record class.

Method Summary

Modifier and Type	Method	Description
List<OpenAiApi.LogProbs.Content>	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.
List<OpenAiApi.LogProbs.Content>	refusal()	Returns the value of the refusal record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Constructor Details

LogProbs

public LogProbs(List<OpenAiApi.LogProbs.Content> content,
 List<OpenAiApi.LogProbs.Content> refusal)

Creates an instance of a LogProbs record class.

Parameters:

content - the value for the content record component

refusal - the value for the refusal 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.

content

public List<OpenAiApi.LogProbs.Content> content()

Returns the value of the content record component.

Returns:

the value of the content record component

refusal

public List<OpenAiApi.LogProbs.Content> refusal()

Returns the value of the refusal record component.

Returns:

the value of the refusal record component