Class FewShotChatMessagePromptTemplate<RunInput, PartialVariableName>

Chat prompt template that contains few-shot examples.

Type Parameters

  • RunInput extends InputValues = any

  • PartialVariableName extends string = any

Hierarchy

Implements

Constructors

Properties

PromptValueReturnType: ChatPromptValueInterface
examplePrompt: BaseMessagePromptTemplate<any, BaseMessage[]> | BaseChatPromptTemplate<any, any>

An BaseMessagePromptTemplate | BaseChatPromptTemplate used to format a single example.

exampleSeparator: string

String separator used to join the prefix, the examples, and suffix.

Default Value

"\n\n"

inputVariables: string[]

A list of variable names the prompt template expects

partialVariables: PartialValues<any>

Partial variables

prefix: string

A prompt template string to put before the examples.

Default Value

""

suffix: string

A prompt template string to put after the examples.

Default Value

""

templateFormat: "f-string"

The format of the prompt template. Options are: 'f-string'

Default Value

f-string

validateTemplate: boolean

Whether or not to try validating the template on initialization.

Default Value

true

exampleSelector?: BaseExampleSelector

An BaseExampleSelector Examples to format into the prompt. Exactly one of this or examples must be provided.

examples?: InputValues[]

Examples to format into the prompt. Exactly one of this or exampleSelector must be provided.

outputParser?: BaseOutputParser<unknown>

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

Methods

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

    Parameters

    • inputs: any[]

      Array of inputs to each batch call.

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

      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<ChatPromptValueInterface[]>

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

  • Parameters

    Returns Promise<(Error | ChatPromptValueInterface)[]>

  • Parameters

    Returns Promise<(Error | ChatPromptValueInterface)[]>

  • Formats the prompt with the given values.

    Parameters

    • values: TypedPromptInputValues<RunInput>

      The values to format the prompt with.

    Returns Promise<string>

    A promise that resolves to a string representing the formatted prompt.

  • Formats the list of values and returns a list of formatted messages.

    Parameters

    • values: TypedPromptInputValues<RunInput>

      The values to format the prompt with.

    Returns Promise<BaseMessage[]>

    A promise that resolves to a string representing the formatted prompt.

  • Format the prompt given the input values and return a formatted prompt value.

    Parameters

    • values: TypedPromptInputValues<any>

    Returns Promise<ChatPromptValueInterface>

    A formatted PromptValue.

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

    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.

  • Partially formats the prompt with the given values.

    Parameters

    • values: PartialValues<PartialVariableName>

      The values to partially format the prompt with.

    Returns Promise<FewShotChatMessagePromptTemplate<RunInput, PartialVariableName>>

    A promise that resolves to an instance of FewShotChatMessagePromptTemplate with the given values partially formatted.

  • 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<ChatPromptValueInterface, NewRunOutput>

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

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

    A new runnable sequence.

  • Stream output in chunks.

    Parameters

    Returns Promise<IterableReadableStream<ChatPromptValueInterface>>

    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<ChatPromptValueInterface, 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, ChatPromptValueInterface, BaseCallbackConfig>

Generated using TypeDoc