Class ViolationOfExpectationsChain

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

Hierarchy (view full)

BaseChain
- ViolationOfExpectationsChain

Implements

ViolationOfExpectationsChainInput

Index

Constructors

constructor

new ViolationOfExpectationsChain(fields): ViolationOfExpectationsChain
Parameters
- fields: ViolationOfExpectationsChainInput
Returns ViolationOfExpectationsChain
Overrides BaseChain.constructor
- Defined in langchain/src/experimental/chains/violation_of_expectations/violation_of_expectations_chain.ts:78

Properties

chatHistoryKey

chatHistoryKey: string = "chat_history"

jsonOutputParser

jsonOutputParser: JsonOutputFunctionsParser<object>

llm

llm: ChatOpenAI

The LLM to use

retriever

retriever: BaseRetrieverInterface<Record<string, any>>

The retriever to use for retrieving stored thoughts and insights.

stringOutputParser

stringOutputParser: StringOutputParser

thoughtsKey

thoughtsKey: string = "thoughts"

`Optional` memory

memory?: BaseMemory

Accessors

inputKeys

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

outputKeys

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

Methods

apply

apply(inputs, config?): Promise<ChainValues[]>
Parameters
- inputs: ChainValues[]
- Optional config: (RunnableConfig | CallbackManager | (BaseCallbackHandler | BaseCallbackHandlerMethodsClass)[])[]
Returns Promise<ChainValues[]>

⚠️ Deprecated ⚠️

Use .batch() instead. Will be removed in 0.2.0.

This feature is deprecated and will be removed in the future.

It is not recommended for use.

Call the chain on all inputs in the list
Inherited from BaseChain.apply
- Defined in langchain/src/chains/base.ts:258

call

call(values, config?, tags?): Promise<ChainValues>
Parameters
- values: ChainValues & {
  signal?: AbortSignal;
  timeout?: number;
  }
- Optional config: RunnableConfig | CallbackManager | (BaseCallbackHandler | BaseCallbackHandlerMethodsClass)[]
- Optional tags: 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 langchain/src/chains/base.ts:243

chunkMessagesByAIResponse

chunkMessagesByAIResponse(chatHistory): 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 langchain/src/experimental/chains/violation_of_expectations/violation_of_expectations_chain.ts:120

getChatHistoryString

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

invoke

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

prepOutputs

prepOutputs(inputs, outputs, returnOnlyOutputs?): 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 langchain/src/chains/base.ts:149

removeDuplicateStrings

removeDuplicateStrings(strings): string[]
Parameters
- strings: string[]
Returns string[]
- Defined in langchain/src/experimental/chains/violation_of_expectations/violation_of_expectations_chain.ts:100

run

run(input, config?): Promise<string>
Parameters
- input: any
- Optional config: RunnableConfig | CallbackManager | (BaseCallbackHandler | BaseCallbackHandlerMethodsClass)[]
Returns Promise<string>
Deprecated
Use .invoke() instead. Will be removed in 0.2.0.
Inherited from BaseChain.run
- Defined in langchain/src/chains/base.ts:190

serialize

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

Returns SerializedBaseChain
Inherited from BaseChain.serialize
- Defined in langchain/src/chains/base.ts:181

`Static` deserialize

deserialize(data, values?): 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 langchain/src/chains/base.ts:270

`Static` fromLLM

fromLLM(llm, retriever, options?): 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<Record<string, any>>
  The retriever used for similarity search.
- Optional options: Partial<Omit<ViolationOfExpectationsChainInput, "llm" | "retriever">>
  Optional options to customize the chain.
Returns ViolationOfExpectationsChain
A new instance of ViolationOfExpectationsChain.
- Defined in langchain/src/experimental/chains/violation_of_expectations/violation_of_expectations_chain.ts:468

Class ViolationOfExpectationsChain

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

fields: ViolationOfExpectationsChainInput

Returns ViolationOfExpectationsChain

Properties

chatHistoryKey

jsonOutputParser

llm

retriever

stringOutputParser

thoughtsKey

Optional memory

Accessors

inputKeys

Returns string[]

outputKeys

Returns string[]

Methods

apply

Parameters

inputs: ChainValues[]

Optional config: (RunnableConfig | CallbackManager | (BaseCallbackHandler | BaseCallbackHandlerMethodsClass)[])[]

Returns Promise<ChainValues[]>

⚠️ Deprecated ⚠️

call

Parameters

values: ChainValues & { signal?: AbortSignal; timeout?: number; }

Optional config: RunnableConfig | CallbackManager | (BaseCallbackHandler | BaseCallbackHandlerMethodsClass)[]

Optional tags: string[]

Deprecated

Returns Promise<ChainValues>

Deprecated

chunkMessagesByAIResponse

Parameters

chatHistory: BaseMessage[]

Returns MessageChunkResult[]

Description

getChatHistoryString

Parameters

chatHistory: BaseMessage[]

Returns string

invoke

Parameters

input: ChainValues

Optional options: RunnableConfig

Returns Promise<ChainValues>

prepOutputs

Parameters

inputs: Record<string, unknown>

outputs: Record<string, unknown>

returnOnlyOutputs: boolean = false

Returns Promise<Record<string, unknown>>

removeDuplicateStrings

Parameters

strings: string[]

Returns string[]

run

Parameters

input: any

Optional config: RunnableConfig | CallbackManager | (BaseCallbackHandler | BaseCallbackHandlerMethodsClass)[]

Returns Promise<string>

Deprecated

serialize

Returns SerializedBaseChain

Static deserialize

Parameters

data: SerializedBaseChain

values: LoadValues = {}

Returns Promise<BaseChain<ChainValues, ChainValues>>

Static fromLLM

Parameters

`Optional` memory

`Optional` config: (RunnableConfig | CallbackManager | (BaseCallbackHandler | BaseCallbackHandlerMethodsClass)[])[]

values: ChainValues & {
signal?: AbortSignal;
timeout?: number;
}

`Optional` config: RunnableConfig | CallbackManager | (BaseCallbackHandler | BaseCallbackHandlerMethodsClass)[]

`Optional` tags: string[]

`Optional` options: RunnableConfig

`Optional` config: RunnableConfig | CallbackManager | (BaseCallbackHandler | BaseCallbackHandlerMethodsClass)[]

`Static` deserialize

`Static` fromLLM

`Optional` options: Partial<Omit<ViolationOfExpectationsChainInput, "llm" | "retriever">>