langchain 1.0.0a12__py3-none-any.whl → 1.0.4__py3-none-any.whl

langchain/embeddings/__init__.py

@@ -1,12 +1,22 @@
-"""Embeddings."""
+"""Embeddings models.
+
+!!! warning "Reference docs"
+    This page contains **reference documentation** for Embeddings. See
+    [the docs](https://docs.langchain.com/oss/python/langchain/retrieval#embedding-models)
+    for conceptual guides, tutorials, and examples on using Embeddings.
+
+!!! warning "Modules moved"
+    With the release of `langchain 1.0.0`, several embeddings modules were moved to
+    `langchain-classic`, such as `CacheBackedEmbeddings` and all community
+    embeddings. See [list](https://github.com/langchain-ai/langchain/blob/bdf1cd383ce36dc18381a3bf3fb0a579337a32b5/libs/langchain/langchain/embeddings/__init__.py)
+    of moved modules to inform your migration.
+"""
 
 from langchain_core.embeddings import Embeddings
 
 from langchain.embeddings.base import init_embeddings
-from langchain.embeddings.cache import CacheBackedEmbeddings
 
 __all__ = [
-    "CacheBackedEmbeddings",
     "Embeddings",
     "init_embeddings",
 ]

langchain/embeddings/base.py

@@ -35,13 +35,13 @@ def _parse_model_string(model_name: str) -> tuple[str, str]:
     Returns:
         A tuple of (provider, model_name)
 
-    .. code-block:: python
+    ```python
+    _parse_model_string("openai:text-embedding-3-small")
+    # Returns: ("openai", "text-embedding-3-small")
 
-        _parse_model_string("openai:text-embedding-3-small")
-        # Returns: ("openai", "text-embedding-3-small")
-
-        _parse_model_string("bedrock:amazon.titan-embed-text-v1")
-        # Returns: ("bedrock", "amazon.titan-embed-text-v1")
+    _parse_model_string("bedrock:amazon.titan-embed-text-v1")
+    # Returns: ("bedrock", "amazon.titan-embed-text-v1")
+    ```
 
     Raises:
         ValueError: If the model string is not in the correct format or
@@ -126,46 +126,66 @@ def init_embeddings(
     provider: str | None = None,
     **kwargs: Any,
 ) -> Embeddings:
-    """Initialize an embeddings model from a model name and optional provider.
+    """Initialize an embedding model from a model name and optional provider.
+
+    !!! note
+        Requires the integration package for the chosen model provider to be installed.
+
+        See the `model_provider` parameter below for specific package names
+        (e.g., `pip install langchain-openai`).
 
-    **Note:** Must have the integration package corresponding to the model provider
-    installed.
+        Refer to the [provider integration's API reference](https://docs.langchain.com/oss/python/integrations/providers)
+        for supported model parameters to use as `**kwargs`.
 
     Args:
-        model: Name of the model to use. Can be either:
-            - A model string like "openai:text-embedding-3-small"
-            - Just the model name if provider is specified
-        provider: Optional explicit provider name. If not specified,
-            will attempt to parse from the model string. Supported providers
-            and their required packages:
+        model: The name of the model, e.g. `'openai:text-embedding-3-small'`.
 
-            {_get_provider_list()}
+            You can also specify model and model provider in a single argument using
+            `'{model_provider}:{model}'` format, e.g. `'openai:text-embedding-3-small'`.
+        provider: The model provider if not specified as part of the model arg
+            (see above).
+
+            Supported `provider` values and the corresponding integration package
+            are:
+
+            - `openai`                  -> [`langchain-openai`](https://docs.langchain.com/oss/python/integrations/providers/openai)
+            - `azure_openai`            -> [`langchain-openai`](https://docs.langchain.com/oss/python/integrations/providers/openai)
+            - `bedrock`                 -> [`langchain-aws`](https://docs.langchain.com/oss/python/integrations/providers/aws)
+            - `cohere`                  -> [`langchain-cohere`](https://docs.langchain.com/oss/python/integrations/providers/cohere)
+            - `google_vertexai`         -> [`langchain-google-vertexai`](https://docs.langchain.com/oss/python/integrations/providers/google)
+            - `huggingface`             -> [`langchain-huggingface`](https://docs.langchain.com/oss/python/integrations/providers/huggingface)
+            - `mistraiai`               -> [`langchain-mistralai`](https://docs.langchain.com/oss/python/integrations/providers/mistralai)
+            - `ollama`                  -> [`langchain-ollama`](https://docs.langchain.com/oss/python/integrations/providers/ollama)
 
         **kwargs: Additional model-specific parameters passed to the embedding model.
-            These vary by provider, see the provider-specific documentation for details.
+
+            These vary by provider. Refer to the specific model provider's
+            [integration reference](https://reference.langchain.com/python/integrations/)
+            for all available parameters.
 
     Returns:
-        An Embeddings instance that can generate embeddings for text.
+        An `Embeddings` instance that can generate embeddings for text.
 
     Raises:
         ValueError: If the model provider is not supported or cannot be determined
         ImportError: If the required provider package is not installed
 
-    ??? note "Example Usage"
-        :open:
+    ???+ example
 
-        .. code-block:: python
+        ```python
+        # pip install langchain langchain-openai
 
-            # Using a model string
-            model = init_embeddings("openai:text-embedding-3-small")
-            model.embed_query("Hello, world!")
+        # Using a model string
+        model = init_embeddings("openai:text-embedding-3-small")
+        model.embed_query("Hello, world!")
 
-            # Using explicit provider
-            model = init_embeddings(model="text-embedding-3-small", provider="openai")
-            model.embed_documents(["Hello, world!", "Goodbye, world!"])
+        # Using explicit provider
+        model = init_embeddings(model="text-embedding-3-small", provider="openai")
+        model.embed_documents(["Hello, world!", "Goodbye, world!"])
 
-            # With additional parameters
-            model = init_embeddings("openai:text-embedding-3-small", api_key="sk-...")
+        # With additional parameters
+        model = init_embeddings("openai:text-embedding-3-small", api_key="sk-...")
+        ```
 
     !!! version-added "Added in version 0.3.9"
 

langchain/messages/__init__.py

@@ -1,29 +1,78 @@
-"""Message types."""
+"""Message and message content types.
+
+Includes message types for different roles (e.g., human, AI, system), as well as types
+for message content blocks (e.g., text, image, audio) and tool calls.
+
+!!! warning "Reference docs"
+    This page contains **reference documentation** for Messages. See
+    [the docs](https://docs.langchain.com/oss/python/langchain/messages) for conceptual
+    guides, tutorials, and examples on using Messages.
+"""
 
 from langchain_core.messages import (
     AIMessage,
     AIMessageChunk,
+    Annotation,
     AnyMessage,
+    AudioContentBlock,
+    Citation,
+    ContentBlock,
+    DataContentBlock,
+    FileContentBlock,
     HumanMessage,
+    ImageContentBlock,
+    InputTokenDetails,
     InvalidToolCall,
     MessageLikeRepresentation,
+    NonStandardAnnotation,
+    NonStandardContentBlock,
+    OutputTokenDetails,
+    PlainTextContentBlock,
+    ReasoningContentBlock,
+    RemoveMessage,
+    ServerToolCall,
+    ServerToolCallChunk,
+    ServerToolResult,
     SystemMessage,
+    TextContentBlock,
     ToolCall,
     ToolCallChunk,
     ToolMessage,
+    UsageMetadata,
+    VideoContentBlock,
     trim_messages,
 )
 
 __all__ = [
     "AIMessage",
     "AIMessageChunk",
+    "Annotation",
     "AnyMessage",
+    "AudioContentBlock",
+    "Citation",
+    "ContentBlock",
+    "DataContentBlock",
+    "FileContentBlock",
     "HumanMessage",
+    "ImageContentBlock",
+    "InputTokenDetails",
     "InvalidToolCall",
     "MessageLikeRepresentation",
+    "NonStandardAnnotation",
+    "NonStandardContentBlock",
+    "OutputTokenDetails",
+    "PlainTextContentBlock",
+    "ReasoningContentBlock",
+    "RemoveMessage",
+    "ServerToolCall",
+    "ServerToolCallChunk",
+    "ServerToolResult",
     "SystemMessage",
+    "TextContentBlock",
     "ToolCall",
     "ToolCallChunk",
     "ToolMessage",
+    "UsageMetadata",
+    "VideoContentBlock",
     "trim_messages",
 ]

langchain/tools/__init__.py

@@ -1,4 +1,10 @@
-"""Tools."""
+"""Tools.
+
+!!! warning "Reference docs"
+    This page contains **reference documentation** for Tools. See
+    [the docs](https://docs.langchain.com/oss/python/langchain/tools) for conceptual
+    guides, tutorials, and examples on using Tools.
+"""
 
 from langchain_core.tools import (
     BaseTool,
@@ -8,11 +14,7 @@ from langchain_core.tools import (
     tool,
 )
 
-from langchain.tools.tool_node import (
-    InjectedState,
-    InjectedStore,
-    ToolNode,
-)
+from langchain.tools.tool_node import InjectedState, InjectedStore, ToolRuntime
 
 __all__ = [
     "BaseTool",
@@ -21,6 +23,6 @@ __all__ = [
     "InjectedToolArg",
     "InjectedToolCallId",
     "ToolException",
-    "ToolNode",
+    "ToolRuntime",
     "tool",
 ]