Class ChatMessagePromptTemplate<RunInput>

Class that represents a chat message prompt template. It extends the BaseMessageStringPromptTemplate.

Type Parameters

Hierarchy

  • BaseMessageStringPromptTemplate<RunInput>
    • ChatMessagePromptTemplate

Constructors

Properties

prompt: BaseStringPromptTemplate<InputValues<Extract<keyof RunInput, string>>, string>
role: string

Accessors

  • get inputVariables(): Extract<Extract<keyof RunInput, string>, string>[]
  • Returns Extract<Extract<keyof RunInput, string>, string>[]

Methods

  • Calls the formatMessages method with the provided input and options.

    Parameters

    • input: RunInput

      Input for the formatMessages method

    • Optional options: BaseCallbackConfig

      Optional BaseCallbackConfig

    Returns Promise<BaseMessage[]>

    Formatted output messages

  • 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<BaseMessage[], NewRunOutput>

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

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

    A new runnable sequence.

  • 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<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<BaseMessage[], any, unknown>

Generated using TypeDoc