Package org.springframework.ai.watsonx

Class WatsonxAiChatOptions

java.lang.Object

org.springframework.ai.watsonx.WatsonxAiChatOptions

All Implemented Interfaces:

ChatOptions, ModelOptions

public class WatsonxAiChatOptions
extends Object
implements ChatOptions

Helper class for creating watsonx.ai options.

Since:

1.0.0

Author:

Pablo Sanchidrian Herrera, John Jairo Moreno Rojas, Thomas Vitale

See Also:

• watsonx.ai valid Parameters and values

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WatsonxAiChatOptions.Builder

Constructor Summary

Constructors

Constructor	Description
WatsonxAiChatOptions()

Method Summary

Modifier and Type	Method	Description
void	addAdditionalProperty(String key, Object value)
static WatsonxAiChatOptions.Builder	builder()
WatsonxAiChatOptions	copy()
static Map<String,Object>	filterNonSupportedFields(Map<String,Object> options)	Filter out the non-supported fields from the options.
static WatsonxAiChatOptions	fromOptions(WatsonxAiChatOptions fromOptions)
Map<String,Object>	getAdditionalProperties()
String	getDecodingMethod()
Double	getFrequencyPenalty()
Integer	getMaxNewTokens()
Integer	getMaxTokens()
Integer	getMinNewTokens()
String	getModel()
Double	getPresencePenalty()
Integer	getRandomSeed()
Double	getRepetitionPenalty()
List<String>	getStopSequences()
Double	getTemperature()
Integer	getTopK()
Double	getTopP()
void	setDecodingMethod(String decodingMethod)
void	setMaxNewTokens(Integer maxNewTokens)
void	setMaxTokens(Integer maxTokens)
void	setMinNewTokens(Integer minNewTokens)
void	setModel(String model)
void	setPresencePenalty(Double presencePenalty)
void	setRandomSeed(Integer randomSeed)
void	setRepetitionPenalty(Double repetitionPenalty)
void	setStopSequences(List<String> stopSequences)
void	setTemperature(Double temperature)
void	setTopK(Integer topK)
void	setTopP(Double topP)
Map<String,Object>	toMap()	Convert the WatsonxAiChatOptions object to a Map of key/value pairs.

Methods inherited from class java.lang.Object

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

Constructor Details

WatsonxAiChatOptions

public WatsonxAiChatOptions()

Method Details

getTemperature

public Double getTemperature()

Specified by:

getTemperature in interface ChatOptions

setTemperature

public void setTemperature(Double temperature)

getTopP

public Double getTopP()

Specified by:

getTopP in interface ChatOptions

setTopP

public void setTopP(Double topP)

getTopK

public Integer getTopK()

Specified by:

getTopK in interface ChatOptions

setTopK

public void setTopK(Integer topK)

getDecodingMethod

public String getDecodingMethod()

setDecodingMethod

public void setDecodingMethod(String decodingMethod)

getMaxTokens

public Integer getMaxTokens()

Specified by:

getMaxTokens in interface ChatOptions

setMaxTokens

public void setMaxTokens(Integer maxTokens)

getMaxNewTokens

public Integer getMaxNewTokens()

setMaxNewTokens

public void setMaxNewTokens(Integer maxNewTokens)

getMinNewTokens

public Integer getMinNewTokens()

setMinNewTokens

public void setMinNewTokens(Integer minNewTokens)

getStopSequences

public List<String> getStopSequences()

Specified by:

getStopSequences in interface ChatOptions

setStopSequences

public void setStopSequences(List<String> stopSequences)

getPresencePenalty

public Double getPresencePenalty()

Specified by:

getPresencePenalty in interface ChatOptions

setPresencePenalty

public void setPresencePenalty(Double presencePenalty)

getRepetitionPenalty

public Double getRepetitionPenalty()

setRepetitionPenalty

public void setRepetitionPenalty(Double repetitionPenalty)

getRandomSeed

public Integer getRandomSeed()

setRandomSeed

public void setRandomSeed(Integer randomSeed)

getModel

public String getModel()

Specified by:

getModel in interface ChatOptions

setModel

public void setModel(String model)

getAdditionalProperties

public Map<String,Object> getAdditionalProperties()

addAdditionalProperty

public void addAdditionalProperty(String key,
 Object value)

getFrequencyPenalty

public Double getFrequencyPenalty()

Specified by:

getFrequencyPenalty in interface ChatOptions

builder

public static WatsonxAiChatOptions.Builder builder()

toMap

public Map<String,Object> toMap()

Convert the WatsonxAiChatOptions object to a Map of key/value pairs.

Returns:

The Map of key/value pairs.

filterNonSupportedFields

public static Map<String,Object> filterNonSupportedFields(Map<String,Object> options)

Filter out the non-supported fields from the options.

Parameters:

options - The options to filter.

Returns:

The filtered options.

copy

public WatsonxAiChatOptions copy()

Specified by:

copy in interface ChatOptions

fromOptions

public static WatsonxAiChatOptions fromOptions(WatsonxAiChatOptions fromOptions)