Package com.sap.ai.sdk.prompt.registry.model

Class SystemChatMessage

java.lang.Object

com.sap.ai.sdk.prompt.registry.model.SystemChatMessage

All Implemented Interfaces:

ChatMessage

public class SystemChatMessage
extends Object
implements ChatMessage

SystemChatMessage

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SystemChatMessage.Builder	Builder helper class.
static interface	SystemChatMessage.Builder1	Builder helper class.
static enum	SystemChatMessage.RoleEnum	Gets or Sets role

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
SystemChatMessage	content(ChatMessageContent content)	Set the content of this SystemChatMessage instance and return the same instance.
static SystemChatMessage.Builder	create()	Create a type-safe, fluent-api builder object to construct a new SystemChatMessage instance with all required arguments.
boolean	equals(Object o)
ChatMessageContent	getContent()	Get content
Object	getCustomField(String name)	Deprecated. Use toMap() instead.
Set<String>	getCustomFieldNames()	Get the names of the unrecognizable properties of the SystemChatMessage.
SystemChatMessage.RoleEnum	getRole()	Get role
int	hashCode()
SystemChatMessage	role(SystemChatMessage.RoleEnum role)	Set the role of this SystemChatMessage instance and return the same instance.
void	setContent(ChatMessageContent content)	Set the content of this SystemChatMessage instance.
void	setCustomField(String customFieldName, Object customFieldValue)	Set an unrecognizable property of this SystemChatMessage instance.
void	setRole(SystemChatMessage.RoleEnum role)	Set the role of this SystemChatMessage instance.
Map<String,Object>	toMap()	Get the value of all properties of this SystemChatMessage instance including unrecognized properties.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

SystemChatMessage

protected SystemChatMessage()

Default constructor for SystemChatMessage.

Method Details

role

@Nonnull
public SystemChatMessage role(@Nonnull
 SystemChatMessage.RoleEnum role)

Set the role of this SystemChatMessage instance and return the same instance.

Parameters:

role - The role of this SystemChatMessage

Returns:

The same instance of this SystemChatMessage class

getRole

@Nonnull
public SystemChatMessage.RoleEnum getRole()

Get role

Returns:

role The role of this SystemChatMessage instance.

setRole

public void setRole(@Nonnull
 SystemChatMessage.RoleEnum role)

Set the role of this SystemChatMessage instance.

Parameters:

role - The role of this SystemChatMessage

content

@Nonnull
public SystemChatMessage content(@Nonnull
 ChatMessageContent content)

Set the content of this SystemChatMessage instance and return the same instance.

Parameters:

content - The content of this SystemChatMessage

Returns:

The same instance of this SystemChatMessage class

getContent

@Nonnull
public ChatMessageContent getContent()

Get content

Returns:

content The content of this SystemChatMessage instance.

setContent

public void setContent(@Nonnull
 ChatMessageContent content)

Set the content of this SystemChatMessage instance.

Parameters:

content - The content of this SystemChatMessage

getCustomFieldNames

@Nonnull
public Set<String> getCustomFieldNames()

Get the names of the unrecognizable properties of the SystemChatMessage.

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

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