Class HumanMessagePromptTemplate<RunInput>

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

Example

const message = HumanMessagePromptTemplate.fromTemplate("{text}");
const formatted = await message.format({ text: "Hello world!" });

const chatPrompt = ChatPromptTemplate.fromMessages([message]);
const formattedChatPrompt = await chatPrompt.invoke({
text: "Hello world!",
});

Type Parameters

Hierarchy

  • _StringImageMessagePromptTemplate<RunInput>
    • HumanMessagePromptTemplate

Constructors

Properties

additionalOptions: Record<string, unknown> = {}
inputVariables: Extract<keyof RunInput, string>[] = []
prompt: BaseStringPromptTemplate<InputValues<Extract<keyof RunInput, string>>, string> | (BaseStringPromptTemplate<InputValues<Extract<keyof RunInput, string>>, string> | ImagePromptTemplate<InputValues<Extract<keyof RunInput, string>>, string> | MessageStringPromptTemplateFields<InputValues<Extract<keyof RunInput, string>>>)[]
name?: string
chatMessageClass?: typeof ChatMessage
messageClass?: MessageClass

Methods

  • Parameters

    • name: string

    Returns "system" | "chat" | "human" | "ai"

  • 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 Runnable<RunInput, Exclude<NewRunOutput, Error>, RunnableConfig>

    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

    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<BaseMessage[], 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<RunInput, BaseMessage[], RunnableConfig>

  • Parameters

    • template: string | (string | _TextTemplateParam | _ImageTemplateParam)[]
    • Optional additionalOptions: Record<string, unknown>

    Returns _StringImageMessagePromptTemplate<any, BaseMessage[]>

Generated using TypeDoc