Skip to content
Baumbart logo Baumbart Documentation

chatbot/state/qanary-types

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

chatbot/state/qanary-types

Section titled “chatbot/state/qanary-types”
  • Package: @leipzigtreechat/chatbot
  • Source file: packages/chatbot/src/state/qanary-types.ts

Summary

Section titled “Summary”

Identifies a question within a conversation.

Classes

Section titled “Classes”

ClarificationQuestionURI

Section titled “ClarificationQuestionURI”
class ClarificationQuestionURI extends Data.TaggedClass("ClarificationQuestionURI")<{ value: string }>

Identifies a question within a conversation.

Extends: Data.TaggedClass("ClarificationQuestionURI")<{ value: string }> Methods

  • constructor(value: string): Creates a new QuestionURI with the given value. Defined at: line 6

ConversationURI

Section titled “ConversationURI”
class ConversationURI extends Data.TaggedClass("ConversationURI")<{ value: string }>

Identifies a conversation instance.

Extends: Data.TaggedClass("ConversationURI")<{ value: string }> Methods

  • constructor(value: string): Creates a new ConversationURI with the given value. Defined at: line 20

ClarificationAnswerURI

Section titled “ClarificationAnswerURI”
class ClarificationAnswerURI extends Data.TaggedClass("ClarificationAnswerURI")<{ value: string }>

Identifies a clarification answer within a conversation.

Extends: Data.TaggedClass("ClarificationAnswerURI")<{ value: string }> Methods

  • constructor(value: string): Creates a new ClarificationAnswerURI with the given value. Defined at: line 34

FinalAnswerURI

Section titled “FinalAnswerURI”
class FinalAnswerURI extends Data.TaggedClass("FinalAnswerURI")<{ value: string }>

Identifies a final answer within a conversation.

Extends: Data.TaggedClass("FinalAnswerURI")<{ value: string }> Methods

  • constructor(value: string): Creates a new FinalAnswerURI with the given value. Defined at: line 48

QanaryClarificationQuestion

Section titled “QanaryClarificationQuestion”
class QanaryClarificationQuestion extends Data.TaggedClass("QanaryClarificationQuestion")<{
  /**
   * Stable identifier for the question.
   */
  uri: ClarificationQuestionURI;


  /**
   * User-facing question text.
   */
  content: string;
}>

A clarification question asked by the chatbot.

Extends: `Data.TaggedClass(“QanaryClarificationQuestion”)<{ /**

  • Stable identifier for the question. */ uri: ClarificationQuestionURI;

/**

  • User-facing question text. */ content: string; }>` Methods
  • constructor(uri: ClarificationQuestionURI, content: string): Creates a new clarification question. Defined at: line 62

QanaryClarificationAnswer

Section titled “QanaryClarificationAnswer”
class QanaryClarificationAnswer extends Data.TaggedClass("QanaryClarificationAnswer")<{
  /**
   * Stable identifier for the answer. Is null for answers that are not yet stored in the triplestore.
   */
  uri: ClarificationAnswerURI | null;


  /**
   * User-facing answer text.
   */
  content: string;
}>

A user-provided answer to a clarification question.

Extends: `Data.TaggedClass(“QanaryClarificationAnswer”)<{ /**

  • Stable identifier for the answer. Is null for answers that are not yet stored in the triplestore. */ uri: ClarificationAnswerURI | null;

/**

  • User-facing answer text. */ content: string; }>` Methods
  • constructor(uri: ClarificationAnswerURI | null, content: string): Creates a new clarification answer. Defined at: line 87

QanaryFinalAnswer

Section titled “QanaryFinalAnswer”
class QanaryFinalAnswer extends Data.TaggedClass("QanaryFinalAnswer")<{
  /**
   * Stable identifier for the final answer.
   */
  uri: FinalAnswerURI;


  /**
   * User-facing final answer text.
   */
  content: string;
}>

A final answer returned by the chatbot.

Extends: `Data.TaggedClass(“QanaryFinalAnswer”)<{ /**

  • Stable identifier for the final answer. */ uri: FinalAnswerURI;

/**

  • User-facing final answer text. */ content: string; }>` Methods
  • constructor(uri: FinalAnswerURI, content: string): Creates a new final answer. Defined at: line 112

In chatbot

Section titled “In chatbot”