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

Record Class CohereChatBedrockApi.CohereChatRequest

java.lang.Object

java.lang.Record

org.springframework.ai.bedrock.cohere.api.CohereChatBedrockApi.CohereChatRequest

Record Components:

prompt - The input prompt to generate the response from.

temperature - (optional) Use a lower value to decrease randomness in the response.

topP - (optional) Use a lower value to ignore less probable options. Set to 0 or 1.0 to disable.

topK - (optional) Specify the number of token choices the model uses to generate the next token.

maxTokens - (optional) Specify the maximum number of tokens to use in the generated response.

stopSequences - (optional) Configure up to four sequences that the model recognizes. After a stop sequence, the model stops generating further tokens. The returned text doesn't contain the stop sequence.

returnLikelihoods - (optional) Specify how and if the token likelihoods are returned with the response.

stream - (optional) Specify true to return the response piece-by-piece in real-time and false to return the complete response after the process finishes.

numGenerations - (optional) The maximum number of generations that the model should return.

logitBias - (optional) prevents the model from generating unwanted tokens or incentivize the model to include desired tokens. The format is {token_id: bias} where bias is a float between -10 and 10. Tokens can be obtained from text using any tokenization service, such as Cohere’s Tokenize endpoint.

truncate - (optional) Specifies how the API handles inputs longer than the maximum token length.

Enclosing class:

CohereChatBedrockApi

public static record CohereChatBedrockApi.CohereChatRequest(String prompt, Float temperature, Float topP, Integer topK, Integer maxTokens, List<String> stopSequences, CohereChatBedrockApi.CohereChatRequest.ReturnLikelihoods returnLikelihoods, boolean stream, Integer numGenerations, CohereChatBedrockApi.CohereChatRequest.LogitBias logitBias, CohereChatBedrockApi.CohereChatRequest.Truncate truncate)
extends Record

CohereChatRequest encapsulates the request parameters for the Cohere command model.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CohereChatBedrockApi.CohereChatRequest.Builder	Builder for the CohereChatRequest.
static final record	CohereChatBedrockApi.CohereChatRequest.LogitBias	Prevents the model from generating unwanted tokens or incentivize the model to include desired tokens.
static enum	CohereChatBedrockApi.CohereChatRequest.ReturnLikelihoods	(optional) Specify how and if the token likelihoods are returned with the response.
static enum	CohereChatBedrockApi.CohereChatRequest.Truncate	Specifies how the API handles inputs longer than the maximum token length.

Constructor Summary

Constructors

Constructor	Description
CohereChatRequest(String prompt, Float temperature, Float topP, Integer topK, Integer maxTokens, List<String> stopSequences, CohereChatBedrockApi.CohereChatRequest.ReturnLikelihoods returnLikelihoods, boolean stream, Integer numGenerations, CohereChatBedrockApi.CohereChatRequest.LogitBias logitBias, CohereChatBedrockApi.CohereChatRequest.Truncate truncate)	Creates an instance of a CohereChatRequest record class.

Method Summary

Modifier and Type	Method	Description
static CohereChatBedrockApi.CohereChatRequest.Builder	builder(String prompt)	Get CohereChatRequest builder.
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.
CohereChatBedrockApi.CohereChatRequest.LogitBias	logitBias()	Returns the value of the logitBias record component.
Integer	maxTokens()	Returns the value of the maxTokens record component.
Integer	numGenerations()	Returns the value of the numGenerations record component.
String	prompt()	Returns the value of the prompt record component.
CohereChatBedrockApi.CohereChatRequest.ReturnLikelihoods	returnLikelihoods()	Returns the value of the returnLikelihoods record component.
List<String>	stopSequences()	Returns the value of the stopSequences record component.
boolean	stream()	Returns the value of the stream record component.
Float	temperature()	Returns the value of the temperature record component.
Integer	topK()	Returns the value of the topK record component.
Float	topP()	Returns the value of the topP record component.
final String	toString()	Returns a string representation of this record class.
CohereChatBedrockApi.CohereChatRequest.Truncate	truncate()	Returns the value of the truncate record component.

Methods inherited from class java.lang.Object

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

Constructor Details

CohereChatRequest

public CohereChatRequest(String prompt,
 Float temperature,
 Float topP,
 Integer topK,
 Integer maxTokens,
 List<String> stopSequences,
 CohereChatBedrockApi.CohereChatRequest.ReturnLikelihoods returnLikelihoods,
 boolean stream,
 Integer numGenerations,
 CohereChatBedrockApi.CohereChatRequest.LogitBias logitBias,
 CohereChatBedrockApi.CohereChatRequest.Truncate truncate)

Creates an instance of a CohereChatRequest record class.

Parameters:

prompt - the value for the prompt record component

temperature - the value for the temperature record component

topP - the value for the topP record component

topK - the value for the topK record component

maxTokens - the value for the maxTokens record component

stopSequences - the value for the stopSequences record component

returnLikelihoods - the value for the returnLikelihoods record component

stream - the value for the stream record component

numGenerations - the value for the numGenerations record component

logitBias - the value for the logitBias record component

truncate - the value for the truncate record component

Method Details

builder

public static CohereChatBedrockApi.CohereChatRequest.Builder builder(String prompt)

Get CohereChatRequest builder.

Parameters:

prompt - compulsory request prompt parameter.

Returns:

CohereChatRequest builder.

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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

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.

prompt

public String prompt()

Returns the value of the prompt record component.

Returns:

the value of the prompt record component

temperature

public Float temperature()

Returns the value of the temperature record component.

Returns:

the value of the temperature record component

topP

public Float topP()

Returns the value of the topP record component.

Returns:

the value of the topP record component

topK

public Integer topK()

Returns the value of the topK record component.

Returns:

the value of the topK record component

maxTokens

public Integer maxTokens()

Returns the value of the maxTokens record component.

Returns:

the value of the maxTokens record component

stopSequences

public List<String> stopSequences()

Returns the value of the stopSequences record component.

Returns:

the value of the stopSequences record component

returnLikelihoods

public CohereChatBedrockApi.CohereChatRequest.ReturnLikelihoods returnLikelihoods()

Returns the value of the returnLikelihoods record component.

Returns:

the value of the returnLikelihoods record component

stream

public boolean stream()

Returns the value of the stream record component.

Returns:

the value of the stream record component

numGenerations

public Integer numGenerations()

Returns the value of the numGenerations record component.

Returns:

the value of the numGenerations record component

logitBias

public CohereChatBedrockApi.CohereChatRequest.LogitBias logitBias()

Returns the value of the logitBias record component.

Returns:

the value of the logitBias record component

truncate

public CohereChatBedrockApi.CohereChatRequest.Truncate truncate()

Returns the value of the truncate record component.

Returns:

the value of the truncate record component