HumanMessageChunk#

class langchain_core.messages.human.HumanMessageChunk[source]#

Human Message chunk.

Pass in content as positional arg.

Parameters:

param additional_kwargs: dict [Optional]#

Reserved for additional payload data associated with the message.

For example, for a message from an AI, this could include tool calls as encoded by the model provider.

param content: str | List[str | Dict] [Required]#: The string contents of the message.

param example: bool = False#

Use to denote that a message is part of an example conversation.

At the moment, this is ignored by most models. Usage is discouraged. Defaults to False.

param id: str | None = None#: An optional unique identifier for the message. This should ideally be provided by the provider/model which created the message.

param name: str | None = None#

An optional name for the message.

This can be used to provide a human-readable name for the message.

Usage of this field is optional, and whether it’s used or not is up to the model implementation.

param response_metadata: dict [Optional]#: Response metadata. For example: response headers, logprobs, token counts.

param type: Literal['HumanMessageChunk'] = 'HumanMessageChunk'#: The type of the message (used for serialization). Defaults to “HumanMessageChunk”.

pretty_print() → None#

pretty_repr(html: bool = False) → str#

Get a pretty representation of the message.

Parameters:: html (bool) – Whether to format the message as HTML. If True, the message will be formatted with HTML tags. Default is False.
Returns:: A pretty representation of the message.
Return type:: str

Examples using HumanMessageChunk