Skip to content
Baumbart logo Baumbart Documentation

chatbot/metadata

This page is auto-generated from TSDoc output. Edit the source file, not this Markdown.

chatbot/metadata

Section titled “chatbot/metadata”
  • Package: @leipzigtreechat/chatbot
  • Source file: packages/chatbot/src/metadata.ts

Summary

Section titled “Summary”

Progress states emitted while the chatbot graph processes a request.

Types

Section titled “Types”

ChatBotMetadataStatus

Section titled “ChatBotMetadataStatus”
type ChatBotMetadataStatus = | "WAITING_FOR_INPUT"
  | "REWRITING_QUESTION"
  | "GATHERING_DATA"
  | "GENERATING_CLARIFICATION"
  | "GENERATING_RESPONSE"
  | "ERROR"

Progress states emitted while the chatbot graph processes a request.

Defined at: line 6

ChatBotMetadataEvent

Section titled “ChatBotMetadataEvent”
type ChatBotMetadataEvent = {
  /**
   * Current processing step within the chatbot pipeline.
   */
  status: ChatBotMetadataStatus;
  /**
   * Optional user-facing detail for the current step, mainly used for errors.
   */
  message?: string;
}

Metadata event forwarded to UI integrations so they can reflect chatbot progress.

Defined at: line 17

ChatBotMetadataCallback

Section titled “ChatBotMetadataCallback”
type ChatBotMetadataCallback = (event: ChatBotMetadataEvent) => Promise<void> | void

Callback invoked whenever the chatbot emits a metadata event.

Defined at: line 31

Constants

Section titled “Constants”

CHATBOT_METADATA_MESSAGES

Section titled “CHATBOT_METADATA_MESSAGES”
const CHATBOT_METADATA_MESSAGES: ReadonlyRecord<ChatBotMetadataStatus, string>

Default user-facing messages for each metadata status.

Defined at: line 36

In chatbot

Section titled “In chatbot”