@langchain/classic 1.0.0-alpha.1

package/dist/experimental/chains/violation_of_expectations/violation_of_expectations_chain.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"violation_of_expectations_chain.cjs","names":["BaseChain","fields: ViolationOfExpectationsChainInput","JsonOutputFunctionsParser","StringOutputParser","chatHistory: BaseMessage[]","strings: Array<string>","newArray: MessageChunkResult[]","tempArray: BaseMessage[]","userResponse: BaseMessage | undefined","HumanMessage","values: ChainValues","runManager?: CallbackManagerForChainRun","chatHistory: unknown[]","PREDICT_NEXT_USER_MESSAGE_FUNCTION","PREDICT_NEXT_USER_MESSAGE_PROMPT","insights: Array<string>","PREDICTION_VIOLATIONS_FUNCTION","PREDICTION_VIOLATIONS_PROMPT","GENERATE_REVISED_PREDICTION_PROMPT","GENERATE_FACTS_PROMPT","llm: ChatOpenAI","retriever: BaseRetrieverInterface","options?: Partial<\n      Omit<ViolationOfExpectationsChainInput, \"llm\" | \"retriever\">\n    >"],"sources":["../../../../src/experimental/chains/violation_of_expectations/violation_of_expectations_chain.ts"],"sourcesContent":["import type { BaseRetrieverInterface } from \"@langchain/core/retrievers\";\nimport { ChatOpenAI } from \"@langchain/openai\";\nimport {\n  BaseMessage,\n  HumanMessage,\n  isBaseMessage,\n} from \"@langchain/core/messages\";\nimport { ChainValues } from \"@langchain/core/utils/types\";\nimport { StringOutputParser } from \"@langchain/core/output_parsers\";\nimport { CallbackManagerForChainRun } from \"@langchain/core/callbacks/manager\";\nimport { JsonOutputFunctionsParser } from \"../../../output_parsers/openai_functions.js\";\nimport { BaseChain, ChainInputs } from \"../../../chains/base.js\";\nimport {\n  GetPredictionViolationsResponse,\n  MessageChunkResult,\n  PREDICTION_VIOLATIONS_FUNCTION,\n  PREDICT_NEXT_USER_MESSAGE_FUNCTION,\n  PredictNextUserMessageResponse,\n} from \"./types.js\";\nimport {\n  GENERATE_FACTS_PROMPT,\n  GENERATE_REVISED_PREDICTION_PROMPT,\n  PREDICTION_VIOLATIONS_PROMPT,\n  PREDICT_NEXT_USER_MESSAGE_PROMPT,\n} from \"./violation_of_expectations_prompt.js\";\n\n/**\n * Interface for the input parameters of the ViolationOfExpectationsChain class.\n */\nexport interface ViolationOfExpectationsChainInput extends ChainInputs {\n  /**\n   * The retriever to use for retrieving stored\n   * thoughts and insights.\n   */\n  retriever: BaseRetrieverInterface;\n  /**\n   * The LLM to use\n   */\n  llm: ChatOpenAI;\n}\n\n/**\n * Chain that generates key insights/facts of a user based on a\n * a chat conversation with an AI.\n */\nexport class ViolationOfExpectationsChain\n  extends BaseChain\n  implements ViolationOfExpectationsChainInput\n{\n  static lc_name() {\n    return \"ViolationOfExpectationsChain\";\n  }\n\n  _chainType(): string {\n    return \"violation_of_expectation_chain\";\n  }\n\n  chatHistoryKey = \"chat_history\";\n\n  thoughtsKey = \"thoughts\";\n\n  get inputKeys() {\n    return [this.chatHistoryKey];\n  }\n\n  get outputKeys() {\n    return [this.thoughtsKey];\n  }\n\n  retriever: BaseRetrieverInterface;\n\n  llm: ChatOpenAI;\n\n  jsonOutputParser: JsonOutputFunctionsParser;\n\n  stringOutputParser: StringOutputParser;\n\n  constructor(fields: ViolationOfExpectationsChainInput) {\n    super(fields);\n    this.retriever = fields.retriever;\n    this.llm = fields.llm;\n    this.jsonOutputParser = new JsonOutputFunctionsParser();\n    this.stringOutputParser = new StringOutputParser();\n  }\n\n  getChatHistoryString(chatHistory: BaseMessage[]): string {\n    return chatHistory\n      .map((chatMessage) => {\n        if (chatMessage._getType() === \"human\") {\n          return `Human: ${chatMessage.content}`;\n        } else if (chatMessage._getType() === \"ai\") {\n          return `AI: ${chatMessage.content}`;\n        } else {\n          return `${chatMessage.content}`;\n        }\n      })\n      .join(\"\\n\");\n  }\n\n  removeDuplicateStrings(strings: Array<string>): Array<string> {\n    return [...new Set(strings)];\n  }\n\n  /**\n   * This method breaks down the chat history into chunks of messages.\n   * Each chunk consists of a sequence of messages ending with an AI message and the subsequent user response, if any.\n   *\n   * @param {BaseMessage[]} chatHistory - The chat history to be chunked.\n   *\n   * @returns {MessageChunkResult[]} An array of message chunks. Each chunk includes a sequence of messages and the subsequent user response.\n   *\n   * @description\n   * The method iterates over the chat history and pushes each message into a temporary array.\n   * When it encounters an AI message, it checks for a subsequent user message.\n   * If a user message is found, it is considered as the user response to the AI message.\n   * If no user message is found after the AI message, the user response is undefined.\n   * The method then pushes the chunk (sequence of messages and user response) into the result array.\n   * This process continues until all messages in the chat history have been processed.\n   */\n  chunkMessagesByAIResponse(chatHistory: BaseMessage[]): MessageChunkResult[] {\n    const newArray: MessageChunkResult[] = [];\n    const tempArray: BaseMessage[] = [];\n\n    chatHistory.forEach((item, index) => {\n      tempArray.push(item);\n      if (item._getType() === \"ai\") {\n        let userResponse: BaseMessage | undefined = chatHistory[index + 1];\n        if (!userResponse || userResponse._getType() !== \"human\") {\n          userResponse = undefined;\n        }\n\n        newArray.push({\n          chunkedMessages: tempArray,\n          userResponse: userResponse\n            ? new HumanMessage(userResponse)\n            : undefined,\n        });\n      }\n    });\n\n    return newArray;\n  }\n\n  /**\n   * This method processes a chat history to generate insights about the user.\n   *\n   * @param {ChainValues} values - The input values for the chain. It should contain a key for chat history.\n   * @param {CallbackManagerForChainRun} [runManager] - Optional callback manager for the chain run.\n   *\n   * @returns {Promise<ChainValues>} A promise that resolves to a list of insights about the user.\n   *\n   * @throws {Error} If the chat history key is not found in the input values or if the chat history is not an array of BaseMessages.\n   *\n   * @description\n   * The method performs the following steps:\n   * 1. Checks if the chat history key is present in the input values and if the chat history is an array of BaseMessages.\n   * 2. Breaks the chat history into chunks of messages.\n   * 3. For each chunk, it generates an initial prediction for the user's next message.\n   * 4. For each prediction, it generates insights and prediction violations, and regenerates the prediction based on the violations.\n   * 5. For each set of messages, it generates a fact/insight about the user.\n   * The method returns a list of these insights.\n   */\n  async _call(\n    values: ChainValues,\n    runManager?: CallbackManagerForChainRun\n  ): Promise<ChainValues> {\n    if (!(this.chatHistoryKey in values)) {\n      throw new Error(`Chat history key ${this.chatHistoryKey} not found`);\n    }\n\n    const chatHistory: unknown[] = values[this.chatHistoryKey];\n\n    const isEveryMessageBaseMessage = chatHistory.every((message) =>\n      isBaseMessage(message)\n    );\n    if (!isEveryMessageBaseMessage) {\n      throw new Error(\"Chat history must be an array of BaseMessages\");\n    }\n\n    const messageChunks = this.chunkMessagesByAIResponse(\n      chatHistory as BaseMessage[]\n    );\n\n    // Generate the initial prediction for every user message.\n    const userPredictions = await Promise.all(\n      messageChunks.map(async (chatHistoryChunk) => ({\n        userPredictions: await this.predictNextUserMessage(\n          chatHistoryChunk.chunkedMessages\n        ),\n        userResponse: chatHistoryChunk.userResponse,\n        runManager,\n      }))\n    );\n\n    // Generate insights, and prediction violations for every user message.\n    // This call also regenerates the prediction based on the violations.\n    const predictionViolations = await Promise.all(\n      userPredictions.map((prediction) =>\n        this.getPredictionViolations({\n          userPredictions: prediction.userPredictions,\n          userResponse: prediction.userResponse,\n          runManager,\n        })\n      )\n    );\n\n    // Generate a fact/insight about the user for every set of messages.\n    const insights = await Promise.all(\n      predictionViolations.map((violation) =>\n        this.generateFacts({\n          userResponse: violation.userResponse,\n          predictions: {\n            revisedPrediction: violation.revisedPrediction,\n            explainedPredictionErrors: violation.explainedPredictionErrors,\n          },\n        })\n      )\n    );\n\n    return {\n      insights,\n    };\n  }\n\n  /**\n   * This method predicts the next user message based on the chat history.\n   *\n   * @param {BaseMessage[]} chatHistory - The chat history based on which the next user message is predicted.\n   * @param {CallbackManagerForChainRun} [runManager] - Optional callback manager for the chain run.\n   *\n   * @returns {Promise<PredictNextUserMessageResponse>} A promise that resolves to the predicted next user message, the user state, and any insights.\n   *\n   * @throws {Error} If the response from the language model does not contain the expected keys: 'userState', 'predictedUserMessage', and 'insights'.\n   */\n  private async predictNextUserMessage(\n    chatHistory: BaseMessage[],\n    runManager?: CallbackManagerForChainRun\n  ): Promise<PredictNextUserMessageResponse> {\n    const messageString = this.getChatHistoryString(chatHistory);\n\n    const llmWithFunctions = this.llm\n      .bindTools([PREDICT_NEXT_USER_MESSAGE_FUNCTION])\n      .withConfig({\n        function_call: { name: PREDICT_NEXT_USER_MESSAGE_FUNCTION.name },\n      });\n\n    const chain = PREDICT_NEXT_USER_MESSAGE_PROMPT.pipe(llmWithFunctions).pipe(\n      this.jsonOutputParser\n    );\n\n    const res = await chain.invoke(\n      {\n        chat_history: messageString,\n      },\n      runManager?.getChild(\"prediction\")\n    );\n\n    if (\n      !(\n        \"userState\" in res &&\n        \"predictedUserMessage\" in res &&\n        \"insights\" in res\n      )\n    ) {\n      throw new Error(`Invalid response from LLM: ${JSON.stringify(res)}`);\n    }\n\n    const predictionResponse = res as PredictNextUserMessageResponse;\n\n    // Query the retriever for relevant insights. Use the generates insights as a query.\n    const retrievedDocs = await this.retrieveRelevantInsights(\n      predictionResponse.insights\n    );\n    const relevantDocs = this.removeDuplicateStrings([\n      ...predictionResponse.insights,\n      ...retrievedDocs,\n    ]);\n\n    return {\n      ...predictionResponse,\n      insights: relevantDocs,\n    };\n  }\n\n  /**\n   * Retrieves relevant insights based on the provided insights.\n   *\n   * @param {Array<string>} insights - An array of insights to be used for retrieving relevant documents.\n   *\n   * @returns {Promise<Array<string>>} A promise that resolves to an array of relevant insights content.\n   */\n  private async retrieveRelevantInsights(\n    insights: Array<string>\n  ): Promise<Array<string>> {\n    // Only extract the first relevant doc from the retriever. We don't need more than one.\n    const relevantInsightsDocuments = await Promise.all(\n      insights.map(async (insight) => {\n        const relevantInsight = await this.retriever.invoke(insight);\n        return relevantInsight[0];\n      })\n    );\n\n    const relevantInsightsContent = relevantInsightsDocuments.map(\n      (document) => document.pageContent\n    );\n\n    return relevantInsightsContent;\n  }\n\n  /**\n   * This method generates prediction violations based on the predicted and actual user responses.\n   * It also generates a revised prediction based on the identified violations.\n   *\n   * @param {Object} params - The parameters for the method.\n   * @param {PredictNextUserMessageResponse} params.userPredictions - The predicted user message, user state, and insights.\n   * @param {BaseMessage} [params.userResponse] - The actual user response.\n   * @param {CallbackManagerForChainRun} [params.runManager] - Optional callback manager for the chain run.\n   *\n   * @returns {Promise<{ userResponse: BaseMessage | undefined; revisedPrediction: string; explainedPredictionErrors: Array<string>; }>} A promise that resolves to an object containing the actual user response, the revised prediction, and the explained prediction errors.\n   *\n   * @throws {Error} If the response from the language model does not contain the expected keys: 'violationExplanation', 'explainedPredictionErrors', and 'accuratePrediction'.\n   */\n  private async getPredictionViolations({\n    userPredictions,\n    userResponse,\n    runManager,\n  }: {\n    userPredictions: PredictNextUserMessageResponse;\n    userResponse?: BaseMessage;\n    runManager?: CallbackManagerForChainRun;\n  }): Promise<GetPredictionViolationsResponse> {\n    const llmWithFunctions = this.llm\n      .bindTools([PREDICTION_VIOLATIONS_FUNCTION])\n      .withConfig({\n        function_call: { name: PREDICTION_VIOLATIONS_FUNCTION.name },\n      });\n\n    const chain = PREDICTION_VIOLATIONS_PROMPT.pipe(llmWithFunctions).pipe(\n      this.jsonOutputParser\n    );\n\n    if (typeof userResponse?.content !== \"string\") {\n      throw new Error(\"This chain does not support non-string model output.\");\n    }\n    const res = (await chain.invoke(\n      {\n        predicted_output: userPredictions.predictedUserMessage,\n        actual_output: userResponse?.content ?? \"\",\n        user_insights: userPredictions.insights.join(\"\\n\"),\n      },\n      runManager?.getChild(\"prediction_violations\")\n    )) as Awaited<{\n      violationExplanation: string;\n      explainedPredictionErrors: Array<string>;\n      accuratePrediction: boolean;\n    }>;\n\n    // Generate a revised prediction based on violations.\n    const revisedPrediction = await this.generateRevisedPrediction({\n      originalPrediction: userPredictions.predictedUserMessage,\n      explainedPredictionErrors: res.explainedPredictionErrors,\n      userInsights: userPredictions.insights,\n      runManager,\n    });\n\n    return {\n      userResponse,\n      revisedPrediction,\n      explainedPredictionErrors: res.explainedPredictionErrors,\n    };\n  }\n\n  /**\n   * This method generates a revised prediction based on the original prediction, explained prediction errors, and user insights.\n   *\n   * @param {Object} params - The parameters for the method.\n   * @param {string} params.originalPrediction - The original prediction made by the model.\n   * @param {Array<string>} params.explainedPredictionErrors - An array of explained prediction errors.\n   * @param {Array<string>} params.userInsights - An array of insights about the user.\n   * @param {CallbackManagerForChainRun} [params.runManager] - Optional callback manager for the chain run.\n   *\n   * @returns {Promise<string>} A promise that resolves to a revised prediction.\n   */\n  private async generateRevisedPrediction({\n    originalPrediction,\n    explainedPredictionErrors,\n    userInsights,\n    runManager,\n  }: {\n    originalPrediction: string;\n    explainedPredictionErrors: Array<string>;\n    userInsights: Array<string>;\n    runManager?: CallbackManagerForChainRun;\n  }): Promise<string> {\n    const revisedPredictionChain = GENERATE_REVISED_PREDICTION_PROMPT.pipe(\n      this.llm\n    ).pipe(this.stringOutputParser);\n\n    const revisedPredictionRes = await revisedPredictionChain.invoke(\n      {\n        prediction: originalPrediction,\n        explained_prediction_errors: explainedPredictionErrors.join(\"\\n\"),\n        user_insights: userInsights.join(\"\\n\"),\n      },\n      runManager?.getChild(\"prediction_revision\")\n    );\n\n    return revisedPredictionRes;\n  }\n\n  /**\n   * This method generates facts or insights about the user based on the revised prediction, explained prediction errors, and the user's response.\n   *\n   * @param {Object} params - The parameters for the method.\n   * @param {BaseMessage} [params.userResponse] - The actual user response.\n   * @param {Object} params.predictions - The revised prediction and explained prediction errors.\n   * @param {string} params.predictions.revisedPrediction - The revised prediction made by the model.\n   * @param {Array<string>} params.predictions.explainedPredictionErrors - An array of explained prediction errors.\n   * @param {CallbackManagerForChainRun} [params.runManager] - Optional callback manager for the chain run.\n   *\n   * @returns {Promise<string>} A promise that resolves to a string containing the generated facts or insights about the user.\n   */\n  private async generateFacts({\n    userResponse,\n    predictions,\n    runManager,\n  }: {\n    userResponse?: BaseMessage;\n    /**\n     * Optional if the prediction was accurate.\n     */\n    predictions: {\n      revisedPrediction: string;\n      explainedPredictionErrors: Array<string>;\n    };\n    runManager?: CallbackManagerForChainRun;\n  }): Promise<string> {\n    const chain = GENERATE_FACTS_PROMPT.pipe(this.llm).pipe(\n      this.stringOutputParser\n    );\n\n    if (typeof userResponse?.content !== \"string\") {\n      throw new Error(\"This chain does not support non-string model output.\");\n    }\n    const res = await chain.invoke(\n      {\n        prediction_violations: predictions.explainedPredictionErrors.join(\"\\n\"),\n        prediction: predictions.revisedPrediction,\n        user_message: userResponse?.content ?? \"\",\n      },\n      runManager?.getChild(\"generate_facts\")\n    );\n\n    return res;\n  }\n\n  /**\n   * Static method that creates a ViolationOfExpectationsChain instance from a\n   * ChatOpenAI and retriever. It also accepts optional options\n   * to customize the chain.\n   *\n   * @param llm The ChatOpenAI instance.\n   * @param retriever The retriever used for similarity search.\n   * @param options Optional options to customize the chain.\n   *\n   * @returns A new instance of ViolationOfExpectationsChain.\n   */\n  static fromLLM(\n    llm: ChatOpenAI,\n    retriever: BaseRetrieverInterface,\n    options?: Partial<\n      Omit<ViolationOfExpectationsChainInput, \"llm\" | \"retriever\">\n    >\n  ): ViolationOfExpectationsChain {\n    return new this({\n      retriever,\n      llm,\n      ...options,\n    });\n  }\n}\n"],"mappings":";;;;;;;;;;;;;AA6CA,IAAa,+BAAb,cACUA,uBAEV;CACE,OAAO,UAAU;AACf,SAAO;CACR;CAED,aAAqB;AACnB,SAAO;CACR;CAED,iBAAiB;CAEjB,cAAc;CAEd,IAAI,YAAY;AACd,SAAO,CAAC,KAAK,cAAe;CAC7B;CAED,IAAI,aAAa;AACf,SAAO,CAAC,KAAK,WAAY;CAC1B;CAED;CAEA;CAEA;CAEA;CAEA,YAAYC,QAA2C;EACrD,MAAM,OAAO;EACb,KAAK,YAAY,OAAO;EACxB,KAAK,MAAM,OAAO;EAClB,KAAK,mBAAmB,IAAIC;EAC5B,KAAK,qBAAqB,IAAIC;CAC/B;CAED,qBAAqBC,aAAoC;AACvD,SAAO,YACJ,IAAI,CAAC,gBAAgB;AACpB,OAAI,YAAY,UAAU,KAAK,QAC7B,QAAO,CAAC,OAAO,EAAE,YAAY,SAAS;YAC7B,YAAY,UAAU,KAAK,KACpC,QAAO,CAAC,IAAI,EAAE,YAAY,SAAS;OAEnC,QAAO,GAAG,YAAY,SAAS;EAElC,EAAC,CACD,KAAK,KAAK;CACd;CAED,uBAAuBC,SAAuC;AAC5D,SAAO,CAAC,GAAG,IAAI,IAAI,QAAS;CAC7B;;;;;;;;;;;;;;;;;CAkBD,0BAA0BD,aAAkD;EAC1E,MAAME,WAAiC,CAAE;EACzC,MAAMC,YAA2B,CAAE;EAEnC,YAAY,QAAQ,CAAC,MAAM,UAAU;GACnC,UAAU,KAAK,KAAK;AACpB,OAAI,KAAK,UAAU,KAAK,MAAM;IAC5B,IAAIC,eAAwC,YAAY,QAAQ;AAChE,QAAI,CAAC,gBAAgB,aAAa,UAAU,KAAK,SAC/C,eAAe;IAGjB,SAAS,KAAK;KACZ,iBAAiB;KACjB,cAAc,eACV,IAAIC,uCAAa,gBACjB;IACL,EAAC;GACH;EACF,EAAC;AAEF,SAAO;CACR;;;;;;;;;;;;;;;;;;;;CAqBD,MAAM,MACJC,QACAC,YACsB;AACtB,MAAI,EAAE,KAAK,kBAAkB,QAC3B,OAAM,IAAI,MAAM,CAAC,iBAAiB,EAAE,KAAK,eAAe,UAAU,CAAC;EAGrE,MAAMC,cAAyB,OAAO,KAAK;EAE3C,MAAM,4BAA4B,YAAY,MAAM,CAAC,yDACrC,QAAQ,CACvB;AACD,MAAI,CAAC,0BACH,OAAM,IAAI,MAAM;EAGlB,MAAM,gBAAgB,KAAK,0BACzB,YACD;EAGD,MAAM,kBAAkB,MAAM,QAAQ,IACpC,cAAc,IAAI,OAAO,sBAAsB;GAC7C,iBAAiB,MAAM,KAAK,uBAC1B,iBAAiB,gBAClB;GACD,cAAc,iBAAiB;GAC/B;EACD,GAAE,CACJ;EAID,MAAM,uBAAuB,MAAM,QAAQ,IACzC,gBAAgB,IAAI,CAAC,eACnB,KAAK,wBAAwB;GAC3B,iBAAiB,WAAW;GAC5B,cAAc,WAAW;GACzB;EACD,EAAC,CACH,CACF;EAGD,MAAM,WAAW,MAAM,QAAQ,IAC7B,qBAAqB,IAAI,CAAC,cACxB,KAAK,cAAc;GACjB,cAAc,UAAU;GACxB,aAAa;IACX,mBAAmB,UAAU;IAC7B,2BAA2B,UAAU;GACtC;EACF,EAAC,CACH,CACF;AAED,SAAO,EACL,SACD;CACF;;;;;;;;;;;CAYD,MAAc,uBACZR,aACAO,YACyC;EACzC,MAAM,gBAAgB,KAAK,qBAAqB,YAAY;EAE5D,MAAM,mBAAmB,KAAK,IAC3B,UAAU,CAACE,gDAAmC,EAAC,CAC/C,WAAW,EACV,eAAe,EAAE,MAAMA,iDAAmC,KAAM,EACjE,EAAC;EAEJ,MAAM,QAAQC,0EAAiC,KAAK,iBAAiB,CAAC,KACpE,KAAK,iBACN;EAED,MAAM,MAAM,MAAM,MAAM,OACtB,EACE,cAAc,cACf,GACD,YAAY,SAAS,aAAa,CACnC;AAED,MACE,EACE,eAAe,OACf,0BAA0B,OAC1B,cAAc,KAGhB,OAAM,IAAI,MAAM,CAAC,2BAA2B,EAAE,KAAK,UAAU,IAAI,EAAE;EAGrE,MAAM,qBAAqB;EAG3B,MAAM,gBAAgB,MAAM,KAAK,yBAC/B,mBAAmB,SACpB;EACD,MAAM,eAAe,KAAK,uBAAuB,CAC/C,GAAG,mBAAmB,UACtB,GAAG,aACJ,EAAC;AAEF,SAAO;GACL,GAAG;GACH,UAAU;EACX;CACF;;;;;;;;CASD,MAAc,yBACZC,UACwB;EAExB,MAAM,4BAA4B,MAAM,QAAQ,IAC9C,SAAS,IAAI,OAAO,YAAY;GAC9B,MAAM,kBAAkB,MAAM,KAAK,UAAU,OAAO,QAAQ;AAC5D,UAAO,gBAAgB;EACxB,EAAC,CACH;EAED,MAAM,0BAA0B,0BAA0B,IACxD,CAAC,aAAa,SAAS,YACxB;AAED,SAAO;CACR;;;;;;;;;;;;;;CAeD,MAAc,wBAAwB,EACpC,iBACA,cACA,YAKD,EAA4C;EAC3C,MAAM,mBAAmB,KAAK,IAC3B,UAAU,CAACC,4CAA+B,EAAC,CAC3C,WAAW,EACV,eAAe,EAAE,MAAMA,6CAA+B,KAAM,EAC7D,EAAC;EAEJ,MAAM,QAAQC,sEAA6B,KAAK,iBAAiB,CAAC,KAChE,KAAK,iBACN;AAED,MAAI,OAAO,cAAc,YAAY,SACnC,OAAM,IAAI,MAAM;EAElB,MAAM,MAAO,MAAM,MAAM,OACvB;GACE,kBAAkB,gBAAgB;GAClC,eAAe,cAAc,WAAW;GACxC,eAAe,gBAAgB,SAAS,KAAK,KAAK;EACnD,GACD,YAAY,SAAS,wBAAwB,CAC9C;EAOD,MAAM,oBAAoB,MAAM,KAAK,0BAA0B;GAC7D,oBAAoB,gBAAgB;GACpC,2BAA2B,IAAI;GAC/B,cAAc,gBAAgB;GAC9B;EACD,EAAC;AAEF,SAAO;GACL;GACA;GACA,2BAA2B,IAAI;EAChC;CACF;;;;;;;;;;;;CAaD,MAAc,0BAA0B,EACtC,oBACA,2BACA,cACA,YAMD,EAAmB;EAClB,MAAM,yBAAyBC,4EAAmC,KAChE,KAAK,IACN,CAAC,KAAK,KAAK,mBAAmB;EAE/B,MAAM,uBAAuB,MAAM,uBAAuB,OACxD;GACE,YAAY;GACZ,6BAA6B,0BAA0B,KAAK,KAAK;GACjE,eAAe,aAAa,KAAK,KAAK;EACvC,GACD,YAAY,SAAS,sBAAsB,CAC5C;AAED,SAAO;CACR;;;;;;;;;;;;;CAcD,MAAc,cAAc,EAC1B,cACA,aACA,YAWD,EAAmB;EAClB,MAAM,QAAQC,+DAAsB,KAAK,KAAK,IAAI,CAAC,KACjD,KAAK,mBACN;AAED,MAAI,OAAO,cAAc,YAAY,SACnC,OAAM,IAAI,MAAM;EAElB,MAAM,MAAM,MAAM,MAAM,OACtB;GACE,uBAAuB,YAAY,0BAA0B,KAAK,KAAK;GACvE,YAAY,YAAY;GACxB,cAAc,cAAc,WAAW;EACxC,GACD,YAAY,SAAS,iBAAiB,CACvC;AAED,SAAO;CACR;;;;;;;;;;;;CAaD,OAAO,QACLC,KACAC,WACAC,SAG8B;AAC9B,SAAO,IAAI,KAAK;GACd;GACA;GACA,GAAG;EACJ;CACF;AACF"}

package/dist/experimental/chains/violation_of_expectations/violation_of_expectations_chain.d.cts

@@ -0,0 +1,102 @@
+import { BaseChain, ChainInputs } from "../../../chains/base.cjs";
+import { JsonOutputFunctionsParser } from "../../../output_parsers/openai_functions.cjs";
+import { MessageChunkResult } from "./types.cjs";
+import { BaseMessage } from "@langchain/core/messages";
+import { StringOutputParser } from "@langchain/core/output_parsers";
+import { ChainValues } from "@langchain/core/utils/types";
+import { CallbackManagerForChainRun } from "@langchain/core/callbacks/manager";
+import { BaseRetrieverInterface } from "@langchain/core/retrievers";
+import { ChatOpenAI } from "@langchain/openai";
+
+//#region src/experimental/chains/violation_of_expectations/violation_of_expectations_chain.d.ts
+
+/**
+ * Interface for the input parameters of the ViolationOfExpectationsChain class.
+ */
+interface ViolationOfExpectationsChainInput extends ChainInputs {
+  /**
+   * The retriever to use for retrieving stored
+   * thoughts and insights.
+   */
+  retriever: BaseRetrieverInterface;
+  /**
+   * The LLM to use
+   */
+  llm: ChatOpenAI;
+}
+/**
+ * Chain that generates key insights/facts of a user based on a
+ * a chat conversation with an AI.
+ */
+declare class ViolationOfExpectationsChain extends BaseChain implements ViolationOfExpectationsChainInput {
+  static lc_name(): string;
+  _chainType(): string;
+  chatHistoryKey: string;
+  thoughtsKey: string;
+  get inputKeys(): string[];
+  get outputKeys(): string[];
+  retriever: BaseRetrieverInterface;
+  llm: ChatOpenAI;
+  jsonOutputParser: JsonOutputFunctionsParser;
+  stringOutputParser: StringOutputParser;
+  constructor(fields: ViolationOfExpectationsChainInput);
+  getChatHistoryString(chatHistory: BaseMessage[]): string;
+  removeDuplicateStrings(strings: Array<string>): Array<string>;
+  /**
+   * 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.
+   *
+   * @param {BaseMessage[]} chatHistory - 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.
+   */
+  chunkMessagesByAIResponse(chatHistory: BaseMessage[]): MessageChunkResult[];
+  /**
+   * This method processes a chat history to generate insights about the user.
+   *
+   * @param {ChainValues} values - The input values for the chain. It should contain a key for chat history.
+   * @param {CallbackManagerForChainRun} [runManager] - Optional callback manager for the chain run.
+   *
+   * @returns {Promise<ChainValues>} A promise that resolves to a list of insights about the user.
+   *
+   * @throws {Error} 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.
+   */
+  _call(values: ChainValues, runManager?: CallbackManagerForChainRun): Promise<ChainValues>;
+  private predictNextUserMessage;
+  private retrieveRelevantInsights;
+  private getPredictionViolations;
+  private generateRevisedPrediction;
+  private generateFacts;
+  /**
+   * Static method that creates a ViolationOfExpectationsChain instance from a
+   * ChatOpenAI and retriever. It also accepts optional options
+   * to customize the chain.
+   *
+   * @param llm The ChatOpenAI instance.
+   * @param retriever The retriever used for similarity search.
+   * @param options Optional options to customize the chain.
+   *
+   * @returns A new instance of ViolationOfExpectationsChain.
+   */
+  static fromLLM(llm: ChatOpenAI, retriever: BaseRetrieverInterface, options?: Partial<Omit<ViolationOfExpectationsChainInput, "llm" | "retriever">>): ViolationOfExpectationsChain;
+}
+//#endregion
+export { ViolationOfExpectationsChain, ViolationOfExpectationsChainInput };
+//# sourceMappingURL=violation_of_expectations_chain.d.cts.map

package/dist/experimental/chains/violation_of_expectations/violation_of_expectations_chain.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"violation_of_expectations_chain.d.cts","names":["BaseRetrieverInterface","ChatOpenAI","BaseMessage","ChainValues","StringOutputParser","CallbackManagerForChainRun","JsonOutputFunctionsParser","BaseChain","ChainInputs","MessageChunkResult","ViolationOfExpectationsChainInput","ViolationOfExpectationsChain","Array","Promise","Omit","Partial"],"sources":["../../../../src/experimental/chains/violation_of_expectations/violation_of_expectations_chain.d.ts"],"sourcesContent":["import type { BaseRetrieverInterface } from \"@langchain/core/retrievers\";\nimport { ChatOpenAI } from \"@langchain/openai\";\nimport { BaseMessage } from \"@langchain/core/messages\";\nimport { ChainValues } from \"@langchain/core/utils/types\";\nimport { StringOutputParser } from \"@langchain/core/output_parsers\";\nimport { CallbackManagerForChainRun } from \"@langchain/core/callbacks/manager\";\nimport { JsonOutputFunctionsParser } from \"../../../output_parsers/openai_functions.js\";\nimport { BaseChain, ChainInputs } from \"../../../chains/base.js\";\nimport { MessageChunkResult } from \"./types.js\";\n/**\n * Interface for the input parameters of the ViolationOfExpectationsChain class.\n */\nexport interface ViolationOfExpectationsChainInput extends ChainInputs {\n    /**\n     * The retriever to use for retrieving stored\n     * thoughts and insights.\n     */\n    retriever: BaseRetrieverInterface;\n    /**\n     * The LLM to use\n     */\n    llm: ChatOpenAI;\n}\n/**\n * Chain that generates key insights/facts of a user based on a\n * a chat conversation with an AI.\n */\nexport declare class ViolationOfExpectationsChain extends BaseChain implements ViolationOfExpectationsChainInput {\n    static lc_name(): string;\n    _chainType(): string;\n    chatHistoryKey: string;\n    thoughtsKey: string;\n    get inputKeys(): string[];\n    get outputKeys(): string[];\n    retriever: BaseRetrieverInterface;\n    llm: ChatOpenAI;\n    jsonOutputParser: JsonOutputFunctionsParser;\n    stringOutputParser: StringOutputParser;\n    constructor(fields: ViolationOfExpectationsChainInput);\n    getChatHistoryString(chatHistory: BaseMessage[]): string;\n    removeDuplicateStrings(strings: Array<string>): Array<string>;\n    /**\n     * This method breaks down the chat history into chunks of messages.\n     * Each chunk consists of a sequence of messages ending with an AI message and the subsequent user response, if any.\n     *\n     * @param {BaseMessage[]} chatHistory - The chat history to be chunked.\n     *\n     * @returns {MessageChunkResult[]} An array of message chunks. Each chunk includes a sequence of messages and the subsequent user response.\n     *\n     * @description\n     * The method iterates over the chat history and pushes each message into a temporary array.\n     * When it encounters an AI message, it checks for a subsequent user message.\n     * If a user message is found, it is considered as the user response to the AI message.\n     * If no user message is found after the AI message, the user response is undefined.\n     * The method then pushes the chunk (sequence of messages and user response) into the result array.\n     * This process continues until all messages in the chat history have been processed.\n     */\n    chunkMessagesByAIResponse(chatHistory: BaseMessage[]): MessageChunkResult[];\n    /**\n     * This method processes a chat history to generate insights about the user.\n     *\n     * @param {ChainValues} values - The input values for the chain. It should contain a key for chat history.\n     * @param {CallbackManagerForChainRun} [runManager] - Optional callback manager for the chain run.\n     *\n     * @returns {Promise<ChainValues>} A promise that resolves to a list of insights about the user.\n     *\n     * @throws {Error} If the chat history key is not found in the input values or if the chat history is not an array of BaseMessages.\n     *\n     * @description\n     * The method performs the following steps:\n     * 1. Checks if the chat history key is present in the input values and if the chat history is an array of BaseMessages.\n     * 2. Breaks the chat history into chunks of messages.\n     * 3. For each chunk, it generates an initial prediction for the user's next message.\n     * 4. For each prediction, it generates insights and prediction violations, and regenerates the prediction based on the violations.\n     * 5. For each set of messages, it generates a fact/insight about the user.\n     * The method returns a list of these insights.\n     */\n    _call(values: ChainValues, runManager?: CallbackManagerForChainRun): Promise<ChainValues>;\n    private predictNextUserMessage;\n    private retrieveRelevantInsights;\n    private getPredictionViolations;\n    private generateRevisedPrediction;\n    private generateFacts;\n    /**\n     * Static method that creates a ViolationOfExpectationsChain instance from a\n     * ChatOpenAI and retriever. It also accepts optional options\n     * to customize the chain.\n     *\n     * @param llm The ChatOpenAI instance.\n     * @param retriever The retriever used for similarity search.\n     * @param options Optional options to customize the chain.\n     *\n     * @returns A new instance of ViolationOfExpectationsChain.\n     */\n    static fromLLM(llm: ChatOpenAI, retriever: BaseRetrieverInterface, options?: Partial<Omit<ViolationOfExpectationsChainInput, \"llm\" | \"retriever\">>): ViolationOfExpectationsChain;\n}\n"],"mappings":";;;;;;;;;;;;;;AAYA;AAAkD,UAAjCU,iCAAAA,SAA0CF,WAAT,CAAA;EAAA;;;AAAoB;EAejDG,SAAAA,EAVNX,sBAUkC;EAAA;;;EAQ9B,GACGM,EAfbL,UAeaK;;;;;;AAqBqBJ,cA9BtBS,4BAAAA,SAAqCJ,SAAAA,YAAqBG,iCA8BpCR,CAAAA;EAAW,OAAKO,OAAAA,CAAAA,CAAAA,EAAAA,MAAAA;EAAkB,UAoB3DN,CAAAA,CAAAA,EAAAA,MAAAA;EAAW,cAAeE,EAAAA,MAAAA;EAA0B,WAAWF,EAAAA,MAAAA;EAAW,IAAnBU,SAAAA,CAAAA,CAAAA,EAAAA,MAAAA,EAAAA;EAAO,IAiBxDZ,UAAAA,CAAAA,CAAAA,EAAAA,MAAAA,EAAAA;EAAU,SAAaD,EA5DhCA,sBA4DgCA;EAAsB,GAAyBU,EA3DrFT,UA2DqFS;EAAiC,gBAAtCI,EA1DnER,yBA0DmEQ;EAAI,kBAAZC,EAzDzDX,kBAyDyDW;EAAO,WAAiEJ,CAAAA,MAAAA,EAxDjID,iCAwDiIC;EAA4B,oBAnE3HJ,CAAAA,WAAAA,EAYpBL,WAZoBK,EAAAA,CAAAA,EAAAA,MAAAA;EAAS,sBAAYG,CAAAA,OAAAA,EAa3CE,KAb2CF,CAAAA,MAAAA,CAAAA,CAAAA,EAa3BE,KAb2BF,CAAAA,MAAAA,CAAAA;EAAiC;;;;;;;;;;;;;;;;yCA8BrER,gBAAgBO;;;;;;;;;;;;;;;;;;;;gBAoBzCN,0BAA0BE,6BAA6BQ,QAAQV;;;;;;;;;;;;;;;;;sBAiBzDF,uBAAuBD,kCAAkCe,QAAQD,KAAKJ,2DAA2DC"}

package/dist/experimental/chains/violation_of_expectations/violation_of_expectations_chain.d.ts

@@ -0,0 +1,102 @@
+import { BaseChain, ChainInputs } from "../../../chains/base.js";
+import { JsonOutputFunctionsParser } from "../../../output_parsers/openai_functions.js";
+import { MessageChunkResult } from "./types.js";
+import { CallbackManagerForChainRun } from "@langchain/core/callbacks/manager";
+import { StringOutputParser } from "@langchain/core/output_parsers";
+import { BaseMessage } from "@langchain/core/messages";
+import { ChainValues } from "@langchain/core/utils/types";
+import { ChatOpenAI } from "@langchain/openai";
+import { BaseRetrieverInterface } from "@langchain/core/retrievers";
+
+//#region src/experimental/chains/violation_of_expectations/violation_of_expectations_chain.d.ts
+
+/**
+ * Interface for the input parameters of the ViolationOfExpectationsChain class.
+ */
+interface ViolationOfExpectationsChainInput extends ChainInputs {
+  /**
+   * The retriever to use for retrieving stored
+   * thoughts and insights.
+   */
+  retriever: BaseRetrieverInterface;
+  /**
+   * The LLM to use
+   */
+  llm: ChatOpenAI;
+}
+/**
+ * Chain that generates key insights/facts of a user based on a
+ * a chat conversation with an AI.
+ */
+declare class ViolationOfExpectationsChain extends BaseChain implements ViolationOfExpectationsChainInput {
+  static lc_name(): string;
+  _chainType(): string;
+  chatHistoryKey: string;
+  thoughtsKey: string;
+  get inputKeys(): string[];
+  get outputKeys(): string[];
+  retriever: BaseRetrieverInterface;
+  llm: ChatOpenAI;
+  jsonOutputParser: JsonOutputFunctionsParser;
+  stringOutputParser: StringOutputParser;
+  constructor(fields: ViolationOfExpectationsChainInput);
+  getChatHistoryString(chatHistory: BaseMessage[]): string;
+  removeDuplicateStrings(strings: Array<string>): Array<string>;
+  /**
+   * 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.
+   *
+   * @param {BaseMessage[]} chatHistory - 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.
+   */
+  chunkMessagesByAIResponse(chatHistory: BaseMessage[]): MessageChunkResult[];
+  /**
+   * This method processes a chat history to generate insights about the user.
+   *
+   * @param {ChainValues} values - The input values for the chain. It should contain a key for chat history.
+   * @param {CallbackManagerForChainRun} [runManager] - Optional callback manager for the chain run.
+   *
+   * @returns {Promise<ChainValues>} A promise that resolves to a list of insights about the user.
+   *
+   * @throws {Error} 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.
+   */
+  _call(values: ChainValues, runManager?: CallbackManagerForChainRun): Promise<ChainValues>;
+  private predictNextUserMessage;
+  private retrieveRelevantInsights;
+  private getPredictionViolations;
+  private generateRevisedPrediction;
+  private generateFacts;
+  /**
+   * Static method that creates a ViolationOfExpectationsChain instance from a
+   * ChatOpenAI and retriever. It also accepts optional options
+   * to customize the chain.
+   *
+   * @param llm The ChatOpenAI instance.
+   * @param retriever The retriever used for similarity search.
+   * @param options Optional options to customize the chain.
+   *
+   * @returns A new instance of ViolationOfExpectationsChain.
+   */
+  static fromLLM(llm: ChatOpenAI, retriever: BaseRetrieverInterface, options?: Partial<Omit<ViolationOfExpectationsChainInput, "llm" | "retriever">>): ViolationOfExpectationsChain;
+}
+//#endregion
+export { ViolationOfExpectationsChain, ViolationOfExpectationsChainInput };
+//# sourceMappingURL=violation_of_expectations_chain.d.ts.map

package/dist/experimental/chains/violation_of_expectations/violation_of_expectations_chain.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"violation_of_expectations_chain.d.ts","names":["BaseRetrieverInterface","ChatOpenAI","BaseMessage","ChainValues","StringOutputParser","CallbackManagerForChainRun","JsonOutputFunctionsParser","BaseChain","ChainInputs","MessageChunkResult","ViolationOfExpectationsChainInput","ViolationOfExpectationsChain","Array","Promise","Omit","Partial"],"sources":["../../../../src/experimental/chains/violation_of_expectations/violation_of_expectations_chain.d.ts"],"sourcesContent":["import type { BaseRetrieverInterface } from \"@langchain/core/retrievers\";\nimport { ChatOpenAI } from \"@langchain/openai\";\nimport { BaseMessage } from \"@langchain/core/messages\";\nimport { ChainValues } from \"@langchain/core/utils/types\";\nimport { StringOutputParser } from \"@langchain/core/output_parsers\";\nimport { CallbackManagerForChainRun } from \"@langchain/core/callbacks/manager\";\nimport { JsonOutputFunctionsParser } from \"../../../output_parsers/openai_functions.js\";\nimport { BaseChain, ChainInputs } from \"../../../chains/base.js\";\nimport { MessageChunkResult } from \"./types.js\";\n/**\n * Interface for the input parameters of the ViolationOfExpectationsChain class.\n */\nexport interface ViolationOfExpectationsChainInput extends ChainInputs {\n    /**\n     * The retriever to use for retrieving stored\n     * thoughts and insights.\n     */\n    retriever: BaseRetrieverInterface;\n    /**\n     * The LLM to use\n     */\n    llm: ChatOpenAI;\n}\n/**\n * Chain that generates key insights/facts of a user based on a\n * a chat conversation with an AI.\n */\nexport declare class ViolationOfExpectationsChain extends BaseChain implements ViolationOfExpectationsChainInput {\n    static lc_name(): string;\n    _chainType(): string;\n    chatHistoryKey: string;\n    thoughtsKey: string;\n    get inputKeys(): string[];\n    get outputKeys(): string[];\n    retriever: BaseRetrieverInterface;\n    llm: ChatOpenAI;\n    jsonOutputParser: JsonOutputFunctionsParser;\n    stringOutputParser: StringOutputParser;\n    constructor(fields: ViolationOfExpectationsChainInput);\n    getChatHistoryString(chatHistory: BaseMessage[]): string;\n    removeDuplicateStrings(strings: Array<string>): Array<string>;\n    /**\n     * This method breaks down the chat history into chunks of messages.\n     * Each chunk consists of a sequence of messages ending with an AI message and the subsequent user response, if any.\n     *\n     * @param {BaseMessage[]} chatHistory - The chat history to be chunked.\n     *\n     * @returns {MessageChunkResult[]} An array of message chunks. Each chunk includes a sequence of messages and the subsequent user response.\n     *\n     * @description\n     * The method iterates over the chat history and pushes each message into a temporary array.\n     * When it encounters an AI message, it checks for a subsequent user message.\n     * If a user message is found, it is considered as the user response to the AI message.\n     * If no user message is found after the AI message, the user response is undefined.\n     * The method then pushes the chunk (sequence of messages and user response) into the result array.\n     * This process continues until all messages in the chat history have been processed.\n     */\n    chunkMessagesByAIResponse(chatHistory: BaseMessage[]): MessageChunkResult[];\n    /**\n     * This method processes a chat history to generate insights about the user.\n     *\n     * @param {ChainValues} values - The input values for the chain. It should contain a key for chat history.\n     * @param {CallbackManagerForChainRun} [runManager] - Optional callback manager for the chain run.\n     *\n     * @returns {Promise<ChainValues>} A promise that resolves to a list of insights about the user.\n     *\n     * @throws {Error} If the chat history key is not found in the input values or if the chat history is not an array of BaseMessages.\n     *\n     * @description\n     * The method performs the following steps:\n     * 1. Checks if the chat history key is present in the input values and if the chat history is an array of BaseMessages.\n     * 2. Breaks the chat history into chunks of messages.\n     * 3. For each chunk, it generates an initial prediction for the user's next message.\n     * 4. For each prediction, it generates insights and prediction violations, and regenerates the prediction based on the violations.\n     * 5. For each set of messages, it generates a fact/insight about the user.\n     * The method returns a list of these insights.\n     */\n    _call(values: ChainValues, runManager?: CallbackManagerForChainRun): Promise<ChainValues>;\n    private predictNextUserMessage;\n    private retrieveRelevantInsights;\n    private getPredictionViolations;\n    private generateRevisedPrediction;\n    private generateFacts;\n    /**\n     * Static method that creates a ViolationOfExpectationsChain instance from a\n     * ChatOpenAI and retriever. It also accepts optional options\n     * to customize the chain.\n     *\n     * @param llm The ChatOpenAI instance.\n     * @param retriever The retriever used for similarity search.\n     * @param options Optional options to customize the chain.\n     *\n     * @returns A new instance of ViolationOfExpectationsChain.\n     */\n    static fromLLM(llm: ChatOpenAI, retriever: BaseRetrieverInterface, options?: Partial<Omit<ViolationOfExpectationsChainInput, \"llm\" | \"retriever\">>): ViolationOfExpectationsChain;\n}\n"],"mappings":";;;;;;;;;;;;;;AAYA;AAAkD,UAAjCU,iCAAAA,SAA0CF,WAAT,CAAA;EAAA;;;AAAoB;EAejDG,SAAAA,EAVNX,sBAUkC;EAAA;;;EAQ9B,GACGM,EAfbL,UAeaK;;;;;;AAqBqBJ,cA9BtBS,4BAAAA,SAAqCJ,SAAAA,YAAqBG,iCA8BpCR,CAAAA;EAAW,OAAKO,OAAAA,CAAAA,CAAAA,EAAAA,MAAAA;EAAkB,UAoB3DN,CAAAA,CAAAA,EAAAA,MAAAA;EAAW,cAAeE,EAAAA,MAAAA;EAA0B,WAAWF,EAAAA,MAAAA;EAAW,IAAnBU,SAAAA,CAAAA,CAAAA,EAAAA,MAAAA,EAAAA;EAAO,IAiBxDZ,UAAAA,CAAAA,CAAAA,EAAAA,MAAAA,EAAAA;EAAU,SAAaD,EA5DhCA,sBA4DgCA;EAAsB,GAAyBU,EA3DrFT,UA2DqFS;EAAiC,gBAAtCI,EA1DnER,yBA0DmEQ;EAAI,kBAAZC,EAzDzDX,kBAyDyDW;EAAO,WAAiEJ,CAAAA,MAAAA,EAxDjID,iCAwDiIC;EAA4B,oBAnE3HJ,CAAAA,WAAAA,EAYpBL,WAZoBK,EAAAA,CAAAA,EAAAA,MAAAA;EAAS,sBAAYG,CAAAA,OAAAA,EAa3CE,KAb2CF,CAAAA,MAAAA,CAAAA,CAAAA,EAa3BE,KAb2BF,CAAAA,MAAAA,CAAAA;EAAiC;;;;;;;;;;;;;;;;yCA8BrER,gBAAgBO;;;;;;;;;;;;;;;;;;;;gBAoBzCN,0BAA0BE,6BAA6BQ,QAAQV;;;;;;;;;;;;;;;;;sBAiBzDF,uBAAuBD,kCAAkCe,QAAQD,KAAKJ,2DAA2DC"}

package/dist/experimental/chains/violation_of_expectations/violation_of_expectations_chain.js

@@ -0,0 +1,262 @@
+import { BaseChain } from "../../../chains/base.js";
+import { JsonOutputFunctionsParser } from "../../../output_parsers/openai_functions.js";
+import { PREDICTION_VIOLATIONS_FUNCTION, PREDICT_NEXT_USER_MESSAGE_FUNCTION } from "./types.js";
+import { GENERATE_FACTS_PROMPT, GENERATE_REVISED_PREDICTION_PROMPT, PREDICTION_VIOLATIONS_PROMPT, PREDICT_NEXT_USER_MESSAGE_PROMPT } from "./violation_of_expectations_prompt.js";
+import { StringOutputParser } from "@langchain/core/output_parsers";
+import { HumanMessage, isBaseMessage } from "@langchain/core/messages";
+
+//#region src/experimental/chains/violation_of_expectations/violation_of_expectations_chain.ts
+/**
+* Chain that generates key insights/facts of a user based on a
+* a chat conversation with an AI.
+*/
+var ViolationOfExpectationsChain = class extends BaseChain {
+	static lc_name() {
+		return "ViolationOfExpectationsChain";
+	}
+	_chainType() {
+		return "violation_of_expectation_chain";
+	}
+	chatHistoryKey = "chat_history";
+	thoughtsKey = "thoughts";
+	get inputKeys() {
+		return [this.chatHistoryKey];
+	}
+	get outputKeys() {
+		return [this.thoughtsKey];
+	}
+	retriever;
+	llm;
+	jsonOutputParser;
+	stringOutputParser;
+	constructor(fields) {
+		super(fields);
+		this.retriever = fields.retriever;
+		this.llm = fields.llm;
+		this.jsonOutputParser = new JsonOutputFunctionsParser();
+		this.stringOutputParser = new StringOutputParser();
+	}
+	getChatHistoryString(chatHistory) {
+		return chatHistory.map((chatMessage) => {
+			if (chatMessage._getType() === "human") return `Human: ${chatMessage.content}`;
+			else if (chatMessage._getType() === "ai") return `AI: ${chatMessage.content}`;
+			else return `${chatMessage.content}`;
+		}).join("\n");
+	}
+	removeDuplicateStrings(strings) {
+		return [...new Set(strings)];
+	}
+	/**
+	* 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.
+	*
+	* @param {BaseMessage[]} chatHistory - 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.
+	*/
+	chunkMessagesByAIResponse(chatHistory) {
+		const newArray = [];
+		const tempArray = [];
+		chatHistory.forEach((item, index) => {
+			tempArray.push(item);
+			if (item._getType() === "ai") {
+				let userResponse = chatHistory[index + 1];
+				if (!userResponse || userResponse._getType() !== "human") userResponse = void 0;
+				newArray.push({
+					chunkedMessages: tempArray,
+					userResponse: userResponse ? new HumanMessage(userResponse) : void 0
+				});
+			}
+		});
+		return newArray;
+	}
+	/**
+	* This method processes a chat history to generate insights about the user.
+	*
+	* @param {ChainValues} values - The input values for the chain. It should contain a key for chat history.
+	* @param {CallbackManagerForChainRun} [runManager] - Optional callback manager for the chain run.
+	*
+	* @returns {Promise<ChainValues>} A promise that resolves to a list of insights about the user.
+	*
+	* @throws {Error} 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.
+	*/
+	async _call(values, runManager) {
+		if (!(this.chatHistoryKey in values)) throw new Error(`Chat history key ${this.chatHistoryKey} not found`);
+		const chatHistory = values[this.chatHistoryKey];
+		const isEveryMessageBaseMessage = chatHistory.every((message) => isBaseMessage(message));
+		if (!isEveryMessageBaseMessage) throw new Error("Chat history must be an array of BaseMessages");
+		const messageChunks = this.chunkMessagesByAIResponse(chatHistory);
+		const userPredictions = await Promise.all(messageChunks.map(async (chatHistoryChunk) => ({
+			userPredictions: await this.predictNextUserMessage(chatHistoryChunk.chunkedMessages),
+			userResponse: chatHistoryChunk.userResponse,
+			runManager
+		})));
+		const predictionViolations = await Promise.all(userPredictions.map((prediction) => this.getPredictionViolations({
+			userPredictions: prediction.userPredictions,
+			userResponse: prediction.userResponse,
+			runManager
+		})));
+		const insights = await Promise.all(predictionViolations.map((violation) => this.generateFacts({
+			userResponse: violation.userResponse,
+			predictions: {
+				revisedPrediction: violation.revisedPrediction,
+				explainedPredictionErrors: violation.explainedPredictionErrors
+			}
+		})));
+		return { insights };
+	}
+	/**
+	* This method predicts the next user message based on the chat history.
+	*
+	* @param {BaseMessage[]} chatHistory - The chat history based on which the next user message is predicted.
+	* @param {CallbackManagerForChainRun} [runManager] - Optional callback manager for the chain run.
+	*
+	* @returns {Promise<PredictNextUserMessageResponse>} A promise that resolves to the predicted next user message, the user state, and any insights.
+	*
+	* @throws {Error} If the response from the language model does not contain the expected keys: 'userState', 'predictedUserMessage', and 'insights'.
+	*/
+	async predictNextUserMessage(chatHistory, runManager) {
+		const messageString = this.getChatHistoryString(chatHistory);
+		const llmWithFunctions = this.llm.bindTools([PREDICT_NEXT_USER_MESSAGE_FUNCTION]).withConfig({ function_call: { name: PREDICT_NEXT_USER_MESSAGE_FUNCTION.name } });
+		const chain = PREDICT_NEXT_USER_MESSAGE_PROMPT.pipe(llmWithFunctions).pipe(this.jsonOutputParser);
+		const res = await chain.invoke({ chat_history: messageString }, runManager?.getChild("prediction"));
+		if (!("userState" in res && "predictedUserMessage" in res && "insights" in res)) throw new Error(`Invalid response from LLM: ${JSON.stringify(res)}`);
+		const predictionResponse = res;
+		const retrievedDocs = await this.retrieveRelevantInsights(predictionResponse.insights);
+		const relevantDocs = this.removeDuplicateStrings([...predictionResponse.insights, ...retrievedDocs]);
+		return {
+			...predictionResponse,
+			insights: relevantDocs
+		};
+	}
+	/**
+	* Retrieves relevant insights based on the provided insights.
+	*
+	* @param {Array<string>} insights - An array of insights to be used for retrieving relevant documents.
+	*
+	* @returns {Promise<Array<string>>} A promise that resolves to an array of relevant insights content.
+	*/
+	async retrieveRelevantInsights(insights) {
+		const relevantInsightsDocuments = await Promise.all(insights.map(async (insight) => {
+			const relevantInsight = await this.retriever.invoke(insight);
+			return relevantInsight[0];
+		}));
+		const relevantInsightsContent = relevantInsightsDocuments.map((document) => document.pageContent);
+		return relevantInsightsContent;
+	}
+	/**
+	* This method generates prediction violations based on the predicted and actual user responses.
+	* It also generates a revised prediction based on the identified violations.
+	*
+	* @param {Object} params - The parameters for the method.
+	* @param {PredictNextUserMessageResponse} params.userPredictions - The predicted user message, user state, and insights.
+	* @param {BaseMessage} [params.userResponse] - The actual user response.
+	* @param {CallbackManagerForChainRun} [params.runManager] - Optional callback manager for the chain run.
+	*
+	* @returns {Promise<{ userResponse: BaseMessage | undefined; revisedPrediction: string; explainedPredictionErrors: Array<string>; }>} A promise that resolves to an object containing the actual user response, the revised prediction, and the explained prediction errors.
+	*
+	* @throws {Error} If the response from the language model does not contain the expected keys: 'violationExplanation', 'explainedPredictionErrors', and 'accuratePrediction'.
+	*/
+	async getPredictionViolations({ userPredictions, userResponse, runManager }) {
+		const llmWithFunctions = this.llm.bindTools([PREDICTION_VIOLATIONS_FUNCTION]).withConfig({ function_call: { name: PREDICTION_VIOLATIONS_FUNCTION.name } });
+		const chain = PREDICTION_VIOLATIONS_PROMPT.pipe(llmWithFunctions).pipe(this.jsonOutputParser);
+		if (typeof userResponse?.content !== "string") throw new Error("This chain does not support non-string model output.");
+		const res = await chain.invoke({
+			predicted_output: userPredictions.predictedUserMessage,
+			actual_output: userResponse?.content ?? "",
+			user_insights: userPredictions.insights.join("\n")
+		}, runManager?.getChild("prediction_violations"));
+		const revisedPrediction = await this.generateRevisedPrediction({
+			originalPrediction: userPredictions.predictedUserMessage,
+			explainedPredictionErrors: res.explainedPredictionErrors,
+			userInsights: userPredictions.insights,
+			runManager
+		});
+		return {
+			userResponse,
+			revisedPrediction,
+			explainedPredictionErrors: res.explainedPredictionErrors
+		};
+	}
+	/**
+	* This method generates a revised prediction based on the original prediction, explained prediction errors, and user insights.
+	*
+	* @param {Object} params - The parameters for the method.
+	* @param {string} params.originalPrediction - The original prediction made by the model.
+	* @param {Array<string>} params.explainedPredictionErrors - An array of explained prediction errors.
+	* @param {Array<string>} params.userInsights - An array of insights about the user.
+	* @param {CallbackManagerForChainRun} [params.runManager] - Optional callback manager for the chain run.
+	*
+	* @returns {Promise<string>} A promise that resolves to a revised prediction.
+	*/
+	async generateRevisedPrediction({ originalPrediction, explainedPredictionErrors, userInsights, runManager }) {
+		const revisedPredictionChain = GENERATE_REVISED_PREDICTION_PROMPT.pipe(this.llm).pipe(this.stringOutputParser);
+		const revisedPredictionRes = await revisedPredictionChain.invoke({
+			prediction: originalPrediction,
+			explained_prediction_errors: explainedPredictionErrors.join("\n"),
+			user_insights: userInsights.join("\n")
+		}, runManager?.getChild("prediction_revision"));
+		return revisedPredictionRes;
+	}
+	/**
+	* This method generates facts or insights about the user based on the revised prediction, explained prediction errors, and the user's response.
+	*
+	* @param {Object} params - The parameters for the method.
+	* @param {BaseMessage} [params.userResponse] - The actual user response.
+	* @param {Object} params.predictions - The revised prediction and explained prediction errors.
+	* @param {string} params.predictions.revisedPrediction - The revised prediction made by the model.
+	* @param {Array<string>} params.predictions.explainedPredictionErrors - An array of explained prediction errors.
+	* @param {CallbackManagerForChainRun} [params.runManager] - Optional callback manager for the chain run.
+	*
+	* @returns {Promise<string>} A promise that resolves to a string containing the generated facts or insights about the user.
+	*/
+	async generateFacts({ userResponse, predictions, runManager }) {
+		const chain = GENERATE_FACTS_PROMPT.pipe(this.llm).pipe(this.stringOutputParser);
+		if (typeof userResponse?.content !== "string") throw new Error("This chain does not support non-string model output.");
+		const res = await chain.invoke({
+			prediction_violations: predictions.explainedPredictionErrors.join("\n"),
+			prediction: predictions.revisedPrediction,
+			user_message: userResponse?.content ?? ""
+		}, runManager?.getChild("generate_facts"));
+		return res;
+	}
+	/**
+	* Static method that creates a ViolationOfExpectationsChain instance from a
+	* ChatOpenAI and retriever. It also accepts optional options
+	* to customize the chain.
+	*
+	* @param llm The ChatOpenAI instance.
+	* @param retriever The retriever used for similarity search.
+	* @param options Optional options to customize the chain.
+	*
+	* @returns A new instance of ViolationOfExpectationsChain.
+	*/
+	static fromLLM(llm, retriever, options) {
+		return new this({
+			retriever,
+			llm,
+			...options
+		});
+	}
+};
+
+//#endregion
+export { ViolationOfExpectationsChain };
+//# sourceMappingURL=violation_of_expectations_chain.js.map

package/dist/experimental/chains/violation_of_expectations/violation_of_expectations_chain.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"violation_of_expectations_chain.js","names":["fields: ViolationOfExpectationsChainInput","chatHistory: BaseMessage[]","strings: Array<string>","newArray: MessageChunkResult[]","tempArray: BaseMessage[]","userResponse: BaseMessage | undefined","values: ChainValues","runManager?: CallbackManagerForChainRun","chatHistory: unknown[]","insights: Array<string>","llm: ChatOpenAI","retriever: BaseRetrieverInterface","options?: Partial<\n      Omit<ViolationOfExpectationsChainInput, \"llm\" | \"retriever\">\n    >"],"sources":["../../../../src/experimental/chains/violation_of_expectations/violation_of_expectations_chain.ts"],"sourcesContent":["import type { BaseRetrieverInterface } from \"@langchain/core/retrievers\";\nimport { ChatOpenAI } from \"@langchain/openai\";\nimport {\n  BaseMessage,\n  HumanMessage,\n  isBaseMessage,\n} from \"@langchain/core/messages\";\nimport { ChainValues } from \"@langchain/core/utils/types\";\nimport { StringOutputParser } from \"@langchain/core/output_parsers\";\nimport { CallbackManagerForChainRun } from \"@langchain/core/callbacks/manager\";\nimport { JsonOutputFunctionsParser } from \"../../../output_parsers/openai_functions.js\";\nimport { BaseChain, ChainInputs } from \"../../../chains/base.js\";\nimport {\n  GetPredictionViolationsResponse,\n  MessageChunkResult,\n  PREDICTION_VIOLATIONS_FUNCTION,\n  PREDICT_NEXT_USER_MESSAGE_FUNCTION,\n  PredictNextUserMessageResponse,\n} from \"./types.js\";\nimport {\n  GENERATE_FACTS_PROMPT,\n  GENERATE_REVISED_PREDICTION_PROMPT,\n  PREDICTION_VIOLATIONS_PROMPT,\n  PREDICT_NEXT_USER_MESSAGE_PROMPT,\n} from \"./violation_of_expectations_prompt.js\";\n\n/**\n * Interface for the input parameters of the ViolationOfExpectationsChain class.\n */\nexport interface ViolationOfExpectationsChainInput extends ChainInputs {\n  /**\n   * The retriever to use for retrieving stored\n   * thoughts and insights.\n   */\n  retriever: BaseRetrieverInterface;\n  /**\n   * The LLM to use\n   */\n  llm: ChatOpenAI;\n}\n\n/**\n * Chain that generates key insights/facts of a user based on a\n * a chat conversation with an AI.\n */\nexport class ViolationOfExpectationsChain\n  extends BaseChain\n  implements ViolationOfExpectationsChainInput\n{\n  static lc_name() {\n    return \"ViolationOfExpectationsChain\";\n  }\n\n  _chainType(): string {\n    return \"violation_of_expectation_chain\";\n  }\n\n  chatHistoryKey = \"chat_history\";\n\n  thoughtsKey = \"thoughts\";\n\n  get inputKeys() {\n    return [this.chatHistoryKey];\n  }\n\n  get outputKeys() {\n    return [this.thoughtsKey];\n  }\n\n  retriever: BaseRetrieverInterface;\n\n  llm: ChatOpenAI;\n\n  jsonOutputParser: JsonOutputFunctionsParser;\n\n  stringOutputParser: StringOutputParser;\n\n  constructor(fields: ViolationOfExpectationsChainInput) {\n    super(fields);\n    this.retriever = fields.retriever;\n    this.llm = fields.llm;\n    this.jsonOutputParser = new JsonOutputFunctionsParser();\n    this.stringOutputParser = new StringOutputParser();\n  }\n\n  getChatHistoryString(chatHistory: BaseMessage[]): string {\n    return chatHistory\n      .map((chatMessage) => {\n        if (chatMessage._getType() === \"human\") {\n          return `Human: ${chatMessage.content}`;\n        } else if (chatMessage._getType() === \"ai\") {\n          return `AI: ${chatMessage.content}`;\n        } else {\n          return `${chatMessage.content}`;\n        }\n      })\n      .join(\"\\n\");\n  }\n\n  removeDuplicateStrings(strings: Array<string>): Array<string> {\n    return [...new Set(strings)];\n  }\n\n  /**\n   * This method breaks down the chat history into chunks of messages.\n   * Each chunk consists of a sequence of messages ending with an AI message and the subsequent user response, if any.\n   *\n   * @param {BaseMessage[]} chatHistory - The chat history to be chunked.\n   *\n   * @returns {MessageChunkResult[]} An array of message chunks. Each chunk includes a sequence of messages and the subsequent user response.\n   *\n   * @description\n   * The method iterates over the chat history and pushes each message into a temporary array.\n   * When it encounters an AI message, it checks for a subsequent user message.\n   * If a user message is found, it is considered as the user response to the AI message.\n   * If no user message is found after the AI message, the user response is undefined.\n   * The method then pushes the chunk (sequence of messages and user response) into the result array.\n   * This process continues until all messages in the chat history have been processed.\n   */\n  chunkMessagesByAIResponse(chatHistory: BaseMessage[]): MessageChunkResult[] {\n    const newArray: MessageChunkResult[] = [];\n    const tempArray: BaseMessage[] = [];\n\n    chatHistory.forEach((item, index) => {\n      tempArray.push(item);\n      if (item._getType() === \"ai\") {\n        let userResponse: BaseMessage | undefined = chatHistory[index + 1];\n        if (!userResponse || userResponse._getType() !== \"human\") {\n          userResponse = undefined;\n        }\n\n        newArray.push({\n          chunkedMessages: tempArray,\n          userResponse: userResponse\n            ? new HumanMessage(userResponse)\n            : undefined,\n        });\n      }\n    });\n\n    return newArray;\n  }\n\n  /**\n   * This method processes a chat history to generate insights about the user.\n   *\n   * @param {ChainValues} values - The input values for the chain. It should contain a key for chat history.\n   * @param {CallbackManagerForChainRun} [runManager] - Optional callback manager for the chain run.\n   *\n   * @returns {Promise<ChainValues>} A promise that resolves to a list of insights about the user.\n   *\n   * @throws {Error} If the chat history key is not found in the input values or if the chat history is not an array of BaseMessages.\n   *\n   * @description\n   * The method performs the following steps:\n   * 1. Checks if the chat history key is present in the input values and if the chat history is an array of BaseMessages.\n   * 2. Breaks the chat history into chunks of messages.\n   * 3. For each chunk, it generates an initial prediction for the user's next message.\n   * 4. For each prediction, it generates insights and prediction violations, and regenerates the prediction based on the violations.\n   * 5. For each set of messages, it generates a fact/insight about the user.\n   * The method returns a list of these insights.\n   */\n  async _call(\n    values: ChainValues,\n    runManager?: CallbackManagerForChainRun\n  ): Promise<ChainValues> {\n    if (!(this.chatHistoryKey in values)) {\n      throw new Error(`Chat history key ${this.chatHistoryKey} not found`);\n    }\n\n    const chatHistory: unknown[] = values[this.chatHistoryKey];\n\n    const isEveryMessageBaseMessage = chatHistory.every((message) =>\n      isBaseMessage(message)\n    );\n    if (!isEveryMessageBaseMessage) {\n      throw new Error(\"Chat history must be an array of BaseMessages\");\n    }\n\n    const messageChunks = this.chunkMessagesByAIResponse(\n      chatHistory as BaseMessage[]\n    );\n\n    // Generate the initial prediction for every user message.\n    const userPredictions = await Promise.all(\n      messageChunks.map(async (chatHistoryChunk) => ({\n        userPredictions: await this.predictNextUserMessage(\n          chatHistoryChunk.chunkedMessages\n        ),\n        userResponse: chatHistoryChunk.userResponse,\n        runManager,\n      }))\n    );\n\n    // Generate insights, and prediction violations for every user message.\n    // This call also regenerates the prediction based on the violations.\n    const predictionViolations = await Promise.all(\n      userPredictions.map((prediction) =>\n        this.getPredictionViolations({\n          userPredictions: prediction.userPredictions,\n          userResponse: prediction.userResponse,\n          runManager,\n        })\n      )\n    );\n\n    // Generate a fact/insight about the user for every set of messages.\n    const insights = await Promise.all(\n      predictionViolations.map((violation) =>\n        this.generateFacts({\n          userResponse: violation.userResponse,\n          predictions: {\n            revisedPrediction: violation.revisedPrediction,\n            explainedPredictionErrors: violation.explainedPredictionErrors,\n          },\n        })\n      )\n    );\n\n    return {\n      insights,\n    };\n  }\n\n  /**\n   * This method predicts the next user message based on the chat history.\n   *\n   * @param {BaseMessage[]} chatHistory - The chat history based on which the next user message is predicted.\n   * @param {CallbackManagerForChainRun} [runManager] - Optional callback manager for the chain run.\n   *\n   * @returns {Promise<PredictNextUserMessageResponse>} A promise that resolves to the predicted next user message, the user state, and any insights.\n   *\n   * @throws {Error} If the response from the language model does not contain the expected keys: 'userState', 'predictedUserMessage', and 'insights'.\n   */\n  private async predictNextUserMessage(\n    chatHistory: BaseMessage[],\n    runManager?: CallbackManagerForChainRun\n  ): Promise<PredictNextUserMessageResponse> {\n    const messageString = this.getChatHistoryString(chatHistory);\n\n    const llmWithFunctions = this.llm\n      .bindTools([PREDICT_NEXT_USER_MESSAGE_FUNCTION])\n      .withConfig({\n        function_call: { name: PREDICT_NEXT_USER_MESSAGE_FUNCTION.name },\n      });\n\n    const chain = PREDICT_NEXT_USER_MESSAGE_PROMPT.pipe(llmWithFunctions).pipe(\n      this.jsonOutputParser\n    );\n\n    const res = await chain.invoke(\n      {\n        chat_history: messageString,\n      },\n      runManager?.getChild(\"prediction\")\n    );\n\n    if (\n      !(\n        \"userState\" in res &&\n        \"predictedUserMessage\" in res &&\n        \"insights\" in res\n      )\n    ) {\n      throw new Error(`Invalid response from LLM: ${JSON.stringify(res)}`);\n    }\n\n    const predictionResponse = res as PredictNextUserMessageResponse;\n\n    // Query the retriever for relevant insights. Use the generates insights as a query.\n    const retrievedDocs = await this.retrieveRelevantInsights(\n      predictionResponse.insights\n    );\n    const relevantDocs = this.removeDuplicateStrings([\n      ...predictionResponse.insights,\n      ...retrievedDocs,\n    ]);\n\n    return {\n      ...predictionResponse,\n      insights: relevantDocs,\n    };\n  }\n\n  /**\n   * Retrieves relevant insights based on the provided insights.\n   *\n   * @param {Array<string>} insights - An array of insights to be used for retrieving relevant documents.\n   *\n   * @returns {Promise<Array<string>>} A promise that resolves to an array of relevant insights content.\n   */\n  private async retrieveRelevantInsights(\n    insights: Array<string>\n  ): Promise<Array<string>> {\n    // Only extract the first relevant doc from the retriever. We don't need more than one.\n    const relevantInsightsDocuments = await Promise.all(\n      insights.map(async (insight) => {\n        const relevantInsight = await this.retriever.invoke(insight);\n        return relevantInsight[0];\n      })\n    );\n\n    const relevantInsightsContent = relevantInsightsDocuments.map(\n      (document) => document.pageContent\n    );\n\n    return relevantInsightsContent;\n  }\n\n  /**\n   * This method generates prediction violations based on the predicted and actual user responses.\n   * It also generates a revised prediction based on the identified violations.\n   *\n   * @param {Object} params - The parameters for the method.\n   * @param {PredictNextUserMessageResponse} params.userPredictions - The predicted user message, user state, and insights.\n   * @param {BaseMessage} [params.userResponse] - The actual user response.\n   * @param {CallbackManagerForChainRun} [params.runManager] - Optional callback manager for the chain run.\n   *\n   * @returns {Promise<{ userResponse: BaseMessage | undefined; revisedPrediction: string; explainedPredictionErrors: Array<string>; }>} A promise that resolves to an object containing the actual user response, the revised prediction, and the explained prediction errors.\n   *\n   * @throws {Error} If the response from the language model does not contain the expected keys: 'violationExplanation', 'explainedPredictionErrors', and 'accuratePrediction'.\n   */\n  private async getPredictionViolations({\n    userPredictions,\n    userResponse,\n    runManager,\n  }: {\n    userPredictions: PredictNextUserMessageResponse;\n    userResponse?: BaseMessage;\n    runManager?: CallbackManagerForChainRun;\n  }): Promise<GetPredictionViolationsResponse> {\n    const llmWithFunctions = this.llm\n      .bindTools([PREDICTION_VIOLATIONS_FUNCTION])\n      .withConfig({\n        function_call: { name: PREDICTION_VIOLATIONS_FUNCTION.name },\n      });\n\n    const chain = PREDICTION_VIOLATIONS_PROMPT.pipe(llmWithFunctions).pipe(\n      this.jsonOutputParser\n    );\n\n    if (typeof userResponse?.content !== \"string\") {\n      throw new Error(\"This chain does not support non-string model output.\");\n    }\n    const res = (await chain.invoke(\n      {\n        predicted_output: userPredictions.predictedUserMessage,\n        actual_output: userResponse?.content ?? \"\",\n        user_insights: userPredictions.insights.join(\"\\n\"),\n      },\n      runManager?.getChild(\"prediction_violations\")\n    )) as Awaited<{\n      violationExplanation: string;\n      explainedPredictionErrors: Array<string>;\n      accuratePrediction: boolean;\n    }>;\n\n    // Generate a revised prediction based on violations.\n    const revisedPrediction = await this.generateRevisedPrediction({\n      originalPrediction: userPredictions.predictedUserMessage,\n      explainedPredictionErrors: res.explainedPredictionErrors,\n      userInsights: userPredictions.insights,\n      runManager,\n    });\n\n    return {\n      userResponse,\n      revisedPrediction,\n      explainedPredictionErrors: res.explainedPredictionErrors,\n    };\n  }\n\n  /**\n   * This method generates a revised prediction based on the original prediction, explained prediction errors, and user insights.\n   *\n   * @param {Object} params - The parameters for the method.\n   * @param {string} params.originalPrediction - The original prediction made by the model.\n   * @param {Array<string>} params.explainedPredictionErrors - An array of explained prediction errors.\n   * @param {Array<string>} params.userInsights - An array of insights about the user.\n   * @param {CallbackManagerForChainRun} [params.runManager] - Optional callback manager for the chain run.\n   *\n   * @returns {Promise<string>} A promise that resolves to a revised prediction.\n   */\n  private async generateRevisedPrediction({\n    originalPrediction,\n    explainedPredictionErrors,\n    userInsights,\n    runManager,\n  }: {\n    originalPrediction: string;\n    explainedPredictionErrors: Array<string>;\n    userInsights: Array<string>;\n    runManager?: CallbackManagerForChainRun;\n  }): Promise<string> {\n    const revisedPredictionChain = GENERATE_REVISED_PREDICTION_PROMPT.pipe(\n      this.llm\n    ).pipe(this.stringOutputParser);\n\n    const revisedPredictionRes = await revisedPredictionChain.invoke(\n      {\n        prediction: originalPrediction,\n        explained_prediction_errors: explainedPredictionErrors.join(\"\\n\"),\n        user_insights: userInsights.join(\"\\n\"),\n      },\n      runManager?.getChild(\"prediction_revision\")\n    );\n\n    return revisedPredictionRes;\n  }\n\n  /**\n   * This method generates facts or insights about the user based on the revised prediction, explained prediction errors, and the user's response.\n   *\n   * @param {Object} params - The parameters for the method.\n   * @param {BaseMessage} [params.userResponse] - The actual user response.\n   * @param {Object} params.predictions - The revised prediction and explained prediction errors.\n   * @param {string} params.predictions.revisedPrediction - The revised prediction made by the model.\n   * @param {Array<string>} params.predictions.explainedPredictionErrors - An array of explained prediction errors.\n   * @param {CallbackManagerForChainRun} [params.runManager] - Optional callback manager for the chain run.\n   *\n   * @returns {Promise<string>} A promise that resolves to a string containing the generated facts or insights about the user.\n   */\n  private async generateFacts({\n    userResponse,\n    predictions,\n    runManager,\n  }: {\n    userResponse?: BaseMessage;\n    /**\n     * Optional if the prediction was accurate.\n     */\n    predictions: {\n      revisedPrediction: string;\n      explainedPredictionErrors: Array<string>;\n    };\n    runManager?: CallbackManagerForChainRun;\n  }): Promise<string> {\n    const chain = GENERATE_FACTS_PROMPT.pipe(this.llm).pipe(\n      this.stringOutputParser\n    );\n\n    if (typeof userResponse?.content !== \"string\") {\n      throw new Error(\"This chain does not support non-string model output.\");\n    }\n    const res = await chain.invoke(\n      {\n        prediction_violations: predictions.explainedPredictionErrors.join(\"\\n\"),\n        prediction: predictions.revisedPrediction,\n        user_message: userResponse?.content ?? \"\",\n      },\n      runManager?.getChild(\"generate_facts\")\n    );\n\n    return res;\n  }\n\n  /**\n   * Static method that creates a ViolationOfExpectationsChain instance from a\n   * ChatOpenAI and retriever. It also accepts optional options\n   * to customize the chain.\n   *\n   * @param llm The ChatOpenAI instance.\n   * @param retriever The retriever used for similarity search.\n   * @param options Optional options to customize the chain.\n   *\n   * @returns A new instance of ViolationOfExpectationsChain.\n   */\n  static fromLLM(\n    llm: ChatOpenAI,\n    retriever: BaseRetrieverInterface,\n    options?: Partial<\n      Omit<ViolationOfExpectationsChainInput, \"llm\" | \"retriever\">\n    >\n  ): ViolationOfExpectationsChain {\n    return new this({\n      retriever,\n      llm,\n      ...options,\n    });\n  }\n}\n"],"mappings":";;;;;;;;;;;;AA6CA,IAAa,+BAAb,cACU,UAEV;CACE,OAAO,UAAU;AACf,SAAO;CACR;CAED,aAAqB;AACnB,SAAO;CACR;CAED,iBAAiB;CAEjB,cAAc;CAEd,IAAI,YAAY;AACd,SAAO,CAAC,KAAK,cAAe;CAC7B;CAED,IAAI,aAAa;AACf,SAAO,CAAC,KAAK,WAAY;CAC1B;CAED;CAEA;CAEA;CAEA;CAEA,YAAYA,QAA2C;EACrD,MAAM,OAAO;EACb,KAAK,YAAY,OAAO;EACxB,KAAK,MAAM,OAAO;EAClB,KAAK,mBAAmB,IAAI;EAC5B,KAAK,qBAAqB,IAAI;CAC/B;CAED,qBAAqBC,aAAoC;AACvD,SAAO,YACJ,IAAI,CAAC,gBAAgB;AACpB,OAAI,YAAY,UAAU,KAAK,QAC7B,QAAO,CAAC,OAAO,EAAE,YAAY,SAAS;YAC7B,YAAY,UAAU,KAAK,KACpC,QAAO,CAAC,IAAI,EAAE,YAAY,SAAS;OAEnC,QAAO,GAAG,YAAY,SAAS;EAElC,EAAC,CACD,KAAK,KAAK;CACd;CAED,uBAAuBC,SAAuC;AAC5D,SAAO,CAAC,GAAG,IAAI,IAAI,QAAS;CAC7B;;;;;;;;;;;;;;;;;CAkBD,0BAA0BD,aAAkD;EAC1E,MAAME,WAAiC,CAAE;EACzC,MAAMC,YAA2B,CAAE;EAEnC,YAAY,QAAQ,CAAC,MAAM,UAAU;GACnC,UAAU,KAAK,KAAK;AACpB,OAAI,KAAK,UAAU,KAAK,MAAM;IAC5B,IAAIC,eAAwC,YAAY,QAAQ;AAChE,QAAI,CAAC,gBAAgB,aAAa,UAAU,KAAK,SAC/C,eAAe;IAGjB,SAAS,KAAK;KACZ,iBAAiB;KACjB,cAAc,eACV,IAAI,aAAa,gBACjB;IACL,EAAC;GACH;EACF,EAAC;AAEF,SAAO;CACR;;;;;;;;;;;;;;;;;;;;CAqBD,MAAM,MACJC,QACAC,YACsB;AACtB,MAAI,EAAE,KAAK,kBAAkB,QAC3B,OAAM,IAAI,MAAM,CAAC,iBAAiB,EAAE,KAAK,eAAe,UAAU,CAAC;EAGrE,MAAMC,cAAyB,OAAO,KAAK;EAE3C,MAAM,4BAA4B,YAAY,MAAM,CAAC,YACnD,cAAc,QAAQ,CACvB;AACD,MAAI,CAAC,0BACH,OAAM,IAAI,MAAM;EAGlB,MAAM,gBAAgB,KAAK,0BACzB,YACD;EAGD,MAAM,kBAAkB,MAAM,QAAQ,IACpC,cAAc,IAAI,OAAO,sBAAsB;GAC7C,iBAAiB,MAAM,KAAK,uBAC1B,iBAAiB,gBAClB;GACD,cAAc,iBAAiB;GAC/B;EACD,GAAE,CACJ;EAID,MAAM,uBAAuB,MAAM,QAAQ,IACzC,gBAAgB,IAAI,CAAC,eACnB,KAAK,wBAAwB;GAC3B,iBAAiB,WAAW;GAC5B,cAAc,WAAW;GACzB;EACD,EAAC,CACH,CACF;EAGD,MAAM,WAAW,MAAM,QAAQ,IAC7B,qBAAqB,IAAI,CAAC,cACxB,KAAK,cAAc;GACjB,cAAc,UAAU;GACxB,aAAa;IACX,mBAAmB,UAAU;IAC7B,2BAA2B,UAAU;GACtC;EACF,EAAC,CACH,CACF;AAED,SAAO,EACL,SACD;CACF;;;;;;;;;;;CAYD,MAAc,uBACZP,aACAM,YACyC;EACzC,MAAM,gBAAgB,KAAK,qBAAqB,YAAY;EAE5D,MAAM,mBAAmB,KAAK,IAC3B,UAAU,CAAC,kCAAmC,EAAC,CAC/C,WAAW,EACV,eAAe,EAAE,MAAM,mCAAmC,KAAM,EACjE,EAAC;EAEJ,MAAM,QAAQ,iCAAiC,KAAK,iBAAiB,CAAC,KACpE,KAAK,iBACN;EAED,MAAM,MAAM,MAAM,MAAM,OACtB,EACE,cAAc,cACf,GACD,YAAY,SAAS,aAAa,CACnC;AAED,MACE,EACE,eAAe,OACf,0BAA0B,OAC1B,cAAc,KAGhB,OAAM,IAAI,MAAM,CAAC,2BAA2B,EAAE,KAAK,UAAU,IAAI,EAAE;EAGrE,MAAM,qBAAqB;EAG3B,MAAM,gBAAgB,MAAM,KAAK,yBAC/B,mBAAmB,SACpB;EACD,MAAM,eAAe,KAAK,uBAAuB,CAC/C,GAAG,mBAAmB,UACtB,GAAG,aACJ,EAAC;AAEF,SAAO;GACL,GAAG;GACH,UAAU;EACX;CACF;;;;;;;;CASD,MAAc,yBACZE,UACwB;EAExB,MAAM,4BAA4B,MAAM,QAAQ,IAC9C,SAAS,IAAI,OAAO,YAAY;GAC9B,MAAM,kBAAkB,MAAM,KAAK,UAAU,OAAO,QAAQ;AAC5D,UAAO,gBAAgB;EACxB,EAAC,CACH;EAED,MAAM,0BAA0B,0BAA0B,IACxD,CAAC,aAAa,SAAS,YACxB;AAED,SAAO;CACR;;;;;;;;;;;;;;CAeD,MAAc,wBAAwB,EACpC,iBACA,cACA,YAKD,EAA4C;EAC3C,MAAM,mBAAmB,KAAK,IAC3B,UAAU,CAAC,8BAA+B,EAAC,CAC3C,WAAW,EACV,eAAe,EAAE,MAAM,+BAA+B,KAAM,EAC7D,EAAC;EAEJ,MAAM,QAAQ,6BAA6B,KAAK,iBAAiB,CAAC,KAChE,KAAK,iBACN;AAED,MAAI,OAAO,cAAc,YAAY,SACnC,OAAM,IAAI,MAAM;EAElB,MAAM,MAAO,MAAM,MAAM,OACvB;GACE,kBAAkB,gBAAgB;GAClC,eAAe,cAAc,WAAW;GACxC,eAAe,gBAAgB,SAAS,KAAK,KAAK;EACnD,GACD,YAAY,SAAS,wBAAwB,CAC9C;EAOD,MAAM,oBAAoB,MAAM,KAAK,0BAA0B;GAC7D,oBAAoB,gBAAgB;GACpC,2BAA2B,IAAI;GAC/B,cAAc,gBAAgB;GAC9B;EACD,EAAC;AAEF,SAAO;GACL;GACA;GACA,2BAA2B,IAAI;EAChC;CACF;;;;;;;;;;;;CAaD,MAAc,0BAA0B,EACtC,oBACA,2BACA,cACA,YAMD,EAAmB;EAClB,MAAM,yBAAyB,mCAAmC,KAChE,KAAK,IACN,CAAC,KAAK,KAAK,mBAAmB;EAE/B,MAAM,uBAAuB,MAAM,uBAAuB,OACxD;GACE,YAAY;GACZ,6BAA6B,0BAA0B,KAAK,KAAK;GACjE,eAAe,aAAa,KAAK,KAAK;EACvC,GACD,YAAY,SAAS,sBAAsB,CAC5C;AAED,SAAO;CACR;;;;;;;;;;;;;CAcD,MAAc,cAAc,EAC1B,cACA,aACA,YAWD,EAAmB;EAClB,MAAM,QAAQ,sBAAsB,KAAK,KAAK,IAAI,CAAC,KACjD,KAAK,mBACN;AAED,MAAI,OAAO,cAAc,YAAY,SACnC,OAAM,IAAI,MAAM;EAElB,MAAM,MAAM,MAAM,MAAM,OACtB;GACE,uBAAuB,YAAY,0BAA0B,KAAK,KAAK;GACvE,YAAY,YAAY;GACxB,cAAc,cAAc,WAAW;EACxC,GACD,YAAY,SAAS,iBAAiB,CACvC;AAED,SAAO;CACR;;;;;;;;;;;;CAaD,OAAO,QACLC,KACAC,WACAC,SAG8B;AAC9B,SAAO,IAAI,KAAK;GACd;GACA;GACA,GAAG;EACJ;CACF;AACF"}