Class TransformChain<I, O>

Class that represents a transform chain. It extends the BaseChain class and implements the TransformChainFields interface. It provides a way to transform input values to output values using a specified transform function.

Deprecated

Switch to expression language. Will be removed in 0.2.0

Type Parameters

I extends BaseMessage
O extends BaseMessage

Hierarchy (View Summary)

BaseChain
- TransformChain

Index

Constructors

constructor

new TransformChain<I extends ChainValues, O extends ChainValues>(
fields: TransformChainFields<I, O>,
): TransformChain<I, O>
Type Parameters
- I extends ChainValues
- O extends ChainValues
Parameters
- fields: TransformChainFields<I, O>
Returns TransformChain<I, O>
Overrides BaseChain.constructor
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/transform.ts:62

Properties

inputVariables

inputVariables: (keyof I extends string ? keyof any : never)[]

`Optional`memory

memory?: any

outputVariables

outputVariables: (keyof O extends string ? keyof any : never)[]

transformFunc

transformFunc: (values: I, callbacks?: any) => O | Promise<O>

Accessors

inputKeys

get inputKeys(): (keyof I extends string ? keyof any : never)[]
Returns (keyof I extends string ? keyof any : never)[]
Overrides BaseChain.inputKeys
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/transform.ts:54

lc_namespace

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

outputKeys

get outputKeys(): (keyof O extends string ? keyof any : never)[]
Returns (keyof O extends string ? keyof any : never)[]
Overrides BaseChain.outputKeys
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/transform.ts:58

Methods

_call

_call(values: I, runManager?: any): Promise<O>
Run the core logic of this chain and return the output
Parameters
- values: I
- OptionalrunManager: any
Returns Promise<O>
Overrides BaseChain._call
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/transform.ts:69

_chainType

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

Returns "transform"
Overrides BaseChain._chainType
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/transform.ts:50

`Protected`_formatValues

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

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

call

call(values: any, config?: any, tags?: string[]): Promise<ChainValues>
Parameters
- values: any
- Optionalconfig: any
- Optionaltags: string[]
  Deprecated
Returns Promise<ChainValues>
Deprecated
Use .invoke() instead. Will be removed in 0.2.0.

Run the core logic of this chain and add to output if desired.

Wraps _call and handles memory.
Inherited from BaseChain.call
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/base.ts:243

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

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

serialize

serialize(): SerializedBaseChain
Return a json-like object representing this chain.

Returns SerializedBaseChain
Inherited from BaseChain.serialize
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/base.ts:181

`Static`deserialize

deserialize(
data: SerializedBaseChain,
values?: LoadValues,
): Promise<BaseChain<ChainValues, ChainValues>>
Load a chain from a json-like object describing it.
Parameters
- data: SerializedBaseChain
- values: LoadValues = {}
Returns Promise<BaseChain<ChainValues, ChainValues>>
Inherited from BaseChain.deserialize
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/base.ts:270

`Static`lc_name

lc_name(): string
Returns string
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/transform.ts:40

Class TransformChain<I, O>

Deprecated

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns TransformChain<I, O>

Properties

inputVariables

Optionalmemory

outputVariables

transformFunc

Accessors

inputKeys

Returns (keyof I extends string ? keyof any : never)[]

lc_namespace

Returns string[]

outputKeys

Returns (keyof O extends string ? keyof any : never)[]

Methods

_call

Parameters

Returns Promise<O>

_chainType

Returns "transform"

Protected_formatValues

Parameters

Returns Promise<any>

apply

Parameters

Returns Promise<ChainValues[]>

Deprecated

call

Parameters

Deprecated

Returns Promise<ChainValues>

Deprecated

invoke

Parameters

Returns Promise<ChainValues>

prepOutputs

Parameters

Returns Promise<Record<string, unknown>>

run

Parameters

Returns Promise<string>

Deprecated

serialize

Returns SerializedBaseChain

Staticdeserialize

Parameters

Returns Promise<BaseChain<ChainValues, ChainValues>>

Staticlc_name

Returns string

Settings

On This Page

`Optional`memory

`Protected`_formatValues

`Static`deserialize

`Static`lc_name