Class ConvexChatMessageHistory<DataModel, SessionIdFieldName, TableName, IndexName, MessageTextFieldName, InsertMutation, LookupQuery, DeleteManyMutation>

Type Parameters

  • DataModel extends GenericDataModel
  • SessionIdFieldName extends FieldPaths<NamedTableInfo<DataModel, TableName>> = "sessionId"
  • TableName extends TableNamesInDataModel<DataModel> = "messages"
  • IndexName extends IndexNames<NamedTableInfo<DataModel, TableName>> = "bySessionId"
  • MessageTextFieldName extends FieldPaths<NamedTableInfo<DataModel, TableName>> = "message"
  • InsertMutation extends FunctionReference<"mutation", "internal", {
        document: object;
        table: string;
    }> = any
  • LookupQuery extends FunctionReference<"query", "internal", {
        index: string;
        key: string;
        keyField: string;
        table: string;
    }, object[]> = any
  • DeleteManyMutation extends FunctionReference<"mutation", "internal", {
        index: string;
        key: string;
        keyField: string;
        table: string;
    }> = any

Hierarchy

  • BaseListChatMessageHistory
    • ConvexChatMessageHistory

Constructors

constructor

Methods

addAIChatMessage addAIMessage addMessage addMessages addUserMessage clear getMessages toJSON toJSONNotImplemented

Constructors

constructor

Methods

addAIChatMessage

  • addAIChatMessage(message): Promise<void>

  • Parameters

    • message: string

    Returns Promise<void>

    Deprecated

    Use addAIMessage instead

addAIMessage

  • addAIMessage(message): Promise<void>

  • This is a convenience method for adding an AI message string to the store. Please note that this is a convenience method. Code should favor the bulk addMessages interface instead to save on round-trips to the underlying persistence layer. This method may be deprecated in a future release.

    Parameters

    • message: string

    Returns Promise<void>

addMessage

addMessages

  • addMessages(messages): Promise<void>

  • Add a list of messages.

    Implementations should override this method to handle bulk addition of messages in an efficient manner to avoid unnecessary round-trips to the underlying store.

    Parameters

    • messages: BaseMessage[]

      A list of BaseMessage objects to store.

    Returns Promise<void>

addUserMessage

  • addUserMessage(message): Promise<void>

  • This is a convenience method for adding a human message string to the store. Please note that this is a convenience method. Code should favor the bulk addMessages interface instead to save on round-trips to the underlying persistence layer. This method may be deprecated in a future release.

    Parameters

    • message: string

    Returns Promise<void>

clear

getMessages

toJSON

  • toJSON(): Serialized

  • Returns Serialized

toJSONNotImplemented

Settings

Member Visibility

On This Page

Constructors
Methods