Package org.springframework.ai.bedrock.titan.api

Record Class TitanChatBedrockApi.TitanChatResponseChunk

java.lang.Object

java.lang.Record

org.springframework.ai.bedrock.titan.api.TitanChatBedrockApi.TitanChatResponseChunk

Record Components:

outputText - The generated text in this chunk.

index - The index of the chunk in the streaming response.

inputTextTokenCount - The number of tokens in the prompt.

totalOutputTextTokenCount - The number of tokens in the response.

completionReason - The reason the response finished being generated.

amazonBedrockInvocationMetrics - The metrics for the invocation.

Enclosing class:

TitanChatBedrockApi

public static record TitanChatBedrockApi.TitanChatResponseChunk(String outputText, Integer index, Integer inputTextTokenCount, Integer totalOutputTextTokenCount, TitanChatBedrockApi.TitanChatResponse.CompletionReason completionReason, AbstractBedrockApi.AmazonBedrockInvocationMetrics amazonBedrockInvocationMetrics)
extends Record

Titan chat model streaming response.

Constructor Summary

Constructors

Constructor	Description
TitanChatResponseChunk(String outputText, Integer index, Integer inputTextTokenCount, Integer totalOutputTextTokenCount, TitanChatBedrockApi.TitanChatResponse.CompletionReason completionReason, AbstractBedrockApi.AmazonBedrockInvocationMetrics amazonBedrockInvocationMetrics)	Creates an instance of a TitanChatResponseChunk record class.

Method Summary

Modifier and Type	Method	Description
AbstractBedrockApi.AmazonBedrockInvocationMetrics	amazonBedrockInvocationMetrics()	Returns the value of the amazonBedrockInvocationMetrics record component.
TitanChatBedrockApi.TitanChatResponse.CompletionReason	completionReason()	Returns the value of the completionReason 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.
Integer	index()	Returns the value of the index record component.
Integer	inputTextTokenCount()	Returns the value of the inputTextTokenCount record component.
String	outputText()	Returns the value of the outputText record component.
final String	toString()	Returns a string representation of this record class.
Integer	totalOutputTextTokenCount()	Returns the value of the totalOutputTextTokenCount record component.

Methods inherited from class java.lang.Object

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

Constructor Details

TitanChatResponseChunk

public TitanChatResponseChunk(String outputText,
 Integer index,
 Integer inputTextTokenCount,
 Integer totalOutputTextTokenCount,
 TitanChatBedrockApi.TitanChatResponse.CompletionReason completionReason,
 AbstractBedrockApi.AmazonBedrockInvocationMetrics amazonBedrockInvocationMetrics)

Creates an instance of a TitanChatResponseChunk record class.

Parameters:

outputText - the value for the outputText record component

index - the value for the index record component

inputTextTokenCount - the value for the inputTextTokenCount record component

totalOutputTextTokenCount - the value for the totalOutputTextTokenCount record component

completionReason - the value for the completionReason record component

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

outputText

public String outputText()

Returns the value of the outputText record component.

Returns:

the value of the outputText record component

index

public Integer index()

Returns the value of the index record component.

Returns:

the value of the index record component

inputTextTokenCount

public Integer inputTextTokenCount()

Returns the value of the inputTextTokenCount record component.

Returns:

the value of the inputTextTokenCount record component

totalOutputTextTokenCount

public Integer totalOutputTextTokenCount()

Returns the value of the totalOutputTextTokenCount record component.

Returns:

the value of the totalOutputTextTokenCount record component

completionReason

public TitanChatBedrockApi.TitanChatResponse.CompletionReason completionReason()

Returns the value of the completionReason record component.

Returns:

the value of the completionReason record component

amazonBedrockInvocationMetrics

public AbstractBedrockApi.AmazonBedrockInvocationMetrics amazonBedrockInvocationMetrics()

Returns the value of the amazonBedrockInvocationMetrics record component.

Returns:

the value of the amazonBedrockInvocationMetrics record component