Class PipelinePromptTemplate<PromptTemplateType>

Class that handles a sequence of prompts, each of which may require different input variables. Includes methods for formatting these prompts, extracting required input values, and handling partial prompts.

Example

const composedPrompt = new PipelinePromptTemplate({
pipelinePrompts: [
{
name: "introduction",
prompt: PromptTemplate.fromTemplate(`You are impersonating {person}.`),
},
{
name: "example",
prompt: PromptTemplate.fromTemplate(
`Here's an example of an interaction:
Q: {example_q}
A: {example_a}`,
),
},
{
name: "start",
prompt: PromptTemplate.fromTemplate(
`Now, do this for real!
Q: {input}
A:`,
),
},
],
finalPrompt: PromptTemplate.fromTemplate(
`{introduction}
{example}
{start}`,
),
});

const formattedPrompt = await composedPrompt.format({
person: "Elon Musk",
example_q: `What's your favorite car?`,
example_a: "Tesla",
input: `What's your favorite social media site?`,
});

Type Parameters

Hierarchy

Constructors

Properties

PromptValueReturnType: BasePromptValue
finalPrompt: PromptTemplateType
inputVariables: string[]

A list of variable names the prompt template expects

partialVariables: PartialValues<any>

Partial variables

pipelinePrompts: PipelinePromptParams<PromptTemplateType>[]
outputParser?: BaseOutputParser<unknown>

How to parse the output of calling an LLM on this formatted prompt

Methods

  • Format the prompt given the input values.

    Parameters

    • values: InputValues

      A dictionary of arguments to be passed to the prompt template.

    Returns Promise<string>

    A formatted prompt string.

    Example

    prompt.format({ foo: "bar" });
    
  • Formats the final prompt value based on the provided input values.

    Parameters

    • values: InputValues

      Input values to format the final prompt value.

    Returns Promise<PromptTemplateType["PromptValueReturnType"]>

    Promise that resolves with the formatted final prompt value.

  • Invokes the prompt template with the given input and options.

    Parameters

    • input: any

      The input to invoke the prompt template with.

    • Optional options: BaseCallbackConfig

      Optional configuration for the callback.

    Returns Promise<BasePromptValue>

    A Promise that resolves to the output of the prompt template.

  • Merges partial variables and user variables.

    Parameters

    • userVariables: TypedPromptInputValues<any>

      The user variables to merge with the partial variables.

    Returns Promise<InputValues<any>>

    A Promise that resolves to an object containing the merged variables.

  • Handles partial prompts, which are prompts that have been partially filled with input values.

    Parameters

    Returns Promise<PipelinePromptTemplate<PromptTemplateType>>

    Promise that resolves with a new PipelinePromptTemplate instance with updated input variables.

  • Create a new runnable sequence that runs each individual runnable in series, piping the output of one runnable into another runnable or runnable-like.

    Type Parameters

    • NewRunOutput

    Parameters

    Returns RunnableSequence<any, Exclude<NewRunOutput, Error>>

    A new runnable sequence.

  • Stream output in chunks.

    Parameters

    Returns Promise<IterableReadableStream<BasePromptValue>>

    A readable stream that is also an iterable.

  • Stream all output from a runnable, as reported to the callback system. This includes all inner runs of LLMs, Retrievers, Tools, etc. Output is streamed as Log objects, which include a list of jsonpatch ops that describe how the state of the run has changed in each step, and the final state of the run. The jsonpatch ops can be applied in order to construct state.

    Parameters

    • input: any
    • Optional options: Partial<BaseCallbackConfig>
    • Optional streamOptions: Omit<LogStreamCallbackHandlerInput, "autoClose">

    Returns AsyncGenerator<RunLogPatch, any, unknown>

  • Default implementation of transform, which buffers input and then calls stream. Subclasses should override this method if they can start producing output while input is still being generated.

    Parameters

    Returns AsyncGenerator<BasePromptValue, any, unknown>

  • Bind lifecycle listeners to a Runnable, returning a new Runnable. The Run object contains information about the run, including its id, type, input, output, error, startTime, endTime, and any tags or metadata added to the run.

    Parameters

    • params: {
          onEnd?: ((run, config?) => void | Promise<void>);
          onError?: ((run, config?) => void | Promise<void>);
          onStart?: ((run, config?) => void | Promise<void>);
      }

      The object containing the callback functions.

      • Optional onEnd?: ((run, config?) => void | Promise<void>)
          • (run, config?): void | Promise<void>
          • Called after the runnable finishes running, with the Run object.

            Parameters

            Returns void | Promise<void>

      • Optional onError?: ((run, config?) => void | Promise<void>)
          • (run, config?): void | Promise<void>
          • Called if the runnable throws an error, with the Run object.

            Parameters

            Returns void | Promise<void>

      • Optional onStart?: ((run, config?) => void | Promise<void>)
          • (run, config?): void | Promise<void>
          • Called before the runnable starts running, with the Run object.

            Parameters

            Returns void | Promise<void>

    Returns Runnable<any, BasePromptValue, BaseCallbackConfig>

  • Computes the input values required by the pipeline prompts.

    Returns string[]

    Array of input values required by the pipeline prompts.

  • Formats the pipeline prompts based on the provided input values.

    Parameters

    • values: InputValues

      Input values to format the pipeline prompts.

    Returns Promise<InputValues>

    Promise that resolves with the formatted input values.

  • Parameters

    Returns InputValues

Generated using TypeDoc