Package com.embabel.chat

Interface Chatbot

  • All Implemented Interfaces:
    
public interface Chatbot

    A chatbot can conduct multiple chat sessions, each identified by a conversationId.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Field Summary

      Fields 
      Modifier and Type Field Description

    • Constructor Summary

      Constructors 
      Constructor Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      abstract ChatSession createSession(User user, OutputChannel outputChannel, String contextId, String conversationId) Create a new chat session, or restore an existing one.
      abstract ChatSession findSession(String conversationId) Get a chat session by conversation id.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

    • Method Detail

      • createSession

         abstract ChatSession createSession(User user, OutputChannel outputChannel, String contextId, String conversationId)

        Create a new chat session, or restore an existing one.

        If contextId is provided, objects from that context are loaded into the blackboard (e.g., user preferences, prior state).

        If conversationId is provided and a conversation exists in storage, the session will be restored with its message history. Otherwise, a new conversation is created with that ID.

        Parameters:
        user - the user to associate the session with, or null for anonymous
        outputChannel - the output channel to send messages to
        contextId - optional context ID to load prior state from
        conversationId - optional ID to restore an existing conversation, or create with specific ID