Class QAEvalChain

Chain to run queries against LLMs.

Example

import { LLMChain } from "langchain/chains";
import { OpenAI } from "langchain/llms/openai";
import { PromptTemplate } from "langchain/prompts";

const prompt = PromptTemplate.fromTemplate("Tell me a {adjective} joke");
const llm = new LLMChain({ llm: new OpenAI(), prompt });

Hierarchy

LLMChain
- QAEvalChain

Index

Constructors

constructor

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

Properties

llm

llm: any

LLM Wrapper to use

outputKey

outputKey: string = "text"

Key to use for output, defaults to text

prompt

prompt: BasePromptTemplate

Prompt object to use

`Optional` llmKwargs

llmKwargs?: any

Kwargs to pass to LLM

`Optional` memory

memory?: any

`Optional` outputParser

outputParser?: any

OutputParser to use

Accessors

inputKeys

get inputKeys(): any
Returns any
Inherited from LLMChain.inputKeys
- Defined in langchain/src/chains/llm_chain.ts:110

outputKeys

get outputKeys(): string[]
Returns string[]
Inherited from LLMChain.outputKeys
- Defined in langchain/src/chains/llm_chain.ts:114

Methods

apply

apply(inputs, config?): Promise<ChainValues[]>
Parameters
- inputs: ChainValues[]
- Optional config: any[]
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 LLMChain.apply
- Defined in langchain/src/chains/base.ts:256

call

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

Wraps _call and handles memory.
Parameters
- values: any
- Optional config: any
Returns Promise<ChainValues>
Inherited from LLMChain.call
- Defined in langchain/src/chains/llm_chain.ts:175

evaluate

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

invoke

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

predict

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

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 LLMChain.prepOutputs
- Defined in langchain/src/chains/base.ts:148

run

run(input, config?): Promise<string>
Parameters
- input: any
- Optional config: any
Returns Promise<string>

Deprecated
Use .invoke() instead. Will be removed in 0.2.0.
Inherited from LLMChain.run
- Defined in langchain/src/chains/base.ts:188

serialize

serialize(): SerializedLLMChain
Returns SerializedLLMChain

Deprecated
Inherited from LLMChain.serialize
- Defined in langchain/src/chains/llm_chain.ts:269

`Static` deserialize

deserialize(data): 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 langchain/src/chains/llm_chain.ts:253

`Static` fromLlm

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

Class QAEvalChain

Example

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

fields: LLMChainInput<string, any>

Returns QAEvalChain

Properties

llm

outputKey

prompt

Optional llmKwargs

Optional memory

Optional outputParser

Accessors

inputKeys

Returns any

outputKeys

Returns string[]

Methods

apply

Parameters

inputs: ChainValues[]

Optional config: any[]

Returns Promise<ChainValues[]>

⚠️ Deprecated ⚠️

call

Parameters

values: any

Optional config: any

Returns Promise<ChainValues>

evaluate

Parameters

examples: ChainValues

predictions: ChainValues

args: EvaluateArgs = ...

Returns Promise<ChainValues>

invoke

Parameters

input: ChainValues

Optional config: any

Returns Promise<ChainValues>

predict

Parameters

values: any

Optional callbackManager: any

Returns Promise<string>

Example

prepOutputs

Parameters

inputs: Record<string, unknown>

outputs: Record<string, unknown>

returnOnlyOutputs: boolean = false

Returns Promise<Record<string, unknown>>

run

Parameters

input: any

Optional config: any

Returns Promise<string>

Deprecated

serialize

Returns SerializedLLMChain

Deprecated

Static deserialize

Parameters

data: SerializedLLMChain

Returns Promise<LLMChain<string, any>>

Static fromLlm

Parameters

llm: BaseLanguageModelInterface

options: { chainInput?: Omit<LLMChainInput<string, any>, "llm">; prompt?: any; } = {}

Optional chainInput?: Omit<LLMChainInput<string, any>, "llm">

Optional prompt?: any

Returns QAEvalChain

`Optional` llmKwargs

`Optional` memory

`Optional` outputParser

`Optional` config: any[]

`Optional` config: any

`Optional` config: any

`Optional` callbackManager: any

`Optional` config: any

`Static` deserialize

`Static` fromLlm

options: {
chainInput?: Omit<LLMChainInput<string, any>, "llm">;
prompt?: any;
} = {}

`Optional` chainInput?: Omit<LLMChainInput<string, any>, "llm">

`Optional` prompt?: any