Class BaseStringPromptTemplate<RunInput, PartialVariableName>Abstract

Base class for string prompt templates. It extends the BasePromptTemplate class and overrides the formatPromptValue method to return a StringPromptValue.

Type Parameters

  • RunInput extends InputValues = any

  • PartialVariableName extends string = any

Hierarchy

Constructors

Properties

PromptValueReturnType: StringPromptValueInterface
inputVariables: Extract<keyof RunInput, string>[]

A list of variable names the prompt template expects

partialVariables: PartialValues<PartialVariableName>

Partial variables

name?: string
outputParser?: BaseOutputParser<unknown>

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

Methods

  • Assigns new fields to the dict output of this runnable. Returns a new runnable.

    Parameters

    • mapping: RunnableMapLike<Record<string, unknown>, Record<string, unknown>>

    Returns RunnableSequence<any, any>

  • Default implementation of batch, which calls invoke N times. Subclasses should override this method if they can batch more efficiently.

    Parameters

    • inputs: RunInput[]

      Array of inputs to each batch call.

    • Optional options: Partial<RunnableConfig> | Partial<RunnableConfig>[]

      Either a single call options object to apply to each batch call or an array for each call.

    • Optional batchOptions: RunnableBatchOptions & {
          returnExceptions?: false;
      }

    Returns Promise<StringPromptValueInterface[]>

    An array of RunOutputs, or mixed RunOutputs and errors if batchOptions.returnExceptions is set

  • Parameters

    Returns Promise<(Error | StringPromptValueInterface)[]>

  • Parameters

    Returns Promise<(Error | StringPromptValueInterface)[]>

  • Bind arguments to a Runnable, returning a new Runnable.

    Parameters

    Returns Runnable<RunInput, StringPromptValueInterface, RunnableConfig>

    A new RunnableBinding that, when invoked, will apply the bound args.

  • Format the prompt given the input values.

    Parameters

    • values: TypedPromptInputValues<RunInput>

      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 prompt given the input values and returns a formatted prompt value.

    Parameters

    • values: TypedPromptInputValues<RunInput>

      The input values to format the prompt.

    Returns Promise<StringPromptValueInterface>

    A Promise that resolves to a formatted prompt value.

  • Parameters

    • Optional suffix: string

    Returns string

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

    Parameters

    • input: RunInput

      The input to invoke the prompt template with.

    • Optional options: BaseCallbackConfig

      Optional configuration for the callback.

    Returns Promise<StringPromptValueInterface>

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

  • Return a new Runnable that maps a list of inputs to a list of outputs, by calling invoke() with each input.

    Returns Runnable<RunInput[], StringPromptValueInterface[], RunnableConfig>

  • Merges partial variables and user variables.

    Parameters

    • userVariables: TypedPromptInputValues<RunInput>

      The user variables to merge with the partial variables.

    Returns Promise<InputValues<PartialVariableName | Extract<keyof RunInput, string>>>

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

  • Pick keys from the dict output of this runnable. Returns a new runnable.

    Parameters

    • keys: string | string[]

    Returns RunnableSequence<any, any>

  • 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

    • coerceable: RunnableLike<StringPromptValueInterface, NewRunOutput>

      A runnable, function, or object whose values are functions or runnables.

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

    A new runnable sequence.

  • Stream output in chunks.

    Parameters

    Returns Promise<IterableReadableStream<StringPromptValueInterface>>

    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: RunInput
    • Optional options: Partial<RunnableConfig>
    • 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

    • generator: AsyncGenerator<RunInput, any, unknown>
    • options: Partial<RunnableConfig>

    Returns AsyncGenerator<StringPromptValueInterface, any, unknown>

  • Create a new runnable from the current one that will try invoking other passed fallback runnables if the initial invocation fails.

    Parameters

    • fields: {
          fallbacks: Runnable<RunInput, StringPromptValueInterface, RunnableConfig>[];
      }
      • fallbacks: Runnable<RunInput, StringPromptValueInterface, RunnableConfig>[]

        Other runnables to call if the runnable errors.

    Returns RunnableWithFallbacks<RunInput, StringPromptValueInterface>

    A new RunnableWithFallbacks.

  • 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<RunInput, StringPromptValueInterface, RunnableConfig>

Generated using TypeDoc