Package org.springframework.ai.bedrock.cohere.api

Record Class CohereChatBedrockApi.CohereChatResponse.Generation

java.lang.Object

java.lang.Record

org.springframework.ai.bedrock.cohere.api.CohereChatBedrockApi.CohereChatResponse.Generation

Record Components:

id - An identifier for the generation. (Always returned).

eventType - The type of event that occurred. (Always returned).

likelihood - The likelihood of the output. The value is the average of the token likelihoods in token_likelihoods. Returned if you specify the return_likelihoods input parameter.

tokenLikelihoods - An array of per token likelihoods. Returned if you specify the return_likelihoods input parameter.

finishReason - states the reason why the model finished generating tokens.

isFinished - A boolean field used only when stream is true, signifying whether or not there are additional tokens that will be generated as part of the streaming response. (Not always returned).

text - The generated text.

index - In a streaming response, use to determine which generation a given token belongs to. When only one response is streamed, all tokens belong to the same generation and index is not returned. index therefore is only returned in a streaming request with a value for num_generations that is larger than one.

amazonBedrockInvocationMetrics - Encapsulates the metrics about the model invocation.

Enclosing class:

CohereChatBedrockApi.CohereChatResponse

public static record CohereChatBedrockApi.CohereChatResponse.Generation(String id, String eventType, Float likelihood, List<CohereChatBedrockApi.CohereChatResponse.Generation.TokenLikelihood> tokenLikelihoods, CohereChatBedrockApi.CohereChatResponse.Generation.FinishReason finishReason, Boolean isFinished, String text, Integer index, AbstractBedrockApi.AmazonBedrockInvocationMetrics amazonBedrockInvocationMetrics)
extends Record

Generated result along with the likelihoods for tokens requested.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	CohereChatBedrockApi.CohereChatResponse.Generation.FinishReason	The reason the response finished being generated.
static final record	CohereChatBedrockApi.CohereChatResponse.Generation.TokenLikelihood	Token likelihood.

Constructor Summary

Constructors

Constructor	Description
Generation(String id, String eventType, Float likelihood, List<CohereChatBedrockApi.CohereChatResponse.Generation.TokenLikelihood> tokenLikelihoods, CohereChatBedrockApi.CohereChatResponse.Generation.FinishReason finishReason, Boolean isFinished, String text, Integer index, AbstractBedrockApi.AmazonBedrockInvocationMetrics amazonBedrockInvocationMetrics)	Creates an instance of a Generation record class.

Method Summary

Modifier and Type	Method	Description
AbstractBedrockApi.AmazonBedrockInvocationMetrics	amazonBedrockInvocationMetrics()	Returns the value of the amazonBedrockInvocationMetrics record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
String	eventType()	Returns the value of the eventType record component.
CohereChatBedrockApi.CohereChatResponse.Generation.FinishReason	finishReason()	Returns the value of the finishReason record component.
final int	hashCode()	Returns a hash code value for this object.
String	id()	Returns the value of the id record component.
Integer	index()	Returns the value of the index record component.
Boolean	isFinished()	Returns the value of the isFinished record component.
Float	likelihood()	Returns the value of the likelihood record component.
String	text()	Returns the value of the text record component.
List<CohereChatBedrockApi.CohereChatResponse.Generation.TokenLikelihood>	tokenLikelihoods()	Returns the value of the tokenLikelihoods 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

Generation

public Generation(String id,
 String eventType,
 Float likelihood,
 List<CohereChatBedrockApi.CohereChatResponse.Generation.TokenLikelihood> tokenLikelihoods,
 CohereChatBedrockApi.CohereChatResponse.Generation.FinishReason finishReason,
 Boolean isFinished,
 String text,
 Integer index,
 AbstractBedrockApi.AmazonBedrockInvocationMetrics amazonBedrockInvocationMetrics)

Creates an instance of a Generation record class.

Parameters:

id - the value for the id record component

eventType - the value for the eventType record component

likelihood - the value for the likelihood record component

tokenLikelihoods - the value for the tokenLikelihoods record component

finishReason - the value for the finishReason record component

isFinished - the value for the isFinished record component

text - the value for the text record component

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

id

public String id()

Returns the value of the id record component.

Returns:

the value of the id record component

eventType

public String eventType()

Returns the value of the eventType record component.

Returns:

the value of the eventType record component

likelihood

public Float likelihood()

Returns the value of the likelihood record component.

Returns:

the value of the likelihood record component

tokenLikelihoods

public List<CohereChatBedrockApi.CohereChatResponse.Generation.TokenLikelihood> tokenLikelihoods()

Returns the value of the tokenLikelihoods record component.

Returns:

the value of the tokenLikelihoods record component

finishReason

public CohereChatBedrockApi.CohereChatResponse.Generation.FinishReason finishReason()

Returns the value of the finishReason record component.

Returns:

the value of the finishReason record component

isFinished

public Boolean isFinished()

Returns the value of the isFinished record component.

Returns:

the value of the isFinished record component

text

public String text()

Returns the value of the text record component.

Returns:

the value of the text record component

index

public Integer index()

Returns the value of the index record component.

Returns:

the value of the index record component

amazonBedrockInvocationMetrics

public AbstractBedrockApi.AmazonBedrockInvocationMetrics amazonBedrockInvocationMetrics()

Returns the value of the amazonBedrockInvocationMetrics record component.

Returns:

the value of the amazonBedrockInvocationMetrics record component