Class QAEvalChain

Deprecated

This class will be removed in 1.0.0. Use the LangChain Expression Language (LCEL) instead. See the example below for how to use LCEL with the LLMChain class:

Chain to run queries against LLMs.

Example

import { ChatPromptTemplate } from "@langchain/core/prompts";
import { ChatOpenAI } from "@langchain/openai";

const prompt = ChatPromptTemplate.fromTemplate("Tell me a {adjective} joke");
const llm = new ChatOpenAI({ model: "gpt-4o-mini" });
const chain = prompt.pipe(llm);

const response = await chain.invoke({ adjective: "funny" });

Hierarchy (View Summary)

LLMChain
- QAEvalChain

Index

Constructors

constructor

new QAEvalChain(fields: LLMChainInput<string, any>): QAEvalChain
Parameters
- fields: LLMChainInput<string, any>
Returns QAEvalChain
Inherited from LLMChain.constructor
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/llm_chain.ts:123

Properties

lc_serializable

lc_serializable: boolean = true

llm

llm: any

LLM Wrapper to use

`Optional`llmKwargs

llmKwargs?: any

Kwargs to pass to LLM

`Optional`memory

memory?: any

outputKey

outputKey: string = "text"

Key to use for output, defaults to text

`Optional`outputParser

outputParser?: any

OutputParser to use

prompt

prompt: BasePromptTemplate

Prompt object to use

Accessors

inputKeys

get inputKeys(): any
Returns any
Inherited from LLMChain.inputKeys
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/llm_chain.ts:115

lc_namespace

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

outputKeys

get outputKeys(): string[]
Returns string[]
Inherited from LLMChain.outputKeys
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/llm_chain.ts:119

Methods

_chainType

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

Returns "llm"
Inherited from LLMChain._chainType
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/llm_chain.ts:254

`Protected`_formatValues

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

_getNumTokens

_getNumTokens(text: string): Promise<number>
Parameters
- text: string
Returns Promise<number>
Inherited from LLMChain._getNumTokens
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/llm_chain.ts:284

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 LLMChain.apply
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/base.ts:258

call

call(values: any, config?: any): Promise<ChainValues>
Run the core logic of this chain and add to output if desired.

Wraps _call and handles memory.
Parameters
- values: any
- Optionalconfig: any
Returns Promise<ChainValues>
Inherited from LLMChain.call
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/llm_chain.ts:180

evaluate

evaluate(
    examples: ChainValues,
    predictions: ChainValues,
    args?: EvaluateArgs,
): Promise<ChainValues>
Parameters
- examples: ChainValues
- predictions: ChainValues
- args: EvaluateArgs = ...
Returns Promise<ChainValues>
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/evaluation/qa/eval_chain.ts:47

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 LLMChain.invoke
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/base.ts:86

predict

predict(values: any, callbackManager?: any): Promise<string>
Format prompt with values and pass to LLM
Parameters
- values: any
  keys to pass to prompt template
- OptionalcallbackManager: any
  CallbackManager to use
Returns Promise<string>
Completion from LLM.
Example
```
llm.predict({ adjective: "funny" })
```
Inherited from LLMChain.predict
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/llm_chain.ts:246

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 LLMChain.prepOutputs
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/base.ts:149

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 LLMChain.run
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/base.ts:190

serialize

serialize(): SerializedLLMChain
Returns SerializedLLMChain
Deprecated
Inherited from LLMChain.serialize
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/llm_chain.ts:274

`Static`deserialize

deserialize(data: SerializedLLMChain): Promise<LLMChain<string, any>>
Load a chain from a json-like object describing it.
Parameters
- data: SerializedLLMChain
Returns Promise<LLMChain<string, any>>
Inherited from LLMChain.deserialize
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/llm_chain.ts:258

`Static`fromLlm

fromLlm(
    llm: BaseLanguageModelInterface,
    options?: {
        chainInput?: Omit<LLMChainInput<string, any>, "llm">;
        prompt?: any;
    },
): QAEvalChain
Parameters
- llm: BaseLanguageModelInterface
- options: { chainInput?: Omit<LLMChainInput<string, any>, "llm">; prompt?: any } = {}
Returns QAEvalChain
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/evaluation/qa/eval_chain.ts:21

`Static`lc_name

lc_name(): string
Returns string
Overrides LLMChain.lc_name
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/evaluation/qa/eval_chain.ts:17

Class QAEvalChain

Deprecated

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns QAEvalChain

Properties

lc_serializable

llm

OptionalllmKwargs

Optionalmemory

outputKey

OptionaloutputParser

prompt

Accessors

inputKeys

Returns any

lc_namespace

Returns string[]

outputKeys

Returns string[]

Methods

_chainType

Returns "llm"

Protected_formatValues

Parameters

Returns Promise<any>

_getNumTokens

Parameters

Returns Promise<number>

apply

Parameters

Returns Promise<ChainValues[]>

Deprecated

call

Parameters

Returns Promise<ChainValues>

evaluate

Parameters

Returns Promise<ChainValues>

invoke

Parameters

Returns Promise<ChainValues>

predict

Parameters

Returns Promise<string>

Example

prepOutputs

Parameters

Returns Promise<Record<string, unknown>>

run

Parameters

Returns Promise<string>

Deprecated

serialize

Returns SerializedLLMChain

Deprecated

Staticdeserialize

Parameters

Returns Promise<LLMChain<string, any>>

StaticfromLlm

Parameters

Returns QAEvalChain

Staticlc_name

Returns string

Settings

On This Page

`Optional`llmKwargs

`Optional`memory

`Optional`outputParser

`Protected`_formatValues

`Static`deserialize

`Static`fromLlm

`Static`lc_name