AIMessage — 🦜🔗 LangChain documentation (original) (raw)

class langchain_core.messages.ai.AIMessage[source]#

Message from an AI.

AIMessage is returned from a chat model as a response to a prompt.

This message represents the output of the model and consists of both the raw output as returned by the model together standardized fields (e.g., tool calls, usage metadata) added by the LangChain framework.

Pass in content as positional arg.

Parameters:

content – The content of the message.
kwargs – Additional arguments to pass to the parent class.

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.

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.

Constraints:

coerce_numbers_to_str = True

param invalid_tool_calls_: list[InvalidToolCall]_ = []#

If provided, tool calls with parsing errors associated with 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 tool_calls_: list[ToolCall]_ = []#

If provided, tool calls associated with the message.

param type_: Literal['ai']_ = 'ai'#

The type of the message (used for deserialization). Defaults to “ai”.

param usage_metadata_: UsageMetadata | None_ = None#

If provided, usage metadata for a message, such as token counts.

This is a standard representation of token usage that is consistent across models.

pretty_print() → None#

Print a pretty representation of the message.

Return type:

None

pretty_repr(html: bool = False) → str[source]#

Return a pretty representation of the message.

Parameters:

html (bool) – Whether to return an HTML-formatted string. Defaults to False.

Returns:

A pretty representation of the message.

Return type:

str

text() → str#

Get the text content of the message.

Returns:

The text content of the message.

Return type:

str

Examples using AIMessage