Package com.sap.ai.sdk.orchestration

Class ToolMessage

java.lang.Object

com.sap.ai.sdk.orchestration.ToolMessage

All Implemented Interfaces:

Message

public final class ToolMessage
extends Object
implements Message

Represents a chat message as 'tool' to the orchestration service.

Since:

1.4.0

Constructor Summary

Constructors

Constructor	Description
ToolMessage(String id, String content)	Constructs ToolMessage object
ToolMessage(String id, String content, CacheControl cacheControl)

Method Summary

Modifier and Type	Method	Description
CacheControl	cacheControl()
MessageContent	content()	Returns the content of the message.
ChatMessage	createChatMessage()	Converts the message to a serializable ChatMessage object.
String	id()
String	role()	The role of the assistant.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ToolMessage

public ToolMessage(@Nonnull
 String id,
 @Nonnull
 String content)

Constructs ToolMessage object

Parameters:

id - tool call id

content - message content

ToolMessage

public ToolMessage(@Nonnull
 String id,
 @Nonnull
 String content,
 @Nullable
 CacheControl cacheControl)

Method Details

content

@Nonnull
public MessageContent content()

Description copied from interface: Message

Returns the content of the message.

Specified by:

content in interface Message

Returns:

the content.

createChatMessage

@Nonnull
public ChatMessage createChatMessage()

Description copied from interface: Message

Converts the message to a serializable ChatMessage object.

Specified by:

createChatMessage in interface Message

Returns:

the corresponding ChatMessage object.

role

@Nonnull
public String role()

The role of the assistant.

Specified by:

role in interface Message

Returns:

the role.

id

@Nonnull
public String id()

cacheControl

@Nullable
public CacheControl cacheControl()