langchain-core 1.0.0a4__py3-none-any.whl → 1.0.0a5__py3-none-any.whl

langchain_core/messages/content.py

@@ -384,23 +384,20 @@ class InvalidToolCall(TypedDict):
     """Provider-specific metadata."""
 
 
-class WebSearchCall(TypedDict):
-    """Built-in web search tool call."""
+class ServerToolCall(TypedDict):
+    """Tool call that is executed server-side."""
 
-    type: Literal["web_search_call"]
-    """Type of the content block. Used for discrimination."""
-
-    id: NotRequired[str]
-    """Content block identifier.
+    type: Literal["server_tool_call"]
+    """Used for discrimination."""
 
-    Either:
-    - Generated by the provider (e.g., OpenAI's file ID)
-    - Generated by LangChain upon creation (``UUID4`` prefixed with ``'lc_'``))
+    id: str
+    """An identifier associated with the tool call."""
 
-    """
+    name: str
+    """The name of the tool to be called."""
 
-    query: NotRequired[str]
-    """The search query used in the web search tool call."""
+    args: dict[str, Any]
+    """The arguments to the tool call."""
 
     index: NotRequired[Union[int, str]]
     """Index of block in aggregate response. Used during streaming."""
@@ -409,51 +406,20 @@ class WebSearchCall(TypedDict):
     """Provider-specific metadata."""
 
 
-class WebSearchResult(TypedDict):
-    """Result of a built-in web search tool call."""
-
-    type: Literal["web_search_result"]
-    """Type of the content block. Used for discrimination."""
-
-    id: NotRequired[str]
-    """Content block identifier.
-
-    Either:
-    - Generated by the provider (e.g., OpenAI's file ID)
-    - Generated by LangChain upon creation (``UUID4`` prefixed with ``'lc_'``))
-
-    """
-
-    urls: NotRequired[list[str]]
-    """List of URLs returned by the web search tool call."""
-
-    index: NotRequired[Union[int, str]]
-    """Index of block in aggregate response. Used during streaming."""
-
-    extras: NotRequired[dict[str, Any]]
-    """Provider-specific metadata."""
+class ServerToolCallChunk(TypedDict):
+    """A chunk of a tool call (as part of a stream)."""
 
+    type: Literal["server_tool_call_chunk"]
+    """Used for discrimination."""
 
-class CodeInterpreterCall(TypedDict):
-    """Built-in code interpreter tool call."""
+    name: NotRequired[str]
+    """The name of the tool to be called."""
 
-    type: Literal["code_interpreter_call"]
-    """Type of the content block. Used for discrimination."""
+    args: NotRequired[str]
+    """JSON substring of the arguments to the tool call."""
 
     id: NotRequired[str]
-    """Content block identifier.
-
-    Either:
-    - Generated by the provider (e.g., OpenAI's file ID)
-    - Generated by LangChain upon creation (``UUID4`` prefixed with ``'lc_'``))
-
-    """
-
-    language: NotRequired[str]
-    """The name of the programming language used in the code interpreter tool call."""
-
-    code: NotRequired[str]
-    """The code to be executed by the code interpreter."""
+    """An identifier associated with the tool call."""
 
     index: NotRequired[Union[int, str]]
     """Index of block in aggregate response. Used during streaming."""
@@ -462,60 +428,23 @@ class CodeInterpreterCall(TypedDict):
     """Provider-specific metadata."""
 
 
-class CodeInterpreterOutput(TypedDict):
-    """Output of a singular code interpreter tool call.
-
-    Full output of a code interpreter tool call is represented by
-    ``CodeInterpreterResult`` which is a list of these blocks.
-
-    """
-
-    type: Literal["code_interpreter_output"]
-    """Type of the content block. Used for discrimination."""
-
-    id: NotRequired[str]
-    """Content block identifier.
-
-    Either:
-    - Generated by the provider (e.g., OpenAI's file ID)
-    - Generated by LangChain upon creation (``UUID4`` prefixed with ``'lc_'``))
-
-    """
-
-    return_code: NotRequired[int]
-    """Return code of the executed code.
+class ServerToolResult(TypedDict):
+    """Result of a server-side tool call."""
 
-    Example: ``0`` for success, non-zero for failure.
-
-    """
-
-    stderr: NotRequired[str]
-    """Standard error output of the executed code."""
-
-    stdout: NotRequired[str]
-    """Standard output of the executed code."""
-
-    file_ids: NotRequired[list[str]]
-    """List of file IDs generated by the code interpreter."""
-
-
-class CodeInterpreterResult(TypedDict):
-    """Result of a code interpreter tool call."""
-
-    type: Literal["code_interpreter_result"]
-    """Type of the content block. Used for discrimination."""
+    type: Literal["server_tool_result"]
+    """Used for discrimination."""
 
     id: NotRequired[str]
-    """Content block identifier.
+    """An identifier associated with the server tool result."""
 
-    Either:
-    - Generated by the provider (e.g., OpenAI's file ID)
-    - Generated by LangChain upon creation (``UUID4`` prefixed with ``'lc_'``))
+    tool_call_id: str
+    """ID of the corresponding server tool call."""
 
-    """
+    status: Literal["success", "error"]
+    """Execution status of the server-side tool."""
 
-    output: list[CodeInterpreterOutput]
-    """List of outputs from the code interpreter tool call."""
+    output: NotRequired[Any]
+    """Output of the executed tool."""
 
     index: NotRequired[Union[int, str]]
     """Index of block in aggregate response. Used during streaming."""
@@ -709,6 +638,12 @@ class AudioContentBlock(TypedDict):
 class PlainTextContentBlock(TypedDict):
     """Plaintext data (e.g., from a document).
 
+    .. note::
+        A ``PlainTextContentBlock`` existed in ``langchain-core<1.0.0``. Although the
+        name has carried over, the structure has changed significantly. The only shared
+        keys between the old and new versions are ``type`` and ``text``, though the
+        ``type`` value has changed from ``'text'`` to ``'text-plain'``.
+
     .. note::
         Title and context are optional fields that may be passed to the model. See
         Anthropic `example <https://docs.anthropic.com/en/docs/build-with-claude/citations#citable-vs-non-citable-content>`__.
@@ -874,10 +809,9 @@ DataContentBlock = Union[
 ToolContentBlock = Union[
     ToolCall,
     ToolCallChunk,
-    CodeInterpreterCall,
-    CodeInterpreterResult,
-    WebSearchCall,
-    WebSearchResult,
+    ServerToolCall,
+    ServerToolCallChunk,
+    ServerToolResult,
 ]
 
 ContentBlock = Union[
@@ -905,13 +839,17 @@ KNOWN_BLOCK_TYPES = {
     "text-plain",
     "video",
     # Server-side tool calls
-    "code_interpreter_call",
-    "code_interpreter_result",
-    "web_search_call",
-    "web_search_result",
+    "server_tool_call",
+    "server_tool_call_chunk",
+    "server_tool_result",
     # Catch-all
     "non_standard",
+    # citation and non_standard_annotation intentionally omitted
 }
+"""These are block types known to ``langchain-core>=1.0.0``.
+
+If a block has a type not in this set, it is considered to be provider-specific.
+"""
 
 
 def _get_data_content_block_types() -> tuple[str, ...]:
@@ -956,10 +894,18 @@ def is_data_content_block(block: dict) -> bool:
     if any(key in block for key in ("url", "base64", "file_id", "text")):
         # Type is valid and at least one data field is present
         # (Accepts old-style image and audio URLContentBlock)
+
+        # 'text' is checked to support v0 PlainTextContentBlock types
+        # We must guard against new style TextContentBlock which also has 'text' `type`
+        # by ensuring the presense of `source_type`
+        if block["type"] == "text" and "source_type" not in block:  # noqa: SIM103  # This is more readable
+            return False
+
         return True
 
-    # Verify data presence based on source type
     if "source_type" in block:
+        # Old-style content blocks had possible types of 'image', 'audio', and 'file'
+        # which is not captured in the prior check
         source_type = block["source_type"]
         if (source_type == "url" and "url" in block) or (
             source_type == "base64" and "data" in block
@@ -970,8 +916,6 @@ def is_data_content_block(block: dict) -> bool:
         ):
             return True
 
-    # Type may be valid, but no data fields are present
-    # (required case since each is optional and we have no validation)
     return False
 
 

langchain_core/messages/function.py

@@ -15,19 +15,20 @@ from langchain_core.utils._merge import merge_dicts
 class FunctionMessage(BaseMessage):
     """Message for passing the result of executing a tool back to a model.
 
-    FunctionMessage are an older version of the ToolMessage schema, and
-    do not contain the tool_call_id field.
+    ``FunctionMessage`` are an older version of the ``ToolMessage`` schema, and
+    do not contain the ``tool_call_id`` field.
 
-    The tool_call_id field is used to associate the tool call request with the
+    The ``tool_call_id`` field is used to associate the tool call request with the
     tool call response. This is useful in situations where a chat model is able
     to request multiple tool calls in parallel.
+
     """
 
     name: str
     """The name of the function that was executed."""
 
     type: Literal["function"] = "function"
-    """The type of the message (used for serialization). Defaults to "function"."""
+    """The type of the message (used for serialization). Defaults to ``'function'``."""
 
 
 class FunctionMessageChunk(FunctionMessage, BaseMessageChunk):
@@ -38,7 +39,10 @@ class FunctionMessageChunk(FunctionMessage, BaseMessageChunk):
     # non-chunk variant.
     type: Literal["FunctionMessageChunk"] = "FunctionMessageChunk"  # type: ignore[assignment]
     """The type of the message (used for serialization).
-    Defaults to "FunctionMessageChunk"."""
+
+    Defaults to ``'FunctionMessageChunk'``.
+
+    """
 
     @override
     def __add__(self, other: Any) -> BaseMessageChunk:  # type: ignore[override]

langchain_core/messages/human.py

@@ -9,7 +9,7 @@ from langchain_core.messages.base import BaseMessage, BaseMessageChunk
 class HumanMessage(BaseMessage):
     """Message from a human.
 
-    HumanMessages are messages that are passed in from a human to the model.
+    ``HumanMessage``s are messages that are passed in from a human to the model.
 
     Example:
 
@@ -29,7 +29,11 @@ class HumanMessage(BaseMessage):
     """
 
     type: Literal["human"] = "human"
-    """The type of the message (used for serialization). Defaults to "human"."""
+    """The type of the message (used for serialization).
+
+    Defaults to ``'human'``.
+
+    """
 
     @overload
     def __init__(

langchain_core/messages/modifier.py

@@ -24,6 +24,7 @@ class RemoveMessage(BaseMessage):
 
         Raises:
             ValueError: If the 'content' field is passed in kwargs.
+
         """
         if kwargs.pop("content", None):
             msg = "RemoveMessage does not support 'content' field."

langchain_core/messages/system.py

@@ -29,7 +29,11 @@ class SystemMessage(BaseMessage):
     """
 
     type: Literal["system"] = "system"
-    """The type of the message (used for serialization). Defaults to "system"."""
+    """The type of the message (used for serialization).
+
+    Defaults to ``'system'``.
+
+    """
 
     @overload
     def __init__(
@@ -70,4 +74,7 @@ class SystemMessageChunk(SystemMessage, BaseMessageChunk):
     # non-chunk variant.
     type: Literal["SystemMessageChunk"] = "SystemMessageChunk"  # type: ignore[assignment]
     """The type of the message (used for serialization).
-    Defaults to "SystemMessageChunk"."""
+
+    Defaults to ``'SystemMessageChunk'``.
+
+    """

langchain_core/messages/tool.py

@@ -16,19 +16,20 @@ from langchain_core.utils._merge import merge_dicts, merge_obj
 class ToolOutputMixin:
     """Mixin for objects that tools can return directly.
 
-    If a custom BaseTool is invoked with a ToolCall and the output of custom code is
-    not an instance of ToolOutputMixin, the output will automatically be coerced to a
-    string and wrapped in a ToolMessage.
+    If a custom BaseTool is invoked with a ``ToolCall`` and the output of custom code is
+    not an instance of ``ToolOutputMixin``, the output will automatically be coerced to
+    a string and wrapped in a ``ToolMessage``.
+
     """
 
 
 class ToolMessage(BaseMessage, ToolOutputMixin):
     """Message for passing the result of executing a tool back to a model.
 
-    ToolMessages contain the result of a tool invocation. Typically, the result
-    is encoded inside the `content` field.
+    ``ToolMessage``s contain the result of a tool invocation. Typically, the result
+    is encoded inside the ``content`` field.
 
-    Example: A ToolMessage representing a result of 42 from a tool call with id
+    Example: A ``ToolMessage`` representing a result of ``42`` from a tool call with id
 
         .. code-block:: python
 
@@ -37,7 +38,7 @@ class ToolMessage(BaseMessage, ToolOutputMixin):
             ToolMessage(content="42", tool_call_id="call_Jja7J89XsjrOLA5r!MEOW!SL")
 
 
-    Example: A ToolMessage where only part of the tool output is sent to the model
+    Example: A ``ToolMessage`` where only part of the tool output is sent to the model
         and the full output is passed in to artifact.
 
         .. versionadded:: 0.2.17
@@ -59,7 +60,7 @@ class ToolMessage(BaseMessage, ToolOutputMixin):
                 tool_call_id="call_Jja7J89XsjrOLA5r!MEOW!SL",
             )
 
-    The tool_call_id field is used to associate the tool call request with the
+    The ``tool_call_id`` field is used to associate the tool call request with the
     tool call response. This is useful in situations where a chat model is able
     to request multiple tool calls in parallel.
 
@@ -69,7 +70,11 @@ class ToolMessage(BaseMessage, ToolOutputMixin):
     """Tool call that this message is responding to."""
 
     type: Literal["tool"] = "tool"
-    """The type of the message (used for serialization). Defaults to "tool"."""
+    """The type of the message (used for serialization).
+
+    Defaults to ``'tool'``.
+
+    """
 
     artifact: Any = None
     """Artifact of the Tool execution which is not meant to be sent to the model.
@@ -79,12 +84,14 @@ class ToolMessage(BaseMessage, ToolOutputMixin):
     output is needed in other parts of the code.
 
     .. versionadded:: 0.2.17
+
     """
 
     status: Literal["success", "error"] = "success"
     """Status of the tool invocation.
 
     .. versionadded:: 0.2.24
+
     """
 
     additional_kwargs: dict = Field(default_factory=dict, repr=False)
@@ -99,6 +106,7 @@ class ToolMessage(BaseMessage, ToolOutputMixin):
 
         Args:
             values: The model arguments.
+
         """
         content = values["content"]
         if isinstance(content, tuple):
@@ -157,7 +165,15 @@ class ToolMessage(BaseMessage, ToolOutputMixin):
         content_blocks: Optional[list[types.ContentBlock]] = None,
         **kwargs: Any,
     ) -> None:
-        """Specify ``content`` as positional arg or ``content_blocks`` for typing."""
+        """Initialize ``ToolMessage``.
+
+        Specify ``content`` as positional arg or ``content_blocks`` for typing.
+
+        Args:
+            content: The string contents of the message.
+            content_blocks: Typed standard content.
+            **kwargs: Additional fields.
+        """
         if content_blocks is not None:
             super().__init__(
                 content=cast("Union[str, list[Union[str, dict]]]", content_blocks),
@@ -208,8 +224,8 @@ class ToolCall(TypedDict):
 
             {"name": "foo", "args": {"a": 1}, "id": "123"}
 
-        This represents a request to call the tool named "foo" with arguments {"a": 1}
-        and an identifier of "123".
+        This represents a request to call the tool named ``'foo'`` with arguments
+        ``{"a": 1}`` and an identifier of ``'123'``.
 
     """
 
@@ -222,6 +238,7 @@ class ToolCall(TypedDict):
 
     An identifier is needed to associate a tool call request with a tool
     call result in events when multiple concurrent tool calls are made.
+
     """
     type: NotRequired[Literal["tool_call"]]
 
@@ -248,9 +265,9 @@ def tool_call(
 class ToolCallChunk(TypedDict):
     """A chunk of a tool call (e.g., as part of a stream).
 
-    When merging ToolCallChunks (e.g., via AIMessageChunk.__add__),
+    When merging ``ToolCallChunk``s (e.g., via ``AIMessageChunk.__add__``),
     all string attributes are concatenated. Chunks are only merged if their
-    values of `index` are equal and not None.
+    values of ``index`` are equal and not None.
 
     Example: