langchain-dev-utils 1.4.3__tar.gz → 1.4.4__tar.gz

langchain_dev_utils-1.4.4/AGENTS.md

@@ -0,0 +1,285 @@
+# Agentic Coding Guidelines for langchain-dev-utils
+
+This file provides guidelines for AI agents working in this repository.
+
+## Project Overview
+
+A Python utility library for LangChain and LangGraph development. Uses hatchling build system, uv for package management, ruff for linting, and pytest for testing.
+
+**Current Version:** 1.4.4
+
+---
+
+## Build/Lint/Test Commands
+
+### Package Management (uv)
+```bash
+# Install dependencies
+uv sync
+
+# Install with optional dependencies
+uv sync --extra standard
+
+# Install dev dependencies
+uv sync --group dev
+
+# Install test dependencies
+uv sync --group tests
+
+# Install docs dependencies
+uv sync --group docs
+```
+
+### Linting & Formatting (ruff)
+```bash
+# Check linting
+uv run ruff check .
+
+# Check specific file
+uv run ruff check src/langchain_dev_utils/path/to/file.py
+
+# Fix auto-fixable issues
+uv run ruff check --fix .
+
+# Format code
+uv run ruff format .
+
+# Format specific file
+uv run ruff format src/langchain_dev_utils/path/to/file.py
+```
+
+### Testing (pytest)
+```bash
+# Run all tests
+uv run pytest
+
+# Run with verbose output
+uv run pytest -v
+
+# Run specific test file
+uv run pytest tests/test_agent.py
+
+# Run specific test function
+uv run pytest tests/test_agent.py::test_prebuilt_agent
+
+# Run specific test class
+uv run pytest tests/test_chat_models.py::TestImageProcessing
+
+# Run with asyncio support (automatically configured)
+uv run pytest -s
+
+# Run tests matching pattern
+uv run pytest -k "test_load"
+```
+
+### Build
+```bash
+# Build package
+uv build
+
+# Build wheel only
+uv build --wheel
+```
+
+### Documentation
+```bash
+# Serve docs locally
+mkdocs serve
+
+# Build docs
+mkdocs build
+
+# Deploy docs
+mkdocs gh-deploy
+```
+
+---
+
+## Code Style Guidelines
+
+### Imports
+- Use absolute imports for external packages
+- Use relative imports within the package (e.g., `from ..chat_models import ...`)
+- Group imports: stdlib → third-party → local
+- Ruff handles import sorting automatically
+
+### Type Hints
+- Use type hints for all function parameters and return types
+- Use `Optional[Type]` or `Type | None` for nullable types (both acceptable)
+- Use `Any` sparingly and only when necessary
+- Use `Sequence`, `Mapping` for generic collections
+- Use generics with TypeVars where appropriate
+
+### Naming Conventions
+- `snake_case` for functions, methods, variables
+- `PascalCase` for classes
+- `UPPER_CASE` for constants
+- `_leading_underscore` for private/internal functions
+- Leading double underscore for name mangling when needed
+
+### Docstrings
+- Use Google-style docstrings
+- Include Args, Returns, Raises sections for public functions
+- Include Examples section for complex functions
+- Keep docstrings under 100 characters per line when possible
+
+### Code Structure
+- Maximum line length: 88 characters (ruff enforces, E501 ignored)
+- Use trailing commas in multi-line structures
+- Two blank lines between top-level functions/classes
+- One blank line between methods
+
+### Error Handling
+- Use specific exception types, not bare `except:`
+- Provide descriptive error messages with f-strings
+- Use `raise ValueError(msg)` pattern with descriptive messages
+- Avoid bare `raise` statements
+
+### Async Code
+- Use `pytest.mark.asyncio` for async test functions
+- Use `async`/`await` consistently
+- Prefer `asyncio` primitives from standard library
+
+### Ruff Configuration
+- Enabled rules: E, F, I, PGH003, T201
+- Import sorting (I) is enforced
+- No print statements in production code (T201)
+
+---
+
+## Testing Guidelines
+
+- Tests live in `tests/` directory
+- Test files named `test_*.py`
+- Test functions named `test_*`
+- Use pytest fixtures for setup/teardown
+- Use `pytest.mark.asyncio` for async tests
+- Mock external API calls in unit tests
+- Integration tests use actual APIs (marked implicitly by test names)
+- Tests use `langchain-tests` for standard integration test suites
+
+---
+
+## Project Structure
+
+```
+langchain-dev-utils/
+├── src/langchain_dev_utils/      # Source code
+│   ├── agents/                   # Agent utilities
+│   │   ├── factory.py            # Agent creation functions
+│   │   ├── wrap.py               # Agent wrapping utilities
+│   │   └── middleware/           # Agent middleware components
+│   │       ├── format_prompt.py      # Format prompt middleware
+│   │       ├── handoffs.py           # Multi-agent handoff middleware
+│   │       ├── model_fallback.py     # Model fallback middleware
+│   │       ├── model_router.py       # Model routing middleware
+│   │       ├── plan.py               # Planning middleware
+│   │       ├── summarization.py      # Message summarization middleware
+│   │       ├── tool_call_repair.py   # Tool call repair middleware
+│   │       ├── tool_emulator.py      # LLM tool emulator middleware
+│   │       └── tool_selection.py     # LLM tool selector middleware
+│   ├── chat_models/              # Chat model utilities
+│   │   ├── base.py               # Base chat model classes
+│   │   ├── types.py              # Type definitions
+│   │   └── adapters/             # Model provider adapters
+│   ├── embeddings/               # Embedding utilities
+│   │   ├── base.py               # Base embedding classes
+│   │   └── adapters/             # Embedding provider adapters
+│   ├── graph/                    # Graph utilities
+│   │   ├── parallel.py           # Parallel graph construction
+│   │   ├── sequential.py         # Sequential graph construction
+│   │   └── types.py              # Graph type definitions
+│   ├── message_convert/          # Message conversion utilities
+│   │   ├── content.py            # Content conversion
+│   │   └── format.py             # Message formatting
+│   ├── pipeline/                 # Pipeline utilities (deprecated since v1.4.0, will be removed in v1.5.0)
+│   │   ├── parallel.py
+│   │   ├── sequential.py
+│   │   └── types.py
+│   └── tool_calling/             # Tool calling utilities
+│       ├── human_in_the_loop.py  # Human review functionality
+│       └── utils.py              # Tool calling utilities
+├── tests/                        # Test files
+├── docs/                         # Documentation (MkDocs)
+│   ├── en/                       # English documentation
+│   └── zh/                       # Chinese documentation
+├── pyproject.toml                # Project configuration
+├── uv.lock                       # Dependency lock file
+└── mkdocs.yml                    # MkDocs configuration
+```
+
+---
+
+## Middleware Components
+
+The `agents.middleware` module provides reusable middleware components for agent enhancement:
+
+| Middleware | Purpose |
+|------------|---------|
+| `SummarizationMiddleware` | Summarizes long message histories |
+| `LLMToolSelectorMiddleware` | Uses LLM to select appropriate tools |
+| `PlanMiddleware` | Adds planning capabilities to agents |
+| `ModelFallbackMiddleware` | Provides fallback to alternative models |
+| `LLMToolEmulator` | Emulates tool calling for models without native support |
+| `ModelRouterMiddleware` | Routes requests to different models based on criteria |
+| `ToolCallRepairMiddleware` | Repairs malformed tool calls |
+| `FormatPromptMiddleware` | Formats prompts with templates |
+| `HandoffAgentMiddleware` | Enables multi-agent handoff workflows |
+
+---
+
+## Dependencies
+
+### Core Dependencies
+- `langchain>=1.2.0` - LangChain framework
+- `langchain-core>=1.2.5` - Core LangChain components
+- `langgraph>=1.0.0` - LangGraph for graph-based workflows
+
+### Optional Dependencies (standard)
+- `jinja2>=3.1.6` - Template engine for prompt formatting
+- `json-repair>=0.53.1` - JSON repair utilities
+- `langchain-openai` - OpenAI integration
+
+### Dev Dependencies
+- `langchain-model-profiles>=0.0.5` - Model profile management
+- `ruff>=0.14.5` - Linting and formatting
+
+### Docs Dependencies
+- `jupyter>=1.1.1` - Jupyter notebook support
+- `mkdocs-material>=9.7.0` - Material theme for MkDocs
+- `mkdocs-static-i18n>=1.3.0` - Internationalization support
+
+### Test Dependencies
+- `python-dotenv>=1.1.1` - Environment variable management
+- `langchain-tests>=1.0.0` - Standard LangChain test suite
+- `langchain-deepseek>=1.0.0` - DeepSeek model integration
+- `langchain-qwq>=0.3.0` - QwQ model integration
+- `langchain-ollama>=1.0.0` - Ollama integration
+- `langchain-community>=0.4.1` - Community model integrations
+- `dashscope>=1.25.12` - Alibaba DashScope integration
+
+**Python version:** >=3.11
+
+---
+
+## Documentation
+
+- Documentation is built with MkDocs using the Material theme
+- Supports internationalization (English and Chinese)
+- Hosted at: https://tbice123123.github.io/langchain-dev-utils/
+- Source files located in `docs/en/` and `docs/zh/`
+
+---
+
+## Release Checklist
+
+When preparing a new release:
+
+1. Update version in `src/langchain_dev_utils/__init__.py`
+2. Update version in `pyproject.toml` if needed
+3. Run full test suite: `uv run pytest`
+4. Run linting: `uv run ruff check .`
+5. Run formatting: `uv run ruff format .`
+6. Build package: `uv build`
+7. Update documentation if needed
+8. Tag release in git

{langchain_dev_utils-1.4.3 → langchain_dev_utils-1.4.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: langchain-dev-utils
-Version: 1.4.3
+Version: 1.4.4
 Summary: A practical utility library for LangChain and LangGraph development
 Project-URL: Source Code, https://github.com/TBice123123/langchain-dev-utils
 Project-URL: repository, https://github.com/TBice123123/langchain-dev-utils

{langchain_dev_utils-1.4.3 → langchain_dev_utils-1.4.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "langchain-dev-utils"
-version = "1.4.3"
+version = "1.4.4"
 description = "A practical utility library for LangChain and LangGraph development"
 readme = "README.md"
 authors = [{ name = "tiebingice", email = "tiebingice123@outlook.com" }]

langchain_dev_utils-1.4.4/src/langchain_dev_utils/__init__.py

@@ -0,0 +1 @@
+__version__ = "1.4.4"

{langchain_dev_utils-1.4.3 → langchain_dev_utils-1.4.4}/src/langchain_dev_utils/agents/middleware/handoffs.py

@@ -25,14 +25,16 @@ class AgentConfig(TypedDict):
     handoffs: list[str] | Literal["all"]
 
 
-def _create_handoffs_tool(agent_name: str, tool_description: Optional[str] = None):
+def _create_handoffs_tool(
+    agent_name: str, tool_description: Optional[str] = None
+) -> BaseTool:
     """Create a tool for handoffs to a specified agent.
 
     Args:
         agent_name (str): The name of the agent to transfer to.
 
     Returns:
-        BaseTool: A tool instance for handoffs to the specified agent.
+        BaseTool: The tool instance for handoffs to the specified agent.
     """
 
     tool_name = f"transfer_to_{agent_name}"
@@ -67,13 +69,13 @@ def _get_default_active_agent(state: dict[str, AgentConfig]) -> Optional[str]:
 
 def _transform_agent_config(
     config: dict[str, AgentConfig],
-    handoffs_tools: list[BaseTool],
+    handoffs_tool_map: dict[str, BaseTool],
 ) -> dict[str, AgentConfig]:
     """Transform the agent config to add handoffs tools.
 
     Args:
         config (dict[str, AgentConfig]): The agent config.
-        handoffs_tools (list[BaseTool]): The list of handoffs tools.
+        handoffs_tool_map (dict[str, BaseTool]): The dict of {agent name: handoffs tool}.
 
     Returns:
         dict[str, AgentConfig]: The transformed agent config.
@@ -96,8 +98,8 @@ def _transform_agent_config(
         if handoffs == "all":
             handoff_tools = [
                 handoff_tool
-                for handoff_tool in handoffs_tools
-                if handoff_tool.name != f"transfer_to_{agent_name}"
+                for transfer_to_agent, handoff_tool in handoffs_tool_map.items()
+                if transfer_to_agent != agent_name
             ]
         else:
             if not isinstance(handoffs, list):
@@ -105,14 +107,13 @@ def _transform_agent_config(
                     f"handoffs for agent {agent_name} must be a list of agent names or 'all'"
                 )
 
+            if agent_name in handoffs:
+                raise ValueError(f"agent {agent_name} cannot handoff to itself")
+
             handoff_tools = [
                 handoff_tool
-                for handoff_tool in handoffs_tools
-                if handoff_tool.name
-                in [
-                    f"transfer_to_{_handoff_agent_name}"
-                    for _handoff_agent_name in handoffs
-                ]
+                for transfer_to_agent, handoff_tool in handoffs_tool_map.items()
+                if transfer_to_agent in handoffs
             ]
 
         new_config[agent_name]["tools"] = [
@@ -158,28 +159,28 @@ class HandoffAgentMiddleware(AgentMiddleware):
         if handoffs_tool_overrides is None:
             handoffs_tool_overrides = {}
 
-        handoffs_tools = []
+        handoffs_tool_map = {}
+
         for agent_name in agents_config.keys():
             if not handoffs_tool_overrides.get(agent_name):
-                handoffs_tools.append(
-                    _create_handoffs_tool(
-                        agent_name,
-                        custom_handoffs_tool_descriptions.get(agent_name),
-                    )
+                handoffs_tool_map[agent_name] = _create_handoffs_tool(
+                    agent_name,
+                    custom_handoffs_tool_descriptions.get(agent_name),
                 )
+
             else:
-                handoffs_tools.append(
-                    cast(BaseTool, handoffs_tool_overrides.get(agent_name))
+                handoffs_tool_map[agent_name] = cast(
+                    BaseTool, handoffs_tool_overrides.get(agent_name)
                 )
 
         self.default_agent_name = default_agent_name
         self.agents_config = _transform_agent_config(
             agents_config,
-            handoffs_tools,
+            handoffs_tool_map,
         )
 
         all_tools = [
-            *handoffs_tools,
+            *handoffs_tool_map.values(),
         ]
 
         for agent_name in agents_config:

{langchain_dev_utils-1.4.3 → langchain_dev_utils-1.4.4}/tests/test_handoffs_middleware.py

@@ -136,10 +136,6 @@ async def test_handoffs_middleware_async():
                 handoffs_tool_overrides=handoffs_tool_map,
             )
         ],
-        tools=[
-            get_current_time,
-            run_code,
-        ],
         checkpointer=InMemorySaver(),
     )
 

langchain_dev_utils-1.4.3/.cache/.gitignore

@@ -1 +0,0 @@
-*

langchain_dev_utils-1.4.3/.cache/10132167963676728850

@@ -1,4 +0,0 @@
-{
-  "data": "\r\n<!doctype html>\r\n<html lang=\"zh\" class=\"no-js\">\r\n  <head>\r\n    \r\n      <meta charset=\"utf-8\">\r\n      <meta name=\"viewport\" content=\"width=device-width,initial-scale=1\">\r\n      \r\n      \r\n      \r\n        <link rel=\"canonical\" href=\"https://tbice123123.github.io/langchain-dev-utils/en/adavance-guide/openai-compatible/embedding/\">\r\n      \r\n      \r\n      \r\n      \r\n        \r\n          <link rel=\"alternate\" href=\"/en/\" hreflang=\"en\">\r\n        \r\n          <link rel=\"alternate\" href=\"/zh/\" hreflang=\"zh\">\r\n        \r\n      \r\n      \r\n      <link rel=\"icon\" href=\"../../../../assets/images/favicon.png\">\r\n      <meta name=\"generator\" content=\"zensical-0.0.21\">\r\n    \r\n    \r\n      \r\n        <title>Creation and Usage of Embedding Models - Langchain Dev Utils</title>\r\n      \r\n    \r\n    \r\n      \r\n        \r\n      \r\n      <link rel=\"stylesheet\" href=\"../../../../assets/stylesheets/modern/main.f28b7ce3.min.css\">\r\n      \r\n        \r\n          \r\n        \r\n        <link rel=\"stylesheet\" href=\"../../../../assets/stylesheets/modern/palette.dfe2e883.min.css\">\r\n      \r\n      \r\n\r\n\r\n    \r\n    \r\n      \r\n    \r\n    \r\n      \r\n        \r\n        \r\n        <link rel=\"preconnect\" href=\"https://fonts.gstatic.com\" crossorigin>\r\n        <link rel=\"stylesheet\" href=\"https://fonts.googleapis.com/css?family=Inter:300,300i,400,400i,500,500i,700,700i%7CJetBrains+Mono:400,400i,700,700i&display=fallback\">\r\n        <style>:root{--md-text-font:\"Inter\";--md-code-font:\"JetBrains Mono\"}</style>\r\n      \r\n    \r\n    \r\n    <script>__md_scope=new URL(\"../../../..\",location),__md_hash=e=>[...e].reduce(((e,t)=>(e<<5)-e+t.charCodeAt(0)),0),__md_get=(e,t=localStorage,a=__md_scope)=>JSON.parse(t.getItem(a.pathname+\".\"+e)),__md_set=(e,t,a=localStorage,_=__md_scope)=>{try{a.setItem(_.pathname+\".\"+e,JSON.stringify(t))}catch(e){}},document.documentElement.setAttribute(\"data-platform\",navigator.platform)</script>\r\n    \r\n      \r\n\r\n    \r\n    \r\n  </head>\r\n  \r\n  \r\n    \r\n    \r\n      \r\n    \r\n    \r\n    \r\n    \r\n    <body dir=\"ltr\" data-md-color-scheme=\"default\" data-md-color-primary=\"light-blue\" data-md-color-accent=\"light-blue\">\r\n  \r\n    \r\n    <input class=\"md-toggle\" data-md-toggle=\"drawer\" type=\"checkbox\" id=\"__drawer\" autocomplete=\"off\">\r\n    <input class=\"md-toggle\" data-md-toggle=\"search\" type=\"checkbox\" id=\"__search\" autocomplete=\"off\">\r\n    <label class=\"md-overlay\" for=\"__drawer\"></label>\r\n    <div data-md-component=\"skip\">\r\n      \r\n        \r\n        <a href=\"#creation-and-usage-of-embedding-models\" class=\"md-skip\">\r\n          跳转至\r\n        </a>\r\n      \r\n    </div>\r\n    <div data-md-component=\"announce\">\r\n      \r\n    </div>\r\n    \r\n    \r\n      \r\n\r\n<header class=\"md-header\" data-md-component=\"header\">\r\n  <nav class=\"md-header__inner md-grid\" aria-label=\"页眉\">\r\n    <a href=\"../../../../index.md\" title=\"Langchain Dev Utils\" class=\"md-header__button md-logo\" aria-label=\"Langchain Dev Utils\" data-md-component=\"logo\">\r\n      \r\n  \r\n  <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-book-open\" viewBox=\"0 0 24 24\"><path d=\"M12 7v14M3 18a1 1 0 0 1-1-1V4a1 1 0 0 1 1-1h5a4 4 0 0 1 4 4 4 4 0 0 1 4-4h5a1 1 0 0 1 1 1v13a1 1 0 0 1-1 1h-6a3 3 0 0 0-3 3 3 3 0 0 0-3-3z\"/></svg>\r\n\r\n    </a>\r\n    <label class=\"md-header__button md-icon\" for=\"__drawer\">\r\n      \r\n      <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-menu\" viewBox=\"0 0 24 24\"><path d=\"M4 5h16M4 12h16M4 19h16\"/></svg>\r\n    </label>\r\n    <div class=\"md-header__title\" data-md-component=\"header-title\">\r\n      <div class=\"md-header__ellipsis\">\r\n        <div class=\"md-header__topic\">\r\n          <span class=\"md-ellipsis\">\r\n            Langchain Dev Utils\r\n          </span>\r\n        </div>\r\n        <div class=\"md-header__topic\" data-md-component=\"header-topic\">\r\n          <span class=\"md-ellipsis\">\r\n            \r\n              Creation and Usage of Embedding Models\r\n            \r\n          </span>\r\n        </div>\r\n      </div>\r\n    </div>\r\n    \r\n      \r\n        <form class=\"md-header__option\" data-md-component=\"palette\">\r\n  \r\n    \r\n    \r\n    \r\n    <input class=\"md-option\" data-md-color-media=\"none\" data-md-color-scheme=\"default\" data-md-color-primary=\"light-blue\" data-md-color-accent=\"light-blue\"  aria-label=\"切换到深色模式\"  type=\"radio\" name=\"__palette\" id=\"__palette_0\">\r\n    \r\n      <label class=\"md-header__button md-icon\" title=\"切换到深色模式\" for=\"__palette_1\" hidden>\r\n        <svg xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 24 24\"><path d=\"M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z\"/></svg>\r\n      </label>\r\n    \r\n  \r\n    \r\n    \r\n    \r\n    <input class=\"md-option\" data-md-color-media=\"none\" data-md-color-scheme=\"slate\" data-md-color-primary=\"light-blue\" data-md-color-accent=\"light-blue\"  aria-label=\"切换到浅色模式\"  type=\"radio\" name=\"__palette\" id=\"__palette_1\">\r\n    \r\n      <label class=\"md-header__button md-icon\" title=\"切换到浅色模式\" for=\"__palette_0\" hidden>\r\n        <svg xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 24 24\"><path d=\"M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12s-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z\"/></svg>\r\n      </label>\r\n    \r\n  \r\n</form>\r\n      \r\n    \r\n    \r\n      <script>var palette=__md_get(\"__palette\");if(palette&&palette.color){if(\"(prefers-color-scheme)\"===palette.color.media){var media=matchMedia(\"(prefers-color-scheme: light)\"),input=document.querySelector(media.matches?\"[data-md-color-media='(prefers-color-scheme: light)']\":\"[data-md-color-media='(prefers-color-scheme: dark)']\");palette.color.media=input.getAttribute(\"data-md-color-media\"),palette.color.scheme=input.getAttribute(\"data-md-color-scheme\"),palette.color.primary=input.getAttribute(\"data-md-color-primary\"),palette.color.accent=input.getAttribute(\"data-md-color-accent\")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute(\"data-md-color-\"+key,value)}</script>\r\n    \r\n    \r\n      <div class=\"md-header__option\">\r\n  <div class=\"md-select\">\r\n    \r\n    <button class=\"md-header__button md-icon\" aria-label=\"选择当前语言\">\r\n      <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-languages\" viewBox=\"0 0 24 24\"><path d=\"m5 8 6 6M4 14l6-6 2-3M2 5h12M7 2h1M22 22l-5-10-5 10M14 18h6\"/></svg>\r\n    </button>\r\n    <div class=\"md-select__inner\">\r\n      <ul class=\"md-select__list\">\r\n        \r\n          <li class=\"md-select__item\">\r\n            <a href=\"/en/\" hreflang=\"en\" class=\"md-select__link\">\r\n              English\r\n            </a>\r\n          </li>\r\n        \r\n          <li class=\"md-select__item\">\r\n            <a href=\"/zh/\" hreflang=\"zh\" class=\"md-select__link\">\r\n              简体中文\r\n            </a>\r\n          </li>\r\n        \r\n      </ul>\r\n    </div>\r\n  </div>\r\n</div>\r\n    \r\n    \r\n      \r\n      \r\n        <label class=\"md-header__button md-icon\" for=\"__search\">\r\n          \r\n          <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-search\" viewBox=\"0 0 24 24\"><path d=\"m21 21-4.34-4.34\"/><circle cx=\"11\" cy=\"11\" r=\"8\"/></svg>\r\n        </label>\r\n        <div class=\"md-search\" data-md-component=\"search\" role=\"dialog\" aria-label=\"查找\">\r\n  <button type=\"button\" class=\"md-search__button\">\r\n    查找\r\n  </button>\r\n</div>\r\n      \r\n    \r\n    <div class=\"md-header__source\">\r\n      \r\n        <a href=\"https://github.com/tbice123123/langchain-dev-utils\" title=\"前往仓库\" class=\"md-source\" data-md-component=\"source\">\r\n  <div class=\"md-source__icon md-icon\">\r\n    \r\n    <svg xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 448 512\"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path fill=\"currentColor\" d=\"M439.6 236.1 244 40.5c-5.4-5.5-12.8-8.5-20.4-8.5s-15 3-20.4 8.4L162.5 81l51.5 51.5c27.1-9.1 52.7 16.8 43.4 43.7l49.7 49.7c34.2-11.8 61.2 31 35.5 56.7-26.5 26.5-70.2-2.9-56-37.3L240.3 199v121.9c25.3 12.5 22.3 41.8 9.1 55-6.4 6.4-15.2 10.1-24.3 10.1s-17.8-3.6-24.3-10.1c-17.6-17.6-11.1-46.9 11.2-56v-123c-20.8-8.5-24.6-30.7-18.6-45L142.6 101 8.5 235.1C3 240.6 0 247.9 0 255.5s3 15 8.5 20.4l195.6 195.7c5.4 5.4 12.7 8.4 20.4 8.4s15-3 20.4-8.4l194.7-194.7c5.4-5.4 8.4-12.8 8.4-20.4s-3-15-8.4-20.4\"/></svg>\r\n  </div>\r\n  <div class=\"md-source__repository\">\r\n    tbice123123/langchain-dev-utils\r\n  </div>\r\n</a>\r\n      \r\n    </div>\r\n  </nav>\r\n  \r\n</header>\r\n    \r\n    <div class=\"md-container\" data-md-component=\"container\">\r\n      \r\n      \r\n        \r\n          \r\n            \r\n<nav class=\"md-tabs\" aria-label=\"标签\" data-md-component=\"tabs\">\r\n  <div class=\"md-grid\">\r\n    <ul class=\"md-tabs__list\">\r\n      \r\n        \r\n  \r\n  \r\n  \r\n  \r\n    <li class=\"md-tabs__item\">\r\n      <a href=\"../../../../index.md\" class=\"md-tabs__link\">\r\n        \r\n  \r\n  Overview\r\n\r\n      </a>\r\n    </li>\r\n  \r\n\r\n      \r\n        \r\n  \r\n  \r\n  \r\n  \r\n    \r\n    \r\n      <li class=\"md-tabs__item\">\r\n        <a href=\"../../../../getting-started-guide/installation.md\" class=\"md-tabs__link\">\r\n          \r\n  \r\n  Getting Started\r\n\r\n        </a>\r\n      </li>\r\n    \r\n  \r\n\r\n      \r\n        \r\n  \r\n  \r\n  \r\n  \r\n    \r\n    \r\n      \r\n  \r\n  \r\n  \r\n  \r\n    \r\n    \r\n      <li class=\"md-tabs__item\">\r\n        <a href=\"../../../../adavance-guide/openai-compatible/overview.md\" class=\"md-tabs__link\">\r\n          \r\n  \r\n  Advanced Guides\r\n\r\n        </a>\r\n      </li>\r\n    \r\n  \r\n\r\n    \r\n  \r\n\r\n      \r\n        \r\n  \r\n  \r\n  \r\n  \r\n    \r\n    \r\n      <li class=\"md-tabs__item\">\r\n        <a href=\"../../../../api-reference/overview.md\" class=\"md-tabs__link\">\r\n          \r\n  \r\n  API Reference\r\n\r\n        </a>\r\n      </li>\r\n    \r\n  \r\n\r\n      \r\n    </ul>\r\n  </div>\r\n</nav>\r\n          \r\n        \r\n      \r\n      <main class=\"md-main\" data-md-component=\"main\">\r\n        <div class=\"md-main__inner md-grid\">\r\n          \r\n            \r\n              \r\n              <div class=\"md-sidebar md-sidebar--primary\" data-md-component=\"sidebar\" data-md-type=\"navigation\" >\r\n                <div class=\"md-sidebar__scrollwrap\">\r\n                  <div class=\"md-sidebar__inner\">\r\n                    \r\n\r\n\r\n  \r\n\r\n\r\n<nav class=\"md-nav md-nav--primary md-nav--lifted\" aria-label=\"导航栏\" data-md-level=\"0\">\r\n  <label class=\"md-nav__title\" for=\"__drawer\">\r\n    <a href=\"../../../../index.md\" title=\"Langchain Dev Utils\" class=\"md-nav__button md-logo\" aria-label=\"Langchain Dev Utils\" data-md-component=\"logo\">\r\n      \r\n  \r\n  <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-book-open\" viewBox=\"0 0 24 24\"><path d=\"M12 7v14M3 18a1 1 0 0 1-1-1V4a1 1 0 0 1 1-1h5a4 4 0 0 1 4 4 4 4 0 0 1 4-4h5a1 1 0 0 1 1 1v13a1 1 0 0 1-1 1h-6a3 3 0 0 0-3 3 3 3 0 0 0-3-3z\"/></svg>\r\n\r\n    </a>\r\n    Langchain Dev Utils\r\n  </label>\r\n  \r\n    <div class=\"md-nav__source\">\r\n      <a href=\"https://github.com/tbice123123/langchain-dev-utils\" title=\"前往仓库\" class=\"md-source\" data-md-component=\"source\">\r\n  <div class=\"md-source__icon md-icon\">\r\n    \r\n    <svg xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 448 512\"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path fill=\"currentColor\" d=\"M439.6 236.1 244 40.5c-5.4-5.5-12.8-8.5-20.4-8.5s-15 3-20.4 8.4L162.5 81l51.5 51.5c27.1-9.1 52.7 16.8 43.4 43.7l49.7 49.7c34.2-11.8 61.2 31 35.5 56.7-26.5 26.5-70.2-2.9-56-37.3L240.3 199v121.9c25.3 12.5 22.3 41.8 9.1 55-6.4 6.4-15.2 10.1-24.3 10.1s-17.8-3.6-24.3-10.1c-17.6-17.6-11.1-46.9 11.2-56v-123c-20.8-8.5-24.6-30.7-18.6-45L142.6 101 8.5 235.1C3 240.6 0 247.9 0 255.5s3 15 8.5 20.4l195.6 195.7c5.4 5.4 12.7 8.4 20.4 8.4s15-3 20.4-8.4l194.7-194.7c5.4-5.4 8.4-12.8 8.4-20.4s-3-15-8.4-20.4\"/></svg>\r\n  </div>\r\n  <div class=\"md-source__repository\">\r\n    tbice123123/langchain-dev-utils\r\n  </div>\r\n</a>\r\n    </div>\r\n  \r\n  <ul class=\"md-nav__list\" data-md-scrollfix>\r\n    \r\n      \r\n      \r\n  \r\n  \r\n  \r\n  \r\n    <li class=\"md-nav__item\">\r\n      <a href=\"../../../../index.md\" class=\"md-nav__link\">\r\n        \r\n  \r\n  \r\n  <span class=\"md-ellipsis\">\r\n    \r\n  \r\n    Overview\r\n  \r\n\r\n    \r\n  </span>\r\n  \r\n  \r\n\r\n      </a>\r\n    </li>\r\n  \r\n\r\n    \r\n      \r\n      \r\n  \r\n  \r\n  \r\n  \r\n    \r\n    \r\n    \r\n    \r\n      \r\n      \r\n        \r\n      \r\n    \r\n    \r\n    <li class=\"md-nav__item md-nav__item--nested\">\r\n      \r\n        \r\n        \r\n          \r\n        \r\n        <input class=\"md-nav__toggle md-toggle md-toggle--indeterminate\" type=\"checkbox\" id=\"__nav_2\" >\r\n        \r\n          \r\n          <label class=\"md-nav__link\" for=\"__nav_2\" id=\"__nav_2_label\" tabindex=\"0\">\r\n            \r\n  \r\n  \r\n  <span class=\"md-ellipsis\">\r\n    \r\n  \r\n    Getting Started\r\n  \r\n\r\n    \r\n  </span>\r\n  \r\n  \r\n\r\n            <span class=\"md-nav__icon md-icon\"></span>\r\n          </label>\r\n        \r\n        <nav class=\"md-nav\" data-md-level=\"1\" aria-labelledby=\"__nav_2_label\" aria-expanded=\"false\">\r\n          <label class=\"md-nav__title\" for=\"__nav_2\">\r\n            <span class=\"md-nav__icon md-icon\"></span>\r\n            \r\n  \r\n    Getting Started\r\n  \r\n\r\n          </label>\r\n          <ul class=\"md-nav__list\" data-md-scrollfix>\r\n            \r\n              \r\n                \r\n  \r\n  \r\n  \r\n  \r\n    <li class=\"md-nav__item\">\r\n      <a href=\"../../../../getting-started-guide/installation.md\" class=\"md-nav__link\">\r\n        \r\n  \r\n  \r\n  <span class=\"md-ellipsis\">\r\n    \r\n  \r\n    Installation\r\n  \r\n\r\n    \r\n  </span>\r\n  \r\n  \r\n\r\n      </a>\r\n    </li>\r\n  \r\n\r\n              \r\n            \r\n              \r\n                \r\n  \r\n  \r\n  \r\n  \r\n    <li class=\"md-nav__item\">\r\n      <a href=\"../../../../getting-started-guide/chat.md\" class=\"md-nav__link\">\r\n        \r\n  \r\n  \r\n  <span class=\"md-ellipsis\">\r\n    \r\n  \r\n    Chat Model Management\r\n  \r\n\r\n    \r\n  </span>\r\n  \r\n  \r\n\r\n      </a>\r\n    </li>\r\n  \r\n\r\n              \r\n            \r\n              \r\n                \r\n  \r\n  \r\n  \r\n  \r\n    <li class=\"md-nav__item\">\r\n      <a href=\"../../../../getting-started-guide/embedding.md\" class=\"md-nav__link\">\r\n        \r\n  \r\n  \r\n  <span class=\"md-ellipsis\">\r\n    \r\n  \r\n    Embedding Model Management\r\n  \r\n\r\n    \r\n  </span>\r\n  \r\n  \r\n\r\n      </a>\r\n    </li>\r\n  \r\n\r\n              \r\n            \r\n              \r\n                \r\n  \r\n  \r\n  \r\n  \r\n    <li class=\"md-nav__item\">\r\n      <a href=\"../../../../getting-started-guide/format.md\" class=\"md-nav__link\">\r\n        \r\n  \r\n  \r\n  <span class=\"md-ellipsis\">\r\n    \r\n  \r\n    Formatting Sequences\r\n  \r\n\r\n    \r\n  </span>\r\n  \r\n  \r\n\r\n      </a>\r\n    </li>\r\n  \r\n\r\n              \r\n            \r\n              \r\n                \r\n  \r\n  \r\n  \r\n  \r\n    <li class=\"md-nav__item\">\r\n      <a href=\"../../../../getting-started-guide/message.md\" class=\"md-nav__link\">\r\n        \r\n  \r\n  \r\n  <span class=\"md-ellipsis\">\r\n    \r\n  \r\n    Message Processing\r\n  \r\n\r\n    \r\n  </span>\r\n  \r\n  \r\n\r\n      </a>\r\n    </li>\r\n  \r\n\r\n              \r\n            \r\n              \r\n                \r\n  \r\n  \r\n  \r\n  \r\n    <li class=\"md-nav__item\">\r\n      <a href=\"../../../../getting-started-guide/tool.md\" class=\"md-nav__link\">\r\n        \r\n  \r\n  \r\n  <span class=\"md-ellipsis\">\r\n    \r\n  \r\n    Tool Calling Processing\r\n  \r\n\r\n    \r\n  </span>\r\n  \r\n  \r\n\r\n      </a>\r\n    </li>\r\n  \r\n\r\n              \r\n            \r\n              \r\n                \r\n  \r\n  \r\n  \r\n  \r\n    <li class=\"md-nav__item\">\r\n      <a href=\"../../../../getting-started-guide/human-in-the-loop.md\" class=\"md-nav__link\">\r\n        \r\n  \r\n  \r\n  <span class=\"md-ellipsis\">\r\n    \r\n  \r\n    Add Human-in-the-Loop Support in Tool Calling\r\n  \r\n\r\n    \r\n  </span>\r\n  \r\n  \r\n\r\n      </a>\r\n    </li>\r\n  \r\n\r\n              \r\n            \r\n          </ul>\r\n        </nav>\r\n      \r\n    </li>\r\n  \r\n\r\n    \r\n      \r\n      \r\n  \r\n  \r\n  \r\n  \r\n    \r\n    \r\n    \r\n    \r\n      \r\n      \r\n        \r\n      \r\n    \r\n    \r\n    <li class=\"md-nav__item md-nav__item--nested\">\r\n      \r\n        \r\n        \r\n          \r\n        \r\n        <input class=\"md-nav__toggle md-toggle md-toggle--indeterminate\" type=\"checkbox\" id=\"__nav_3\" >\r\n        \r\n          \r\n          <label class=\"md-nav__link\" for=\"__nav_3\" id=\"__nav_3_label\" tabindex=\"0\">\r\n            \r\n  \r\n  \r\n  <span class=\"md-ellipsis\">\r\n    \r\n  \r\n    Advanced Guides\r\n  \r\n\r\n    \r\n  </span>\r\n  \r\n  \r\n\r\n            <span class=\"md-nav__icon md-icon\"></span>\r\n          </label>\r\n        \r\n        <nav class=\"md-nav\" data-md-level=\"1\" aria-labelledby=\"__nav_3_label\" aria-expanded=\"false\">\r\n          <label class=\"md-nav__title\" for=\"__nav_3\">\r\n            <span class=\"md-nav__icon md-icon\"></span>\r\n            \r\n  \r\n    Advanced Guides\r\n  \r\n\r\n          </label>\r\n          <ul class=\"md-nav__list\" data-md-scrollfix>\r\n            \r\n              \r\n                \r\n  \r\n  \r\n  \r\n  \r\n    \r\n    \r\n    \r\n    \r\n      \r\n      \r\n        \r\n      \r\n    \r\n    \r\n    <li class=\"md-nav__item md-nav__item--nested\">\r\n      \r\n        \r\n        \r\n          \r\n        \r\n        <input class=\"md-nav__toggle md-toggle md-toggle--indeterminate\" type=\"checkbox\" id=\"__nav_3_1\" >\r\n        \r\n          \r\n          <label class=\"md-nav__link\" for=\"__nav_3_1\" id=\"__nav_3_1_label\" tabindex=\"0\">\r\n            \r\n  \r\n  \r\n  <span class=\"md-ellipsis\">\r\n    \r\n  \r\n    OpenAI Compatible API Integration\r\n  \r\n\r\n    \r\n  </span>\r\n  \r\n  \r\n\r\n            <span class=\"md-nav__icon md-icon\"></span>\r\n          </label>\r\n        \r\n        <nav class=\"md-nav\" data-md-level=\"2\" aria-labelledby=\"__nav_3_1_label\" aria-expanded=\"false\">\r\n          <label class=\"md-nav__title\" for=\"__nav_3_1\">\r\n            <span class=\"md-nav__icon md-icon\"></span>\r\n            \r\n  \r\n    OpenAI Compatible API Integration\r\n  \r\n\r\n          </label>\r\n          <ul class=\"md-nav__list\" data-md-scrollfix>\r\n            \r\n              \r\n                \r\n  \r\n  \r\n  \r\n  \r\n    <li class=\"md-nav__item\">\r\n      <a href=\"../../../../adavance-guide/openai-compatible/overview.md\" class=\"md-nav__link\">\r\n        \r\n  \r\n  \r\n  <span class=\"md-ellipsis\">\r\n    \r\n  \r\n    Overview\r\n  \r\n\r\n    \r\n  </span>\r\n  \r\n  \r\n\r\n      </a>\r\n    </li>\r\n  \r\n\r\n              \r\n            \r\n              \r\n                \r\n  \r\n  \r\n  \r\n  \r\n    <li class=\"md-nav__item\">\r\n      <a href=\"../../../../adavance-guide/openai-compatible/chat.md\" class=\"md-nav__link\">\r\n        \r\n  \r\n  \r\n  <span class=\"md-ellipsis\">\r\n    \r\n  \r\n    Creating and Using Chat Models\r\n  \r\n\r\n    \r\n  </span>\r\n  \r\n  \r\n\r\n      </a>\r\n    </li>\r\n  \r\n\r\n              \r\n            \r\n              \r\n                \r\n  \r\n  \r\n  \r\n  \r\n    <li class=\"md-nav__item\">\r\n      <a href=\"../../../../adavance-guide/openai-compatible/embedding.md\" class=\"md-nav__link\">\r\n        \r\n  \r\n  \r\n  <span class=\"md-ellipsis\">\r\n    \r\n  \r\n    Creating and Using Embedding Models\r\n  \r\n\r\n    \r\n  </span>\r\n  \r\n  \r\n\r\n      </a>\r\n    </li>\r\n  \r\n\r\n              \r\n            \r\n              \r\n                \r\n  \r\n  \r\n  \r\n  \r\n    <li class=\"md-nav__item\">\r\n      <a href=\"../../../../adavance-guide/openai-compatible/register.md\" class=\"md-nav__link\">\r\n        \r\n  \r\n  \r\n  <span class=\"md-ellipsis\">\r\n    \r\n  \r\n    Integration with Model Management\r\n  \r\n\r\n    \r\n  </span>\r\n  \r\n  \r\n\r\n      </a>\r\n    </li>\r\n  \r\n\r\n              \r\n            \r\n          </ul>\r\n        </nav>\r\n      \r\n    </li>\r\n  \r\n\r\n              \r\n            \r\n              \r\n                \r\n  \r\n  \r\n  \r\n  \r\n    \r\n    \r\n    \r\n    \r\n      \r\n      \r\n        \r\n      \r\n    \r\n    \r\n    <li class=\"md-nav__item md-nav__item--nested\">\r\n      \r\n        \r\n        \r\n          \r\n        \r\n        <input class=\"md-nav__toggle md-toggle md-toggle--indeterminate\" type=\"checkbox\" id=\"__nav_3_2\" >\r\n        \r\n          \r\n          <label class=\"md-nav__link\" for=\"__nav_3_2\" id=\"__nav_3_2_label\" tabindex=\"0\">\r\n            \r\n  \r\n  \r\n  <span class=\"md-ellipsis\">\r\n    \r\n  \r\n    Middleware\r\n  \r\n\r\n    \r\n  </span>\r\n  \r\n  \r\n\r\n            <span class=\"md-nav__icon md-icon\"></span>\r\n          </label>\r\n        \r\n        <nav class=\"md-nav\" data-md-level=\"2\" aria-labelledby=\"__nav_3_2_label\" aria-expanded=\"false\">\r\n          <label class=\"md-nav__title\" for=\"__nav_3_2\">\r\n            <span class=\"md-nav__icon md-icon\"></span>\r\n            \r\n  \r\n    Middleware\r\n  \r\n\r\n          </label>\r\n          <ul class=\"md-nav__list\" data-md-scrollfix>\r\n            \r\n              \r\n                \r\n  \r\n  \r\n  \r\n  \r\n    <li class=\"md-nav__item\">\r\n      <a href=\"../../../../adavance-guide/middleware/overview.md\" class=\"md-nav__link\">\r\n        \r\n  \r\n  \r\n  <span class=\"md-ellipsis\">\r\n    \r\n  \r\n    Overview\r\n  \r\n\r\n    \r\n  </span>\r\n  \r\n  \r\n\r\n      </a>\r\n    </li>\r\n  \r\n\r\n              \r\n            \r\n              \r\n                \r\n  \r\n  \r\n  \r\n  \r\n    <li class=\"md-nav__item\">\r\n      <a href=\"../../../../adavance-guide/middleware/plan.md\" class=\"md-nav__link\">\r\n        \r\n  \r\n  \r\n  <span class=\"md-ellipsis\">\r\n    \r\n  \r\n    Task Planning\r\n  \r\n\r\n    \r\n  </span>\r\n  \r\n  \r\n\r\n      </a>\r\n    </li>\r\n  \r\n\r\n              \r\n            \r\n              \r\n                \r\n  \r\n  \r\n  \r\n  \r\n    <li class=\"md-nav__item\">\r\n      <a href=\"../../../../adavance-guide/middleware/router.md\" class=\"md-nav__link\">\r\n        \r\n  \r\n  \r\n  <span class=\"md-ellipsis\">\r\n    \r\n  \r\n    Model Routing\r\n  \r\n\r\n    \r\n  </span>\r\n  \r\n  \r\n\r\n      </a>\r\n    </li>\r\n  \r\n\r\n              \r\n            \r\n              \r\n                \r\n  \r\n  \r\n  \r\n  \r\n    <li class=\"md-nav__item\">\r\n      <a href=\"../../../../adavance-guide/middleware/handoffs.md\" class=\"md-nav__link\">\r\n        \r\n  \r\n  \r\n  <span class=\"md-ellipsis\">\r\n    \r\n  \r\n    Agent Handoff\r\n  \r\n\r\n    \r\n  </span>\r\n  \r\n  \r\n\r\n      </a>\r\n    </li>\r\n  \r\n\r\n              \r\n            \r\n              \r\n                \r\n  \r\n  \r\n  \r\n  \r\n    <li class=\"md-nav__item\">\r\n      <a href=\"../../../../adavance-guide/middleware/tool-call-repair.md\" class=\"md-nav__link\">\r\n        \r\n  \r\n  \r\n  <span class=\"md-ellipsis\">\r\n    \r\n  \r\n    Tool Call Repair\r\n  \r\n\r\n    \r\n  </span>\r\n  \r\n  \r\n\r\n      </a>\r\n    </li>\r\n  \r\n\r\n              \r\n            \r\n              \r\n                \r\n  \r\n  \r\n  \r\n  \r\n    <li class=\"md-nav__item\">\r\n      <a href=\"../../../../adavance-guide/middleware/format.md\" class=\"md-nav__link\">\r\n        \r\n  \r\n  \r\n  <span class=\"md-ellipsis\">\r\n    \r\n  \r\n    Format System Prompts\r\n  \r\n\r\n    \r\n  </span>\r\n  \r\n  \r\n\r\n      </a>\r\n    </li>\r\n  \r\n\r\n              \r\n            \r\n              \r\n                \r\n  \r\n  \r\n  \r\n  \r\n    <li class=\"md-nav__item\">\r\n      <a href=\"../../../../adavance-guide/middleware/official.md\" class=\"md-nav__link\">\r\n        \r\n  \r\n  \r\n  <span class=\"md-ellipsis\">\r\n    \r\n  \r\n    LangChain Built-in Middleware Extensions\r\n  \r\n\r\n    \r\n  </span>\r\n  \r\n  \r\n\r\n      </a>\r\n    </li>\r\n  \r\n\r\n              \r\n            \r\n          </ul>\r\n        </nav>\r\n      \r\n    </li>\r\n  \r\n\r\n              \r\n            \r\n              \r\n                \r\n  \r\n  \r\n  \r\n  \r\n    <li class=\"md-nav__item\">\r\n      <a href=\"../../../../adavance-guide/multi-agent.md\" class=\"md-nav__link\">\r\n        \r\n  \r\n  \r\n  <span class=\"md-ellipsis\">\r\n    \r\n  \r\n    Subagent Tools (Agent as Tool)\r\n  \r\n\r\n    \r\n  </span>\r\n  \r\n  \r\n\r\n      </a>\r\n    </li>\r\n  \r\n\r\n              \r\n            \r\n              \r\n                \r\n  \r\n  \r\n  \r\n  \r\n    <li class=\"md-nav__item\">\r\n      <a href=\"../../../../adavance-guide/graph.md\" class=\"md-nav__link\">\r\n        \r\n  \r\n  \r\n  <span class=\"md-ellipsis\">\r\n    \r\n  \r\n    Prebuilt State-Graph Building Functions\r\n  \r\n\r\n    \r\n  </span>\r\n  \r\n  \r\n\r\n      </a>\r\n    </li>\r\n  \r\n\r\n              \r\n            \r\n          </ul>\r\n        </nav>\r\n      \r\n    </li>\r\n  \r\n\r\n    \r\n      \r\n      \r\n  \r\n  \r\n  \r\n  \r\n    \r\n    \r\n    \r\n    \r\n      \r\n      \r\n        \r\n      \r\n    \r\n    \r\n    <li class=\"md-nav__item md-nav__item--nested\">\r\n      \r\n        \r\n        \r\n          \r\n        \r\n        <input class=\"md-nav__toggle md-toggle md-toggle--indeterminate\" type=\"checkbox\" id=\"__nav_4\" >\r\n        \r\n          \r\n          <label class=\"md-nav__link\" for=\"__nav_4\" id=\"__nav_4_label\" tabindex=\"0\">\r\n            \r\n  \r\n  \r\n  <span class=\"md-ellipsis\">\r\n    \r\n  \r\n    API Reference\r\n  \r\n\r\n    \r\n  </span>\r\n  \r\n  \r\n\r\n            <span class=\"md-nav__icon md-icon\"></span>\r\n          </label>\r\n        \r\n        <nav class=\"md-nav\" data-md-level=\"1\" aria-labelledby=\"__nav_4_label\" aria-expanded=\"false\">\r\n          <label class=\"md-nav__title\" for=\"__nav_4\">\r\n            <span class=\"md-nav__icon md-icon\"></span>\r\n            \r\n  \r\n    API Reference\r\n  \r\n\r\n          </label>\r\n          <ul class=\"md-nav__list\" data-md-scrollfix>\r\n            \r\n              \r\n                \r\n  \r\n  \r\n  \r\n  \r\n    <li class=\"md-nav__item\">\r\n      <a href=\"../../../../api-reference/overview.md\" class=\"md-nav__link\">\r\n        \r\n  \r\n  \r\n  <span class=\"md-ellipsis\">\r\n    \r\n  \r\n    Overview\r\n  \r\n\r\n    \r\n  </span>\r\n  \r\n  \r\n\r\n      </a>\r\n    </li>\r\n  \r\n\r\n              \r\n            \r\n              \r\n                \r\n  \r\n  \r\n  \r\n  \r\n    <li class=\"md-nav__item\">\r\n      <a href=\"../../../../api-reference/chat.md\" class=\"md-nav__link\">\r\n        \r\n  \r\n  \r\n  <span class=\"md-ellipsis\">\r\n    \r\n  \r\n    Chat Model Management\r\n  \r\n\r\n    \r\n  </span>\r\n  \r\n  \r\n\r\n      </a>\r\n    </li>\r\n  \r\n\r\n              \r\n            \r\n              \r\n                \r\n  \r\n  \r\n  \r\n  \r\n    <li class=\"md-nav__item\">\r\n      <a href=\"../../../../api-reference/embedding.md\" class=\"md-nav__link\">\r\n        \r\n  \r\n  \r\n  <span class=\"md-ellipsis\">\r\n    \r\n  \r\n    Embedding Model Management\r\n  \r\n\r\n    \r\n  </span>\r\n  \r\n  \r\n\r\n      </a>\r\n    </li>\r\n  \r\n\r\n              \r\n            \r\n              \r\n                \r\n  \r\n  \r\n  \r\n  \r\n    <li class=\"md-nav__item\">\r\n      <a href=\"../../../../api-reference/format.md\" class=\"md-nav__link\">\r\n        \r\n  \r\n  \r\n  <span class=\"md-ellipsis\">\r\n    \r\n  \r\n    Formatting Sequences\r\n  \r\n\r\n    \r\n  </span>\r\n  \r\n  \r\n\r\n      </a>\r\n    </li>\r\n  \r\n\r\n              \r\n            \r\n              \r\n                \r\n  \r\n  \r\n  \r\n  \r\n    <li class=\"md-nav__item\">\r\n      <a href=\"../../../../api-reference/message.md\" class=\"md-nav__link\">\r\n        \r\n  \r\n  \r\n  <span class=\"md-ellipsis\">\r\n    \r\n  \r\n    Message Processing\r\n  \r\n\r\n    \r\n  </span>\r\n  \r\n  \r\n\r\n      </a>\r\n    </li>\r\n  \r\n\r\n              \r\n            \r\n              \r\n                \r\n  \r\n  \r\n  \r\n  \r\n    <li class=\"md-nav__item\">\r\n      <a href=\"../../../../api-reference/tool.md\" class=\"md-nav__link\">\r\n        \r\n  \r\n  \r\n  <span class=\"md-ellipsis\">\r\n    \r\n  \r\n    Tool Calling Processing\r\n  \r\n\r\n    \r\n  </span>\r\n  \r\n  \r\n\r\n      </a>\r\n    </li>\r\n  \r\n\r\n              \r\n            \r\n              \r\n                \r\n  \r\n  \r\n  \r\n  \r\n    <li class=\"md-nav__item\">\r\n      <a href=\"../../../../api-reference/human-in-the-loop.md\" class=\"md-nav__link\">\r\n        \r\n  \r\n  \r\n  <span class=\"md-ellipsis\">\r\n    \r\n  \r\n    Add Human-in-the-Loop Support in Tool Calling\r\n  \r\n\r\n    \r\n  </span>\r\n  \r\n  \r\n\r\n      </a>\r\n    </li>\r\n  \r\n\r\n              \r\n            \r\n          </ul>\r\n        </nav>\r\n      \r\n    </li>\r\n  \r\n\r\n    \r\n  </ul>\r\n</nav>\r\n                  </div>\r\n                </div>\r\n              </div>\r\n            \r\n            \r\n              \r\n              <div class=\"md-sidebar md-sidebar--secondary\" data-md-component=\"sidebar\" data-md-type=\"toc\" >\r\n                <div class=\"md-sidebar__scrollwrap\">\r\n                  <div class=\"md-sidebar__inner\">\r\n                    \r\n\r\n\r\n<nav class=\"md-nav md-nav--secondary\" aria-label=\"目录\">\r\n  \r\n  \r\n  \r\n    \r\n  \r\n  \r\n    <label class=\"md-nav__title\" for=\"__toc\">\r\n      <span class=\"md-nav__icon md-icon\"></span>\r\n      目录\r\n    </label>\r\n    <ul class=\"md-nav__list\" data-md-component=\"toc\" data-md-scrollfix>\r\n      \r\n        <li class=\"md-nav__item\">\r\n  <a href=\"#creating-embedding-model-classes\" class=\"md-nav__link\">\r\n    <span class=\"md-ellipsis\">\r\n      \r\n        Creating Embedding Model Classes\r\n      \r\n    </span>\r\n  </a>\r\n  \r\n</li>\r\n      \r\n        <li class=\"md-nav__item\">\r\n  <a href=\"#using-the-embedding-model-class\" class=\"md-nav__link\">\r\n    <span class=\"md-ellipsis\">\r\n      \r\n        Using the Embedding Model Class\r\n      \r\n    </span>\r\n  </a>\r\n  \r\n    <nav class=\"md-nav\" aria-label=\"Using the Embedding Model Class\">\r\n      <ul class=\"md-nav__list\">\r\n        \r\n          <li class=\"md-nav__item\">\r\n  <a href=\"#vectorizing-queries\" class=\"md-nav__link\">\r\n    <span class=\"md-ellipsis\">\r\n      \r\n        Vectorizing Queries\r\n      \r\n    </span>\r\n  </a>\r\n  \r\n</li>\r\n        \r\n          <li class=\"md-nav__item\">\r\n  <a href=\"#vectorizing-a-list-of-strings\" class=\"md-nav__link\">\r\n    <span class=\"md-ellipsis\">\r\n      \r\n        Vectorizing a List of Strings\r\n      \r\n    </span>\r\n  </a>\r\n  \r\n</li>\r\n        \r\n      </ul>\r\n    </nav>\r\n  \r\n</li>\r\n      \r\n    </ul>\r\n  \r\n</nav>\r\n                  </div>\r\n                </div>\r\n              </div>\r\n            \r\n          \r\n          \r\n            <div class=\"md-content\" data-md-component=\"content\">\r\n              \r\n              <article class=\"md-content__inner md-typeset\">\r\n                \r\n                  \r\n  \r\n  \r\n\r\n\r\n<h1 id=\"creation-and-usage-of-embedding-models\">Creation and Usage of Embedding Models</h1>\n<h2 id=\"creating-embedding-model-classes\">Creating Embedding Model Classes</h2>\n<p>Similar to chat model classes, you can use <code>create_openai_compatible_embedding</code> to create an integrated embedding model class. This function accepts the following parameters:</p>\n<table>\n<thead>\n<tr>\n<th>Parameter</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>embedding_provider</code></td>\n<td>Embedding model provider name, e.g., <code>vllm</code>. Must start with a letter or number, can only contain letters, numbers, and underscores, with a maximum length of 20 characters.<br><br><strong>Type</strong>: <code>str</code><br><strong>Required</strong>: Yes</td>\n</tr>\n<tr>\n<td><code>base_url</code></td>\n<td>Default API endpoint for the model provider.<br><br><strong>Type</strong>: <code>str</code><br><strong>Required</strong>: No</td>\n</tr>\n<tr>\n<td><code>embedding_model_cls_name</code></td>\n<td>Embedding model class name (must comply with Python class naming conventions). Default value is <code>{Provider}Embeddings</code> (where <code>{Provider}</code> is the capitalized provider name).<br><br><strong>Type</strong>: <code>str</code><br><strong>Required</strong>: No</td>\n</tr>\n</tbody>\n</table>\n<p>Similarly, we use <code>create_openai_compatible_embedding</code> to integrate vLLM's embedding model.</p>\n<div class=\"highlight\"><pre><span></span><code><span class=\"kn\">from</span><span class=\"w\"> </span><span class=\"nn\">langchain_dev_utils.embeddings.adapters</span><span class=\"w\"> </span><span class=\"kn\">import</span> <span class=\"n\">create_openai_compatible_embedding</span>\n\n<span class=\"n\">VLLMEmbeddings</span> <span class=\"o\">=</span> <span class=\"n\">create_openai_compatible_embedding</span><span class=\"p\">(</span>\n<span class=\"hll\">    <span class=\"n\">embedding_provider</span><span class=\"o\">=</span><span class=\"s2\">&quot;vllm&quot;</span><span class=\"p\">,</span>\n</span><span class=\"hll\">    <span class=\"n\">base_url</span><span class=\"o\">=</span><span class=\"s2\">&quot;http://localhost:8000/v1&quot;</span><span class=\"p\">,</span>\n</span><span class=\"hll\">    <span class=\"n\">embedding_model_cls_name</span><span class=\"o\">=</span><span class=\"s2\">&quot;VLLMEmbeddings&quot;</span><span class=\"p\">,</span>\n</span><span class=\"p\">)</span>\n\n<span class=\"n\">embedding</span> <span class=\"o\">=</span> <span class=\"n\">VLLMEmbeddings</span><span class=\"p\">(</span><span class=\"n\">model</span><span class=\"o\">=</span><span class=\"s2\">&quot;qwen3-embedding-4b&quot;</span><span class=\"p\">)</span>\n<span class=\"nb\">print</span><span class=\"p\">(</span><span class=\"n\">embedding</span><span class=\"o\">.</span><span class=\"n\">embed_query</span><span class=\"p\">(</span><span class=\"s2\">&quot;Hello&quot;</span><span class=\"p\">))</span>\n</code></pre></div>\n<p><code>base_url</code> can also be omitted. If not provided, the library will read the environment variable <code>VLLM_API_BASE</code> by default:</p>\n<div class=\"highlight\"><pre><span></span><code><span class=\"nb\">export</span><span class=\"w\"> </span><span class=\"nv\">VLLM_API_BASE</span><span class=\"o\">=</span><span class=\"s2\">&quot;http://localhost:8000/v1&quot;</span>\n</code></pre></div>\n<p>At this point, the code can omit <code>base_url</code>:</p>\n<div class=\"highlight\"><pre><span></span><code><span class=\"kn\">from</span><span class=\"w\"> </span><span class=\"nn\">langchain_dev_utils.embeddings.adapters</span><span class=\"w\"> </span><span class=\"kn\">import</span> <span class=\"n\">create_openai_compatible_embedding</span>\n\n<span class=\"n\">VLLMEmbeddings</span> <span class=\"o\">=</span> <span class=\"n\">create_openai_compatible_embedding</span><span class=\"p\">(</span>\n<span class=\"hll\">    <span class=\"n\">embedding_provider</span><span class=\"o\">=</span><span class=\"s2\">&quot;vllm&quot;</span><span class=\"p\">,</span>\n</span><span class=\"hll\">    <span class=\"n\">embedding_model_cls_name</span><span class=\"o\">=</span><span class=\"s2\">&quot;VLLMEmbeddings&quot;</span><span class=\"p\">,</span>\n</span><span class=\"p\">)</span>\n\n<span class=\"n\">embedding</span> <span class=\"o\">=</span> <span class=\"n\">VLLMEmbeddings</span><span class=\"p\">(</span><span class=\"n\">model</span><span class=\"o\">=</span><span class=\"s2\">&quot;qwen3-embedding-4b&quot;</span><span class=\"p\">)</span>\n<span class=\"nb\">print</span><span class=\"p\">(</span><span class=\"n\">embedding</span><span class=\"o\">.</span><span class=\"n\">embed_query</span><span class=\"p\">(</span><span class=\"s2\">&quot;Hello&quot;</span><span class=\"p\">))</span>\n</code></pre></div>\n<p><strong>Note</strong>: The above code successfully runs assuming the environment variable <code>VLLM_API_KEY</code> is configured. Although vLLM itself does not require an API Key, the embedding model class initialization requires one. Therefore, please set this variable first, for example:</p>\n<div class=\"highlight\"><pre><span></span><code><span class=\"nb\">export</span><span class=\"w\"> </span><span class=\"nv\">VLLM_API_KEY</span><span class=\"o\">=</span>vllm_api_key\n</code></pre></div>\n<h2 id=\"using-the-embedding-model-class\">Using the Embedding Model Class</h2>\n<p>Here, we use the previously created <code>VLLMEmbeddings</code> class to initialize an embedding model instance.</p>\n<h3 id=\"vectorizing-queries\">Vectorizing Queries</h3>\n<div class=\"highlight\"><pre><span></span><code><span class=\"n\">embedding</span> <span class=\"o\">=</span> <span class=\"n\">VLLMEmbeddings</span><span class=\"p\">(</span><span class=\"n\">model</span><span class=\"o\">=</span><span class=\"s2\">&quot;qwen3-embedding-4b&quot;</span><span class=\"p\">)</span>\n<span class=\"nb\">print</span><span class=\"p\">(</span><span class=\"n\">embedding</span><span class=\"o\">.</span><span class=\"n\">embed_query</span><span class=\"p\">(</span><span class=\"s2\">&quot;Hello&quot;</span><span class=\"p\">))</span>\n</code></pre></div>\n<p>Similarly, asynchronous invocation is also supported:</p>\n<div class=\"highlight\"><pre><span></span><code><span class=\"n\">embedding</span> <span class=\"o\">=</span> <span class=\"n\">VLLMEmbeddings</span><span class=\"p\">(</span><span class=\"n\">model</span><span class=\"o\">=</span><span class=\"s2\">&quot;qwen3-embedding-4b&quot;</span><span class=\"p\">)</span>\n<span class=\"n\">res</span> <span class=\"o\">=</span> <span class=\"k\">await</span> <span class=\"n\">embedding</span><span class=\"o\">.</span><span class=\"n\">aembed_query</span><span class=\"p\">(</span><span class=\"s2\">&quot;Hello&quot;</span><span class=\"p\">)</span>\n<span class=\"nb\">print</span><span class=\"p\">(</span><span class=\"n\">res</span><span class=\"p\">)</span>\n</code></pre></div>\n<h3 id=\"vectorizing-a-list-of-strings\">Vectorizing a List of Strings</h3>\n<p><div class=\"highlight\"><pre><span></span><code><span class=\"n\">documents</span> <span class=\"o\">=</span> <span class=\"p\">[</span><span class=\"s2\">&quot;Hello&quot;</span><span class=\"p\">,</span> <span class=\"s2\">&quot;Hello, I am Zhang San&quot;</span><span class=\"p\">]</span>\n<span class=\"n\">embedding</span> <span class=\"o\">=</span> <span class=\"n\">VLLMEmbeddings</span><span class=\"p\">(</span><span class=\"n\">model</span><span class=\"o\">=</span><span class=\"s2\">&quot;qwen3-embedding-4b&quot;</span><span class=\"p\">)</span>\n<span class=\"nb\">print</span><span class=\"p\">(</span><span class=\"n\">embedding</span><span class=\"o\">.</span><span class=\"n\">embed_documents</span><span class=\"p\">(</span><span class=\"n\">documents</span><span class=\"p\">))</span>\n</code></pre></div>\nSimilarly, asynchronous invocation is also supported:</p>\n<div class=\"highlight\"><pre><span></span><code><span class=\"n\">documents</span> <span class=\"o\">=</span> <span class=\"p\">[</span><span class=\"s2\">&quot;Hello&quot;</span><span class=\"p\">,</span> <span class=\"s2\">&quot;Hello, I am Zhang San&quot;</span><span class=\"p\">]</span>\n<span class=\"n\">embedding</span> <span class=\"o\">=</span> <span class=\"n\">VLLMEmbeddings</span><span class=\"p\">(</span><span class=\"n\">model</span><span class=\"o\">=</span><span class=\"s2\">&quot;qwen3-embedding-4b&quot;</span><span class=\"p\">)</span>\n<span class=\"n\">res</span> <span class=\"o\">=</span> <span class=\"k\">await</span> <span class=\"n\">embedding</span><span class=\"o\">.</span><span class=\"n\">aembed_documents</span><span class=\"p\">(</span><span class=\"n\">documents</span><span class=\"p\">)</span>\n<span class=\"nb\">print</span><span class=\"p\">(</span><span class=\"n\">res</span><span class=\"p\">)</span>\n</code></pre></div>\n<div class=\"admonition warning\">\n<p class=\"admonition-title\">Embedding Model Compatibility Notes</p>\n<p>OpenAI-compatible embedding APIs generally exhibit good compatibility, but the following differences should be noted:</p>\n<ol>\n<li>\n<p><code>check_embedding_ctx_length</code>: Set to <code>True</code> only when using the official OpenAI embedding service; for all other embedding models, set it to <code>False</code>.</p>\n</li>\n<li>\n<p><code>dimensions</code>: If the model supports custom vector dimensions (e.g., 1024, 4096), you can directly pass this parameter.</p>\n</li>\n<li>\n<p><code>chunk_size</code>: The maximum number of texts that can be processed in a single API call. For example, a <code>chunk_size</code> of 10 means a single request can vectorize up to 10 texts.</p>\n</li>\n<li>\n<p>Single-text token limit: Cannot be controlled via parameters; must be ensured during preprocessing and chunking stages.</p>\n</li>\n</ol>\n</div>\n<div class=\"admonition warning\">\n<p class=\"admonition-title\">Note</p>\n<p>Similarly, this function uses <code>pydantic.create_model</code> under the hood to create embedding model classes, which incurs some performance overhead. It is recommended to create integration classes during project startup and avoid dynamic creation afterward.</p>\n</div>\n<div class=\"admonition success\">\n<p class=\"admonition-title\">Best Practice</p>\n<p>When connecting to an OpenAI-compatible API embedding model provider, you can directly use <code>langchain-openai</code>'s <code>OpenAIEmbeddings</code> and point <code>base_url</code> and <code>api_key</code> to your provider's service. Embedding model API compatibility is usually better: in most cases, you can directly use <code>OpenAIEmbeddings</code> with <code>check_embedding_ctx_length=False</code>.</p>\n</div>\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n                \r\n              </article>\r\n            </div>\r\n          \r\n          \r\n  <script>var tabs=__md_get(\"__tabs\");if(Array.isArray(tabs))e:for(var set of document.querySelectorAll(\".tabbed-set\")){var labels=set.querySelector(\".tabbed-labels\");for(var tab of tabs)for(var label of labels.getElementsByTagName(\"label\"))if(label.innerText.trim()===tab){var input=document.getElementById(label.htmlFor);input.checked=!0;continue e}}</script>\r\n\r\n<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith(\"__tabbed_\"))</script>\r\n        </div>\r\n        \r\n          <button type=\"button\" class=\"md-top md-icon\" data-md-component=\"top\" hidden>\r\n  \r\n  <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-circle-arrow-up\" viewBox=\"0 0 24 24\"><circle cx=\"12\" cy=\"12\" r=\"10\"/><path d=\"m16 12-4-4-4 4M12 16V8\"/></svg>\r\n  回到页面顶部\r\n</button>\r\n        \r\n      </main>\r\n      \r\n        <footer class=\"md-footer\">\r\n  \r\n  <div class=\"md-footer-meta md-typeset\">\r\n    <div class=\"md-footer-meta__inner md-grid\">\r\n      <div class=\"md-copyright\">\r\n  \r\n  \r\n    Made with\r\n    <a href=\"https://zensical.org/\" target=\"_blank\" rel=\"noopener\">\r\n      Zensical\r\n    </a>\r\n  \r\n</div>\r\n      \r\n    </div>\r\n  </div>\r\n</footer>\r\n      \r\n    </div>\r\n    <div class=\"md-dialog\" data-md-component=\"dialog\">\r\n      <div class=\"md-dialog__inner md-typeset\"></div>\r\n    </div>\r\n    \r\n    \r\n    \r\n      \r\n      \r\n      \r\n      <script id=\"__config\" type=\"application/json\">{\"annotate\":null,\"base\":\"../../../..\",\"features\":[\"navigation.tabs\",\"navigation.sections\",\"navigation.expand\",\"navigation.instant\",\"navigation.tracking\",\"navigation.top\",\"search.suggest\",\"search.highlight\",\"search.share\",\"content.code.copy\",\"content.code.annotate\",\"content.tabs.link\",\"content.tooltips\",\"content.footnote.tooltips\"],\"search\":\"../../../../assets/javascripts/workers/search.e2d2d235.min.js\",\"tags\":null,\"translations\":{\"clipboard.copied\":\"已复制\",\"clipboard.copy\":\"复制\",\"search.result.more.one\":\"在该页上还有 1 个符合条件的结果\",\"search.result.more.other\":\"在该页上还有 # 个符合条件的结果\",\"search.result.none\":\"没有找到符合条件的结果\",\"search.result.one\":\"找到 1 个符合条件的结果\",\"search.result.other\":\"# 个符合条件的结果\",\"search.result.placeholder\":\"键入以开始搜索\",\"search.result.term.missing\":\"缺少\",\"select.version\":\"选择当前版本\"},\"version\":null}</script>\r\n    \r\n    \r\n      <script src=\"../../../../assets/javascripts/bundle.36a64b72.min.js\"></script>\r\n      \r\n    \r\n  </body>\r\n</html>",
-  "hash": 617130092991168079
-}