Class LLMChain<T, Model>

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 });

Type Parameters

T extends string | object = string
Model extends LLMType = LLMType

Hierarchy

BaseChain
- LLMChain

Implements

LLMChainInput<T>

Index

Constructors

constructor

new LLMChain<T, Model>(fields): LLMChain<T, Model>
Type Parameters
- T extends string | object = string
- Model extends LLMType = LLMType
Parameters
- fields: LLMChainInput<T, Model>
Returns LLMChain<T, Model>
Overrides BaseChain.constructor
- Defined in langchain/src/chains/llm_chain.ts:118

Properties

llm

llm: Model

LLM Wrapper to use

outputKey

outputKey: string = "text"

Key to use for output, defaults to text

prompt

prompt: BasePromptTemplate<any, BasePromptValueInterface, any>

Prompt object to use

verbose

verbose: boolean

Whether to print out response text.

`Optional` callbacks

callbacks?: Callbacks

`Optional` llmKwargs

llmKwargs?: CallOptionsIfAvailable<Model>

Kwargs to pass to LLM

`Optional` memory

memory?: BaseMemory

`Optional` metadata

metadata?: Record<string, unknown>

`Optional` name

name?: string

`Optional` outputParser

outputParser?: BaseLLMOutputParser<T>

OutputParser to use

`Optional` tags

tags?: string[]

Accessors

inputKeys

get inputKeys(): string[]
Returns string[]
Overrides BaseChain.inputKeys
- Defined in langchain/src/chains/llm_chain.ts:110

outputKeys

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

Methods

apply

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

assign

assign(mapping): RunnableSequence<any, any>
Assigns new fields to the dict output of this runnable. Returns a new runnable.
Parameters
- mapping: RunnableMapLike<Record<string, unknown>, Record<string, unknown>>
Returns RunnableSequence<any, any>
Inherited from BaseChain.assign
- Defined in langchain-core/dist/runnables/base.d.ts:158

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<RunnableConfig> | Partial<RunnableConfig>[]
  
  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 BaseChain.batch
- Defined in langchain-core/dist/runnables/base.d.ts:96
batch(inputs, options?, batchOptions?): Promise<(ChainValues | Error)[]>
Parameters
- inputs: ChainValues[]
- Optional options: Partial<RunnableConfig> | Partial<RunnableConfig>[]
- Optional batchOptions: RunnableBatchOptions & {
  returnExceptions: true;
  }
Returns Promise<(ChainValues | Error)[]>
Inherited from BaseChain.batch
- Defined in langchain-core/dist/runnables/base.d.ts:99
batch(inputs, options?, batchOptions?): Promise<(ChainValues | Error)[]>
Parameters
- inputs: ChainValues[]
- Optional options: Partial<RunnableConfig> | Partial<RunnableConfig>[]
- Optional batchOptions: RunnableBatchOptions
Returns Promise<(ChainValues | Error)[]>
Inherited from BaseChain.batch
- Defined in langchain-core/dist/runnables/base.d.ts:102

bind

bind(kwargs): Runnable<ChainValues, ChainValues, RunnableConfig>
Bind arguments to a Runnable, returning a new Runnable.
Parameters
- kwargs: Partial<RunnableConfig>
Returns Runnable<ChainValues, ChainValues, RunnableConfig>
A new RunnableBinding that, when invoked, will apply the bound args.
Inherited from BaseChain.bind
- Defined in langchain-core/dist/runnables/base.d.ts:54

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: ChainValues & CallOptionsIfAvailable<Model>
- Optional config: BaseCallbackConfig | Callbacks
Returns Promise<ChainValues>
Overrides BaseChain.call
- Defined in langchain/src/chains/llm_chain.ts:175

getName

getName(suffix?): string
Parameters
- Optional suffix: string
Returns string
Inherited from BaseChain.getName
- Defined in langchain-core/dist/runnables/base.d.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: RunnableConfig
  
  Optional configuration for the Runnable.
Returns Promise<ChainValues>
Promise that resolves with the output of the chain run.
Inherited from BaseChain.invoke
- Defined in langchain/src/chains/base.ts:82

map

map(): Runnable<ChainValues[], ChainValues[], RunnableConfig>
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[], RunnableConfig>
Inherited from BaseChain.map
- Defined in langchain-core/dist/runnables/base.d.ts:59

pick

pick(keys): RunnableSequence<any, any>
Pick keys from the dict output of this runnable. Returns a new runnable.
Parameters
- keys: string | string[]
Returns RunnableSequence<any, any>
Inherited from BaseChain.pick
- Defined in langchain-core/dist/runnables/base.d.ts:154

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 BaseChain.pipe
- Defined in langchain-core/dist/runnables/base.d.ts:150

predict

predict(values, callbackManager?): Promise<T>
Format prompt with values and pass to LLM
Parameters
- values: ChainValues & CallOptionsIfAvailable<Model>
  
  keys to pass to prompt template
- Optional callbackManager: CallbackManager
  
  CallbackManager to use
Returns Promise<T>
Completion from LLM.
Example
```
llm.predict({ adjective: "funny" })
```
- 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 BaseChain.prepOutputs
- Defined in langchain/src/chains/base.ts:97

run

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

serialize

serialize(): SerializedLLMChain
Returns SerializedLLMChain

Deprecated
Overrides BaseChain.serialize
- Defined in langchain/src/chains/llm_chain.ts:269

stream

stream(input, options?): Promise<IterableReadableStream<ChainValues>>
Stream output in chunks.
Parameters
- input: ChainValues
- Optional options: Partial<RunnableConfig>
Returns Promise<IterableReadableStream<ChainValues>>
A readable stream that is also an iterable.
Inherited from BaseChain.stream
- Defined in langchain-core/dist/runnables/base.d.ts:116

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<RunnableConfig>
- Optional streamOptions: Omit<LogStreamCallbackHandlerInput, "autoClose">
Returns AsyncGenerator<RunLogPatch, any, unknown>
Inherited from BaseChain.streamLog
- Defined in langchain-core/dist/runnables/base.d.ts:178

toJSON

toJSON(): Serialized
Returns Serialized
Inherited from BaseChain.toJSON
- Defined in langchain-core/dist/load/serializable.d.ts:64

toJSONNotImplemented

toJSONNotImplemented(): SerializedNotImplemented
Returns SerializedNotImplemented
Inherited from BaseChain.toJSONNotImplemented
- Defined in langchain-core/dist/load/serializable.d.ts:65

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<RunnableConfig>
Returns AsyncGenerator<ChainValues, any, unknown>
Inherited from BaseChain.transform
- Defined in langchain-core/dist/runnables/base.d.ts:166

withConfig

withConfig(config): RunnableBinding<ChainValues, ChainValues, RunnableConfig>
Bind config to a Runnable, returning a new Runnable.
Parameters
- config: RunnableConfig
  
  New configuration parameters to attach to the new runnable.
Returns RunnableBinding<ChainValues, ChainValues, RunnableConfig>
A new RunnableBinding with a config matching what's passed.
Inherited from BaseChain.withConfig
- Defined in langchain-core/dist/runnables/base.d.ts:74

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, RunnableConfig>[];
  }
  - fallbacks: Runnable<ChainValues, ChainValues, RunnableConfig>[]
    
    Other runnables to call if the runnable errors.
Returns RunnableWithFallbacks<ChainValues, ChainValues>
A new RunnableWithFallbacks.
Inherited from BaseChain.withFallbacks
- Defined in langchain-core/dist/runnables/base.d.ts:81

withListeners

withListeners(params): Runnable<ChainValues, ChainValues, RunnableConfig>
Bind lifecycle listeners to a Runnable, returning a new Runnable. The Run object contains information about the run, including its id, type, input, output, error, startTime, endTime, and any tags or metadata added to the run.
Parameters
- params: {
      onEnd?: ((run, config?) => void | Promise<void>);
      onError?: ((run, config?) => void | Promise<void>);
      onStart?: ((run, config?) => void | Promise<void>);
  }
  
  The object containing the callback functions.
  - Optional onEnd?: ((run, config?) => void | Promise<void>)
    - (run, config?): void | Promise<void>
      
      Called after the runnable finishes running, with the Run object.
      
      Parameters
      
      run: Run
      
      Optional config: RunnableConfig
      
      Returns void | Promise<void>
  - Optional onError?: ((run, config?) => void | Promise<void>)
    - (run, config?): void | Promise<void>
      
      Called if the runnable throws an error, with the Run object.
      
      Parameters
      
      run: Run
      
      Optional config: RunnableConfig
      
      Returns void | Promise<void>
  - Optional onStart?: ((run, config?) => void | Promise<void>)
    - (run, config?): void | Promise<void>
      
      Called before the runnable starts running, with the Run object.
      
      Parameters
      
      run: Run
      
      Optional config: RunnableConfig
      
      Returns void | Promise<void>
Returns Runnable<ChainValues, ChainValues, RunnableConfig>
Inherited from BaseChain.withListeners
- Defined in langchain-core/dist/runnables/base.d.ts:191

withRetry

withRetry(fields?): RunnableRetry<ChainValues, ChainValues, RunnableConfig>
Add retry logic to an existing runnable.
Parameters
- Optional fields: {
  onFailedAttempt?: RunnableRetryFailedAttemptHandler;
  stopAfterAttempt?: number;
  }
  - Optional onFailedAttempt?: RunnableRetryFailedAttemptHandler
  - Optional stopAfterAttempt?: number
Returns RunnableRetry<ChainValues, ChainValues, RunnableConfig>
A new RunnableRetry that, when invoked, will retry according to the parameters.
Inherited from BaseChain.withRetry
- Defined in langchain-core/dist/runnables/base.d.ts:65

`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>>>
Overrides BaseChain.deserialize
- Defined in langchain/src/chains/llm_chain.ts:253

`Static` isRunnable

isRunnable(thing): thing is Runnable<any, any, RunnableConfig>
Parameters
- thing: any
Returns thing is Runnable<any, any, RunnableConfig>
Inherited from BaseChain.isRunnable
- Defined in langchain-core/dist/runnables/base.d.ts:179

Class LLMChain<T, Model>

Example

Type Parameters

T extends string | object = string

Model extends LLMType = LLMType

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

T extends string | object = string

Model extends LLMType = LLMType

Parameters

fields: LLMChainInput<T, Model>

Returns LLMChain<T, Model>

Properties

llm

outputKey

prompt

verbose

Optional callbacks

Optional llmKwargs

Optional memory

Optional metadata

Optional name

Optional outputParser

Optional tags

Accessors

inputKeys

Returns string[]

outputKeys

Returns string[]

Methods

apply

Parameters

inputs: ChainValues[]

Optional config: (RunnableConfig | Callbacks)[]

Returns Promise<ChainValues[]>

assign

Parameters

mapping: RunnableMapLike<Record<string, unknown>, Record<string, unknown>>

Returns RunnableSequence<any, any>

batch

Parameters

inputs: ChainValues[]

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

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

Returns Promise<ChainValues[]>

Parameters

inputs: ChainValues[]

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

Optional batchOptions: RunnableBatchOptions & { returnExceptions: true; }

Returns Promise<(ChainValues | Error)[]>

Parameters

inputs: ChainValues[]

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

Optional batchOptions: RunnableBatchOptions

Returns Promise<(ChainValues | Error)[]>

bind

Parameters

kwargs: Partial<RunnableConfig>

Returns Runnable<ChainValues, ChainValues, RunnableConfig>

call

Parameters

values: ChainValues & CallOptionsIfAvailable<Model>

Optional config: BaseCallbackConfig | Callbacks

Returns Promise<ChainValues>

getName

Parameters

Optional suffix: string

Returns string

invoke

Parameters

input: ChainValues

Optional config: RunnableConfig

`Optional` callbacks

`Optional` llmKwargs

`Optional` memory

`Optional` metadata

`Optional` name

`Optional` outputParser

`Optional` tags

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

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

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

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

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

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

`Optional` batchOptions: RunnableBatchOptions

`Optional` config: BaseCallbackConfig | Callbacks

`Optional` suffix: string

`Optional` config: RunnableConfig

`Optional` callbackManager: CallbackManager

`Optional` config: RunnableConfig | Callbacks

`Optional` options: Partial<RunnableConfig>

`Optional` options: Partial<RunnableConfig>

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

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

params: {
onEnd?: ((run, config?) => void | Promise<void>);
onError?: ((run, config?) => void | Promise<void>);
onStart?: ((run, config?) => void | Promise<void>);
}

`Optional` onEnd?: ((run, config?) => void | Promise<void>)

`Optional` config: RunnableConfig