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, LLMType>
Returns QAEvalChain
Inherited from LLMChain.constructor
- Defined in docs/api_refs/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

`Optional` llmKwargs

llmKwargs?: any

Kwargs to pass to LLM

`Optional` memory

memory?: BaseMemory

`Optional` outputParser

outputParser?: BaseLLMOutputParser<string>

OutputParser to use

Accessors

inputKeys

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

outputKeys

get outputKeys(): string[]
Returns string[]
Inherited from LLMChain.outputKeys
- Defined in docs/api_refs/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: (BaseCallbackConfig | Callbacks)[]
Returns Promise<ChainValues[]>
Inherited from LLMChain.apply
- Defined in docs/api_refs/langchain/src/chains/base.ts:252

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

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 docs/api_refs/langchain/src/chains/llm_chain.ts:244

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 docs/api_refs/langchain/src/chains/base.ts:99

run

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

serialize

serialize(): SerializedLLMChain
Returns SerializedLLMChain

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

`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 docs/api_refs/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 docs/api_refs/langchain/src/evaluation/qa/eval_chain.ts:22

Class QAEvalChain

Example

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

fields: LLMChainInput<string, LLMType>

Returns QAEvalChain

Properties

llm

outputKey

prompt

Optional llmKwargs

Optional memory

Optional outputParser

Accessors

inputKeys

Returns string[]

outputKeys

Returns string[]

Methods

apply

Parameters

inputs: ChainValues[]

Optional config: (BaseCallbackConfig | Callbacks)[]

Returns Promise<ChainValues[]>

call

Parameters

values: any

Optional config: BaseCallbackConfig | Callbacks

Returns Promise<ChainValues>

evaluate

Parameters

examples: ChainValues

predictions: ChainValues

args: EvaluateArgs = ...

Returns Promise<ChainValues>

invoke

Parameters

input: ChainValues

Optional config: BaseCallbackConfig

Returns Promise<ChainValues>

predict

Parameters

values: any

Optional callbackManager: CallbackManager

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

Returns Promise<string>

serialize

Returns SerializedLLMChain

Deprecated

Static deserialize

Parameters

data: SerializedLLMChain

Returns Promise<LLMChain<string, BaseLanguageModel<any, BaseLanguageModelCallOptions>>>

Static fromLlm

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

Settings

Member Visibility

`Optional` llmKwargs

`Optional` memory

`Optional` outputParser

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

`Optional` config: BaseCallbackConfig | Callbacks

`Optional` config: BaseCallbackConfig

`Optional` callbackManager: CallbackManager

`Optional` config: BaseCallbackConfig | Callbacks

`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>