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

RunInput extends InputValues = any

Hierarchy

BaseMessageStringPromptTemplate<RunInput>
- HumanMessagePromptTemplate

Index

Constructors

constructor

new HumanMessagePromptTemplate<RunInput>(prompt): HumanMessagePromptTemplate<RunInput>
Type Parameters
- RunInput extends InputValues = any
Parameters
- prompt: BaseStringPromptTemplate<InputValues<Extract<keyof RunInput, string>>, any>
Returns HumanMessagePromptTemplate<RunInput>
Inherited from BaseMessageStringPromptTemplate<RunInput>.constructor
- Defined in docs/api_refs/langchain/src/prompts/chat.ts:227
new HumanMessagePromptTemplate<RunInput>(fields): HumanMessagePromptTemplate<RunInput>
Type Parameters
- RunInput extends InputValues = any
Parameters
- fields: MessageStringPromptTemplateFields<InputValues<Extract<keyof RunInput, string>>>
Returns HumanMessagePromptTemplate<RunInput>
Inherited from BaseMessageStringPromptTemplate<RunInput>.constructor
- Defined in docs/api_refs/langchain/src/prompts/chat.ts:233

Properties

prompt

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

Accessors

inputVariables

get inputVariables(): Extract<Extract<keyof RunInput, string>, string>[]
Returns Extract<Extract<keyof RunInput, string>, string>[]
Inherited from BaseMessageStringPromptTemplate.inputVariables
- Defined in docs/api_refs/langchain/src/prompts/chat.ts:257

Methods

batch

batch(inputs, options?, batchOptions?): Promise<BaseMessage[][]>
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
Inherited from BaseMessageStringPromptTemplate.batch
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:159
batch(inputs, options?, batchOptions?): Promise<(Error | BaseMessage[])[]>
Parameters
- inputs: RunInput[]
- Optional options: Partial<BaseCallbackConfig> | Partial<BaseCallbackConfig>[]
- Optional batchOptions: RunnableBatchOptions & {
  returnExceptions: true;
  }
Returns Promise<(Error | BaseMessage[])[]>
Inherited from BaseMessageStringPromptTemplate.batch
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:165
batch(inputs, options?, batchOptions?): Promise<(Error | BaseMessage[])[]>
Parameters
- inputs: RunInput[]
- Optional options: Partial<BaseCallbackConfig> | Partial<BaseCallbackConfig>[]
- Optional batchOptions: RunnableBatchOptions
Returns Promise<(Error | BaseMessage[])[]>
Inherited from BaseMessageStringPromptTemplate.batch
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:171

bind

bind(kwargs): Runnable<RunInput, BaseMessage[], BaseCallbackConfig>
Bind arguments to a Runnable, returning a new Runnable.
Parameters
- kwargs: Partial<BaseCallbackConfig>
Returns Runnable<RunInput, BaseMessage[], BaseCallbackConfig>
A new RunnableBinding that, when invoked, will apply the bound args.
Inherited from BaseMessageStringPromptTemplate.bind
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:67

format

format(values): Promise<BaseMessage>
Parameters
- values: RunInput
Returns Promise<BaseMessage>
Overrides BaseMessageStringPromptTemplate.format
- Defined in docs/api_refs/langchain/src/prompts/chat.ts:387

formatMessages

formatMessages(values): Promise<BaseMessage[]>
Parameters
- values: TypedPromptInputValues<RunInput>
Returns Promise<BaseMessage[]>
Inherited from BaseMessageStringPromptTemplate.formatMessages
- Defined in docs/api_refs/langchain/src/prompts/chat.ts:265

invoke

invoke(input, options?): 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
Inherited from BaseMessageStringPromptTemplate.invoke
- Defined in docs/api_refs/langchain/src/prompts/chat.ts:62

map

map(): Runnable<RunInput[], BaseMessage[][], BaseCallbackConfig>
Return a new Runnable that maps a list of inputs to a list of outputs, by calling invoke() with each input.

Returns Runnable<RunInput[], BaseMessage[][], BaseCallbackConfig>
Inherited from BaseMessageStringPromptTemplate.map
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:78

pipe

pipe<NewRunOutput>(coerceable): RunnableSequence<RunInput, Exclude<NewRunOutput, Error>>
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.
Inherited from BaseMessageStringPromptTemplate.pipe
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:461

stream

stream(input, options?): Promise<IterableReadableStream<BaseMessage[]>>
Stream output in chunks.
Parameters
- input: RunInput
- Optional options: Partial<BaseCallbackConfig>
Returns Promise<IterableReadableStream<BaseMessage[]>>
A readable stream that is also an iterable.
Inherited from BaseMessageStringPromptTemplate.stream
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:225

streamLog

streamLog(input, options?, streamOptions?): AsyncGenerator<RunLogPatch, any, unknown>
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>
Inherited from BaseMessageStringPromptTemplate.streamLog
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:507

toJSON

toJSON(): Serialized
Returns Serialized
Inherited from BaseMessageStringPromptTemplate.toJSON
- Defined in docs/api_refs/langchain/src/load/serializable.ts:148

toJSONNotImplemented

toJSONNotImplemented(): SerializedNotImplemented
Returns SerializedNotImplemented
Inherited from BaseMessageStringPromptTemplate.toJSONNotImplemented
- Defined in docs/api_refs/langchain/src/load/serializable.ts:222

transform

transform(generator, options): AsyncGenerator<BaseMessage[], 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<BaseCallbackConfig>
Returns AsyncGenerator<BaseMessage[], any, unknown>
Inherited from BaseMessageStringPromptTemplate.transform
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:478

withConfig

withConfig(config): RunnableBinding<RunInput, BaseMessage[], BaseCallbackConfig>
Bind config to a Runnable, returning a new Runnable.
Parameters
- config: BaseCallbackConfig
  
  New configuration parameters to attach to the new runnable.
Returns RunnableBinding<RunInput, BaseMessage[], BaseCallbackConfig>
A new RunnableBinding with a config matching what's passed.
Inherited from BaseMessageStringPromptTemplate.withConfig
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:107

withFallbacks

withFallbacks(fields): RunnableWithFallbacks<RunInput, BaseMessage[]>
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, BaseMessage[], BaseCallbackConfig>[];
  }
  - fallbacks: Runnable<RunInput, BaseMessage[], BaseCallbackConfig>[]
    
    Other runnables to call if the runnable errors.
Returns RunnableWithFallbacks<RunInput, BaseMessage[]>
A new RunnableWithFallbacks.
Inherited from BaseMessageStringPromptTemplate.withFallbacks
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:124

withRetry

withRetry(fields?): RunnableRetry<RunInput, BaseMessage[], BaseCallbackConfig>
Add retry logic to an existing runnable.
Parameters
- Optional fields: {
  onFailedAttempt?: RunnableRetryFailedAttemptHandler;
  stopAfterAttempt?: number;
  }
  - Optional onFailedAttempt?: RunnableRetryFailedAttemptHandler
  - Optional stopAfterAttempt?: number
Returns RunnableRetry<RunInput, BaseMessage[], BaseCallbackConfig>
A new RunnableRetry that, when invoked, will retry according to the parameters.
Inherited from BaseMessageStringPromptTemplate.withRetry
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:88

`Static` fromTemplate

fromTemplate(template): HumanMessagePromptTemplate<any>
Parameters
- template: string
Returns HumanMessagePromptTemplate<any>
- Defined in docs/api_refs/langchain/src/prompts/chat.ts:391

`Static` isRunnable

isRunnable(thing): thing is Runnable<any, any, BaseCallbackConfig>
Parameters
- thing: any
Returns thing is Runnable<any, any, BaseCallbackConfig>
Inherited from BaseMessageStringPromptTemplate.isRunnable
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:557

Class HumanMessagePromptTemplate<RunInput>

Example

Type Parameters

RunInput extends InputValues = any

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

RunInput extends InputValues = any

Parameters

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

Returns HumanMessagePromptTemplate<RunInput>

Type Parameters

RunInput extends InputValues = any

Parameters

fields: MessageStringPromptTemplateFields<InputValues<Extract<keyof RunInput, string>>>

Returns HumanMessagePromptTemplate<RunInput>

Properties

prompt

Accessors

inputVariables

Returns Extract<Extract<keyof RunInput, string>, string>[]

Methods

batch

Parameters

inputs: RunInput[]

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

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

Returns Promise<BaseMessage[][]>

Parameters

inputs: RunInput[]

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

Optional batchOptions: RunnableBatchOptions & { returnExceptions: true; }

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

Parameters

inputs: RunInput[]

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

Optional batchOptions: RunnableBatchOptions

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

bind

Parameters

kwargs: Partial<BaseCallbackConfig>

Returns Runnable<RunInput, BaseMessage[], BaseCallbackConfig>

format

Parameters

values: RunInput

Returns Promise<BaseMessage>

formatMessages

Parameters

values: TypedPromptInputValues<RunInput>

Returns Promise<BaseMessage[]>

invoke

Parameters

input: RunInput

Optional options: BaseCallbackConfig

Returns Promise<BaseMessage[]>

map

Returns Runnable<RunInput[], BaseMessage[][], BaseCallbackConfig>

pipe

Type Parameters

NewRunOutput

Parameters

coerceable: RunnableLike<BaseMessage[], NewRunOutput>

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

stream

Parameters

input: RunInput

Optional options: Partial<BaseCallbackConfig>

Returns Promise<IterableReadableStream<BaseMessage[]>>

streamLog

Parameters

input: RunInput

Optional options: Partial<BaseCallbackConfig>

Optional streamOptions: Omit<LogStreamCallbackHandlerInput, "autoClose">

Returns AsyncGenerator<RunLogPatch, any, unknown>

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

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

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

`Optional` batchOptions: RunnableBatchOptions & {
returnExceptions: true;
}

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

`Optional` batchOptions: RunnableBatchOptions

`Optional` options: BaseCallbackConfig

`Optional` options: Partial<BaseCallbackConfig>

`Optional` options: Partial<BaseCallbackConfig>

`Optional` streamOptions: Omit<LogStreamCallbackHandlerInput, "autoClose">

fields: {
fallbacks: Runnable<RunInput, BaseMessage[], BaseCallbackConfig>[];
}

`Optional` fields: {
onFailedAttempt?: RunnableRetryFailedAttemptHandler;
stopAfterAttempt?: number;
}

`Optional` onFailedAttempt?: RunnableRetryFailedAttemptHandler

`Optional` stopAfterAttempt?: number

`Static` fromTemplate

`Static` isRunnable