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

  • BaseMessageStringPromptTemplate<RunInput>
    • HumanMessagePromptTemplate

Constructors

Properties

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

Accessors

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

Methods

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

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

  • Parameters

    Returns Promise<(Error | BaseMessage[])[]>

  • Parameters

    Returns Promise<(Error | BaseMessage[])[]>

  • Parameters

    • values: RunInput

    Returns Promise<BaseMessage>

  • Parameters

    • values: TypedPromptInputValues<RunInput>

    Returns Promise<BaseMessage[]>

  • 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 output in chunks.

    Parameters

    Returns Promise<IterableReadableStream<BaseMessage[]>>

    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<BaseCallbackConfig>
    • Optional streamOptions: Omit<LogStreamCallbackHandlerInput, "autoClose">

    Returns AsyncGenerator<RunLogPatch, any, unknown>

  • Returns Serialized

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

  • Parameters

    • thing: any

    Returns thing is Runnable<any, any, BaseCallbackConfig>

Generated using TypeDoc