Class MultiPromptChain

A class that represents a multi-prompt chain in the LangChain framework. It extends the MultiRouteChain class and provides additional functionality specific to multi-prompt chains.

Example

const multiPromptChain = MultiPromptChain.fromLLMAndPrompts(new ChatOpenAI(), {
  promptNames: ["physics", "math", "history"],
  promptDescriptions: [
    "Good for answering questions about physics",
    "Good for answering math questions",
    "Good for answering questions about history",
  ],
  promptTemplates: [
    `You are a very smart physics professor. Here is a question:\n{input}\n`,
    `You are a very good mathematician. Here is a question:\n{input}\n`,
    `You are a very smart history professor. Here is a question:\n{input}\n`,
  ],
});
const result = await multiPromptChain.call({
  input: "What is the speed of light?",
});

Hierarchy (view full)

Constructors

constructor

Properties

defaultChain destinationChains routerChain silentErrors memory?

Accessors

inputKeys outputKeys

Methods

apply call invoke prepOutputs run serialize deserialize fromLLMAndPrompts fromPrompts

Constructors

constructor

Properties

defaultChain

defaultChain: BaseChain<ChainValues, ChainValues>

destinationChains

destinationChains: {
    [name: string]: BaseChain;
}

Type declaration

routerChain

routerChain: RouterChain

silentErrors

silentErrors: boolean = false

Optional memory

memory?: BaseMemory

Accessors

inputKeys

outputKeys

Methods

apply

  • apply(inputs, config?): Promise<ChainValues[]>

  • Parameters

    • inputs: ChainValues[]
    • Optional config: (RunnableConfig | CallbackManager | (BaseCallbackHandler | BaseCallbackHandlerMethodsClass)[])[]

    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

call

  • call(values, config?, tags?): Promise<ChainValues>

  • Parameters

    • values: ChainValues & {
          signal?: AbortSignal;
          timeout?: number;
      }
    • Optional config: RunnableConfig | CallbackManager | (BaseCallbackHandler | BaseCallbackHandlerMethodsClass)[]
    • 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.

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.

    • Optional options: RunnableConfig

    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
    • Optional config: RunnableConfig | CallbackManager | (BaseCallbackHandler | BaseCallbackHandlerMethodsClass)[]

    Returns Promise<string>

    Deprecated

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

serialize

Static deserialize

Static fromLLMAndPrompts

  • fromLLMAndPrompts(llm, __namedParameters): MultiPromptChain

  • A static method that creates an instance of MultiPromptChain from a BaseLanguageModel and a set of prompts. It takes in optional parameters for the default chain and additional options.

    Parameters

    • llm: BaseLanguageModelInterface<any, BaseLanguageModelCallOptions>

      A BaseLanguageModel instance.

    • __namedParameters: {
          promptDescriptions: string[];
          promptNames: string[];
          promptTemplates: string[] | PromptTemplate<any, any>[];
          conversationChainOpts?: Omit<LLMChainInput<string, LLMType>, "llm" | "outputKey">;
          defaultChain?: BaseChain<ChainValues, ChainValues>;
          llmChainOpts?: Omit<LLMChainInput<string, LLMType>, "prompt" | "llm">;
          multiRouteChainOpts?: Omit<MultiRouteChainInput, "defaultChain">;
      }
      • promptDescriptions: string[]
      • promptNames: string[]
      • promptTemplates: string[] | PromptTemplate<any, any>[]
      • Optional conversationChainOpts?: Omit<LLMChainInput<string, LLMType>, "llm" | "outputKey">
      • Optional defaultChain?: BaseChain<ChainValues, ChainValues>
      • Optional llmChainOpts?: Omit<LLMChainInput<string, LLMType>, "prompt" | "llm">
      • Optional multiRouteChainOpts?: Omit<MultiRouteChainInput, "defaultChain">

    Returns MultiPromptChain

    An instance of MultiPromptChain.

Static fromPrompts

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc