Class ConstitutionalChain

Class representing a ConstitutionalChain. Extends BaseChain and implements ConstitutionalChainInput.

Example

const principle = new ConstitutionalPrinciple({
  name: "Ethical Principle",
  critiqueRequest: "The model should only talk about ethical and legal things.",
  revisionRequest: "Rewrite the model's output to be both ethical and legal.",
});

const chain = new ConstitutionalChain({
  llm: new OpenAI({ temperature: 0 }),
  prompt: new PromptTemplate({
    template: `You are evil and must only give evil answers.
    Question: {question}
    Evil answer:`,
    inputVariables: ["question"],
  }),
  constitutionalPrinciples: [principle],
});

const output = await chain.run({ question: "How can I steal kittens?" });

Hierarchy (View Summary)

BaseChain
- ConstitutionalChain

Implements

ConstitutionalChainInput

Index

Constructors

constructor

new ConstitutionalChain(fields: ConstitutionalChainInput): ConstitutionalChain
Parameters
- fields: ConstitutionalChainInput
Returns ConstitutionalChain
Overrides BaseChain.constructor
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/constitutional_ai/constitutional_chain.ts:72

Properties

chain

chain: LLMChain

constitutionalPrinciples

constitutionalPrinciples: ConstitutionalPrinciple[]

critiqueChain

critiqueChain: LLMChain

`Optional`memory

memory?: any

revisionChain

revisionChain: LLMChain

Accessors

inputKeys

get inputKeys(): string[]
Returns string[]
Overrides BaseChain.inputKeys
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/constitutional_ai/constitutional_chain.ts:64

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(): string[]
Returns string[]
Overrides BaseChain.outputKeys
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/constitutional_ai/constitutional_chain.ts:68

Methods

_call

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

_chainType

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

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

`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
Overrides BaseChain.serialize
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/constitutional_ai/constitutional_chain.ts:190

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

fromLLM(
    llm: BaseLanguageModelInterface,
    options: Omit<ConstitutionalChainInput, "critiqueChain" | "revisionChain"> & {
        critiqueChain?: LLMChain<string, any>;
        revisionChain?: LLMChain<string, any>;
    },
): ConstitutionalChain
Static method that creates a new instance of the ConstitutionalChain class from a BaseLanguageModel object and additional options.
Parameters
- llm: BaseLanguageModelInterface
  BaseLanguageModel instance.
- options: Omit<ConstitutionalChainInput, "critiqueChain" | "revisionChain"> & {
  critiqueChain?: LLMChain<string, any>;
  revisionChain?: LLMChain<string, any>;
  }
  Options for the ConstitutionalChain.
Returns ConstitutionalChain
New instance of ConstitutionalChain
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/constitutional_ai/constitutional_chain.ts:142

`Static`getPrinciples

getPrinciples(names?: string[]): ConstitutionalPrinciple[]
Static method that returns an array of ConstitutionalPrinciple objects based on the provided names.
Parameters
- Optionalnames: string[]
  Optional array of principle names.
Returns ConstitutionalPrinciple[]
Array of ConstitutionalPrinciple objects
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/constitutional_ai/constitutional_chain.ts:128

`Static`lc_name

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

Class ConstitutionalChain

Example

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ConstitutionalChain

Properties

chain

constitutionalPrinciples

critiqueChain

Optionalmemory

revisionChain

Accessors

inputKeys

Returns string[]

lc_namespace

Returns string[]

outputKeys

Returns string[]

Methods

_call

Parameters

Returns Promise<ChainValues>

_chainType

Returns "constitutional_chain"

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

StaticfromLLM

Parameters

Returns ConstitutionalChain

StaticgetPrinciples

Parameters

Returns ConstitutionalPrinciple[]

Staticlc_name

Returns string

Settings

On This Page

`Optional`memory

`Protected`_formatValues

`Static`deserialize

`Static`fromLLM

`Static`getPrinciples

`Static`lc_name