langchain-core 1.0.0a6__py3-none-any.whl → 1.0.3__py3-none-any.whl

langchain_core/messages/utils.py

@@ -5,7 +5,6 @@ Some examples of what you can do with these functions include:
 * Convert messages to strings (serialization)
 * Convert messages from dicts to Message objects (deserialization)
 * Filter messages from a list of messages based on name, type or id etc.
-
 """
 
 from __future__ import annotations
@@ -15,16 +14,13 @@ import inspect
 import json
 import logging
 import math
-from collections.abc import Iterable, Sequence
+from collections.abc import Callable, Iterable, Sequence
 from functools import partial
 from typing import (
     TYPE_CHECKING,
     Annotated,
     Any,
-    Callable,
     Literal,
-    Optional,
-    Union,
     cast,
     overload,
 )
@@ -76,22 +72,21 @@ def _get_type(v: Any) -> str:
 
 
 AnyMessage = Annotated[
-    Union[
-        Annotated[AIMessage, Tag(tag="ai")],
-        Annotated[HumanMessage, Tag(tag="human")],
-        Annotated[ChatMessage, Tag(tag="chat")],
-        Annotated[SystemMessage, Tag(tag="system")],
-        Annotated[FunctionMessage, Tag(tag="function")],
-        Annotated[ToolMessage, Tag(tag="tool")],
-        Annotated[AIMessageChunk, Tag(tag="AIMessageChunk")],
-        Annotated[HumanMessageChunk, Tag(tag="HumanMessageChunk")],
-        Annotated[ChatMessageChunk, Tag(tag="ChatMessageChunk")],
-        Annotated[SystemMessageChunk, Tag(tag="SystemMessageChunk")],
-        Annotated[FunctionMessageChunk, Tag(tag="FunctionMessageChunk")],
-        Annotated[ToolMessageChunk, Tag(tag="ToolMessageChunk")],
-    ],
+    Annotated[AIMessage, Tag(tag="ai")]
+    | Annotated[HumanMessage, Tag(tag="human")]
+    | Annotated[ChatMessage, Tag(tag="chat")]
+    | Annotated[SystemMessage, Tag(tag="system")]
+    | Annotated[FunctionMessage, Tag(tag="function")]
+    | Annotated[ToolMessage, Tag(tag="tool")]
+    | Annotated[AIMessageChunk, Tag(tag="AIMessageChunk")]
+    | Annotated[HumanMessageChunk, Tag(tag="HumanMessageChunk")]
+    | Annotated[ChatMessageChunk, Tag(tag="ChatMessageChunk")]
+    | Annotated[SystemMessageChunk, Tag(tag="SystemMessageChunk")]
+    | Annotated[FunctionMessageChunk, Tag(tag="FunctionMessageChunk")]
+    | Annotated[ToolMessageChunk, Tag(tag="ToolMessageChunk")],
     Field(discriminator=Discriminator(_get_type)),
 ]
+"""A type representing any defined `Message` or `MessageChunk` type."""
 
 
 def get_buffer_string(
@@ -101,10 +96,8 @@ def get_buffer_string(
 
     Args:
         messages: Messages to be converted to strings.
-        human_prefix: The prefix to prepend to contents of ``HumanMessage``s.
-            Default is ``'Human'``.
-        ai_prefix: The prefix to prepend to contents of ``AIMessage``. Default is
-            ``'AI'``.
+        human_prefix: The prefix to prepend to contents of `HumanMessage`s.
+        ai_prefix: The prefix to prepend to contents of `AIMessage`.
 
     Returns:
         A single string concatenation of all input messages.
@@ -113,17 +106,16 @@ def get_buffer_string(
         ValueError: If an unsupported message type is encountered.
 
     Example:
-        .. code-block:: python
-
-            from langchain_core import AIMessage, HumanMessage
-
-            messages = [
-                HumanMessage(content="Hi, how are you?"),
-                AIMessage(content="Good, how are you?"),
-            ]
-            get_buffer_string(messages)
-            # -> "Human: Hi, how are you?\nAI: Good, how are you?"
-
+        ```python
+        from langchain_core import AIMessage, HumanMessage
+
+        messages = [
+            HumanMessage(content="Hi, how are you?"),
+            AIMessage(content="Good, how are you?"),
+        ]
+        get_buffer_string(messages)
+        # -> "Human: Hi, how are you?\nAI: Good, how are you?"
+        ```
     """
     string_messages = []
     for m in messages:
@@ -183,7 +175,7 @@ def _message_from_dict(message: dict) -> BaseMessage:
 
 
 def messages_from_dict(messages: Sequence[dict]) -> list[BaseMessage]:
-    """Convert a sequence of messages from dicts to ``Message`` objects.
+    """Convert a sequence of messages from dicts to `Message` objects.
 
     Args:
         messages: Sequence of messages (as dicts) to convert.
@@ -196,7 +188,7 @@ def messages_from_dict(messages: Sequence[dict]) -> list[BaseMessage]:
 
 
 def message_chunk_to_message(chunk: BaseMessage) -> BaseMessage:
-    """Convert a message chunk to a ``Message``.
+    """Convert a message chunk to a `Message`.
 
     Args:
         chunk: Message chunk to convert.
@@ -215,38 +207,39 @@ def message_chunk_to_message(chunk: BaseMessage) -> BaseMessage:
     )
 
 
-MessageLikeRepresentation = Union[
-    BaseMessage, list[str], tuple[str, str], str, dict[str, Any]
-]
+MessageLikeRepresentation = (
+    BaseMessage | list[str] | tuple[str, str] | str | dict[str, Any]
+)
+"""A type representing the various ways a message can be represented."""
 
 
 def _create_message_from_message_type(
     message_type: str,
     content: str,
-    name: Optional[str] = None,
-    tool_call_id: Optional[str] = None,
-    tool_calls: Optional[list[dict[str, Any]]] = None,
-    id: Optional[str] = None,
+    name: str | None = None,
+    tool_call_id: str | None = None,
+    tool_calls: list[dict[str, Any]] | None = None,
+    id: str | None = None,
     **additional_kwargs: Any,
 ) -> BaseMessage:
-    """Create a message from a ``Message`` type and content string.
+    """Create a message from a `Message` type and content string.
 
     Args:
-        message_type: (str) the type of the message (e.g., ``'human'``, ``'ai'``, etc.).
+        message_type: (str) the type of the message (e.g., `'human'`, `'ai'`, etc.).
         content: (str) the content string.
-        name: (str) the name of the message. Default is None.
-        tool_call_id: (str) the tool call id. Default is None.
-        tool_calls: (list[dict[str, Any]]) the tool calls. Default is None.
-        id: (str) the id of the message. Default is None.
+        name: (str) the name of the message.
+        tool_call_id: (str) the tool call id.
+        tool_calls: (list[dict[str, Any]]) the tool calls.
+        id: (str) the id of the message.
         additional_kwargs: (dict[str, Any]) additional keyword arguments.
 
     Returns:
         a message of the appropriate type.
 
     Raises:
-        ValueError: if the message type is not one of ``'human'``, ``'user'``, ``'ai'``,
-            ``'assistant'``, ``'function'``, ``'tool'``, ``'system'``, or
-            ``'developer'``.
+        ValueError: if the message type is not one of `'human'`, `'user'`, `'ai'`,
+            `'assistant'`, `'function'`, `'tool'`, `'system'`, or
+            `'developer'`.
     """
     kwargs: dict[str, Any] = {}
     if name is not None:
@@ -312,21 +305,21 @@ def _create_message_from_message_type(
 
 
 def _convert_to_message(message: MessageLikeRepresentation) -> BaseMessage:
-    """Instantiate a ``Message`` from a variety of message formats.
+    """Instantiate a `Message` from a variety of message formats.
 
     The message format can be one of the following:
 
-    - ``BaseMessagePromptTemplate``
-    - ``BaseMessage``
-    - 2-tuple of (role string, template); e.g., (``'human'``, ``'{user_input}'``)
+    - `BaseMessagePromptTemplate`
+    - `BaseMessage`
+    - 2-tuple of (role string, template); e.g., (`'human'`, `'{user_input}'`)
     - dict: a message dict with role and content keys
-    - string: shorthand for (``'human'``, template); e.g., ``'{user_input}'``
+    - string: shorthand for (`'human'`, template); e.g., `'{user_input}'`
 
     Args:
         message: a representation of a message in one of the supported formats.
 
     Returns:
-        an instance of a message or a message template.
+        An instance of a message or a message template.
 
     Raises:
         NotImplementedError: if the message type is not supported.
@@ -368,7 +361,7 @@ def _convert_to_message(message: MessageLikeRepresentation) -> BaseMessage:
 
 
 def convert_to_messages(
-    messages: Union[Iterable[MessageLikeRepresentation], PromptValue],
+    messages: Iterable[MessageLikeRepresentation] | PromptValue,
 ) -> list[BaseMessage]:
     """Convert a sequence of messages to a list of messages.
 
@@ -399,12 +392,12 @@ def _runnable_support(func: Callable) -> Callable:
     ) -> list[BaseMessage]: ...
 
     def wrapped(
-        messages: Union[Sequence[MessageLikeRepresentation], None] = None,
+        messages: Sequence[MessageLikeRepresentation] | None = None,
         **kwargs: Any,
-    ) -> Union[
-        list[BaseMessage],
-        Runnable[Sequence[MessageLikeRepresentation], list[BaseMessage]],
-    ]:
+    ) -> (
+        list[BaseMessage]
+        | Runnable[Sequence[MessageLikeRepresentation], list[BaseMessage]]
+    ):
         # Import locally to prevent circular import.
         from langchain_core.runnables.base import RunnableLambda  # noqa: PLC0415
 
@@ -418,89 +411,88 @@ def _runnable_support(func: Callable) -> Callable:
 
 @_runnable_support
 def filter_messages(
-    messages: Union[Iterable[MessageLikeRepresentation], PromptValue],
+    messages: Iterable[MessageLikeRepresentation] | PromptValue,
     *,
-    include_names: Optional[Sequence[str]] = None,
-    exclude_names: Optional[Sequence[str]] = None,
-    include_types: Optional[Sequence[Union[str, type[BaseMessage]]]] = None,
-    exclude_types: Optional[Sequence[Union[str, type[BaseMessage]]]] = None,
-    include_ids: Optional[Sequence[str]] = None,
-    exclude_ids: Optional[Sequence[str]] = None,
-    exclude_tool_calls: Optional[Sequence[str] | bool] = None,
+    include_names: Sequence[str] | None = None,
+    exclude_names: Sequence[str] | None = None,
+    include_types: Sequence[str | type[BaseMessage]] | None = None,
+    exclude_types: Sequence[str | type[BaseMessage]] | None = None,
+    include_ids: Sequence[str] | None = None,
+    exclude_ids: Sequence[str] | None = None,
+    exclude_tool_calls: Sequence[str] | bool | None = None,
 ) -> list[BaseMessage]:
-    """Filter messages based on ``name``, ``type`` or ``id``.
+    """Filter messages based on `name`, `type` or `id`.
 
     Args:
         messages: Sequence Message-like objects to filter.
-        include_names: Message names to include. Default is None.
-        exclude_names: Messages names to exclude. Default is None.
+        include_names: Message names to include.
+        exclude_names: Messages names to exclude.
         include_types: Message types to include. Can be specified as string names
-            (e.g. ``'system'``, ``'human'``, ``'ai'``, ...) or as ``BaseMessage``
-            classes (e.g. ``SystemMessage``, ``HumanMessage``, ``AIMessage``, ...).
-            Default is None.
+            (e.g. `'system'`, `'human'`, `'ai'`, ...) or as `BaseMessage`
+            classes (e.g. `SystemMessage`, `HumanMessage`, `AIMessage`, ...).
+
         exclude_types: Message types to exclude. Can be specified as string names
-            (e.g. ``'system'``, ``'human'``, ``'ai'``, ...) or as ``BaseMessage``
-            classes (e.g. ``SystemMessage``, ``HumanMessage``, ``AIMessage``, ...).
-            Default is None.
-        include_ids: Message IDs to include. Default is None.
-        exclude_ids: Message IDs to exclude. Default is None.
-        exclude_tool_calls: Tool call IDs to exclude. Default is None.
+            (e.g. `'system'`, `'human'`, `'ai'`, ...) or as `BaseMessage`
+            classes (e.g. `SystemMessage`, `HumanMessage`, `AIMessage`, ...).
+
+        include_ids: Message IDs to include.
+        exclude_ids: Message IDs to exclude.
+        exclude_tool_calls: Tool call IDs to exclude.
             Can be one of the following:
-            - ``True``: all ``AIMessage``s with tool calls and all
-              ``ToolMessage``s will be excluded.
+            - `True`: All `AIMessage` objects with tool calls and all `ToolMessage`
+                objects will be excluded.
             - a sequence of tool call IDs to exclude:
-              - ``ToolMessage``s with the corresponding tool call ID will be
-                excluded.
-              - The ``tool_calls`` in the AIMessage will be updated to exclude
-                matching tool calls. If all ``tool_calls`` are filtered from an
-                AIMessage, the whole message is excluded.
+                - `ToolMessage` objects with the corresponding tool call ID will be
+                    excluded.
+                - The `tool_calls` in the AIMessage will be updated to exclude
+                    matching tool calls. If all `tool_calls` are filtered from an
+                    AIMessage, the whole message is excluded.
 
     Returns:
-        A list of Messages that meets at least one of the ``incl_*`` conditions and none
-        of the ``excl_*`` conditions. If not ``incl_*`` conditions are specified then
+        A list of Messages that meets at least one of the `incl_*` conditions and none
+        of the `excl_*` conditions. If not `incl_*` conditions are specified then
         anything that is not explicitly excluded will be included.
 
     Raises:
-        ValueError if two incompatible arguments are provided.
+        ValueError: If two incompatible arguments are provided.
 
     Example:
-        .. code-block:: python
-
-            from langchain_core.messages import (
-                filter_messages,
-                AIMessage,
-                HumanMessage,
-                SystemMessage,
-            )
-
-            messages = [
-                SystemMessage("you're a good assistant."),
-                HumanMessage("what's your name", id="foo", name="example_user"),
-                AIMessage("steve-o", id="bar", name="example_assistant"),
-                HumanMessage(
-                    "what's your favorite color",
-                    id="baz",
-                ),
-                AIMessage(
-                    "silicon blue",
-                    id="blah",
-                ),
-            ]
-
-            filter_messages(
-                messages,
-                incl_names=("example_user", "example_assistant"),
-                incl_types=("system",),
-                excl_ids=("bar",),
-            )
-
-        .. code-block:: python
-
-            [
-                SystemMessage("you're a good assistant."),
-                HumanMessage("what's your name", id="foo", name="example_user"),
-            ]
+        ```python
+        from langchain_core.messages import (
+            filter_messages,
+            AIMessage,
+            HumanMessage,
+            SystemMessage,
+        )
 
+        messages = [
+            SystemMessage("you're a good assistant."),
+            HumanMessage("what's your name", id="foo", name="example_user"),
+            AIMessage("steve-o", id="bar", name="example_assistant"),
+            HumanMessage(
+                "what's your favorite color",
+                id="baz",
+            ),
+            AIMessage(
+                "silicon blue",
+                id="blah",
+            ),
+        ]
+
+        filter_messages(
+            messages,
+            incl_names=("example_user", "example_assistant"),
+            incl_types=("system",),
+            excl_ids=("bar",),
+        )
+        ```
+
+        ```python
+        [
+            SystemMessage("you're a good assistant."),
+            HumanMessage("what's your name", id="foo", name="example_user"),
+        ]
+        ```
     """
     messages = convert_to_messages(messages)
     filtered: list[BaseMessage] = []
@@ -563,20 +555,19 @@ def filter_messages(
 
 @_runnable_support
 def merge_message_runs(
-    messages: Union[Iterable[MessageLikeRepresentation], PromptValue],
+    messages: Iterable[MessageLikeRepresentation] | PromptValue,
     *,
     chunk_separator: str = "\n",
 ) -> list[BaseMessage]:
     r"""Merge consecutive Messages of the same type.
 
-    .. note::
-        ToolMessages are not merged, as each has a distinct tool call id that can't be
-        merged.
+    !!! note
+        `ToolMessage` objects are not merged, as each has a distinct tool call id that
+        can't be merged.
 
     Args:
         messages: Sequence Message-like objects to merge.
         chunk_separator: Specify the string to be inserted between message chunks.
-        Default is ``'\n'``.
 
     Returns:
         list of BaseMessages with consecutive runs of message types merged into single
@@ -584,87 +575,86 @@ def merge_message_runs(
         the merged content is a concatenation of the two strings with a new-line
         separator.
         The separator inserted between message chunks can be controlled by specifying
-        any string with ``chunk_separator``. If at least one of the messages has a list
+        any string with `chunk_separator`. If at least one of the messages has a list
         of content blocks, the merged content is a list of content blocks.
 
     Example:
+        ```python
+        from langchain_core.messages import (
+            merge_message_runs,
+            AIMessage,
+            HumanMessage,
+            SystemMessage,
+            ToolCall,
+        )
 
-        .. code-block:: python
-
-            from langchain_core.messages import (
-                merge_message_runs,
-                AIMessage,
-                HumanMessage,
-                SystemMessage,
-                ToolCall,
-            )
-
-            messages = [
-                SystemMessage("you're a good assistant."),
-                HumanMessage(
-                    "what's your favorite color",
-                    id="foo",
-                ),
-                HumanMessage(
-                    "wait your favorite food",
-                    id="bar",
-                ),
-                AIMessage(
+        messages = [
+            SystemMessage("you're a good assistant."),
+            HumanMessage(
+                "what's your favorite color",
+                id="foo",
+            ),
+            HumanMessage(
+                "wait your favorite food",
+                id="bar",
+            ),
+            AIMessage(
+                "my favorite colo",
+                tool_calls=[
+                    ToolCall(
+                        name="blah_tool", args={"x": 2}, id="123", type="tool_call"
+                    )
+                ],
+                id="baz",
+            ),
+            AIMessage(
+                [{"type": "text", "text": "my favorite dish is lasagna"}],
+                tool_calls=[
+                    ToolCall(
+                        name="blah_tool",
+                        args={"x": -10},
+                        id="456",
+                        type="tool_call",
+                    )
+                ],
+                id="blur",
+            ),
+        ]
+
+        merge_message_runs(messages)
+        ```
+
+        ```python
+        [
+            SystemMessage("you're a good assistant."),
+            HumanMessage(
+                "what's your favorite color\\n"
+                "wait your favorite food", id="foo",
+            ),
+            AIMessage(
+                [
                     "my favorite colo",
-                    tool_calls=[
-                        ToolCall(
-                            name="blah_tool", args={"x": 2}, id="123", type="tool_call"
-                        )
-                    ],
-                    id="baz",
-                ),
-                AIMessage(
-                    [{"type": "text", "text": "my favorite dish is lasagna"}],
-                    tool_calls=[
-                        ToolCall(
-                            name="blah_tool",
-                            args={"x": -10},
-                            id="456",
-                            type="tool_call",
-                        )
-                    ],
-                    id="blur",
-                ),
-            ]
-
-            merge_message_runs(messages)
-
-        .. code-block:: python
-
-            [
-                SystemMessage("you're a good assistant."),
-                HumanMessage(
-                    "what's your favorite color\\n"
-                    "wait your favorite food", id="foo",
-                ),
-                AIMessage(
-                    [
-                        "my favorite colo",
-                        {"type": "text", "text": "my favorite dish is lasagna"}
-                    ],
-                    tool_calls=[
-                        ToolCall({
-                            "name": "blah_tool",
-                            "args": {"x": 2},
-                            "id": "123",
-                            "type": "tool_call"
-                        }),
-                        ToolCall({
-                            "name": "blah_tool",
-                            "args": {"x": -10},
-                            "id": "456",
-                            "type": "tool_call"
-                        })
-                    ]
-                    id="baz"
-                ),
-            ]
+                    {"type": "text", "text": "my favorite dish is lasagna"}
+                ],
+                tool_calls=[
+                    ToolCall({
+                        "name": "blah_tool",
+                        "args": {"x": 2},
+                        "id": "123",
+                        "type": "tool_call"
+                    }),
+                    ToolCall({
+                        "name": "blah_tool",
+                        "args": {"x": -10},
+                        "id": "456",
+                        "type": "tool_call"
+                    })
+                ]
+                id="baz"
+            ),
+        ]
 
+        ```
     """
     if not messages:
         return []
@@ -696,174 +686,161 @@ def merge_message_runs(
 # init not at runtime.
 @_runnable_support
 def trim_messages(
-    messages: Union[Iterable[MessageLikeRepresentation], PromptValue],
+    messages: Iterable[MessageLikeRepresentation] | PromptValue,
     *,
     max_tokens: int,
-    token_counter: Union[
-        Callable[[list[BaseMessage]], int],
-        Callable[[BaseMessage], int],
-        BaseLanguageModel,
-    ],
+    token_counter: Callable[[list[BaseMessage]], int]
+    | Callable[[BaseMessage], int]
+    | BaseLanguageModel,
     strategy: Literal["first", "last"] = "last",
     allow_partial: bool = False,
-    end_on: Optional[
-        Union[str, type[BaseMessage], Sequence[Union[str, type[BaseMessage]]]]
-    ] = None,
-    start_on: Optional[
-        Union[str, type[BaseMessage], Sequence[Union[str, type[BaseMessage]]]]
-    ] = None,
+    end_on: str | type[BaseMessage] | Sequence[str | type[BaseMessage]] | None = None,
+    start_on: str | type[BaseMessage] | Sequence[str | type[BaseMessage]] | None = None,
     include_system: bool = False,
-    text_splitter: Optional[Union[Callable[[str], list[str]], TextSplitter]] = None,
+    text_splitter: Callable[[str], list[str]] | TextSplitter | None = None,
 ) -> list[BaseMessage]:
     r"""Trim messages to be below a token count.
 
-    ``trim_messages`` can be used to reduce the size of a chat history to a specified
-    token count or specified message count.
+    `trim_messages` can be used to reduce the size of a chat history to a specified
+    token or message count.
 
     In either case, if passing the trimmed chat history back into a chat model
     directly, the resulting chat history should usually satisfy the following
     properties:
 
     1. The resulting chat history should be valid. Most chat models expect that chat
-       history starts with either (1) a ``HumanMessage`` or (2) a ``SystemMessage``
-       followed by a ``HumanMessage``. To achieve this, set ``start_on='human'``.
-       In addition, generally a ``ToolMessage`` can only appear after an ``AIMessage``
-       that involved a tool call.
-       Please see the following link for more information about messages:
-       https://python.langchain.com/docs/concepts/#messages
+        history starts with either (1) a `HumanMessage` or (2) a `SystemMessage`
+        followed by a `HumanMessage`. To achieve this, set `start_on='human'`.
+        In addition, generally a `ToolMessage` can only appear after an `AIMessage`
+        that involved a tool call.
     2. It includes recent messages and drops old messages in the chat history.
-       To achieve this set the ``strategy='last'``.
-    3. Usually, the new chat history should include the ``SystemMessage`` if it
-       was present in the original chat history since the ``SystemMessage`` includes
-       special instructions to the chat model. The ``SystemMessage`` is almost always
-       the first message in the history if present. To achieve this set the
-       ``include_system=True``.
-
-    .. note::
-        The examples below show how to configure ``trim_messages`` to achieve a behavior
+        To achieve this set the `strategy='last'`.
+    3. Usually, the new chat history should include the `SystemMessage` if it
+        was present in the original chat history since the `SystemMessage` includes
+        special instructions to the chat model. The `SystemMessage` is almost always
+        the first message in the history if present. To achieve this set the
+        `include_system=True`.
+
+    !!! note
+        The examples below show how to configure `trim_messages` to achieve a behavior
         consistent with the above properties.
 
     Args:
         messages: Sequence of Message-like objects to trim.
         max_tokens: Max token count of trimmed messages.
-        token_counter: Function or llm for counting tokens in a ``BaseMessage`` or a
-            list of ``BaseMessage``. If a ``BaseLanguageModel`` is passed in then
-            ``BaseLanguageModel.get_num_tokens_from_messages()`` will be used.
-            Set to ``len`` to count the number of **messages** in the chat history.
+        token_counter: Function or llm for counting tokens in a `BaseMessage` or a
+            list of `BaseMessage`. If a `BaseLanguageModel` is passed in then
+            `BaseLanguageModel.get_num_tokens_from_messages()` will be used.
+            Set to `len` to count the number of **messages** in the chat history.
 
-            .. note::
-                Use ``count_tokens_approximately`` to get fast, approximate token
+            !!! note
+                Use `count_tokens_approximately` to get fast, approximate token
                 counts.
-                This is recommended for using ``trim_messages`` on the hot path, where
+                This is recommended for using `trim_messages` on the hot path, where
                 exact token counting is not necessary.
 
         strategy: Strategy for trimming.
-            - ``'first'``: Keep the first ``<= n_count`` tokens of the messages.
-            - ``'last'``: Keep the last ``<= n_count`` tokens of the messages.
-            Default is ``'last'``.
+            - `'first'`: Keep the first `<= n_count` tokens of the messages.
+            - `'last'`: Keep the last `<= n_count` tokens of the messages.
         allow_partial: Whether to split a message if only part of the message can be
-            included. If ``strategy='last'`` then the last partial contents of a message
-            are included. If ``strategy='first'`` then the first partial contents of a
+            included. If `strategy='last'` then the last partial contents of a message
+            are included. If `strategy='first'` then the first partial contents of a
             message are included.
-            Default is False.
         end_on: The message type to end on. If specified then every message after the
-            last occurrence of this type is ignored. If ``strategy='last'`` then this
-            is done before we attempt to get the last ``max_tokens``. If
-            ``strategy='first'`` then this is done after we get the first
-            ``max_tokens``. Can be specified as string names (e.g. ``'system'``,
-            ``'human'``, ``'ai'``, ...) or as ``BaseMessage`` classes (e.g.
-            ``SystemMessage``, ``HumanMessage``, ``AIMessage``, ...). Can be a single
+            last occurrence of this type is ignored. If `strategy='last'` then this
+            is done before we attempt to get the last `max_tokens`. If
+            `strategy='first'` then this is done after we get the first
+            `max_tokens`. Can be specified as string names (e.g. `'system'`,
+            `'human'`, `'ai'`, ...) or as `BaseMessage` classes (e.g.
+            `SystemMessage`, `HumanMessage`, `AIMessage`, ...). Can be a single
             type or a list of types.
-            Default is None.
+
         start_on: The message type to start on. Should only be specified if
-            ``strategy='last'``. If specified then every message before
+            `strategy='last'`. If specified then every message before
             the first occurrence of this type is ignored. This is done after we trim
-            the initial messages to the last ``max_tokens``. Does not
-            apply to a ``SystemMessage`` at index 0 if ``include_system=True``. Can be
-            specified as string names (e.g. ``'system'``, ``'human'``, ``'ai'``, ...) or
-            as ``BaseMessage`` classes (e.g. ``SystemMessage``, ``HumanMessage``,
-            ``AIMessage``, ...). Can be a single type or a list of types.
-            Default is None.
-        include_system: Whether to keep the SystemMessage if there is one at index 0.
-            Should only be specified if ``strategy="last"``.
-            Default is False.
-        text_splitter: Function or ``langchain_text_splitters.TextSplitter`` for
+            the initial messages to the last `max_tokens`. Does not
+            apply to a `SystemMessage` at index 0 if `include_system=True`. Can be
+            specified as string names (e.g. `'system'`, `'human'`, `'ai'`, ...) or
+            as `BaseMessage` classes (e.g. `SystemMessage`, `HumanMessage`,
+            `AIMessage`, ...). Can be a single type or a list of types.
+
+        include_system: Whether to keep the `SystemMessage` if there is one at index
+            `0`. Should only be specified if `strategy="last"`.
+        text_splitter: Function or `langchain_text_splitters.TextSplitter` for
             splitting the string contents of a message. Only used if
-            ``allow_partial=True``. If ``strategy='last'`` then the last split tokens
-            from a partial message will be included. if ``strategy='first'`` then the
+            `allow_partial=True`. If `strategy='last'` then the last split tokens
+            from a partial message will be included. if `strategy='first'` then the
             first split tokens from a partial message will be included. Token splitter
             assumes that separators are kept, so that split contents can be directly
             concatenated to recreate the original text. Defaults to splitting on
             newlines.
 
     Returns:
-        list of trimmed ``BaseMessage``.
+        List of trimmed `BaseMessage`.
 
     Raises:
         ValueError: if two incompatible arguments are specified or an unrecognized
-            ``strategy`` is specified.
+            `strategy` is specified.
 
     Example:
-        Trim chat history based on token count, keeping the ``SystemMessage`` if
-        present, and ensuring that the chat history starts with a ``HumanMessage`` (
-        or a ``SystemMessage`` followed by a ``HumanMessage``).
-
-        .. code-block:: python
-
-            from langchain_core.messages import (
-                AIMessage,
-                HumanMessage,
-                BaseMessage,
-                SystemMessage,
-                trim_messages,
-            )
-
-            messages = [
-                SystemMessage(
-                    "you're a good assistant, you always respond with a joke."
-                ),
-                HumanMessage("i wonder why it's called langchain"),
-                AIMessage(
-                    'Well, I guess they thought "WordRope" and "SentenceString" just '
-                    "didn't have the same ring to it!"
-                ),
-                HumanMessage("and who is harrison chasing anyways"),
-                AIMessage(
-                    "Hmmm let me think.\n\nWhy, he's probably chasing after the last "
-                    "cup of coffee in the office!"
-                ),
-                HumanMessage("what do you call a speechless parrot"),
-            ]
-
-
-            trim_messages(
-                messages,
-                max_tokens=45,
-                strategy="last",
-                token_counter=ChatOpenAI(model="gpt-4o"),
-                # Most chat models expect that chat history starts with either:
-                # (1) a HumanMessage or
-                # (2) a SystemMessage followed by a HumanMessage
-                start_on="human",
-                # Usually, we want to keep the SystemMessage
-                # if it's present in the original history.
-                # The SystemMessage has special instructions for the model.
-                include_system=True,
-                allow_partial=False,
-            )
+        Trim chat history based on token count, keeping the `SystemMessage` if
+        present, and ensuring that the chat history starts with a `HumanMessage` (
+        or a `SystemMessage` followed by a `HumanMessage`).
+
+        ```python
+        from langchain_core.messages import (
+            AIMessage,
+            HumanMessage,
+            BaseMessage,
+            SystemMessage,
+            trim_messages,
+        )
 
-        .. code-block:: python
+        messages = [
+            SystemMessage("you're a good assistant, you always respond with a joke."),
+            HumanMessage("i wonder why it's called langchain"),
+            AIMessage(
+                'Well, I guess they thought "WordRope" and "SentenceString" just '
+                "didn't have the same ring to it!"
+            ),
+            HumanMessage("and who is harrison chasing anyways"),
+            AIMessage(
+                "Hmmm let me think.\n\nWhy, he's probably chasing after the last "
+                "cup of coffee in the office!"
+            ),
+            HumanMessage("what do you call a speechless parrot"),
+        ]
+
+
+        trim_messages(
+            messages,
+            max_tokens=45,
+            strategy="last",
+            token_counter=ChatOpenAI(model="gpt-4o"),
+            # Most chat models expect that chat history starts with either:
+            # (1) a HumanMessage or
+            # (2) a SystemMessage followed by a HumanMessage
+            start_on="human",
+            # Usually, we want to keep the SystemMessage
+            # if it's present in the original history.
+            # The SystemMessage has special instructions for the model.
+            include_system=True,
+            allow_partial=False,
+        )
+        ```
 
-            [
-                SystemMessage(
-                    content="you're a good assistant, you always respond with a joke."
-                ),
-                HumanMessage(content="what do you call a speechless parrot"),
-            ]
+        ```python
+        [
+            SystemMessage(
+                content="you're a good assistant, you always respond with a joke."
+            ),
+            HumanMessage(content="what do you call a speechless parrot"),
+        ]
+        ```
 
-        Trim chat history based on the message count, keeping the ``SystemMessage`` if
-        present, and ensuring that the chat history starts with a ``HumanMessage`` (
-        or a ``SystemMessage`` followed by a ``HumanMessage``).
+        Trim chat history based on the message count, keeping the `SystemMessage` if
+        present, and ensuring that the chat history starts with a `HumanMessage` (
+        or a `SystemMessage` followed by a `HumanMessage`).
 
             trim_messages(
                 messages,
@@ -885,100 +862,95 @@ def trim_messages(
                 allow_partial=False,
             )
 
-        .. code-block:: python
-
-            [
-                SystemMessage(
-                    content="you're a good assistant, you always respond with a joke."
-                ),
-                HumanMessage(content="and who is harrison chasing anyways"),
-                AIMessage(
-                    content="Hmmm let me think.\n\nWhy, he's probably chasing after "
-                    "the last cup of coffee in the office!"
-                ),
-                HumanMessage(content="what do you call a speechless parrot"),
-            ]
-
-
+        ```python
+        [
+            SystemMessage(
+                content="you're a good assistant, you always respond with a joke."
+            ),
+            HumanMessage(content="and who is harrison chasing anyways"),
+            AIMessage(
+                content="Hmmm let me think.\n\nWhy, he's probably chasing after "
+                "the last cup of coffee in the office!"
+            ),
+            HumanMessage(content="what do you call a speechless parrot"),
+        ]
+        ```
         Trim chat history using a custom token counter function that counts the
         number of tokens in each message.
 
-        .. code-block:: python
-
-            messages = [
-                SystemMessage("This is a 4 token text. The full message is 10 tokens."),
-                HumanMessage(
-                    "This is a 4 token text. The full message is 10 tokens.", id="first"
-                ),
-                AIMessage(
-                    [
-                        {"type": "text", "text": "This is the FIRST 4 token block."},
-                        {"type": "text", "text": "This is the SECOND 4 token block."},
-                    ],
-                    id="second",
-                ),
-                HumanMessage(
-                    "This is a 4 token text. The full message is 10 tokens.", id="third"
-                ),
-                AIMessage(
-                    "This is a 4 token text. The full message is 10 tokens.",
-                    id="fourth",
-                ),
-            ]
-
-
-            def dummy_token_counter(messages: list[BaseMessage]) -> int:
-                # treat each message like it adds 3 default tokens at the beginning
-                # of the message and at the end of the message. 3 + 4 + 3 = 10 tokens
-                # per message.
-
-                default_content_len = 4
-                default_msg_prefix_len = 3
-                default_msg_suffix_len = 3
-
-                count = 0
-                for msg in messages:
-                    if isinstance(msg.content, str):
-                        count += (
-                            default_msg_prefix_len
-                            + default_content_len
-                            + default_msg_suffix_len
-                        )
-                    if isinstance(msg.content, list):
-                        count += (
-                            default_msg_prefix_len
-                            + len(msg.content) * default_content_len
-                            + default_msg_suffix_len
-                        )
-                return count
-
-        First 30 tokens, allowing partial messages:
-            .. code-block:: python
-
-                trim_messages(
-                    messages,
-                    max_tokens=30,
-                    token_counter=dummy_token_counter,
-                    strategy="first",
-                    allow_partial=True,
-                )
-
-            .. code-block:: python
-
+        ```python
+        messages = [
+            SystemMessage("This is a 4 token text. The full message is 10 tokens."),
+            HumanMessage(
+                "This is a 4 token text. The full message is 10 tokens.", id="first"
+            ),
+            AIMessage(
                 [
-                    SystemMessage(
-                        "This is a 4 token text. The full message is 10 tokens."
-                    ),
-                    HumanMessage(
-                        "This is a 4 token text. The full message is 10 tokens.",
-                        id="first",
-                    ),
-                    AIMessage(
-                        [{"type": "text", "text": "This is the FIRST 4 token block."}],
-                        id="second",
-                    ),
-                ]
+                    {"type": "text", "text": "This is the FIRST 4 token block."},
+                    {"type": "text", "text": "This is the SECOND 4 token block."},
+                ],
+                id="second",
+            ),
+            HumanMessage(
+                "This is a 4 token text. The full message is 10 tokens.", id="third"
+            ),
+            AIMessage(
+                "This is a 4 token text. The full message is 10 tokens.",
+                id="fourth",
+            ),
+        ]
+
+
+        def dummy_token_counter(messages: list[BaseMessage]) -> int:
+            # treat each message like it adds 3 default tokens at the beginning
+            # of the message and at the end of the message. 3 + 4 + 3 = 10 tokens
+            # per message.
+
+            default_content_len = 4
+            default_msg_prefix_len = 3
+            default_msg_suffix_len = 3
+
+            count = 0
+            for msg in messages:
+                if isinstance(msg.content, str):
+                    count += (
+                        default_msg_prefix_len
+                        + default_content_len
+                        + default_msg_suffix_len
+                    )
+                if isinstance(msg.content, list):
+                    count += (
+                        default_msg_prefix_len
+                        + len(msg.content) * default_content_len
+                        + default_msg_suffix_len
+                    )
+            return count
+        ```
 
+        First 30 tokens, allowing partial messages:
+        ```python
+        trim_messages(
+            messages,
+            max_tokens=30,
+            token_counter=dummy_token_counter,
+            strategy="first",
+            allow_partial=True,
+        )
+        ```
+
+        ```python
+        [
+            SystemMessage("This is a 4 token text. The full message is 10 tokens."),
+            HumanMessage(
+                "This is a 4 token text. The full message is 10 tokens.",
+                id="first",
+            ),
+            AIMessage(
+                [{"type": "text", "text": "This is the FIRST 4 token block."}],
+                id="second",
+            ),
+        ]
+        ```
     """
     # Validate arguments
     if start_on and strategy == "first":
@@ -1042,88 +1014,90 @@ def trim_messages(
 
 
 def convert_to_openai_messages(
-    messages: Union[MessageLikeRepresentation, Sequence[MessageLikeRepresentation]],
+    messages: MessageLikeRepresentation | Sequence[MessageLikeRepresentation],
     *,
     text_format: Literal["string", "block"] = "string",
-) -> Union[dict, list[dict]]:
+    include_id: bool = False,
+) -> dict | list[dict]:
     """Convert LangChain messages into OpenAI message dicts.
 
     Args:
         messages: Message-like object or iterable of objects whose contents are
             in OpenAI, Anthropic, Bedrock Converse, or VertexAI formats.
         text_format: How to format string or text block contents:
-                - ``'string'``:
-                    If a message has a string content, this is left as a string. If
-                    a message has content blocks that are all of type ``'text'``, these
-                    are joined with a newline to make a single string. If a message has
-                    content blocks and at least one isn't of type ``'text'``, then
-                    all blocks are left as dicts.
-                - ``'block'``:
-                    If a message has a string content, this is turned into a list
-                    with a single content block of type ``'text'``. If a message has
-                    content blocks these are left as is.
+            - `'string'`:
+                If a message has a string content, this is left as a string. If
+                a message has content blocks that are all of type `'text'`, these
+                are joined with a newline to make a single string. If a message has
+                content blocks and at least one isn't of type `'text'`, then
+                all blocks are left as dicts.
+            - `'block'`:
+                If a message has a string content, this is turned into a list
+                with a single content block of type `'text'`. If a message has
+                content blocks these are left as is.
+        include_id: Whether to include message IDs in the openai messages, if they
+            are present in the source messages.
 
     Raises:
-        ValueError: if an unrecognized ``text_format`` is specified, or if a message
+        ValueError: if an unrecognized `text_format` is specified, or if a message
             content block is missing expected keys.
 
     Returns:
         The return type depends on the input type:
 
         - dict:
-          If a single message-like object is passed in, a single OpenAI message
-          dict is returned.
+            If a single message-like object is passed in, a single OpenAI message
+            dict is returned.
         - list[dict]:
-          If a sequence of message-like objects are passed in, a list of OpenAI
-          message dicts is returned.
+            If a sequence of message-like objects are passed in, a list of OpenAI
+            message dicts is returned.
 
     Example:
+        ```python
+        from langchain_core.messages import (
+            convert_to_openai_messages,
+            AIMessage,
+            SystemMessage,
+            ToolMessage,
+        )
 
-        .. code-block:: python
-
-            from langchain_core.messages import (
-                convert_to_openai_messages,
-                AIMessage,
-                SystemMessage,
-                ToolMessage,
-            )
-
-            messages = [
-                SystemMessage([{"type": "text", "text": "foo"}]),
-                {
-                    "role": "user",
-                    "content": [
-                        {"type": "text", "text": "whats in this"},
-                        {
-                            "type": "image_url",
-                            "image_url": {"url": "data:image/png;base64,'/9j/4AAQSk'"},
-                        },
-                    ],
-                },
-                AIMessage(
-                    "",
-                    tool_calls=[
-                        {
-                            "name": "analyze",
-                            "args": {"baz": "buz"},
-                            "id": "1",
-                            "type": "tool_call",
-                        }
-                    ],
-                ),
-                ToolMessage("foobar", tool_call_id="1", name="bar"),
-                {"role": "assistant", "content": "thats nice"},
-            ]
-            oai_messages = convert_to_openai_messages(messages)
-            # -> [
-            #   {'role': 'system', 'content': 'foo'},
-            #   {'role': 'user', 'content': [{'type': 'text', 'text': 'whats in this'}, {'type': 'image_url', 'image_url': {'url': "data:image/png;base64,'/9j/4AAQSk'"}}]},
-            #   {'role': 'assistant', 'tool_calls': [{'type': 'function', 'id': '1','function': {'name': 'analyze', 'arguments': '{"baz": "buz"}'}}], 'content': ''},
-            #   {'role': 'tool', 'name': 'bar', 'content': 'foobar'},
-            #   {'role': 'assistant', 'content': 'thats nice'}
-            # ]
-
-    .. versionadded:: 0.3.11
+        messages = [
+            SystemMessage([{"type": "text", "text": "foo"}]),
+            {
+                "role": "user",
+                "content": [
+                    {"type": "text", "text": "whats in this"},
+                    {
+                        "type": "image_url",
+                        "image_url": {"url": "data:image/png;base64,'/9j/4AAQSk'"},
+                    },
+                ],
+            },
+            AIMessage(
+                "",
+                tool_calls=[
+                    {
+                        "name": "analyze",
+                        "args": {"baz": "buz"},
+                        "id": "1",
+                        "type": "tool_call",
+                    }
+                ],
+            ),
+            ToolMessage("foobar", tool_call_id="1", name="bar"),
+            {"role": "assistant", "content": "thats nice"},
+        ]
+        oai_messages = convert_to_openai_messages(messages)
+        # -> [
+        #   {'role': 'system', 'content': 'foo'},
+        #   {'role': 'user', 'content': [{'type': 'text', 'text': 'whats in this'}, {'type': 'image_url', 'image_url': {'url': "data:image/png;base64,'/9j/4AAQSk'"}}]},
+        #   {'role': 'assistant', 'tool_calls': [{'type': 'function', 'id': '1','function': {'name': 'analyze', 'arguments': '{"baz": "buz"}'}}], 'content': ''},
+        #   {'role': 'tool', 'name': 'bar', 'content': 'foobar'},
+        #   {'role': 'assistant', 'content': 'thats nice'}
+        # ]
+        ```
+
+    !!! version-added "Added in version 0.3.11"
 
     """  # noqa: E501
     if text_format not in {"string", "block"}:
@@ -1140,7 +1114,7 @@ def convert_to_openai_messages(
     for i, message in enumerate(messages):
         oai_msg: dict = {"role": _get_message_openai_role(message)}
         tool_messages: list = []
-        content: Union[str, list[dict]]
+        content: str | list[dict]
 
         if message.name:
             oai_msg["name"] = message.name
@@ -1150,6 +1124,8 @@ def convert_to_openai_messages(
             oai_msg["refusal"] = message.additional_kwargs["refusal"]
         if isinstance(message, ToolMessage):
             oai_msg["tool_call_id"] = message.tool_call_id
+        if include_id and message.id:
+            oai_msg["id"] = message.id
 
         if not message.content:
             content = "" if text_format == "string" else []
@@ -1421,10 +1397,8 @@ def _first_max_tokens(
     max_tokens: int,
     token_counter: Callable[[list[BaseMessage]], int],
     text_splitter: Callable[[str], list[str]],
-    partial_strategy: Optional[Literal["first", "last"]] = None,
-    end_on: Optional[
-        Union[str, type[BaseMessage], Sequence[Union[str, type[BaseMessage]]]]
-    ] = None,
+    partial_strategy: Literal["first", "last"] | None = None,
+    end_on: str | type[BaseMessage] | Sequence[str | type[BaseMessage]] | None = None,
 ) -> list[BaseMessage]:
     messages = list(messages)
     if not messages:
@@ -1541,12 +1515,8 @@ def _last_max_tokens(
     text_splitter: Callable[[str], list[str]],
     allow_partial: bool = False,
     include_system: bool = False,
-    start_on: Optional[
-        Union[str, type[BaseMessage], Sequence[Union[str, type[BaseMessage]]]]
-    ] = None,
-    end_on: Optional[
-        Union[str, type[BaseMessage], Sequence[Union[str, type[BaseMessage]]]]
-    ] = None,
+    start_on: str | type[BaseMessage] | Sequence[str | type[BaseMessage]] | None = None,
+    end_on: str | type[BaseMessage] | Sequence[str | type[BaseMessage]] | None = None,
 ) -> list[BaseMessage]:
     messages = list(messages)
     if len(messages) == 0:
@@ -1647,7 +1617,7 @@ def _default_text_splitter(text: str) -> list[str]:
 
 def _is_message_type(
     message: BaseMessage,
-    type_: Union[str, type[BaseMessage], Sequence[Union[str, type[BaseMessage]]]],
+    type_: str | type[BaseMessage] | Sequence[str | type[BaseMessage]],
 ) -> bool:
     types = [type_] if isinstance(type_, (str, type)) else type_
     types_str = [t for t in types if isinstance(t, str)]
@@ -1707,27 +1677,27 @@ def count_tokens_approximately(
     Args:
         messages: List of messages to count tokens for.
         chars_per_token: Number of characters per token to use for the approximation.
-            Default is 4 (one token corresponds to ~4 chars for common English text).
-            You can also specify float values for more fine-grained control.
-            `See more here. <https://platform.openai.com/tokenizer>`__
-        extra_tokens_per_message: Number of extra tokens to add per message.
-            Default is 3 (special tokens, including beginning/end of message).
-            You can also specify float values for more fine-grained control.
-            `See more here. <https://github.com/openai/openai-cookbook/blob/main/examples/How_to_count_tokens_with_tiktoken.ipynb>`__
+            One token corresponds to ~4 chars for common English text.
+            You can also specify `float` values for more fine-grained control.
+            [See more here](https://platform.openai.com/tokenizer).
+        extra_tokens_per_message: Number of extra tokens to add per message, e.g.
+            special tokens, including beginning/end of message.
+            You can also specify `float` values for more fine-grained control.
+            [See more here](https://github.com/openai/openai-cookbook/blob/main/examples/How_to_count_tokens_with_tiktoken.ipynb).
         count_name: Whether to include message names in the count.
             Enabled by default.
 
     Returns:
         Approximate number of tokens in the messages.
 
-    .. note::
+    !!! note
         This is a simple approximation that may not match the exact token count used by
         specific models. For accurate counts, use model-specific tokenizers.
 
     Warning:
         This function does not currently support counting image tokens.
 
-    .. versionadded:: 0.3.46
+    !!! version-added "Added in version 0.3.46"
 
     """
     token_count = 0.0