HumanMessage#
- class langchain_core.messages.human.HumanMessage[source]#
Bases:
BaseMessage
Message from a human.
HumanMessages are messages that are passed in from a human to the model.
Example
from langchain_core.messages import HumanMessage, SystemMessage messages = [ SystemMessage( content="You are a helpful assistant! Your name is Bob." ), HumanMessage( content="What is your name?" ) ] # Instantiate a chat model and invoke it with the messages model = ... print(model.invoke(messages))
Pass in content as positional arg.
- Parameters:
content β The string contents of the message.
kwargs β Additional fields to pass to the message.
- 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['human'] = 'human'#
The type of the message (used for serialization). Defaults to βhumanβ.
- pretty_print() None #
- Return type:
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 HumanMessage