langchain-core 0.4.0.dev0__py3-none-any.whl → 1.0.0__py3-none-any.whl

langchain_core/messages/block_translators/groq.py

@@ -0,0 +1,143 @@
+"""Derivations of standard content blocks from Groq content."""
+
+import json
+import re
+from typing import Any
+
+from langchain_core.messages import AIMessage, AIMessageChunk
+from langchain_core.messages import content as types
+from langchain_core.messages.base import _extract_reasoning_from_additional_kwargs
+
+
+def _populate_extras(
+    standard_block: types.ContentBlock, block: dict[str, Any], known_fields: set[str]
+) -> types.ContentBlock:
+    """Mutate a block, populating extras."""
+    if standard_block.get("type") == "non_standard":
+        return standard_block
+
+    for key, value in block.items():
+        if key not in known_fields:
+            if "extras" not in standard_block:
+                # Below type-ignores are because mypy thinks a non-standard block can
+                # get here, although we exclude them above.
+                standard_block["extras"] = {}  # type: ignore[typeddict-unknown-key]
+            standard_block["extras"][key] = value  # type: ignore[typeddict-item]
+
+    return standard_block
+
+
+def _parse_code_json(s: str) -> dict:
+    """Extract Python code from Groq built-in tool content.
+
+    Extracts the value of the 'code' field from a string of the form:
+    {"code": some_arbitrary_text_with_unescaped_quotes}
+
+    As Groq may not escape quotes in the executed tools, e.g.:
+    ```
+    '{"code": "import math; print("The square root of 101 is: "); print(math.sqrt(101))"}'
+    ```
+    """  # noqa: E501
+    m = re.fullmatch(r'\s*\{\s*"code"\s*:\s*"(.*)"\s*\}\s*', s, flags=re.DOTALL)
+    if not m:
+        msg = (
+            "Could not extract Python code from Groq tool arguments. "
+            "Expected a JSON object with a 'code' field."
+        )
+        raise ValueError(msg)
+    return {"code": m.group(1)}
+
+
+def _convert_to_v1_from_groq(message: AIMessage) -> list[types.ContentBlock]:
+    """Convert groq message content to v1 format."""
+    content_blocks: list[types.ContentBlock] = []
+
+    if reasoning_block := _extract_reasoning_from_additional_kwargs(message):
+        content_blocks.append(reasoning_block)
+
+    if executed_tools := message.additional_kwargs.get("executed_tools"):
+        for idx, executed_tool in enumerate(executed_tools):
+            args: dict[str, Any] | None = None
+            if arguments := executed_tool.get("arguments"):
+                try:
+                    args = json.loads(arguments)
+                except json.JSONDecodeError:
+                    if executed_tool.get("type") == "python":
+                        try:
+                            args = _parse_code_json(arguments)
+                        except ValueError:
+                            continue
+                    elif (
+                        executed_tool.get("type") == "function"
+                        and executed_tool.get("name") == "python"
+                    ):
+                        # GPT-OSS
+                        args = {"code": arguments}
+                    else:
+                        continue
+            if isinstance(args, dict):
+                name = ""
+                if executed_tool.get("type") == "search":
+                    name = "web_search"
+                elif executed_tool.get("type") == "python" or (
+                    executed_tool.get("type") == "function"
+                    and executed_tool.get("name") == "python"
+                ):
+                    name = "code_interpreter"
+                server_tool_call: types.ServerToolCall = {
+                    "type": "server_tool_call",
+                    "name": name,
+                    "id": str(idx),
+                    "args": args,
+                }
+                content_blocks.append(server_tool_call)
+            if tool_output := executed_tool.get("output"):
+                tool_result: types.ServerToolResult = {
+                    "type": "server_tool_result",
+                    "tool_call_id": str(idx),
+                    "output": tool_output,
+                    "status": "success",
+                }
+                known_fields = {"type", "arguments", "index", "output"}
+                _populate_extras(tool_result, executed_tool, known_fields)
+                content_blocks.append(tool_result)
+
+    if isinstance(message.content, str) and message.content:
+        content_blocks.append({"type": "text", "text": message.content})
+
+    for tool_call in message.tool_calls:
+        content_blocks.append(  # noqa: PERF401
+            {
+                "type": "tool_call",
+                "name": tool_call["name"],
+                "args": tool_call["args"],
+                "id": tool_call.get("id"),
+            }
+        )
+
+    return content_blocks
+
+
+def translate_content(message: AIMessage) -> list[types.ContentBlock]:
+    """Derive standard content blocks from a message with groq content."""
+    return _convert_to_v1_from_groq(message)
+
+
+def translate_content_chunk(message: AIMessageChunk) -> list[types.ContentBlock]:
+    """Derive standard content blocks from a message chunk with groq content."""
+    return _convert_to_v1_from_groq(message)
+
+
+def _register_groq_translator() -> None:
+    """Register the groq translator with the central registry.
+
+    Run automatically when the module is imported.
+    """
+    from langchain_core.messages.block_translators import (  # noqa: PLC0415
+        register_translator,
+    )
+
+    register_translator("groq", translate_content, translate_content_chunk)
+
+
+_register_groq_translator()

langchain_core/messages/block_translators/langchain_v0.py

@@ -0,0 +1,301 @@
+"""Derivations of standard content blocks from LangChain v0 multimodal content."""
+
+from typing import Any, cast
+
+from langchain_core.messages import content as types
+
+
+def _convert_v0_multimodal_input_to_v1(
+    content: list[types.ContentBlock],
+) -> list[types.ContentBlock]:
+    """Convert v0 multimodal blocks to v1 format.
+
+    During the `content_blocks` parsing process, we wrap blocks not recognized as a v1
+    block as a `'non_standard'` block with the original block stored in the `value`
+    field. This function attempts to unpack those blocks and convert any v0 format
+    blocks to v1 format.
+
+    If conversion fails, the block is left as a `'non_standard'` block.
+
+    Args:
+        content: List of content blocks to process.
+
+    Returns:
+        v1 content blocks.
+    """
+    converted_blocks = []
+    unpacked_blocks: list[dict[str, Any]] = [
+        cast("dict[str, Any]", block)
+        if block.get("type") != "non_standard"
+        else block["value"]  # type: ignore[typeddict-item]  # this is only non-standard blocks
+        for block in content
+    ]
+    for block in unpacked_blocks:
+        if block.get("type") in {"image", "audio", "file"} and "source_type" in block:
+            converted_block = _convert_legacy_v0_content_block_to_v1(block)
+            converted_blocks.append(cast("types.ContentBlock", converted_block))
+        elif block.get("type") in types.KNOWN_BLOCK_TYPES:
+            # Guard in case this function is used outside of the .content_blocks flow
+            converted_blocks.append(cast("types.ContentBlock", block))
+        else:
+            converted_blocks.append({"type": "non_standard", "value": block})
+
+    return converted_blocks
+
+
+def _convert_legacy_v0_content_block_to_v1(
+    block: dict,
+) -> types.ContentBlock | dict:
+    """Convert a LangChain v0 content block to v1 format.
+
+    Preserves unknown keys as extras to avoid data loss.
+
+    Returns the original block unchanged if it's not in v0 format.
+    """
+
+    def _extract_v0_extras(block_dict: dict, known_keys: set[str]) -> dict[str, Any]:
+        """Extract unknown keys from v0 block to preserve as extras.
+
+        Args:
+            block_dict: The original v0 block dictionary.
+            known_keys: Set of keys known to be part of the v0 format for this block.
+
+        Returns:
+            A dictionary of extra keys not part of the known v0 format.
+        """
+        return {k: v for k, v in block_dict.items() if k not in known_keys}
+
+    # Check if this is actually a v0 format block
+    block_type = block.get("type")
+    if block_type not in {"image", "audio", "file"} or "source_type" not in block:
+        # Not a v0 format block, return unchanged
+        return block
+
+    if block.get("type") == "image":
+        source_type = block.get("source_type")
+        if source_type == "url":
+            # image-url
+            known_keys = {"mime_type", "type", "source_type", "url"}
+            extras = _extract_v0_extras(block, known_keys)
+            if "id" in block:
+                return types.create_image_block(
+                    url=block["url"],
+                    mime_type=block.get("mime_type"),
+                    id=block["id"],
+                    **extras,
+                )
+
+            # Don't construct with an ID if not present in original block
+            v1_image_url = types.ImageContentBlock(type="image", url=block["url"])
+            if block.get("mime_type"):
+                v1_image_url["mime_type"] = block["mime_type"]
+
+            v1_image_url["extras"] = {}
+            for key, value in extras.items():
+                if value is not None:
+                    v1_image_url["extras"][key] = value
+            if v1_image_url["extras"] == {}:
+                del v1_image_url["extras"]
+
+            return v1_image_url
+        if source_type == "base64":
+            # image-base64
+            known_keys = {"mime_type", "type", "source_type", "data"}
+            extras = _extract_v0_extras(block, known_keys)
+            if "id" in block:
+                return types.create_image_block(
+                    base64=block["data"],
+                    mime_type=block.get("mime_type"),
+                    id=block["id"],
+                    **extras,
+                )
+
+            v1_image_base64 = types.ImageContentBlock(
+                type="image", base64=block["data"]
+            )
+            if block.get("mime_type"):
+                v1_image_base64["mime_type"] = block["mime_type"]
+
+            v1_image_base64["extras"] = {}
+            for key, value in extras.items():
+                if value is not None:
+                    v1_image_base64["extras"][key] = value
+            if v1_image_base64["extras"] == {}:
+                del v1_image_base64["extras"]
+
+            return v1_image_base64
+        if source_type == "id":
+            # image-id
+            known_keys = {"type", "source_type", "id"}
+            extras = _extract_v0_extras(block, known_keys)
+            # For id `source_type`, `id` is the file reference, not block ID
+            v1_image_id = types.ImageContentBlock(type="image", file_id=block["id"])
+
+            v1_image_id["extras"] = {}
+            for key, value in extras.items():
+                if value is not None:
+                    v1_image_id["extras"][key] = value
+            if v1_image_id["extras"] == {}:
+                del v1_image_id["extras"]
+
+            return v1_image_id
+    elif block.get("type") == "audio":
+        source_type = block.get("source_type")
+        if source_type == "url":
+            # audio-url
+            known_keys = {"mime_type", "type", "source_type", "url"}
+            extras = _extract_v0_extras(block, known_keys)
+            if "id" in block:
+                return types.create_audio_block(
+                    url=block["url"],
+                    mime_type=block.get("mime_type"),
+                    id=block["id"],
+                    **extras,
+                )
+
+            # Don't construct with an ID if not present in original block
+            v1_audio_url: types.AudioContentBlock = types.AudioContentBlock(
+                type="audio", url=block["url"]
+            )
+            if block.get("mime_type"):
+                v1_audio_url["mime_type"] = block["mime_type"]
+
+            v1_audio_url["extras"] = {}
+            for key, value in extras.items():
+                if value is not None:
+                    v1_audio_url["extras"][key] = value
+            if v1_audio_url["extras"] == {}:
+                del v1_audio_url["extras"]
+
+            return v1_audio_url
+        if source_type == "base64":
+            # audio-base64
+            known_keys = {"mime_type", "type", "source_type", "data"}
+            extras = _extract_v0_extras(block, known_keys)
+            if "id" in block:
+                return types.create_audio_block(
+                    base64=block["data"],
+                    mime_type=block.get("mime_type"),
+                    id=block["id"],
+                    **extras,
+                )
+
+            v1_audio_base64: types.AudioContentBlock = types.AudioContentBlock(
+                type="audio", base64=block["data"]
+            )
+            if block.get("mime_type"):
+                v1_audio_base64["mime_type"] = block["mime_type"]
+
+            v1_audio_base64["extras"] = {}
+            for key, value in extras.items():
+                if value is not None:
+                    v1_audio_base64["extras"][key] = value
+            if v1_audio_base64["extras"] == {}:
+                del v1_audio_base64["extras"]
+
+            return v1_audio_base64
+        if source_type == "id":
+            # audio-id
+            known_keys = {"type", "source_type", "id"}
+            extras = _extract_v0_extras(block, known_keys)
+            v1_audio_id: types.AudioContentBlock = types.AudioContentBlock(
+                type="audio", file_id=block["id"]
+            )
+
+            v1_audio_id["extras"] = {}
+            for key, value in extras.items():
+                if value is not None:
+                    v1_audio_id["extras"][key] = value
+            if v1_audio_id["extras"] == {}:
+                del v1_audio_id["extras"]
+
+            return v1_audio_id
+    elif block.get("type") == "file":
+        source_type = block.get("source_type")
+        if source_type == "url":
+            # file-url
+            known_keys = {"mime_type", "type", "source_type", "url"}
+            extras = _extract_v0_extras(block, known_keys)
+            if "id" in block:
+                return types.create_file_block(
+                    url=block["url"],
+                    mime_type=block.get("mime_type"),
+                    id=block["id"],
+                    **extras,
+                )
+
+            v1_file_url: types.FileContentBlock = types.FileContentBlock(
+                type="file", url=block["url"]
+            )
+            if block.get("mime_type"):
+                v1_file_url["mime_type"] = block["mime_type"]
+
+            v1_file_url["extras"] = {}
+            for key, value in extras.items():
+                if value is not None:
+                    v1_file_url["extras"][key] = value
+            if v1_file_url["extras"] == {}:
+                del v1_file_url["extras"]
+
+            return v1_file_url
+        if source_type == "base64":
+            # file-base64
+            known_keys = {"mime_type", "type", "source_type", "data"}
+            extras = _extract_v0_extras(block, known_keys)
+            if "id" in block:
+                return types.create_file_block(
+                    base64=block["data"],
+                    mime_type=block.get("mime_type"),
+                    id=block["id"],
+                    **extras,
+                )
+
+            v1_file_base64: types.FileContentBlock = types.FileContentBlock(
+                type="file", base64=block["data"]
+            )
+            if block.get("mime_type"):
+                v1_file_base64["mime_type"] = block["mime_type"]
+
+            v1_file_base64["extras"] = {}
+            for key, value in extras.items():
+                if value is not None:
+                    v1_file_base64["extras"][key] = value
+            if v1_file_base64["extras"] == {}:
+                del v1_file_base64["extras"]
+
+            return v1_file_base64
+        if source_type == "id":
+            # file-id
+            known_keys = {"type", "source_type", "id"}
+            extras = _extract_v0_extras(block, known_keys)
+            return types.create_file_block(file_id=block["id"], **extras)
+        if source_type == "text":
+            # file-text
+            known_keys = {"mime_type", "type", "source_type", "url"}
+            extras = _extract_v0_extras(block, known_keys)
+            if "id" in block:
+                return types.create_plaintext_block(
+                    # In v0, URL points to the text file content
+                    # TODO: attribute this claim
+                    text=block["url"],
+                    id=block["id"],
+                    **extras,
+                )
+
+            v1_file_text: types.PlainTextContentBlock = types.PlainTextContentBlock(
+                type="text-plain", text=block["url"], mime_type="text/plain"
+            )
+            if block.get("mime_type"):
+                v1_file_text["mime_type"] = block["mime_type"]
+
+            v1_file_text["extras"] = {}
+            for key, value in extras.items():
+                if value is not None:
+                    v1_file_text["extras"][key] = value
+            if v1_file_text["extras"] == {}:
+                del v1_file_text["extras"]
+
+            return v1_file_text
+
+    # If we can't convert, return the block unchanged
+    return block