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

Class UserChatMessage

java.lang.Object

com.sap.ai.sdk.orchestration.model.UserChatMessage

All Implemented Interfaces:

ChatMessage

public class UserChatMessage
extends Object
implements ChatMessage

UserChatMessage

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

UserChatMessage

protected UserChatMessage()

Default constructor for UserChatMessage.

Method Details

content

@Nonnull
public UserChatMessage content(@Nonnull
 UserChatMessageContent content)

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

Parameters:

content - The content of this UserChatMessage

Returns:

The same instance of this UserChatMessage class

getContent

@Nonnull
public UserChatMessageContent getContent()

Get content

Returns:

content The content of this UserChatMessage instance.

setContent

public void setContent(@Nonnull
 UserChatMessageContent content)

Set the content of this UserChatMessage instance.

Parameters:

content - The content of this UserChatMessage

role

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

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

Parameters:

role - The role of this UserChatMessage

Returns:

The same instance of this UserChatMessage class

getRole

@Nonnull
public UserChatMessage.RoleEnum getRole()

Get role

Returns:

role The role of this UserChatMessage instance.

setRole

public void setRole(@Nonnull
 UserChatMessage.RoleEnum role)

Set the role of this UserChatMessage instance.

Parameters:

role - The role of this UserChatMessage

getCustomFieldNames

@Nonnull
public Set<String> getCustomFieldNames()

Get the names of the unrecognizable properties of the UserChatMessage.

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

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