langchain-dev-utils 1.2.6__py3-none-any.whl → 1.2.7__py3-none-any.whl

langchain_dev_utils/chat_models/base.py

@@ -5,7 +5,7 @@ from langchain_core.language_models.chat_models import BaseChatModel
 from langchain_core.utils import from_env
 
 from langchain_dev_utils._utils import (
-    _check_langchain_openai_install,
+    _check_pkg_install,
     _get_base_url_field_name,
 )
 
@@ -95,11 +95,22 @@ def register_model_provider(
     string identifiers for supported providers.
 
     Args:
-        provider_name: The name of the model provider, used as an identifier for loading models later.
-        chat_model: The chat model, which can be either a `ChatModel` instance or a string (currently only `"openai-compatible"` is supported).
-        base_url: The API endpoint URL of the model provider (optional; applicable to both `chat_model` types, but primarily used when `chat_model` is a string with value `"openai-compatible"`).
-        model_profiles: Declares the capabilities and parameters supported by each model provided by this provider (optional; applicable to both `chat_model` types). The configuration corresponding to the `model_name` will be loaded and assigned to `model.profile` (e.g., fields such as `max_input_tokens`, `tool_calling`etc.).
-        compatibility_options: Compatibility options for the model provider (optional; only effective when `chat_model` is a string with value `"openai-compatible"`). Used to declare support for OpenAI-compatible features (e.g., `tool_choice` strategies, JSON mode, etc.) to ensure correct functional adaptation.
+        provider_name: The name of the model provider, used as an identifier for
+            loading models later.
+        chat_model: The chat model, which can be either a `ChatModel` instance or
+            a string (currently only `"openai-compatible"` is supported).
+        base_url: The API endpoint URL of the model provider (optional; applicable
+            to both `chat_model` types, but primarily used when `chat_model` is a
+            string with value `"openai-compatible"`).
+        model_profiles: Declares the capabilities and parameters supported by each
+            model provided by this provider (optional; applicable to both `chat_model`
+            types). The configuration corresponding to the `model_name` will be loaded
+            and assigned to `model.profile` (e.g., fields such as `max_input_tokens`,
+            `tool_calling`etc.).
+        compatibility_options: Compatibility options for the model provider (optional;
+            only effective when `chat_model` is a string with value `"openai-compatible"`).
+            Used to declare support for OpenAI-compatible features (e.g., `tool_choice`
+            strategies, JSON mode, etc.) to ensure correct functional adaptation.
     Raises:
         ValueError: If base_url is not provided when chat_model is a string,
                    or if chat_model string is not in supported providers
@@ -109,19 +120,23 @@ def register_model_provider(
         >>> from langchain_dev_utils.chat_models import register_model_provider, load_chat_model
         >>> from langchain_core.language_models.fake_chat_models import FakeChatModel
         >>>
-        >>> # Register custom model provider
+        # Register custom model provider
         >>> register_model_provider("fakechat", FakeChatModel)
         >>> model = load_chat_model(model="fakechat:fake-model")
         >>> model.invoke("Hello")
         >>>
-        >>> # Using with OpenAI-compatible API:
-        >>> register_model_provider("vllm","openai-compatible",base_url="http://localhost:8000/v1")
+        # Using with OpenAI-compatible API:
+        >>> register_model_provider(
+        ...     provider_name="vllm",
+        ...     chat_model="openai-compatible",
+        ...     base_url="http://localhost:8000/v1",
+        ... )
         >>> model = load_chat_model(model="vllm:qwen3-4b")
         >>> model.invoke("Hello")
     """
     base_url = base_url or from_env(f"{provider_name.upper()}_API_BASE", default=None)()
     if isinstance(chat_model, str):
-        _check_langchain_openai_install()
+        _check_pkg_install("langchain_openai")
         from .adapters.openai_compatible import _create_openai_compatible_model
 
         if base_url is None:
@@ -204,7 +219,7 @@ def batch_register_model_provider(
             >>> from langchain_dev_utils.chat_models import batch_register_model_provider, load_chat_model
             >>> from langchain_core.language_models.fake_chat_models import FakeChatModel
             >>>
-            >>> # Register multiple providers
+            # Register multiple providers
             >>> batch_register_model_provider([
             ...     {
             ...         "provider_name": "fakechat",
@@ -217,7 +232,7 @@ def batch_register_model_provider(
             ...     },
             ... ])
             >>>
-            >>> # Use registered providers
+            # Use registered providers
             >>> model = load_chat_model("fakechat:fake-model")
             >>> model.invoke("Hello")
             >>>
@@ -257,16 +272,16 @@ def load_chat_model(
         BaseChatModel: Initialized chat model instance
 
     Example:
-        Load model with provider prefix:
+        # Load model with provider prefix:
         >>> from langchain_dev_utils.chat_models import load_chat_model
         >>> model = load_chat_model("vllm:qwen3-4b")
         >>> model.invoke("hello")
 
-        Load model with separate provider parameter:
+        # Load model with separate provider parameter:
         >>> model = load_chat_model("qwen3-4b", model_provider="vllm")
         >>> model.invoke("hello")
 
-        Load model with additional parameters:
+        # Load model with additional parameters:
         >>> model = load_chat_model(
         ...     "vllm:qwen3-4b",
         ...     temperature=0.7

langchain_dev_utils/chat_models/types.py

@@ -2,7 +2,6 @@ from typing import Literal, NotRequired, TypedDict, Union
 
 from langchain_core.language_models.chat_models import BaseChatModel
 
-
 ChatModelType = Union[type[BaseChatModel], Literal["openai-compatible"]]
 
 

langchain_dev_utils/embeddings/base.py

@@ -1,10 +1,10 @@
 from typing import Any, Literal, NotRequired, Optional, TypedDict, Union
 
-from langchain.embeddings.base import Embeddings, _SUPPORTED_PROVIDERS, init_embeddings
+from langchain.embeddings.base import _SUPPORTED_PROVIDERS, Embeddings, init_embeddings
 from langchain_core.utils import from_env, secret_from_env
 
 from langchain_dev_utils._utils import (
-    _check_langchain_openai_install,
+    _check_pkg_install,
     _get_base_url_field_name,
 )
 
@@ -60,14 +60,17 @@ def register_embeddings_provider(
 
     Args:
         provider_name: Name of the provider to register
-        embeddings_model: Either an Embeddings class or a string identifier for a supported provider
-        base_url: The API address of the Embedding model provider (optional, valid for both types of `embeddings_model`, but mainly used when `embeddings_model` is a string and is "openai-compatible")
+        embeddings_model: Either an Embeddings class or a string identifier
+            for a supported provider
+        base_url: The API address of the Embedding model provider (optional,
+            valid for both types of `embeddings_model`, but mainly used when
+            `embeddings_model` is a string and is "openai-compatible")
 
     Raises:
         ValueError: If base_url is not provided when embeddings_model is a string
 
     Example:
-        Register with custom model class:
+        # Register with custom model class:
         >>> from langchain_dev_utils.embeddings import register_embeddings_provider, load_embeddings
         >>> from langchain_core.embeddings.fake import FakeEmbeddings
         >>>
@@ -75,9 +78,11 @@ def register_embeddings_provider(
         >>> embeddings = load_embeddings("fakeembeddings:fake-embeddings",size=1024)
         >>> embeddings.embed_query("hello world")
 
-        Register with OpenAI-compatible API:
+        # Register with OpenAI-compatible API:
         >>> register_embeddings_provider(
-        ...     "vllm", "openai-compatible", base_url="http://localhost:8000/v1"
+        ...     "vllm",
+        ...     "openai-compatible",
+        ...     base_url="http://localhost:8000/v1"
         ... )
         >>> embeddings = load_embeddings("vllm:qwen3-embedding-4b")
         >>> embeddings.embed_query("hello world")
@@ -95,7 +100,7 @@ def register_embeddings_provider(
                 "when embeddings_model is a string, the value must be 'openai-compatible'"
             )
 
-        _check_langchain_openai_install()
+        _check_pkg_install("langchain_openai")
 
         _EMBEDDINGS_PROVIDERS_DICT.update(
             {
@@ -126,32 +131,44 @@ def batch_register_embeddings_provider(
 ):
     """Batch register embeddings providers.
 
-    This function allows you to register multiple embeddings providers at once, which is
-    useful when setting up applications that need to work with multiple embedding services.
+    This function allows you to register multiple embeddings providers at once,
+    which is useful when setting up applications that need to work with multiple
+    embedding services.
 
     Args:
         providers: List of EmbeddingProvider dictionaries, each containing:
             - provider_name: str - Provider name
-            - embeddings_model: Union[Type[Embeddings], str] - Model class or provider string
-            - base_url: The API address of the Embedding model provider (optional, valid for both types of `embeddings_model`, but mainly used when `embeddings_model` is a string and is "openai-compatible")
+            - embeddings_model: Union[Type[Embeddings], str] - Model class or
+                provider string
+            - base_url: The API address of the Embedding model provider
+                (optional, valid for both types of `embeddings_model`, but
+                mainly used when `embeddings_model` is a string and is
+                "openai-compatible")
 
     Raises:
         ValueError: If any of the providers are invalid
 
     Example:
-        Register multiple providers at once:
+        # Register multiple providers at once:
         >>> from langchain_dev_utils.embeddings import batch_register_embeddings_provider, load_embeddings
         >>> from langchain_core.embeddings.fake import FakeEmbeddings
         >>>
         >>> batch_register_embeddings_provider(
         ...     [
-        ...         {"provider_name": "fakeembeddings", "embeddings_model": FakeEmbeddings},
-        ...         {"provider_name": "vllm", "embeddings_model": "openai-compatible", "base_url": "http://localhost:8000/v1"},
+        ...         {
+        ...             "provider_name": "fakeembeddings",
+        ...             "embeddings_model": FakeEmbeddings,
+        ...         },
+        ...         {
+        ...             "provider_name": "vllm",
+        ...             "embeddings_model":  "openai-compatible",
+        ...             "base_url": "http://localhost:8000/v1"
+        ...         },
         ...     ]
         ... )
         >>> embeddings = load_embeddings("vllm:qwen3-embedding-4b")
         >>> embeddings.embed_query("hello world")
-        >>> embeddings = load_embeddings("fakeembeddings:fake-embeddings",size=1024)
+        >>> embeddings = load_embeddings("fakeembeddings:fake-embeddings", size=1024)
         >>> embeddings.embed_query("hello world")
     """
     for provider in providers:
@@ -185,12 +202,12 @@ def load_embeddings(
         ValueError: If provider is not registered or API key is not found
 
     Example:
-        Load model with provider prefix:
+        # Load model with provider prefix:
         >>> from langchain_dev_utils.embeddings import load_embeddings
         >>> embeddings = load_embeddings("vllm:qwen3-embedding-4b")
         >>> embeddings.embed_query("hello world")
 
-        Load model with separate provider parameter:
+        # Load model with separate provider parameter:
         >>> embeddings = load_embeddings("qwen3-embedding-4b", provider="vllm")
         >>> embeddings.embed_query("hello world")
     """

langchain_dev_utils/message_convert/__init__.py

@@ -6,7 +6,6 @@ from .content import (
 )
 from .format import format_sequence
 
-
 __all__ = [
     "convert_reasoning_content_for_ai_message",
     "convert_reasoning_content_for_chunk_iterator",

langchain_dev_utils/message_convert/content.py

@@ -36,13 +36,13 @@ def convert_reasoning_content_for_ai_message(
         AIMessage: Modified AI message with reasoning content in visible content
 
     Example:
-        Basic usage with default tags:
+        # Basic usage with default tags:
         >>> from langchain_dev_utils.message_convert import convert_reasoning_content_for_ai_message
         >>> response = model.invoke("Explain quantum computing")
         >>> response = convert_reasoning_content_for_ai_message(response)
         >>> response.content
 
-        Custom tags for reasoning content:
+        # Custom tags for reasoning content:
         >>> response = convert_reasoning_content_for_ai_message(
         ...     response, think_tag=('<reasoning>', '</reasoning>')
         ... )
@@ -77,14 +77,14 @@ def convert_reasoning_content_for_chunk_iterator(
         BaseMessageChunk: Modified message chunks with reasoning content
 
     Example:
-        Process streaming response:
+        # Process streaming response:
         >>> from langchain_dev_utils.message_convert import convert_reasoning_content_for_chunk_iterator
         >>> for chunk in convert_reasoning_content_for_chunk_iterator(
         ...     model.stream("What is the capital of France?")
         ... ):
         ...     print(chunk.content, end="", flush=True)
 
-        Custom tags for streaming:
+        # Custom tags for streaming:
         >>> for chunk in convert_reasoning_content_for_chunk_iterator(
         ...     model.stream("Explain quantum computing"),
         ...     think_tag=('<reasoning>', '</reasoning>')
@@ -127,14 +127,14 @@ async def aconvert_reasoning_content_for_chunk_iterator(
         BaseMessageChunk: Modified message chunks with reasoning content
 
     Example:
-        Process async streaming response:
+        # Process async streaming response:
         >>> from langchain_dev_utils.message_convert import aconvert_reasoning_content_for_chunk_iterator
         >>> async for chunk in aconvert_reasoning_content_for_chunk_iterator(
         ...     model.astream("What is the capital of France?")
         ... ):
         ...     print(chunk.content, end="", flush=True)
 
-        Custom tags for async streaming:
+        # Custom tags for async streaming:
         >>> async for chunk in aconvert_reasoning_content_for_chunk_iterator(
         ...     model.astream("Explain quantum computing"),
         ...     think_tag=('<reasoning>', '</reasoning>')
@@ -172,12 +172,9 @@ def merge_ai_message_chunk(chunks: Sequence[AIMessageChunk]) -> AIMessage:
         AIMessage: Merged AIMessage
 
     Example:
-        Merge streaming chunks:
+        # Merge streaming chunks:
         >>> from langchain_dev_utils.message_convert import merge_ai_message_chunk
-        >>> chunks = []
-        >>> for chunk in model.stream("What is the capital of France?"):
-        ...     chunks.append(chunk)
-        >>> merged_message = merge_ai_message_chunk(chunks)
+        >>> merged_message = merge_ai_message_chunk(list(model.stream("What is the capital of France?")))
         >>> merged_message.content
     """
     ai_message_chunk = cast(AIMessageChunk, reduce(lambda x, y: x + y, chunks))

langchain_dev_utils/message_convert/format.py

@@ -34,7 +34,7 @@ def format_sequence(
         A formatted string composed of the input contents, joined by `separator`.
 
     Example:
-        Format messages with default separator:
+        # Format messages with default separator:
         >>> from langchain_dev_utils.message_convert import format_sequence
         >>> from langchain_core.messages import HumanMessage, AIMessage
         >>> messages = [
@@ -44,7 +44,7 @@ def format_sequence(
         >>> formatted = format_sequence(messages)
         >>> formatted
 
-        Format with custom separator and numbering:
+        # Format with custom separator and numbering:
         >>> formatted = format_sequence(messages, separator="---", with_num=True)
         >>> formatted
     """

langchain_dev_utils/pipeline/parallel.py

@@ -38,41 +38,27 @@ def create_parallel_pipeline(
         sub_graphs: List of sub-graphs to execute in parallel
         state_schema: state schema of the final constructed graph
         graph_name: Name of the final constructed graph
-        branches_fn: Optional function to determine which sub-graphs to execute in parallel
+        branches_fn: Optional function to determine which sub-graphs to execute
+            in parallel
         context_schema: context schema of the final constructed graph
         input_schema: input schema of the final constructed graph
         output_schema: output schema of the final constructed graph
-        checkpointer: Optional LangGraph checkpointer for the final constructed graph
+        checkpointer: Optional LangGraph checkpointer for the final constructed
+            graph
         store: Optional LangGraph store for the final constructed graph
         cache: Optional LangGraph cache for the final constructed graph
 
     Returns:
-        CompiledStateGraph[StateT, ContextT, InputT, OutputT]: Compiled state graph of the pipeline.
+        CompiledStateGraph[StateT, ContextT, InputT, OutputT]: Compiled state
+            graph of the pipeline.
 
     Example:
-        Basic parallel pipeline with multiple specialized agents:
+        # Basic parallel pipeline: multiple specialized agents run concurrently
         >>> from langchain_dev_utils.pipeline import create_parallel_pipeline
         >>>
         >>> graph = create_parallel_pipeline(
         ...     sub_graphs=[
-        ...         create_agent(
-        ...             model="vllm:qwen3-4b",
-        ...             tools=[get_current_time],
-        ...             system_prompt="You are a time query assistant. You can only answer questions about current time. If the question is unrelated to time, please directly respond with 'I cannot answer that'.",
-        ...             name="time_agent",
-        ...         ),
-        ...         create_agent(
-        ...             model="vllm:qwen3-4b",
-        ...             tools=[get_current_weather],
-        ...             system_prompt="You are a weather query assistant. You can only answer questions about current weather. If the question is unrelated to weather, please directly respond with 'I cannot answer that'.",
-        ...             name="weather_agent",
-        ...         ),
-        ...         create_agent(
-        ...             model="vllm:qwen3-4b",
-        ...             tools=[get_current_user],
-        ...             system_prompt="You are a user query assistant. You can only answer questions about current user. If the question is unrelated to user information, please directly respond with 'I cannot answer that'.",
-        ...             name="user_agent",
-        ...         ),
+        ...        time_agent, weather_agent, user_agent
         ...     ],
         ...     state_schema=AgentState,
         ...     graph_name="parallel_agents_pipeline",
@@ -80,27 +66,10 @@ def create_parallel_pipeline(
         >>>
         >>> response = graph.invoke({"messages": [HumanMessage("Hello")]})
 
-        set branch_fn:
+        # Dynamic parallel pipeline: decide which agents to run based on conditional branches
         >>> graph = create_parallel_pipeline(
         ...     sub_graphs=[
-        ...         create_agent(
-        ...             model="vllm:qwen3-4b",
-        ...             tools=[get_current_time],
-        ...             system_prompt="You are a time query assistant. You can only answer questions about current time. If the question is unrelated to time, please directly respond with 'I cannot answer that'.",
-        ...             name="time_agent",
-        ...         ),
-        ...         create_agent(
-        ...             model="vllm:qwen3-4b",
-        ...             tools=[get_current_weather],
-        ...             system_prompt="You are a weather query assistant. You can only answer questions about current weather. If the question is unrelated to weather, please directly respond with 'I cannot answer that'.",
-        ...             name="weather_agent",
-        ...         ),
-        ...         create_agent(
-        ...             model="vllm:qwen3-4b",
-        ...             tools=[get_current_user],
-        ...             system_prompt="You are a user query assistant. You can only answer questions about current user. If the question is unrelated to user information, please directly respond with 'I cannot answer that'.",
-        ...             name="user_agent",
-        ...         ),
+        ...         time_agent, weather_agent, user_agent
         ...     ],
         ...     state_schema=AgentState,
         ...     branches_fn=lambda state: [

langchain_dev_utils/pipeline/sequential.py

@@ -35,37 +35,22 @@ def create_sequential_pipeline(
         context_schema: context schema of the final constructed graph
         input_schema: input schema of the final constructed graph
         output_schema: output schema of the final constructed graph
-        checkpointer: Optional LangGraph checkpointer for the final constructed graph
+        checkpointer: Optional LangGraph checkpointer for the final constructed
+            graph
         store: Optional LangGraph store for the final constructed graph
         cache: Optional LangGraph cache for the final constructed graph
 
     Returns:
-        CompiledStateGraph[StateT, ContextT, InputT, OutputT]: Compiled state graph of the pipeline.
+        CompiledStateGraph[StateT, ContextT, InputT, OutputT]: Compiled state
+            graph of the pipeline.
 
     Example:
-        Basic sequential pipeline with multiple specialized agents:
+        # Basic sequential pipeline with multiple specialized agents:
         >>> from langchain_dev_utils.pipeline import create_sequential_pipeline
         >>>
         >>> graph = create_sequential_pipeline(
         ...     sub_graphs=[
-        ...         create_agent(
-        ...             model="vllm:qwen3-4b",
-        ...             tools=[get_current_time],
-        ...             system_prompt="You are a time query assistant. You can only answer questions about current time. If the question is unrelated to time, please directly respond with 'I cannot answer that'.",
-        ...             name="time_agent",
-        ...         ),
-        ...         create_agent(
-        ...             model="vllm:qwen3-4b",
-        ...             tools=[get_current_weather],
-        ...             system_prompt="You are a weather query assistant. You can only answer questions about current weather. If the question is unrelated to weather, please directly respond with 'I cannot answer that'.",
-        ...             name="weather_agent",
-        ...         ),
-        ...         create_agent(
-        ...             model="vllm:qwen3-4b",
-        ...             tools=[get_current_user],
-        ...             system_prompt="You are a user query assistant. You can only answer questions about current user. If the question is unrelated to user information, please directly respond with 'I cannot answer that'.",
-        ...             name="user_agent",
-        ...         ),
+        ...         time_agent, weather_agent, user_agent
         ...     ],
         ...     state_schema=AgentState,
         ...     graph_name="sequential_agents_pipeline",

langchain_dev_utils/tool_calling/human_in_the_loop.py

@@ -133,7 +133,7 @@ def human_in_the_loop(
         If `func` is None, returns a decorator that will decorate the target function.
 
     Example:
-        Basic usage with default handler:
+        # Basic usage with default handler:
         >>> from langchain_dev_utils.tool_calling import human_in_the_loop
         >>> from langchain_core.tools import tool
         >>> import datetime
@@ -144,10 +144,10 @@ def human_in_the_loop(
         ...     \"\"\"Get current timestamp\"\"\"
         ...     return str(datetime.datetime.now().timestamp())
 
-        Usage with custom handler:
+        # Usage with custom handler:
         >>> def custom_handler(params: InterruptParams) -> Any:
         ...     response = interrupt(
-        ...         f"I am about to invoke tool '{params['tool_call_name']}' with arguments {params['tool_call_args']}. Please confirm whether to proceed."
+        ...        # Please add your custom interrupt response content here
         ...     )
         ...     if response["type"] == "accept":
         ...         return params["tool"].invoke(params["tool_call_args"])
@@ -219,7 +219,7 @@ def human_in_the_loop_async(
         If `func` is None, returns a decorator that will decorate the target function.
 
     Example:
-        Basic usage with default handler:
+        # Basic usage with default handler:
         >>> from langchain_dev_utils.tool_calling import human_in_the_loop_async
         >>> from langchain_core.tools import tool
         >>> import asyncio
@@ -232,10 +232,10 @@ def human_in_the_loop_async(
         ...     await asyncio.sleep(1)
         ...     return str(datetime.datetime.now().timestamp())
 
-        Usage with custom handler:
+        # Usage with custom handler:
         >>> async def custom_handler(params: InterruptParams) -> Any:
         ...     response = interrupt(
-        ...         f"I am about to invoke tool '{params['tool_call_name']}' with arguments {params['tool_call_args']}. Please confirm whether to proceed."
+        ...         ... # Please add your custom interrupt response content here
         ...     )
         ...     if response["type"] == "accept":
         ...         return await params["tool"].ainvoke(params["tool_call_args"])

langchain_dev_utils/tool_calling/utils.py

@@ -16,7 +16,7 @@ def has_tool_calling(message: AIMessage) -> bool:
         bool: True if message is an AIMessage with tool calls, False otherwise
 
     Example:
-        Check for tool calls in response:
+        # Check for tool calls in response:
         >>> from langchain_dev_utils.tool_calling import has_tool_calling, parse_tool_calling
         >>> response = model.invoke("What time is it now?")
         >>> if has_tool_calling(response):
@@ -50,14 +50,14 @@ def parse_tool_calling(
         Union[tuple[str, dict], list[tuple[str, dict]]]: The tool call name and args
 
     Example:
-        Parse single tool call:
+        # Parse single tool call:
         >>> from langchain_dev_utils.tool_calling import has_tool_calling, parse_tool_calling
         >>> response = model.invoke("What time is it now?")
         >>> response
         >>> if has_tool_calling(response):
         ...     tool_name, tool_args = parse_tool_calling(response, first_tool_call_only=True)
 
-        Parse multiple tool calls:
+        # Parse multiple tool calls:
         >>> if has_tool_calling(response):
         ...     tool_calls = parse_tool_calling(response)
     """