Chain that generates key insights/facts of a user based on a a chat conversation with an AI.

Hierarchy

Implements

Constructors

Properties

chatHistoryKey: string = "chat_history"
jsonOutputParser: JsonOutputFunctionsParser
lc_kwargs: SerializedFields
lc_serializable: boolean = false

The LLM to use

retriever: BaseRetriever

The retriever to use for retrieving stored thoughts and insights.

stringOutputParser: StringOutputParser
thoughtsKey: string = "thoughts"
verbose: boolean

Whether to print out response text.

callbacks?: Callbacks
memory?: BaseMemory
metadata?: Record<string, unknown>
tags?: string[]
lc_runnable: boolean = true

Accessors

  • get lc_aliases(): undefined | {
        [key: string]: string;
    }
  • A map of aliases for constructor args. Keys are the attribute names, e.g. "foo". Values are the alias that will replace the key in serialization. This is used to eg. make argument names match Python.

    Returns undefined | {
        [key: string]: string;
    }

  • get lc_attributes(): undefined | {
        [key: string]: undefined;
    }
  • A map of additional attributes to merge with constructor args. Keys are the attribute names, e.g. "foo". Values are the attribute values, which will be serialized. These attributes need to be accepted by the constructor as arguments.

    Returns undefined | {
        [key: string]: undefined;
    }

  • get lc_namespace(): string[]
  • A path to the module that contains the class, eg. ["langchain", "llms"] Usually should be the same as the entrypoint the class is exported from.

    Returns string[]

  • get lc_secrets(): undefined | {
        [key: string]: string;
    }
  • A map of secrets, which will be omitted from serialization. Keys are paths to the secret in constructor args, e.g. "foo.bar.baz". Values are the secret ids, which will be used when deserializing.

    Returns undefined | {
        [key: string]: string;
    }

Methods

  • This method processes a chat history to generate insights about the user.

    Parameters

    • values: ChainValues

      The input values for the chain. It should contain a key for chat history.

    • Optional runManager: CallbackManagerForChainRun

      Optional callback manager for the chain run.

    Returns Promise<ChainValues>

    A promise that resolves to a list of insights about the user.

    Throws

    If the chat history key is not found in the input values or if the chat history is not an array of BaseMessages.

    Description

    The method performs the following steps:

    1. Checks if the chat history key is present in the input values and if the chat history is an array of BaseMessages.
    2. Breaks the chat history into chunks of messages.
    3. For each chunk, it generates an initial prediction for the user's next message.
    4. For each prediction, it generates insights and prediction violations, and regenerates the prediction based on the violations.
    5. For each set of messages, it generates a fact/insight about the user. The method returns a list of these insights.
  • This method breaks down the chat history into chunks of messages. Each chunk consists of a sequence of messages ending with an AI message and the subsequent user response, if any.

    Parameters

    • chatHistory: BaseMessage[]

      The chat history to be chunked.

    Returns MessageChunkResult[]

    An array of message chunks. Each chunk includes a sequence of messages and the subsequent user response.

    Description

    The method iterates over the chat history and pushes each message into a temporary array. When it encounters an AI message, it checks for a subsequent user message. If a user message is found, it is considered as the user response to the AI message. If no user message is found after the AI message, the user response is undefined. The method then pushes the chunk (sequence of messages and user response) into the result array. This process continues until all messages in the chat history have been processed.

  • Stream all output from a runnable, as reported to the callback system. This includes all inner runs of LLMs, Retrievers, Tools, etc. Output is streamed as Log objects, which include a list of jsonpatch ops that describe how the state of the run has changed in each step, and the final state of the run. The jsonpatch ops can be applied in order to construct state.

    Parameters

    Returns AsyncGenerator<RunLogPatch, any, unknown>

  • Helper method to transform an Iterator of Input values into an Iterator of Output values, with callbacks. Use this to implement stream() or transform() in Runnable subclasses.

    Type Parameters

    Parameters

    • inputGenerator: AsyncGenerator<I, any, unknown>
    • transformer: ((generator, runManager?, options?) => AsyncGenerator<O, any, unknown>)
        • (generator, runManager?, options?): AsyncGenerator<O, any, unknown>
        • Parameters

          Returns AsyncGenerator<O, any, unknown>

    • Optional options: BaseCallbackConfig & {
          runType?: string;
      }

    Returns AsyncGenerator<O, any, unknown>

Generated using TypeDoc