A class for conducting conversations between a human and an AI. It extends the LLMChain class.

const model = new ChatOpenAI({});
const chain = new ConversationChain({ llm: model });

// Sending a greeting to the conversation chain
const res1 = await chain.call({ input: "Hi! I'm Jim." });
console.log({ res1 });

// Following up with a question in the conversation
const res2 = await chain.call({ input: "What's my name?" });
console.log({ res2 });

Hierarchy (view full)

Constructors

Properties

llm: any

LLM Wrapper to use

outputKey: string = "text"

Key to use for output, defaults to text

prompt: BasePromptTemplate

Prompt object to use

llmKwargs?: any

Kwargs to pass to LLM

memory?: any
outputParser?: any

OutputParser to use

Accessors

Methods

  • Parameters

    • inputs: ChainValues[]
    • Optionalconfig: any[]

    Returns Promise<ChainValues[]>

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

    Call the chain on all inputs in the list

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

    Wraps _call and handles memory.

    Parameters

    • values: any
    • Optionalconfig: any

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

  • Format prompt with values and pass to LLM

    Parameters

    • values: any

      keys to pass to prompt template

    • OptionalcallbackManager: any

      CallbackManager to use

    Returns Promise<string>

    Completion from LLM.

    llm.predict({ adjective: "funny" })
    
  • Parameters

    • inputs: Record<string, unknown>
    • outputs: Record<string, unknown>
    • returnOnlyOutputs: boolean = false

    Returns Promise<Record<string, unknown>>

  • Parameters

    • input: any
    • Optionalconfig: any

    Returns Promise<string>

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

""