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

Implements

Constructors

constructor

Properties

chain constitutionalPrinciples critiqueChain revisionChain memory?

Accessors

inputKeys outputKeys

Methods

apply call invoke prepOutputs run serialize deserialize fromLLM getPrinciples

Constructors

constructor

Properties

chain

chain: LLMChain<string, any>

constitutionalPrinciples

constitutionalPrinciples: ConstitutionalPrinciple[]

critiqueChain

critiqueChain: LLMChain<string, any>

revisionChain

revisionChain: LLMChain<string, any>

Optionalmemory

memory?: any

Accessors

inputKeys

outputKeys

Methods

apply

  • apply(inputs, config?): 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

call

  • call(values, config?, tags?): 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.

invoke

  • invoke(input, options?): 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.

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

run

  • run(input, config?): Promise<string>

  • Parameters

    • input: any
    • Optionalconfig: any

    Returns Promise<string>

    Deprecated

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

serialize

Staticdeserialize

StaticfromLLM

StaticgetPrinciples

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods