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

Class AssistantChatMessage

java.lang.Object

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

All Implemented Interfaces:

ChatMessage

public class AssistantChatMessage
extends Object
implements ChatMessage

AssistantChatMessage

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
AssistantChatMessage	addToolCallsItem(MessageToolCall toolCallsItem)	Add one toolCalls instance to this AssistantChatMessage.
AssistantChatMessage	content(ChatMessageContent content)	Set the content of this AssistantChatMessage instance and return the same instance.
static AssistantChatMessage.Builder	create()	Create a type-safe, fluent-api builder object to construct a new AssistantChatMessage 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 AssistantChatMessage.
String	getRefusal()	Get refusal
AssistantChatMessage.RoleEnum	getRole()	Get role
List<MessageToolCall>	getToolCalls()	The tool calls generated by the model, such as function calls.
int	hashCode()
AssistantChatMessage	refusal(String refusal)	Set the refusal of this AssistantChatMessage instance and return the same instance.
AssistantChatMessage	role(AssistantChatMessage.RoleEnum role)	Set the role of this AssistantChatMessage instance and return the same instance.
void	setContent(ChatMessageContent content)	Set the content of this AssistantChatMessage instance.
void	setCustomField(String customFieldName, Object customFieldValue)	Set an unrecognizable property of this AssistantChatMessage instance.
void	setRefusal(String refusal)	Set the refusal of this AssistantChatMessage instance.
void	setRole(AssistantChatMessage.RoleEnum role)	Set the role of this AssistantChatMessage instance.
void	setToolCalls(List<MessageToolCall> toolCalls)	Set the toolCalls of this AssistantChatMessage instance.
Map<String,Object>	toMap()	Get the value of all properties of this AssistantChatMessage instance including unrecognized properties.
AssistantChatMessage	toolCalls(List<MessageToolCall> toolCalls)	Set the toolCalls of this AssistantChatMessage instance and return the same instance.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

AssistantChatMessage

protected AssistantChatMessage()

Default constructor for AssistantChatMessage.

Method Details

role

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

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

Parameters:

role - The role of this AssistantChatMessage

Returns:

The same instance of this AssistantChatMessage class

getRole

@Nonnull
public AssistantChatMessage.RoleEnum getRole()

Get role

Returns:

role The role of this AssistantChatMessage instance.

setRole

public void setRole(@Nonnull
 AssistantChatMessage.RoleEnum role)

Set the role of this AssistantChatMessage instance.

Parameters:

role - The role of this AssistantChatMessage

content

@Nonnull
public AssistantChatMessage content(@Nullable
 ChatMessageContent content)

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

Parameters:

content - The content of this AssistantChatMessage

Returns:

The same instance of this AssistantChatMessage class

getContent

@Nonnull
public ChatMessageContent getContent()

Get content

Returns:

content The content of this AssistantChatMessage instance.

setContent

public void setContent(@Nullable
 ChatMessageContent content)

Set the content of this AssistantChatMessage instance.

Parameters:

content - The content of this AssistantChatMessage

refusal

@Nonnull
public AssistantChatMessage refusal(@Nullable
 String refusal)

Set the refusal of this AssistantChatMessage instance and return the same instance.

Parameters:

refusal - The refusal of this AssistantChatMessage

Returns:

The same instance of this AssistantChatMessage class

getRefusal

@Nonnull
public String getRefusal()

Get refusal

Returns:

refusal The refusal of this AssistantChatMessage instance.

setRefusal

public void setRefusal(@Nullable
 String refusal)

Set the refusal of this AssistantChatMessage instance.

Parameters:

refusal - The refusal of this AssistantChatMessage

toolCalls

@Nonnull
public AssistantChatMessage toolCalls(@Nullable
 List<MessageToolCall> toolCalls)

Set the toolCalls of this AssistantChatMessage instance and return the same instance.

Parameters:

toolCalls - The tool calls generated by the model, such as function calls.

Returns:

The same instance of this AssistantChatMessage class

addToolCallsItem

@Nonnull
public AssistantChatMessage addToolCallsItem(@Nonnull
 MessageToolCall toolCallsItem)

Add one toolCalls instance to this AssistantChatMessage.

Parameters:

toolCallsItem - The toolCalls that should be added

Returns:

The same instance of type AssistantChatMessage

getToolCalls

@Nonnull
public List<MessageToolCall> getToolCalls()

The tool calls generated by the model, such as function calls.

Returns:

toolCalls The toolCalls of this AssistantChatMessage instance.

setToolCalls

public void setToolCalls(@Nullable
 List<MessageToolCall> toolCalls)

Set the toolCalls of this AssistantChatMessage instance.

Parameters:

toolCalls - The tool calls generated by the model, such as function calls.

getCustomFieldNames

@Nonnull
public Set<String> getCustomFieldNames()

Get the names of the unrecognizable properties of the AssistantChatMessage.

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

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