Package org.springframework.ai.watsonx.api

Record Class WatsonxAiChatResults

java.lang.Object

java.lang.Record

org.springframework.ai.watsonx.api.WatsonxAiChatResults

Record Components:

generatedText - the generated text

generatedTokenCount - the number of tokens generated

inputTokenCount - the number of tokens in the input

stopReason - the reason the generation stopped

public record WatsonxAiChatResults(String generatedText, Integer generatedTokenCount, Integer inputTokenCount, String stopReason)
extends Record

Java class for Watsonx.ai Chat Results object.

Since:

1.0.0

Author:

Pablo Sanchidrian Herrera

Constructor Summary

Constructors

Constructor	Description
WatsonxAiChatResults(String generatedText, Integer generatedTokenCount, Integer inputTokenCount, String stopReason)	Creates an instance of a WatsonxAiChatResults record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
String	generatedText()	Returns the value of the generatedText record component.
Integer	generatedTokenCount()	Returns the value of the generatedTokenCount record component.
final int	hashCode()	Returns a hash code value for this object.
Integer	inputTokenCount()	Returns the value of the inputTokenCount record component.
String	stopReason()	Returns the value of the stopReason 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

WatsonxAiChatResults

public WatsonxAiChatResults(String generatedText,
 Integer generatedTokenCount,
 Integer inputTokenCount,
 String stopReason)

Creates an instance of a WatsonxAiChatResults record class.

Parameters:

generatedText - the value for the generatedText record component

generatedTokenCount - the value for the generatedTokenCount record component

inputTokenCount - the value for the inputTokenCount record component

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

generatedText

public String generatedText()

Returns the value of the generatedText record component.

Returns:

the value of the generatedText record component

generatedTokenCount

public Integer generatedTokenCount()

Returns the value of the generatedTokenCount record component.

Returns:

the value of the generatedTokenCount record component

inputTokenCount

public Integer inputTokenCount()

Returns the value of the inputTokenCount record component.

Returns:

the value of the inputTokenCount record component

stopReason

public String stopReason()

Returns the value of the stopReason record component.

Returns:

the value of the stopReason record component