Class ViolationOfExpectationsChain

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

Hierarchy (View Summary)

BaseChain
- ViolationOfExpectationsChain

Implements

ViolationOfExpectationsChainInput

Index

Constructors

constructor

new ViolationOfExpectationsChain(
fields: ViolationOfExpectationsChainInput,
): ViolationOfExpectationsChain
Parameters
- fields: ViolationOfExpectationsChainInput
Returns ViolationOfExpectationsChain
Overrides BaseChain.constructor
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-classic/src/experimental/chains/violation_of_expectations/violation_of_expectations_chain.ts:78

Properties

chatHistoryKey

chatHistoryKey: string = "chat_history"

jsonOutputParser

jsonOutputParser: JsonOutputFunctionsParser

llm

llm: ChatOpenAI

The LLM to use

`Optional`memory

memory?: any

retriever

retriever: BaseRetrieverInterface

The retriever to use for retrieving stored thoughts and insights.

stringOutputParser

stringOutputParser: StringOutputParser

thoughtsKey

thoughtsKey: string = "thoughts"

Accessors

inputKeys

get inputKeys(): string[]
Returns string[]
Overrides BaseChain.inputKeys
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-classic/src/experimental/chains/violation_of_expectations/violation_of_expectations_chain.ts:62

lc_namespace

get lc_namespace(): string[]
Returns string[]
Inherited from BaseChain.lc_namespace
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-classic/src/chains/base.ts:41

outputKeys

get outputKeys(): string[]
Returns string[]
Overrides BaseChain.outputKeys
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-classic/src/experimental/chains/violation_of_expectations/violation_of_expectations_chain.ts:66

Methods

_call

_call(values: ChainValues, runManager?: any): Promise<ChainValues>
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.
- OptionalrunManager: any
  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.
Overrides BaseChain._call
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-classic/src/experimental/chains/violation_of_expectations/violation_of_expectations_chain.ts:163

_chainType

_chainType(): string
Return the string type key uniquely identifying this class of chain.

Returns string
Overrides BaseChain._chainType
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-classic/src/experimental/chains/violation_of_expectations/violation_of_expectations_chain.ts:54

`Protected`_formatValues

_formatValues(values: any): Promise<any>
Parameters
- values: any
Returns Promise<any>
Inherited from BaseChain._formatValues
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-classic/src/chains/base.ts:217

apply

apply(inputs: ChainValues[], config?: any[]): Promise<ChainValues[]>
Parameters
- inputs: ChainValues[]
- Optionalconfig: any[]
Returns Promise<ChainValues[]>
Deprecated
Use .batch() instead. Will be removed in 0.2.0.

Call the chain on all inputs in the list
Inherited from BaseChain.apply
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-classic/src/chains/base.ts:258

call

call(values: any, config?: any, tags?: string[]): Promise<ChainValues>
Parameters
- values: any
- Optionalconfig: any
- Optionaltags: string[]
  Deprecated
Returns Promise<ChainValues>
Deprecated
Use .invoke() instead. Will be removed in 0.2.0.

Run the core logic of this chain and add to output if desired.

Wraps _call and handles memory.
Inherited from BaseChain.call
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-classic/src/chains/base.ts:243

chunkMessagesByAIResponse

chunkMessagesByAIResponse(chatHistory: BaseMessage[]): MessageChunkResult[]
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.
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-classic/src/experimental/chains/violation_of_expectations/violation_of_expectations_chain.ts:120

getChatHistoryString

getChatHistoryString(chatHistory: BaseMessage[]): string
Parameters
- chatHistory: BaseMessage[]
Returns string
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-classic/src/experimental/chains/violation_of_expectations/violation_of_expectations_chain.ts:86

invoke

invoke(input: ChainValues, options?: any): Promise<ChainValues>
Invoke the chain with the provided input and returns the output.
Parameters
- input: ChainValues
  Input values for the chain run.
- Optionaloptions: any
Returns Promise<ChainValues>
Promise that resolves with the output of the chain run.
Inherited from BaseChain.invoke
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-classic/src/chains/base.ts:86

prepOutputs

prepOutputs(
    inputs: Record<string, unknown>,
    outputs: Record<string, unknown>,
    returnOnlyOutputs?: boolean,
): Promise<Record<string, unknown>>
Parameters
- inputs: Record<string, unknown>
- outputs: Record<string, unknown>
- returnOnlyOutputs: boolean = false
Returns Promise<Record<string, unknown>>
Inherited from BaseChain.prepOutputs
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-classic/src/chains/base.ts:149

removeDuplicateStrings

removeDuplicateStrings(strings: string[]): string[]
Parameters
- strings: string[]
Returns string[]
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-classic/src/experimental/chains/violation_of_expectations/violation_of_expectations_chain.ts:100

run

run(input: any, config?: any): Promise<string>
Parameters
- input: any
- Optionalconfig: any
Returns Promise<string>
Deprecated
Use .invoke() instead. Will be removed in 0.2.0.
Inherited from BaseChain.run
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-classic/src/chains/base.ts:190

serialize

serialize(): SerializedBaseChain
Return a json-like object representing this chain.

Returns SerializedBaseChain
Inherited from BaseChain.serialize
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-classic/src/chains/base.ts:181

`Static`deserialize

deserialize(
data: SerializedBaseChain,
values?: LoadValues,
): Promise<BaseChain<ChainValues, ChainValues>>
Load a chain from a json-like object describing it.
Parameters
- data: SerializedBaseChain
- values: LoadValues = {}
Returns Promise<BaseChain<ChainValues, ChainValues>>
Inherited from BaseChain.deserialize
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-classic/src/chains/base.ts:270

`Static`fromLLM

fromLLM(
    llm: ChatOpenAI,
    retriever: BaseRetrieverInterface,
    options?: Partial<
        Omit<ViolationOfExpectationsChainInput, "llm" | "retriever">,
    >,
): ViolationOfExpectationsChain
Static method that creates a ViolationOfExpectationsChain instance from a ChatOpenAI and retriever. It also accepts optional options to customize the chain.
Parameters
- llm: ChatOpenAI
  The ChatOpenAI instance.
- retriever: BaseRetrieverInterface
  The retriever used for similarity search.
- Optionaloptions: Partial<Omit<ViolationOfExpectationsChainInput, "llm" | "retriever">>
  Optional options to customize the chain.
Returns ViolationOfExpectationsChain
A new instance of ViolationOfExpectationsChain.
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-classic/src/experimental/chains/violation_of_expectations/violation_of_expectations_chain.ts:468

`Static`lc_name

lc_name(): string
Returns string
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-classic/src/experimental/chains/violation_of_expectations/violation_of_expectations_chain.ts:50

Class ViolationOfExpectationsChain

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ViolationOfExpectationsChain

Properties

chatHistoryKey

jsonOutputParser

llm

Optionalmemory

retriever

stringOutputParser

thoughtsKey

Accessors

inputKeys

Returns string[]

lc_namespace

Returns string[]

outputKeys

Returns string[]

Methods

_call

Parameters

Returns Promise<ChainValues>

Throws

Description

_chainType

Returns string

Protected_formatValues

Parameters

Returns Promise<any>

apply

Parameters

Returns Promise<ChainValues[]>

Deprecated

call

Parameters

Deprecated

Returns Promise<ChainValues>

Deprecated

chunkMessagesByAIResponse

Parameters

Returns MessageChunkResult[]

Description

getChatHistoryString

Parameters

Returns string

invoke

Parameters

Returns Promise<ChainValues>

prepOutputs

Parameters

Returns Promise<Record<string, unknown>>

removeDuplicateStrings

Parameters

Returns string[]

run

Parameters

Returns Promise<string>

Deprecated

serialize

Returns SerializedBaseChain

Staticdeserialize

Parameters

Returns Promise<BaseChain<ChainValues, ChainValues>>

StaticfromLLM

Parameters

Returns ViolationOfExpectationsChain

Staticlc_name

Returns string

Settings

On This Page

`Optional`memory

`Protected`_formatValues

`Static`deserialize

`Static`fromLLM

`Static`lc_name