Package com.sap.ai.sdk.orchestration.model

Class CompletionRequestConfiguration

java.lang.Object

com.sap.ai.sdk.orchestration.model.CompletionRequestConfiguration

All Implemented Interfaces:

CompletionPostRequest

public class CompletionRequestConfiguration
extends Object
implements CompletionPostRequest

CompletionRequestConfiguration

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CompletionRequestConfiguration.Builder	Builder helper class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CompletionRequestConfiguration()	Default constructor for CompletionRequestConfiguration.

Method Summary

Modifier and Type	Method	Description
CompletionRequestConfiguration	addMessagesHistoryItem(ChatMessage messagesHistoryItem)	Add one messagesHistory instance to this CompletionRequestConfiguration.
CompletionRequestConfiguration	config(OrchestrationConfig config)	Set the config of this CompletionRequestConfiguration instance and return the same instance.
static CompletionRequestConfiguration.Builder	create()	Create a type-safe, fluent-api builder object to construct a new CompletionRequestConfiguration instance with all required arguments.
boolean	equals(Object o)
OrchestrationConfig	getConfig()	Get config
Object	getCustomField(String name)	Deprecated. Use toMap() instead.
Set<String>	getCustomFieldNames()	Get the names of the unrecognizable properties of the CompletionRequestConfiguration.
List<ChatMessage>	getMessagesHistory()	History of chat messages.
Map<String,String>	getPlaceholderValues()	Get placeholderValues
int	hashCode()
CompletionRequestConfiguration	messagesHistory(List<ChatMessage> messagesHistory)	Set the messagesHistory of this CompletionRequestConfiguration instance and return the same instance.
CompletionRequestConfiguration	placeholderValues(Map<String,String> placeholderValues)	Set the placeholderValues of this CompletionRequestConfiguration instance and return the same instance.
CompletionRequestConfiguration	putplaceholderValuesItem(String key, String placeholderValuesItem)	Put one placeholderValues instance to this CompletionRequestConfiguration instance.
void	setConfig(OrchestrationConfig config)	Set the config of this CompletionRequestConfiguration instance.
void	setCustomField(String customFieldName, Object customFieldValue)	Set an unrecognizable property of this CompletionRequestConfiguration instance.
void	setMessagesHistory(List<ChatMessage> messagesHistory)	Set the messagesHistory of this CompletionRequestConfiguration instance.
void	setPlaceholderValues(Map<String,String> placeholderValues)	Set the placeholderValues of this CompletionRequestConfiguration instance.
Map<String,Object>	toMap()	Get the value of all properties of this CompletionRequestConfiguration instance including unrecognized properties.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

CompletionRequestConfiguration

protected CompletionRequestConfiguration()

Default constructor for CompletionRequestConfiguration.

Method Details

config

@Nonnull
public CompletionRequestConfiguration config(@Nonnull
 OrchestrationConfig config)

Set the config of this CompletionRequestConfiguration instance and return the same instance.

Parameters:

config - The config of this CompletionRequestConfiguration

Returns:

The same instance of this CompletionRequestConfiguration class

getConfig

@Nonnull
public OrchestrationConfig getConfig()

Get config

Returns:

config The config of this CompletionRequestConfiguration instance.

setConfig

public void setConfig(@Nonnull
 OrchestrationConfig config)

Set the config of this CompletionRequestConfiguration instance.

Parameters:

config - The config of this CompletionRequestConfiguration

placeholderValues

@Nonnull
public CompletionRequestConfiguration placeholderValues(@Nullable
 Map<String,String> placeholderValues)

Set the placeholderValues of this CompletionRequestConfiguration instance and return the same instance.

Parameters:

placeholderValues - The placeholderValues of this CompletionRequestConfiguration

Returns:

The same instance of this CompletionRequestConfiguration class

putplaceholderValuesItem

@Nonnull
public CompletionRequestConfiguration putplaceholderValuesItem(@Nonnull
 String key,
 @Nonnull
 String placeholderValuesItem)

Put one placeholderValues instance to this CompletionRequestConfiguration instance.

Parameters:

key - The String key of this placeholderValues instance

placeholderValuesItem - The placeholderValues that should be added under the given key

Returns:

The same instance of type CompletionRequestConfiguration

getPlaceholderValues

@Nonnull
public Map<String,String> getPlaceholderValues()

Get placeholderValues

Returns:

placeholderValues The placeholderValues of this CompletionRequestConfiguration instance.

setPlaceholderValues

public void setPlaceholderValues(@Nullable
 Map<String,String> placeholderValues)

Set the placeholderValues of this CompletionRequestConfiguration instance.

Parameters:

placeholderValues - The placeholderValues of this CompletionRequestConfiguration

messagesHistory

@Nonnull
public CompletionRequestConfiguration messagesHistory(@Nullable
 List<ChatMessage> messagesHistory)

Set the messagesHistory of this CompletionRequestConfiguration instance and return the same instance.

Parameters:

messagesHistory - History of chat messages. Can be used to provide system and assistant messages to set the context of the conversation. Will be merged with the template message

Returns:

The same instance of this CompletionRequestConfiguration class

addMessagesHistoryItem

@Nonnull
public CompletionRequestConfiguration addMessagesHistoryItem(@Nonnull
 ChatMessage messagesHistoryItem)

Add one messagesHistory instance to this CompletionRequestConfiguration.

Parameters:

messagesHistoryItem - The messagesHistory that should be added

Returns:

The same instance of type CompletionRequestConfiguration

getMessagesHistory

@Nonnull
public List<ChatMessage> getMessagesHistory()

History of chat messages. Can be used to provide system and assistant messages to set the context of the conversation. Will be merged with the template message

Returns:

messagesHistory The messagesHistory of this CompletionRequestConfiguration instance.

setMessagesHistory

public void setMessagesHistory(@Nullable
 List<ChatMessage> messagesHistory)

Set the messagesHistory of this CompletionRequestConfiguration instance.

Parameters:

messagesHistory - History of chat messages. Can be used to provide system and assistant messages to set the context of the conversation. Will be merged with the template message

getCustomFieldNames

@Nonnull
public Set<String> getCustomFieldNames()

Get the names of the unrecognizable properties of the CompletionRequestConfiguration.

Returns:

The set of properties names

getCustomField

@Nullable
@Deprecated
public Object getCustomField(@Nonnull
 String name)
                      throws NoSuchElementException

Deprecated.

Use toMap() instead.

Get the value of an unrecognizable property of this CompletionRequestConfiguration instance.

Parameters:

name - The name of the property

Returns:

The value of the property

Throws:

NoSuchElementException - If no property with the given name could be found.

toMap

@Nonnull
public Map<String,Object> toMap()

Get the value of all properties of this CompletionRequestConfiguration instance including unrecognized properties.

Returns:

The map of all properties

setCustomField

public void setCustomField(@Nonnull
 String customFieldName,
 @Nullable
 Object customFieldValue)

Set an unrecognizable property of this CompletionRequestConfiguration instance. If the map previously contained a mapping for the key, the old value is replaced by the specified value.

Parameters:

customFieldName - The name of the property

customFieldValue - The value of the property

equals

public boolean equals(@Nullable
 Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

@Nonnull
public String toString()

Overrides:

toString in class Object

create

public static CompletionRequestConfiguration.Builder create()

Create a type-safe, fluent-api builder object to construct a new CompletionRequestConfiguration instance with all required arguments.