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

Class CompletionRequestConfigurationReferenceById

java.lang.Object

com.sap.ai.sdk.orchestration.model.CompletionRequestConfigurationReferenceById

All Implemented Interfaces:

CompletionPostRequest

public class CompletionRequestConfigurationReferenceById
extends Object
implements CompletionPostRequest

CompletionRequestConfigurationReferenceById

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

CompletionRequestConfigurationReferenceById

protected CompletionRequestConfigurationReferenceById()

Default constructor for CompletionRequestConfigurationReferenceById.

Method Details

configRef

@Nonnull
public CompletionRequestConfigurationReferenceById configRef(@Nonnull
 CompletionRequestConfigurationReferenceByIdConfigRef configRef)

Set the configRef of this CompletionRequestConfigurationReferenceById instance and return the same instance.

Parameters:

configRef - The configRef of this CompletionRequestConfigurationReferenceById

Returns:

The same instance of this CompletionRequestConfigurationReferenceById class

getConfigRef

@Nonnull
public CompletionRequestConfigurationReferenceByIdConfigRef getConfigRef()

Get configRef

Returns:

configRef The configRef of this CompletionRequestConfigurationReferenceById instance.

setConfigRef

public void setConfigRef(@Nonnull
 CompletionRequestConfigurationReferenceByIdConfigRef configRef)

Set the configRef of this CompletionRequestConfigurationReferenceById instance.

Parameters:

configRef - The configRef of this CompletionRequestConfigurationReferenceById

placeholderValues

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

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

Parameters:

placeholderValues - The placeholderValues of this CompletionRequestConfigurationReferenceById

Returns:

The same instance of this CompletionRequestConfigurationReferenceById class

putplaceholderValuesItem

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

Put one placeholderValues instance to this CompletionRequestConfigurationReferenceById 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 CompletionRequestConfigurationReferenceById

getPlaceholderValues

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

Get placeholderValues

Returns:

placeholderValues The placeholderValues of this CompletionRequestConfigurationReferenceById instance.

setPlaceholderValues

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

Set the placeholderValues of this CompletionRequestConfigurationReferenceById instance.

Parameters:

placeholderValues - The placeholderValues of this CompletionRequestConfigurationReferenceById

messagesHistory

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

Set the messagesHistory of this CompletionRequestConfigurationReferenceById 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 CompletionRequestConfigurationReferenceById class

addMessagesHistoryItem

@Nonnull
public CompletionRequestConfigurationReferenceById addMessagesHistoryItem(@Nonnull
 ChatMessage messagesHistoryItem)

Add one messagesHistory instance to this CompletionRequestConfigurationReferenceById.

Parameters:

messagesHistoryItem - The messagesHistory that should be added

Returns:

The same instance of type CompletionRequestConfigurationReferenceById

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 CompletionRequestConfigurationReferenceById instance.

setMessagesHistory

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

Set the messagesHistory of this CompletionRequestConfigurationReferenceById 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 CompletionRequestConfigurationReferenceById.

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 CompletionRequestConfigurationReferenceById 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 CompletionRequestConfigurationReferenceById 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 CompletionRequestConfigurationReferenceById 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 CompletionRequestConfigurationReferenceById.Builder create()

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