Package de.espirit.firstspirit.ai.dto

Interface Message

@Experimental public interface Message
A specific message in the context of a generative AI request.
Since:
5.2.240708

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    Message.Builder
    Builder for a message object.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    ASSISTANT
    Typical role for a prompt/response from the generative AI.
    static final String
    SYSTEM
    Typical role for a system prompt.
    static final String
    TOOL
    Typical role for a tool invocation.
    static final String
    USER
    Typical role for a user prompt.

  • Method Summary

    Modifier and Type
    Method
    Description
    static @NotNull Message.Builder
    builder()
    Creates a new builder for creating message object.
    static @NotNull Message
    create(@NotNull String role, @NotNull String text)
    Creates a new text message.
    @NotNull List<MessagePart>
    getContent()
    Returns the message content parts.
    default <T extends MessagePart>
    @NotNull Stream<T>
    getContent(@NotNull Class<T> type)
    Returns the message content object.
    @NotNull Optional<Integer>
    getIndex()
    Returns the index of a choice in the context of a response stream.
    @NotNull String
    getRole()
    Returns the configured role of the message author.
    default @NotNull Optional<String>
    getText()
    Returns textual content of this message, if available.
    @NotNull Optional<String>
    getToolCallId()
    Reference to a specific previously requested ToolCall this message contains a response for.
    @NotNull List<ToolCall>
    getToolCalls()
    Returns a list of tools as part of an AI response, which are expected to be evaluated by the requester.

  • Field Details

  • Method Details

    • builder

      @NotNull static @NotNull Message.Builder builder()
      Creates a new builder for creating message object.
      Returns:
      The new builder instance.
      Since:
      5.2.240708

    • create

      @NotNull static @NotNull Message create(@NotNull @NotNull String role, @NotNull @NotNull String text)
      Creates a new text message.
      Parameters:
      role - The role of the author (e.g. "user").
      text - The message text.
      Returns:
      The new message object.
      Since:
      5.2.240708

    • getRole

      @NotNull @NotNull String getRole()
      Returns the configured role of the message author. Any implementation of a GenerativeAIConnectorPlugin is encouraged to support common roles like "user", "system" and "assistant", if possible. This allows users of the GenerativeAIAgent do be as generic as possible.
      Returns:
      The message role.
      Since:
      5.2.240708

    • getContent

      @NotNull @NotNull List<MessagePart> getContent()
      Returns the message content parts.
      Returns:
      The message content.
      Since:
      5.2.240708

    • getContent

      @NotNull default <T extends MessagePart> @NotNull Stream<T> getContent(@NotNull @NotNull Class<T> type)
      Returns the message content object.
      Returns:
      The message content.
      Since:
      5.2.240708

    • getText

      @NotNull default @NotNull Optional<String> getText()
      Returns textual content of this message, if available.
      Returns:
      The message content as text, or empty.
      Since:
      5.2.240708

    • getToolCalls

      @NotNull @NotNull List<ToolCall> getToolCalls()
      Returns a list of tools as part of an AI response, which are expected to be evaluated by the requester.
      Returns:
      The requested tool calls.
      Since:
      5.2.250908

    • getToolCallId

      @NotNull @NotNull Optional<String> getToolCallId()
      Reference to a specific previously requested ToolCall this message contains a response for.
      Returns:
      The associated ToolCall identifier, if available.
      Since:
      5.2.250908

    • getIndex

      @NotNull @NotNull Optional<Integer> getIndex()
      Returns the index of a choice in the context of a response stream.
      Returns:
      The index of the choice this message is associated with, if specified.
      Since:
      5.2.250908