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

Constructors

constructor

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

Properties

llm

llm: LLMType

LLM Wrapper to use

outputKey

outputKey: string = "text"

Key to use for output, defaults to text

prompt

prompt: BasePromptTemplate<any, BasePromptValue, any>

Prompt object to use

verbose

verbose: boolean

Whether to print out response text.

`Optional` callbacks

callbacks?: Callbacks

`Optional` llmKwargs

llmKwargs?: any

Kwargs to pass to LLM

`Optional` memory

memory?: BaseMemory

`Optional` metadata

metadata?: Record<string, unknown>

`Optional` outputParser

outputParser?: BaseLLMOutputParser<string>

OutputParser to use

`Optional` tags

tags?: string[]

`Protected` lc_runnable

lc_runnable: boolean = true

Accessors

inputKeys

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

outputKeys

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

Methods

apply

apply(inputs, config?): Promise<ChainValues[]>
Call the chain on all inputs in the list
Parameters
- inputs: ChainValues[]
- Optional config: (Callbacks | BaseCallbackConfig)[]
Returns Promise<ChainValues[]>
Inherited from LLMChain.apply
- Defined in langchain/src/chains/base.ts:222

batch

batch(inputs, options?, batchOptions?): Promise<ChainValues[]>
Default implementation of batch, which calls invoke N times. Subclasses should override this method if they can batch more efficiently.
Parameters
- inputs: ChainValues[]
  
  Array of inputs to each batch call.
- Optional options: Partial<BaseCallbackConfig> | Partial<BaseCallbackConfig>[]
  
  Either a single call options object to apply to each batch call or an array for each call.
- Optional batchOptions: RunnableBatchOptions & {
  returnExceptions?: false;
  }
Returns Promise<ChainValues[]>
An array of RunOutputs, or mixed RunOutputs and errors if batchOptions.returnExceptions is set
Inherited from LLMChain.batch
- Defined in langchain/src/schema/runnable/base.ts:157
batch(inputs, options?, batchOptions?): Promise<(Error | ChainValues)[]>
Parameters
- inputs: ChainValues[]
- Optional options: Partial<BaseCallbackConfig> | Partial<BaseCallbackConfig>[]
- Optional batchOptions: RunnableBatchOptions & {
  returnExceptions: true;
  }
Returns Promise<(Error | ChainValues)[]>
Inherited from LLMChain.batch
- Defined in langchain/src/schema/runnable/base.ts:163
batch(inputs, options?, batchOptions?): Promise<(Error | ChainValues)[]>
Parameters
- inputs: ChainValues[]
- Optional options: Partial<BaseCallbackConfig> | Partial<BaseCallbackConfig>[]
- Optional batchOptions: RunnableBatchOptions
Returns Promise<(Error | ChainValues)[]>
Inherited from LLMChain.batch
- Defined in langchain/src/schema/runnable/base.ts:169

bind

bind(kwargs): Runnable<ChainValues, ChainValues, BaseCallbackConfig>
Bind arguments to a Runnable, returning a new Runnable.
Parameters
- kwargs: Partial<BaseCallbackConfig>
Returns Runnable<ChainValues, ChainValues, BaseCallbackConfig>
A new RunnableBinding that, when invoked, will apply the bound args.
Inherited from LLMChain.bind
- Defined in langchain/src/schema/runnable/base.ts:66

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: Callbacks | BaseCallbackConfig
Returns Promise<ChainValues>
Inherited from LLMChain.call
- Defined in langchain/src/chains/llm_chain.ts:178

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:48

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: BaseCallbackConfig
  
  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:83

map

map(): Runnable<ChainValues[], ChainValues[], BaseCallbackConfig>
Return a new Runnable that maps a list of inputs to a list of outputs, by calling invoke() with each input.

Returns Runnable<ChainValues[], ChainValues[], BaseCallbackConfig>
Inherited from LLMChain.map
- Defined in langchain/src/schema/runnable/base.ts:77

pipe

pipe<NewRunOutput>(coerceable): RunnableSequence<ChainValues, Exclude<NewRunOutput, Error>>
Create a new runnable sequence that runs each individual runnable in series, piping the output of one runnable into another runnable or runnable-like.
Type Parameters
- NewRunOutput
Parameters
- coerceable: RunnableLike<ChainValues, NewRunOutput>
  
  A runnable, function, or object whose values are functions or runnables.
Returns RunnableSequence<ChainValues, Exclude<NewRunOutput, Error>>
A new runnable sequence.
Inherited from LLMChain.pipe
- Defined in langchain/src/schema/runnable/base.ts:456

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: CallbackManager
  
  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:244

run

run(input, config?): Promise<string>
Parameters
- input: any
- Optional config: Callbacks | BaseCallbackConfig
Returns Promise<string>
Inherited from LLMChain.run
- Defined in langchain/src/chains/base.ts:111

serialize

serialize(): SerializedLLMChain
Returns SerializedLLMChain

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

stream

stream(input, options?): Promise<IterableReadableStream<ChainValues>>
Stream output in chunks.
Parameters
- input: ChainValues
- Optional options: Partial<BaseCallbackConfig>
Returns Promise<IterableReadableStream<ChainValues>>
A readable stream that is also an iterable.
Inherited from LLMChain.stream
- Defined in langchain/src/schema/runnable/base.ts:223

streamLog

streamLog(input, options?, streamOptions?): AsyncGenerator<RunLogPatch, any, unknown>
Stream all output from a runnable, as reported to the callback system. This includes all inner runs of LLMs, Retrievers, Tools, etc. Output is streamed as Log objects, which include a list of jsonpatch ops that describe how the state of the run has changed in each step, and the final state of the run. The jsonpatch ops can be applied in order to construct state.
Parameters
- input: ChainValues
- Optional options: Partial<BaseCallbackConfig>
- Optional streamOptions: Omit<LogStreamCallbackHandlerInput, "autoClose">
Returns AsyncGenerator<RunLogPatch, any, unknown>
Inherited from LLMChain.streamLog
- Defined in langchain/src/schema/runnable/base.ts:502

toJSON

toJSON(): Serialized
Returns Serialized
Inherited from LLMChain.toJSON
- Defined in langchain/src/load/serializable.ts:147

toJSONNotImplemented

toJSONNotImplemented(): SerializedNotImplemented
Returns SerializedNotImplemented
Inherited from LLMChain.toJSONNotImplemented
- Defined in langchain/src/load/serializable.ts:221

transform

transform(generator, options): AsyncGenerator<ChainValues, any, unknown>
Default implementation of transform, which buffers input and then calls stream. Subclasses should override this method if they can start producing output while input is still being generated.
Parameters
- generator: AsyncGenerator<ChainValues, any, unknown>
- options: Partial<BaseCallbackConfig>
Returns AsyncGenerator<ChainValues, any, unknown>
Inherited from LLMChain.transform
- Defined in langchain/src/schema/runnable/base.ts:473

withConfig

withConfig(config): RunnableBinding<ChainValues, ChainValues, BaseCallbackConfig>
Bind config to a Runnable, returning a new Runnable.
Parameters
- config: BaseCallbackConfig
  
  New configuration parameters to attach to the new runnable.
Returns RunnableBinding<ChainValues, ChainValues, BaseCallbackConfig>
A new RunnableBinding with a config matching what's passed.
Inherited from LLMChain.withConfig
- Defined in langchain/src/schema/runnable/base.ts:106

withFallbacks

withFallbacks(fields): RunnableWithFallbacks<ChainValues, ChainValues>
Create a new runnable from the current one that will try invoking other passed fallback runnables if the initial invocation fails.
Parameters
- fields: {
  fallbacks: Runnable<ChainValues, ChainValues, BaseCallbackConfig>[];
  }
  - fallbacks: Runnable<ChainValues, ChainValues, BaseCallbackConfig>[]
    
    Other runnables to call if the runnable errors.
Returns RunnableWithFallbacks<ChainValues, ChainValues>
A new RunnableWithFallbacks.
Inherited from LLMChain.withFallbacks
- Defined in langchain/src/schema/runnable/base.ts:123

withRetry

withRetry(fields?): RunnableRetry<ChainValues, ChainValues, BaseCallbackConfig>
Add retry logic to an existing runnable.
Parameters
- Optional fields: {
  onFailedAttempt?: RunnableRetryFailedAttemptHandler;
  stopAfterAttempt?: number;
  }
  - Optional onFailedAttempt?: RunnableRetryFailedAttemptHandler
  - Optional stopAfterAttempt?: number
Returns RunnableRetry<ChainValues, ChainValues, BaseCallbackConfig>
A new RunnableRetry that, when invoked, will retry according to the parameters.
Inherited from LLMChain.withRetry
- Defined in langchain/src/schema/runnable/base.ts:87

`Static` deserialize

deserialize(data): Promise<LLMChain<string, BaseLanguageModel<any, BaseLanguageModelCallOptions>>>
Load a chain from a json-like object describing it.
Parameters
- data: SerializedLLMChain
Returns Promise<LLMChain<string, BaseLanguageModel<any, BaseLanguageModelCallOptions>>>
Inherited from LLMChain.deserialize
- Defined in langchain/src/chains/llm_chain.ts:257

`Static` fromLlm

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

`Static` isRunnable

isRunnable(thing): thing is Runnable<any, any, BaseCallbackConfig>
Parameters
- thing: any
Returns thing is Runnable<any, any, BaseCallbackConfig>
Inherited from LLMChain.isRunnable
- Defined in langchain/src/schema/runnable/base.ts:552

`Protected` _callWithConfig

_callWithConfig<T>(func, input, options?): Promise<ChainValues>
Type Parameters
- T extends ChainValues
Parameters
- func: ((input) => Promise<ChainValues>) | ((input, config?, runManager?) => Promise<ChainValues>)
- input: T
- Optional options: Partial<BaseCallbackConfig> & {
  runType?: string;
  }
Returns Promise<ChainValues>
Inherited from LLMChain._callWithConfig
- Defined in langchain/src/schema/runnable/base.ts:249

`Protected` _formatValues

_formatValues(values): Promise<ChainValues & {
signal?: AbortSignal;
timeout?: number;
}>
Parameters
- values: ChainValues & {
  signal?: AbortSignal;
  timeout?: number;
  }
Returns Promise<ChainValues & {
signal?: AbortSignal;
timeout?: number;
}>
Inherited from LLMChain._formatValues
- Defined in langchain/src/chains/base.ts:138

`Protected` _getOptionsList

_getOptionsList(options, length?): Partial<BaseCallbackConfig & {
runType?: string;
}>[]
Parameters
- options: Partial<BaseCallbackConfig> | Partial<BaseCallbackConfig>[]
- length: number = 0
Returns Partial<BaseCallbackConfig & {
runType?: string;
}>[]
Inherited from LLMChain._getOptionsList
- Defined in langchain/src/schema/runnable/base.ts:133

`Protected` _separateRunnableConfigFromCallOptions

_separateRunnableConfigFromCallOptions(options?): [BaseCallbackConfig, Omit<Partial<BaseCallbackConfig>, keyof BaseCallbackConfig>]
Parameters
- options: Partial<BaseCallbackConfig> = {}
Returns [BaseCallbackConfig, Omit<Partial<BaseCallbackConfig>, keyof BaseCallbackConfig>]
Inherited from LLMChain._separateRunnableConfigFromCallOptions
- Defined in langchain/src/schema/runnable/base.ts:232

`Protected` _transformStreamWithConfig

_transformStreamWithConfig<I, O>(inputGenerator, transformer, options?): AsyncGenerator<O, any, unknown>
Helper method to transform an Iterator of Input values into an Iterator of Output values, with callbacks. Use this to implement stream() or transform() in Runnable subclasses.
Type Parameters
- I extends ChainValues
- O extends ChainValues
Parameters
- inputGenerator: AsyncGenerator<I, any, unknown>
- transformer: ((generator, runManager?, options?) => AsyncGenerator<O, any, unknown>)
  - - (generator, runManager?, options?): AsyncGenerator<O, any, unknown>
    - Parameters
      
      generator: AsyncGenerator<I, any, unknown>
      
      Optional runManager: CallbackManagerForChainRun
      
      Optional options: Partial<BaseCallbackConfig>
      
      Returns AsyncGenerator<O, any, unknown>
- Optional options: BaseCallbackConfig & {
  runType?: string;
  }
Returns AsyncGenerator<O, any, unknown>
Inherited from LLMChain._transformStreamWithConfig
- Defined in langchain/src/schema/runnable/base.ts:343

Class QAEvalChain

Example

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

fields: LLMChainInput<string, LLMType>

Returns QAEvalChain

Properties

llm

outputKey

prompt

verbose

Optional callbacks

Optional llmKwargs

Optional memory

Optional metadata

Optional outputParser

Optional tags

Protected lc_runnable

Accessors

inputKeys

Returns string[]

outputKeys

Returns string[]

Methods

apply

Parameters

inputs: ChainValues[]

Optional config: (Callbacks | BaseCallbackConfig)[]

Returns Promise<ChainValues[]>

batch

Parameters

inputs: ChainValues[]

Optional options: Partial<BaseCallbackConfig> | Partial<BaseCallbackConfig>[]

Optional batchOptions: RunnableBatchOptions & { returnExceptions?: false; }

Returns Promise<ChainValues[]>

Parameters

inputs: ChainValues[]

Optional options: Partial<BaseCallbackConfig> | Partial<BaseCallbackConfig>[]

Optional batchOptions: RunnableBatchOptions & { returnExceptions: true; }

Returns Promise<(Error | ChainValues)[]>

Parameters

inputs: ChainValues[]

Optional options: Partial<BaseCallbackConfig> | Partial<BaseCallbackConfig>[]

Optional batchOptions: RunnableBatchOptions

Returns Promise<(Error | ChainValues)[]>

bind

Parameters

kwargs: Partial<BaseCallbackConfig>

Returns Runnable<ChainValues, ChainValues, BaseCallbackConfig>

call

Parameters

values: any

Optional config: Callbacks | BaseCallbackConfig

Returns Promise<ChainValues>

evaluate

Parameters

examples: ChainValues

predictions: ChainValues

args: EvaluateArgs = ...

Returns Promise<ChainValues>

invoke

Parameters

input: ChainValues

Optional config: BaseCallbackConfig

Returns Promise<ChainValues>

map

Returns Runnable<ChainValues[], ChainValues[], BaseCallbackConfig>

pipe

Type Parameters

NewRunOutput

Parameters

coerceable: RunnableLike<ChainValues, NewRunOutput>

Returns RunnableSequence<ChainValues, Exclude<NewRunOutput, Error>>

`Optional` callbacks

`Optional` llmKwargs

`Optional` memory

`Optional` metadata

`Optional` outputParser

`Optional` tags

`Protected` lc_runnable

`Optional` config: (Callbacks | BaseCallbackConfig)[]

`Optional` options: Partial<BaseCallbackConfig> | Partial<BaseCallbackConfig>[]

`Optional` batchOptions: RunnableBatchOptions & {
returnExceptions?: false;
}

`Optional` options: Partial<BaseCallbackConfig> | Partial<BaseCallbackConfig>[]

`Optional` batchOptions: RunnableBatchOptions & {
returnExceptions: true;
}

`Optional` options: Partial<BaseCallbackConfig> | Partial<BaseCallbackConfig>[]

`Optional` batchOptions: RunnableBatchOptions

`Optional` config: Callbacks | BaseCallbackConfig

`Optional` config: BaseCallbackConfig

`Optional` callbackManager: CallbackManager

`Optional` config: Callbacks | BaseCallbackConfig

`Optional` options: Partial<BaseCallbackConfig>

`Optional` options: Partial<BaseCallbackConfig>

`Optional` streamOptions: Omit<LogStreamCallbackHandlerInput, "autoClose">

fields: {
fallbacks: Runnable<ChainValues, ChainValues, BaseCallbackConfig>[];
}

`Optional` fields: {
onFailedAttempt?: RunnableRetryFailedAttemptHandler;
stopAfterAttempt?: number;
}

`Optional` onFailedAttempt?: RunnableRetryFailedAttemptHandler

`Optional` stopAfterAttempt?: number

`Static` deserialize

`Static` fromLlm

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

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

`Optional` prompt?: PromptTemplate<any, any>

`Static` isRunnable

`Protected` _callWithConfig