Class Chat

A chat is a conversation between a user and a machine. The machine can interact with external services (see Service).

Example

const chat = new Chat();
chat.registerService('currency', new CurrencyService());
chat.addUserInput('Hello bot!');
chat.addAssistantOutput('{"message":"Hello human!"}');

Hierarchy

  • Chat

Constructors

constructor

Properties

_messages _prompt _services

Accessors

lastMessage messages prompt

Methods

addAssistantMessage addAssistantOutput addSystemMessage addUserInput describe getMethodResponse init parseBotMessage registerService

Constructors

constructor

  • Parameters

    • Optional config: {
          prompt?: string;
      }
      • Optional prompt?: string

    Returns Chat

Properties

Private _messages

_messages: ChatMessage[] = []

Private _prompt

_prompt: string

Private _services

_services: Record<string, Service> = {}

Accessors

lastMessage

  • get lastMessage(): ChatMessage

  • Returns the last message in the chat. The message is returned as a deep clone to prevent accidental mutation.

    Returns ChatMessage

messages

  • get messages(): ChatMessage[]

  • Returns the messages in the chat. The messages are returned as a deep clone to prevent accidental mutation. The messages are returned in the order they were added. The first message is the prompt.

    Returns ChatMessage[]

prompt

  • get prompt(): string

  • Returns the prompt for the chat.

    Returns string

Methods

addAssistantMessage

addAssistantOutput

addSystemMessage

addUserInput

  • Adds a message from the user to the chat.

    Parameters

    • message: string

    Returns void

describe

Private getMethodResponse

Private init

  • Starts the conversation

    Returns void

Private parseBotMessage

registerService

  • Type Parameters

    • N extends string

    • S extends Service

    Parameters

    • name: N & (N extends keyof Chat
          ? never
          : N)
    • service: S

    Returns Chat & {
        [K in string]: S
    }

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc