Package com.psddev.ai.chat

Class Prompt

java.lang.Object
com.psddev.dari.db.Record
com.psddev.ai.chat.Message
com.psddev.ai.chat.Prompt
All Implemented Interfaces:
com.psddev.dari.db.Recordable, com.psddev.dari.util.HtmlObject, BeanInfo, Cloneable, Comparable<com.psddev.dari.db.Record>
public class Prompt extends Message
Represents a user-generated prompt message in a chat conversation.

This class encapsulates messages that originate from human users as part of their interaction with AI assistants. Prompts typically contain questions, requests, instructions, or other input that the user wants the AI to respond to.

Key characteristics:

  • Always represents Message.MessageUser.USER message type
  • Renders with user-specific styling in the chat interface
  • May contain both raw user input and processed/contextualized text
  • Forms the foundation for AI assistant responses

The HTML rendering includes appropriate CSS classes for user message styling and accessibility. The rendered content uses the raw text rather than templated text to show exactly what the user entered.

Since:
v1.0.0
See Also:

  • Nested Class Summary

    Nested classes/interfaces inherited from class com.psddev.ai.chat.Message

    Message.MessageUser

    Nested classes/interfaces inherited from interface com.psddev.dari.db.Recordable

    com.psddev.dari.db.Recordable.Abstract, com.psddev.dari.db.Recordable.BeanProperty, com.psddev.dari.db.Recordable.BootstrapFollowReferences, com.psddev.dari.db.Recordable.BootstrapPackages, com.psddev.dari.db.Recordable.BootstrapTypeMappable, com.psddev.dari.db.Recordable.CollectionMaximum, com.psddev.dari.db.Recordable.CollectionMinimum, com.psddev.dari.db.Recordable.Denormalized, com.psddev.dari.db.Recordable.DisplayName, com.psddev.dari.db.Recordable.Embedded, com.psddev.dari.db.Recordable.FieldInternalNamePrefix, com.psddev.dari.db.Recordable.Groups, com.psddev.dari.db.Recordable.Ignored, com.psddev.dari.db.Recordable.IgnoredIfEmbedded, com.psddev.dari.db.Recordable.Indexed, com.psddev.dari.db.Recordable.InternalName, com.psddev.dari.db.Recordable.JunctionField, com.psddev.dari.db.Recordable.JunctionPositionField, com.psddev.dari.db.Recordable.LabelFields, com.psddev.dari.db.Recordable.Maximum, com.psddev.dari.db.Recordable.MetricValue, com.psddev.dari.db.Recordable.MimeTypes, com.psddev.dari.db.Recordable.Minimum, com.psddev.dari.db.Recordable.PreviewField, com.psddev.dari.db.Recordable.Raw, com.psddev.dari.db.Recordable.Recalculate, com.psddev.dari.db.Recordable.Regex, com.psddev.dari.db.Recordable.Relocate, com.psddev.dari.db.Recordable.Required, com.psddev.dari.db.Recordable.SourceDatabaseClass, com.psddev.dari.db.Recordable.SourceDatabaseName, com.psddev.dari.db.Recordable.SourceDatabaseProviderClass, com.psddev.dari.db.Recordable.Step, com.psddev.dari.db.Recordable.TypeId, com.psddev.dari.db.Recordable.TypePostProcessorClasses, com.psddev.dari.db.Recordable.Types, com.psddev.dari.db.Recordable.TypesExclude, com.psddev.dari.db.Recordable.Values, com.psddev.dari.db.Recordable.Where

  • Field Summary

    Fields inherited from interface java.beans.BeanInfo

    ICON_COLOR_16x16, ICON_COLOR_32x32, ICON_MONO_16x16, ICON_MONO_32x32

  • Constructor Summary

    Constructors
    Constructor
    Description
    Prompt()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    Message.MessageUser
    getUser()
    Returns the user type for prompt messages.
    com.psddev.dari.html.content.FlowContent
    toHtml()
    Renders this prompt as HTML content for the chat interface.

    Methods inherited from class com.psddev.ai.chat.Message

    getTemplatedText, getText, setTemplatedText, setText

    Methods inherited from class com.psddev.dari.db.Record

    afterCreate, afterDelete, afterSave, afterValidate, beforeCommit, beforeDelete, beforeSave, beginWrites, clone, commitWrites, compareTo, delete, endWrites, equals, format, getAdditionalBeanInfo, getAs, getBeanDescriptor, getDefaultEventIndex, getDefaultPropertyIndex, getEventSetDescriptors, getExtra, getIcon, getId, getMethodDescriptors, getPropertyDescriptors, getState, hashCode, is, is, onDuplicate, onValidate, queryFrom, receiveMessage, save, saveEventually, saveImmediately, saveUniquely, sendMessage, setState, toString

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface com.psddev.dari.db.Recordable

    as, getLabel, isInstantiableTo

  • Constructor Details

    • Prompt

      public Prompt()

  • Method Details

    • toHtml

      public com.psddev.dari.html.content.FlowContent toHtml()
      Renders this prompt as HTML content for the chat interface.

      The prompt is rendered as a div element with the "AIChat-prompt" CSS class for appropriate user message styling. The content displayed is the raw text as entered by the user.

      Specified by:
      toHtml in class Message
      Returns:
      a div element containing the prompt text with user message styling

    • getUser

      public Message.MessageUser getUser()
      Returns the user type for prompt messages.

      All prompt messages are generated by human users and therefore always return Message.MessageUser.USER.

      Specified by:
      getUser in class Message
      Returns:
      Message.MessageUser.USER indicating this is a user message
      See Also: