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

BaseChain
- ConstitutionalChain

Implements

ConstitutionalChainInput

Index

Constructors

constructor

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

Properties

chain

chain: LLMChain<string, any>

constitutionalPrinciples

constitutionalPrinciples: ConstitutionalPrinciple[]

critiqueChain

critiqueChain: LLMChain<string, any>

revisionChain

revisionChain: LLMChain<string, any>

`Optional` memory

memory?: any

Accessors

inputKeys

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

outputKeys

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

Methods

apply

apply(inputs, config?): Promise<ChainValues[]>
Parameters
- inputs: ChainValues[]
- Optional config: any[]
Returns Promise<ChainValues[]>

⚠️ Deprecated ⚠️

Use .batch() instead. Will be removed in 0.2.0.

This feature is deprecated and will be removed in the future.

It is not recommended for use.

Call the chain on all inputs in the list
Inherited from BaseChain.apply
- Defined in langchain/src/chains/base.ts:256

call

call(values, config?, tags?): Promise<ChainValues>
Parameters
- values: any
- Optional config: any
- Optional tags: 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 langchain/src/chains/base.ts:241

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: any
  
  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:86

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

run

run(input, config?): Promise<string>
Parameters
- input: any
- Optional config: any
Returns Promise<string>

Deprecated
Use .invoke() instead. Will be removed in 0.2.0.
Inherited from BaseChain.run
- Defined in langchain/src/chains/base.ts:188

serialize

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

Returns SerializedBaseChain
Overrides BaseChain.serialize
- Defined in langchain/src/chains/constitutional_ai/constitutional_chain.ts:192

`Static` deserialize

deserialize(data, values?): 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 langchain/src/chains/base.ts:268

`Static` fromLLM

fromLLM(llm, options): 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 langchain/src/chains/constitutional_ai/constitutional_chain.ts:142

`Static` getPrinciples

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

Class ConstitutionalChain

Example

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

fields: ConstitutionalChainInput

Returns ConstitutionalChain

Properties

chain

constitutionalPrinciples

critiqueChain

revisionChain

Optional memory

Accessors

inputKeys

Returns string[]

outputKeys

Returns string[]

Methods

apply

Parameters

inputs: ChainValues[]

Optional config: any[]

Returns Promise<ChainValues[]>

⚠️ Deprecated ⚠️

call

Parameters

values: any

Optional config: any

Optional tags: string[]

Deprecated

Returns Promise<ChainValues>

Deprecated

invoke

Parameters

input: ChainValues

Optional config: any

Returns Promise<ChainValues>

prepOutputs

Parameters

inputs: Record<string, unknown>

outputs: Record<string, unknown>

returnOnlyOutputs: boolean = false

Returns Promise<Record<string, unknown>>

run

Parameters

input: any

Optional config: any

Returns Promise<string>

Deprecated

serialize

Returns SerializedBaseChain

Static deserialize

Parameters

data: SerializedBaseChain

values: LoadValues = {}

Returns Promise<BaseChain<ChainValues, ChainValues>>

Static fromLLM

Parameters

llm: BaseLanguageModelInterface

options: Omit<ConstitutionalChainInput, "critiqueChain" | "revisionChain"> & { critiqueChain?: LLMChain<string, any>; revisionChain?: LLMChain<string, any>; }

Returns ConstitutionalChain

Static getPrinciples

Parameters

Optional names: string[]

Returns ConstitutionalPrinciple[]

Settings

Member Visibility

Theme

On This Page

`Optional` memory

`Optional` config: any[]

`Optional` config: any

`Optional` tags: string[]

`Optional` config: any

`Optional` config: any

`Static` deserialize

`Static` fromLLM

options: Omit<ConstitutionalChainInput, "critiqueChain" | "revisionChain"> & {
critiqueChain?: LLMChain<string, any>;
revisionChain?: LLMChain<string, any>;
}

`Static` getPrinciples

`Optional` names: string[]