Package org.springframework.ai.bedrock.cohere

Class BedrockCohereChatOptions

java.lang.Object

org.springframework.ai.bedrock.cohere.BedrockCohereChatOptions

All Implemented Interfaces:

ChatOptions, ModelOptions

public class BedrockCohereChatOptions
extends Object
implements ChatOptions

Options for the Bedrock Cohere chat API.

Since:

0.8.0

Author:

Christian Tzolov, Thomas Vitale, Ilayaperumal Gopinathan

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BedrockCohereChatOptions.Builder

Constructor Summary

Constructors

Constructor	Description
BedrockCohereChatOptions()

Method Summary

Modifier and Type	Method	Description
static BedrockCohereChatOptions.Builder	builder()	Creates a new ChatOptions.Builder to create the default ChatOptions.
BedrockCohereChatOptions	copy()	Returns a copy of this ChatOptions.
static BedrockCohereChatOptions	fromOptions(BedrockCohereChatOptions fromOptions)
Double	getFrequencyPenalty()	Returns the frequency penalty to use for the chat.
CohereChatBedrockApi.CohereChatRequest.LogitBias	getLogitBias()
Integer	getMaxTokens()	Returns the maximum number of tokens to use for the chat.
String	getModel()	Returns the model to use for the chat.
Integer	getNumGenerations()
Double	getPresencePenalty()	Returns the presence penalty to use for the chat.
CohereChatBedrockApi.CohereChatRequest.ReturnLikelihoods	getReturnLikelihoods()
List<String>	getStopSequences()	Returns the stop sequences to use for the chat.
Double	getTemperature()	Returns the temperature to use for the chat.
Integer	getTopK()	Returns the top K to use for the chat.
Double	getTopP()	Returns the top P to use for the chat.
CohereChatBedrockApi.CohereChatRequest.Truncate	getTruncate()
void	setLogitBias(CohereChatBedrockApi.CohereChatRequest.LogitBias logitBias)
void	setMaxTokens(Integer maxTokens)
void	setNumGenerations(Integer numGenerations)
void	setReturnLikelihoods(CohereChatBedrockApi.CohereChatRequest.ReturnLikelihoods returnLikelihoods)
void	setStopSequences(List<String> stopSequences)
void	setTemperature(Double temperature)
void	setTopK(Integer topK)
void	setTopP(Double topP)
void	setTruncate(CohereChatBedrockApi.CohereChatRequest.Truncate truncate)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

BedrockCohereChatOptions

public BedrockCohereChatOptions()

Method Details

builder

public static BedrockCohereChatOptions.Builder builder()

Description copied from interface: ChatOptions

Creates a new ChatOptions.Builder to create the default ChatOptions.

Returns:

Returns a new ChatOptions.Builder.

fromOptions

public static BedrockCohereChatOptions fromOptions(BedrockCohereChatOptions fromOptions)

getTemperature

public Double getTemperature()

Description copied from interface: ChatOptions

Returns the temperature to use for the chat.

Specified by:

getTemperature in interface ChatOptions

Returns:

the temperature to use for the chat

setTemperature

public void setTemperature(Double temperature)

getTopP

public Double getTopP()

Description copied from interface: ChatOptions

Returns the top P to use for the chat.

Specified by:

getTopP in interface ChatOptions

Returns:

the top P to use for the chat

setTopP

public void setTopP(Double topP)

getTopK

public Integer getTopK()

Description copied from interface: ChatOptions

Returns the top K to use for the chat.

Specified by:

getTopK in interface ChatOptions

Returns:

the top K to use for the chat

setTopK

public void setTopK(Integer topK)

getMaxTokens

public Integer getMaxTokens()

Description copied from interface: ChatOptions

Returns the maximum number of tokens to use for the chat.

Specified by:

getMaxTokens in interface ChatOptions

Returns:

the maximum number of tokens to use for the chat

setMaxTokens

public void setMaxTokens(Integer maxTokens)

getStopSequences

public List<String> getStopSequences()

Description copied from interface: ChatOptions

Returns the stop sequences to use for the chat.

Specified by:

getStopSequences in interface ChatOptions

Returns:

the stop sequences to use for the chat

setStopSequences

public void setStopSequences(List<String> stopSequences)

getReturnLikelihoods

public CohereChatBedrockApi.CohereChatRequest.ReturnLikelihoods getReturnLikelihoods()

setReturnLikelihoods

public void setReturnLikelihoods(CohereChatBedrockApi.CohereChatRequest.ReturnLikelihoods returnLikelihoods)

getNumGenerations

public Integer getNumGenerations()

setNumGenerations

public void setNumGenerations(Integer numGenerations)

getLogitBias

public CohereChatBedrockApi.CohereChatRequest.LogitBias getLogitBias()

setLogitBias

public void setLogitBias(CohereChatBedrockApi.CohereChatRequest.LogitBias logitBias)

getTruncate

public CohereChatBedrockApi.CohereChatRequest.Truncate getTruncate()

setTruncate

public void setTruncate(CohereChatBedrockApi.CohereChatRequest.Truncate truncate)

getModel

public String getModel()

Description copied from interface: ChatOptions

Returns the model to use for the chat.

Specified by:

getModel in interface ChatOptions

Returns:

the model to use for the chat

getFrequencyPenalty

public Double getFrequencyPenalty()

Description copied from interface: ChatOptions

Returns the frequency penalty to use for the chat.

Specified by:

getFrequencyPenalty in interface ChatOptions

Returns:

the frequency penalty to use for the chat

getPresencePenalty

public Double getPresencePenalty()

Description copied from interface: ChatOptions

Returns the presence penalty to use for the chat.

Specified by:

getPresencePenalty in interface ChatOptions

Returns:

the presence penalty to use for the chat

copy

public BedrockCohereChatOptions copy()

Description copied from interface: ChatOptions

Returns a copy of this ChatOptions.

Specified by:

copy in interface ChatOptions

Returns:

a copy of this ChatOptions