Package com.sap.ai.sdk.orchestration

Class Message

java.lang.Object
com.sap.ai.sdk.orchestration.Message
Direct Known Subclasses:
AssistantMessage, SystemMessage, ToolMessage, UserMessage
public abstract class Message extends Object
Contract-representing class for convenience wrappers of chat message to the orchestration service.

  • Method Details

    • user

      @Nonnull public static UserMessage user(@Nonnull String message)
      A convenience method to create a user message from a string.
      Parameters:
      message - the message content.
      Returns:
      the user message.

    • user

      @Nonnull public static UserMessage user(@Nonnull String message, @Nullable CacheControl cacheControl)
      A convenience method to create a user message from a string.
      Parameters:
      message - the message content.
      cacheControl - cache checkpoint configuration.
      Returns:
      the user message.
      Since:
      1.23.0

    • user

      @Nonnull public static UserMessage user(@Nonnull ImageItem imageItem)
      A convenience method to create a user message containing only an image.
      Parameters:
      imageItem - the message content.
      Returns:
      the user message.
      Since:
      1.3.0

    • user

      @Nonnull public static UserMessage user(@Nonnull Path filePath)
      A convenience method to create a user message containing only a file loaded from disk.
      Parameters:
      filePath - the path to a local file.
      Returns:
      the user message.
      Since:
      1.18.0

    • assistant

      @Nonnull public static AssistantMessage assistant(@Nonnull String message)
      A convenience method to create an assistant message.
      Parameters:
      message - the message content.
      Returns:
      the assistant message.

    • system

      @Nonnull public static SystemMessage system(@Nonnull String message)
      A convenience method to create a system message from a string.
      Parameters:
      message - the message content.
      Returns:
      the system message.

    • system

      @Nonnull public static SystemMessage system(@Nonnull String message, @Nullable CacheControl cacheControl)
      A convenience method to create a system message from a string allowing to configure cache checkpoint.
      Parameters:
      message - the message content.
      cacheControl - optional cache checkpoint configuration.
      Returns:
      the system message.
      Since:
      1.23.0

    • role

      @Nonnull public abstract String role()
      Returns the role of the assistant.
      Returns:
      the role.

    • content

      @Nonnull public abstract MessageContent content()
      Returns the content of the message.
      Returns:
      the content.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object