langchain-core 1.0.0a1__py3-none-any.whl → 1.0.0a3__py3-none-any.whl

langchain_core/utils/pydantic.py

@@ -57,6 +57,9 @@ def get_pydantic_major_version() -> int:
     """DEPRECATED - Get the major version of Pydantic.
 
     Use PYDANTIC_VERSION.major instead.
+
+    Returns:
+        The major version of Pydantic.
     """
     return PYDANTIC_VERSION.major
 
@@ -74,12 +77,20 @@ TBaseModel = TypeVar("TBaseModel", bound=PydanticBaseModel)
 
 
 def is_pydantic_v1_subclass(cls: type) -> bool:
-    """Check if the installed Pydantic version is 1.x-like."""
+    """Check if the given class is Pydantic v1-like.
+
+    Returns:
+        True if the given class is a subclass of Pydantic ``BaseModel`` 1.x.
+    """
     return issubclass(cls, BaseModelV1)
 
 
 def is_pydantic_v2_subclass(cls: type) -> bool:
-    """Check if the installed Pydantic version is 1.x-like."""
+    """Check if the given class is Pydantic v2-like.
+
+    Returns:
+        True if the given class is a subclass of Pydantic BaseModel 2.x.
+    """
     return issubclass(cls, BaseModel)
 
 
@@ -90,6 +101,9 @@ def is_basemodel_subclass(cls: type) -> bool:
 
     * pydantic.BaseModel in Pydantic 2.x
     * pydantic.v1.BaseModel in Pydantic 2.x
+
+    Returns:
+        True if the given class is a subclass of Pydantic ``BaseModel``.
     """
     # Before we can use issubclass on the cls we need to check if it is a class
     if not inspect.isclass(cls) or isinstance(cls, GenericAlias):
@@ -105,6 +119,9 @@ def is_basemodel_instance(obj: Any) -> bool:
 
     * pydantic.BaseModel in Pydantic 2.x
     * pydantic.v1.BaseModel in Pydantic 2.x
+
+    Returns:
+        True if the given class is an instance of Pydantic ``BaseModel``.
     """
     return isinstance(obj, (BaseModel, BaseModelV1))
 
@@ -125,7 +142,7 @@ def pre_init(func: Callable) -> Any:
         # Ideally we would use @model_validator(mode="before") but this would change the
         # order of the validators. See https://github.com/pydantic/pydantic/discussions/7434.
         # So we keep root_validator for backward compatibility.
-        @root_validator(pre=True)
+        @root_validator(pre=True)  # type: ignore[deprecated]
         @wraps(func)
         def wrapper(cls: type[BaseModel], values: dict[str, Any]) -> dict[str, Any]:
             """Decorator to run a function before model initialization.
@@ -262,7 +279,11 @@ def _create_subset_model(
     descriptions: Optional[dict] = None,
     fn_description: Optional[str] = None,
 ) -> type[BaseModel]:
-    """Create subset model using the same pydantic version as the input model."""
+    """Create subset model using the same pydantic version as the input model.
+
+    Returns:
+        The created subset model.
+    """
     if issubclass(model, BaseModelV1):
         return _create_subset_model_v1(
             name,
@@ -299,13 +320,21 @@ def get_fields(model: BaseModelV1) -> dict[str, ModelField]: ...
 def get_fields(
     model: Union[type[Union[BaseModel, BaseModelV1]], BaseModel, BaseModelV1],
 ) -> Union[dict[str, FieldInfoV2], dict[str, ModelField]]:
-    """Get the field names of a Pydantic model."""
-    if hasattr(model, "model_fields"):
-        return model.model_fields
+    """Return the field names of a Pydantic model.
 
-    if hasattr(model, "__fields__"):
+    Args:
+        model: The Pydantic model or instance.
+
+    Raises:
+        TypeError: If the model is not a Pydantic model.
+    """
+    if not isinstance(model, type):
+        model = type(model)
+    if issubclass(model, BaseModel):
+        return model.model_fields
+    if issubclass(model, BaseModelV1):
         return model.__fields__
-    msg = f"Expected a Pydantic model. Got {type(model)}"
+    msg = f"Expected a Pydantic model. Got {model}"
     raise TypeError(msg)
 
 

langchain_core/utils/utils.py

@@ -22,17 +22,14 @@ from langchain_core.utils.pydantic import (
 
 
 def xor_args(*arg_groups: tuple[str, ...]) -> Callable:
-    """Validate specified keyword args are mutually exclusive.".
+    """Validate specified keyword args are mutually exclusive.
 
     Args:
         *arg_groups (tuple[str, ...]): Groups of mutually exclusive keyword args.
 
     Returns:
         Callable: Decorator that validates the specified keyword args
-            are mutually exclusive
-
-    Raises:
-        ValueError: If more than one arg in a group is defined.
+            are mutually exclusive.
     """
 
     def decorator(func: Callable) -> Callable:
@@ -138,7 +135,7 @@ def guard_import(
     try:
         module = importlib.import_module(module_name, package)
     except (ImportError, ModuleNotFoundError) as e:
-        pip_name = pip_name or module_name.split(".")[0].replace("_", "-")
+        pip_name = pip_name or module_name.split(".", maxsplit=1)[0].replace("_", "-")
         msg = (
             f"Could not import {module_name} python package. "
             f"Please install it with `pip install {pip_name}`."
@@ -224,7 +221,7 @@ def _build_model_kwargs(
     values: dict[str, Any],
     all_required_field_names: set[str],
 ) -> dict[str, Any]:
-    """Build "model_kwargs" param from Pydanitc constructor values.
+    """Build "model_kwargs" param from Pydantic constructor values.
 
     Args:
         values: All init args passed in by user.
@@ -382,10 +379,21 @@ def from_env(
         error_message: the error message which will be raised if the key is not found
             and no default value is provided.
             This will be raised as a ValueError.
+
+    Returns:
+        factory method that will look up the value from the environment.
     """
 
     def get_from_env_fn() -> Optional[str]:
-        """Get a value from an environment variable."""
+        """Get a value from an environment variable.
+
+        Raises:
+            ValueError: If the environment variable is not set and no default is
+                provided.
+
+        Returns:
+            The value from the environment.
+        """
         if isinstance(key, (list, tuple)):
             for k in key:
                 if k in os.environ:
@@ -446,7 +454,15 @@ def secret_from_env(
     """
 
     def get_secret_from_env() -> Optional[SecretStr]:
-        """Get a value from an environment variable."""
+        """Get a value from an environment variable.
+
+        Raises:
+            ValueError: If the environment variable is not set and no default is
+                provided.
+
+        Returns:
+            The secret from the environment.
+        """
         if isinstance(key, (list, tuple)):
             for k in key:
                 if k in os.environ:

langchain_core/vectorstores/base.py

@@ -38,6 +38,7 @@ from typing import (
 from pydantic import ConfigDict, Field, model_validator
 from typing_extensions import Self, override
 
+from langchain_core.documents import Document
 from langchain_core.embeddings import Embeddings
 from langchain_core.retrievers import BaseRetriever, LangSmithRetrieverParams
 from langchain_core.runnables.config import run_in_executor
@@ -49,7 +50,6 @@ if TYPE_CHECKING:
         AsyncCallbackManagerForRetrieverRun,
         CallbackManagerForRetrieverRun,
     )
-    from langchain_core.documents import Document
 
 logger = logging.getLogger(__name__)
 
@@ -85,9 +85,6 @@ class VectorStore(ABC):
             ValueError: If the number of ids does not match the number of texts.
         """
         if type(self).add_documents != VectorStore.add_documents:
-            # Import document in local scope to avoid circular imports
-            from langchain_core.documents import Document
-
             # This condition is triggered if the subclass has provided
             # an implementation of the upsert method.
             # The existing add_texts
@@ -234,9 +231,6 @@ class VectorStore(ABC):
             # For backward compatibility
             kwargs["ids"] = ids
         if type(self).aadd_documents != VectorStore.aadd_documents:
-            # Import document in local scope to avoid circular imports
-            from langchain_core.documents import Document
-
             # This condition is triggered if the subclass has provided
             # an implementation of the upsert method.
             # The existing add_texts
@@ -270,9 +264,6 @@ class VectorStore(ABC):
 
         Returns:
             List of IDs of the added texts.
-
-        Raises:
-            ValueError: If the number of ids does not match the number of documents.
         """
         if type(self).add_texts != VectorStore.add_texts:
             if "ids" not in kwargs:
@@ -303,9 +294,6 @@ class VectorStore(ABC):
 
         Returns:
             List of IDs of the added texts.
-
-        Raises:
-            ValueError: If the number of IDs does not match the number of documents.
         """
         # If the async method has been overridden, we'll use that.
         if type(self).aadd_texts != VectorStore.aadd_texts:
@@ -435,6 +423,7 @@ class VectorStore(ABC):
         """The 'correct' relevance function.
 
         may differ depending on a few things, including:
+
         - the distance / similarity metric used by the VectorStore
         - the scale of your embeddings (OpenAI's are unit normed. Many others are not!)
         - embedding dimensionality
@@ -969,30 +958,28 @@ class VectorStore(ABC):
             # Retrieve more documents with higher diversity
             # Useful if your dataset has many similar documents
             docsearch.as_retriever(
-                search_type="mmr",
-                search_kwargs={'k': 6, 'lambda_mult': 0.25}
+                search_type="mmr", search_kwargs={"k": 6, "lambda_mult": 0.25}
             )
 
             # Fetch more documents for the MMR algorithm to consider
             # But only return the top 5
             docsearch.as_retriever(
-                search_type="mmr",
-                search_kwargs={'k': 5, 'fetch_k': 50}
+                search_type="mmr", search_kwargs={"k": 5, "fetch_k": 50}
             )
 
             # Only retrieve documents that have a relevance score
             # Above a certain threshold
             docsearch.as_retriever(
                 search_type="similarity_score_threshold",
-                search_kwargs={'score_threshold': 0.8}
+                search_kwargs={"score_threshold": 0.8},
             )
 
             # Only get the single most similar document from the dataset
-            docsearch.as_retriever(search_kwargs={'k': 1})
+            docsearch.as_retriever(search_kwargs={"k": 1})
 
             # Use a filter to only retrieve documents from a specific paper
             docsearch.as_retriever(
-                search_kwargs={'filter': {'paper_title':'GPT-4 Technical Report'}}
+                search_kwargs={"filter": {"paper_title": "GPT-4 Technical Report"}}
             )
 
         """

langchain_core/vectorstores/in_memory.py

@@ -27,6 +27,13 @@ if TYPE_CHECKING:
     from langchain_core.embeddings import Embeddings
     from langchain_core.indexing import UpsertResponse
 
+try:
+    import numpy as np
+
+    _HAS_NUMPY = True
+except ImportError:
+    _HAS_NUMPY = False
+
 
 class InMemoryVectorStore(VectorStore):
     """In-memory vector store implementation.
@@ -83,7 +90,7 @@ class InMemoryVectorStore(VectorStore):
     Search:
         .. code-block:: python
 
-            results = vector_store.similarity_search(query="thud",k=1)
+            results = vector_store.similarity_search(query="thud", k=1)
             for doc in results:
                 print(f"* {doc.page_content} [{doc.metadata}]")
 
@@ -97,6 +104,7 @@ class InMemoryVectorStore(VectorStore):
             def _filter_function(doc: Document) -> bool:
                 return doc.metadata.get("bar") == "baz"
 
+
             results = vector_store.similarity_search(
                 query="thud", k=1, filter=_filter_function
             )
@@ -111,9 +119,7 @@ class InMemoryVectorStore(VectorStore):
     Search with score:
         .. code-block:: python
 
-            results = vector_store.similarity_search_with_score(
-                query="qux", k=1
-            )
+            results = vector_store.similarity_search_with_score(query="qux", k=1)
             for doc, score in results:
                 print(f"* [SIM={score:3f}] {doc.page_content} [{doc.metadata}]")
 
@@ -135,7 +141,7 @@ class InMemoryVectorStore(VectorStore):
 
             # search with score
             results = await vector_store.asimilarity_search_with_score(query="qux", k=1)
-            for doc,score in results:
+            for doc, score in results:
                 print(f"* [SIM={score:3f}] {doc.page_content} [{doc.metadata}]")
 
         .. code-block:: none
@@ -190,7 +196,6 @@ class InMemoryVectorStore(VectorStore):
         ids: Optional[list[str]] = None,
         **kwargs: Any,
     ) -> list[str]:
-        """Add documents to the store."""
         texts = [doc.page_content for doc in documents]
         vectors = self.embedding.embed_documents(texts)
 
@@ -224,7 +229,6 @@ class InMemoryVectorStore(VectorStore):
     async def aadd_documents(
         self, documents: list[Document], ids: Optional[list[str]] = None, **kwargs: Any
     ) -> list[str]:
-        """Add documents to the store."""
         texts = [doc.page_content for doc in documents]
         vectors = await self.embedding.aembed_documents(texts)
 
@@ -372,7 +376,11 @@ class InMemoryVectorStore(VectorStore):
             docs = [
                 doc
                 for doc in docs
-                if filter(Document(page_content=doc["text"], metadata=doc["metadata"]))
+                if filter(
+                    Document(
+                        id=doc["id"], page_content=doc["text"], metadata=doc["metadata"]
+                    )
+                )
             ]
 
         if not docs:
@@ -499,14 +507,12 @@ class InMemoryVectorStore(VectorStore):
             filter=filter,
         )
 
-        try:
-            import numpy as np
-        except ImportError as e:
+        if not _HAS_NUMPY:
             msg = (
                 "numpy must be installed to use max_marginal_relevance_search "
                 "pip install numpy"
             )
-            raise ImportError(msg) from e
+            raise ImportError(msg)
 
         mmr_chosen_indices = maximal_marginal_relevance(
             np.array(embedding, dtype=np.float32),
@@ -597,7 +603,7 @@ class InMemoryVectorStore(VectorStore):
             A VectorStore object.
         """
         path_: Path = Path(path)
-        with path_.open("r") as f:
+        with path_.open("r", encoding="utf-8") as f:
             store = load(json.load(f))
         vectorstore = cls(embedding=embedding, **kwargs)
         vectorstore.store = store
@@ -611,5 +617,5 @@ class InMemoryVectorStore(VectorStore):
         """
         path_: Path = Path(path)
         path_.parent.mkdir(exist_ok=True, parents=True)
-        with path_.open("w") as f:
+        with path_.open("w", encoding="utf-8") as f:
             json.dump(dumpd(self.store), f, indent=2)

langchain_core/vectorstores/utils.py

@@ -10,9 +10,21 @@ import logging
 import warnings
 from typing import TYPE_CHECKING, Union
 
-if TYPE_CHECKING:
+try:
     import numpy as np
 
+    _HAS_NUMPY = True
+except ImportError:
+    _HAS_NUMPY = False
+
+try:
+    import simsimd as simd  # type: ignore[import-not-found]
+
+    _HAS_SIMSIMD = True
+except ImportError:
+    _HAS_SIMSIMD = False
+
+if TYPE_CHECKING:
     Matrix = Union[list[list[float]], list[np.ndarray], np.ndarray]
 
 logger = logging.getLogger(__name__)
@@ -33,14 +45,12 @@ def _cosine_similarity(x: Matrix, y: Matrix) -> np.ndarray:
         ValueError: If the number of columns in X and Y are not the same.
         ImportError: If numpy is not installed.
     """
-    try:
-        import numpy as np
-    except ImportError as e:
+    if not _HAS_NUMPY:
         msg = (
             "cosine_similarity requires numpy to be installed. "
             "Please install numpy with `pip install numpy`."
         )
-        raise ImportError(msg) from e
+        raise ImportError(msg)
 
     if len(x) == 0 or len(y) == 0:
         return np.array([[]])
@@ -70,9 +80,7 @@ def _cosine_similarity(x: Matrix, y: Matrix) -> np.ndarray:
             f"and Y has shape {y.shape}."
         )
         raise ValueError(msg)
-    try:
-        import simsimd as simd  # type: ignore[import-not-found]
-    except ImportError:
+    if not _HAS_SIMSIMD:
         logger.debug(
             "Unable to import simsimd, defaulting to NumPy implementation. If you want "
             "to use simsimd please install with `pip install simsimd`."
@@ -113,14 +121,12 @@ def maximal_marginal_relevance(
     Raises:
         ImportError: If numpy is not installed.
     """
-    try:
-        import numpy as np
-    except ImportError as e:
+    if not _HAS_NUMPY:
         msg = (
             "maximal_marginal_relevance requires numpy to be installed. "
             "Please install numpy with `pip install numpy`."
         )
-        raise ImportError(msg) from e
+        raise ImportError(msg)
 
     if min(k, len(embedding_list)) <= 0:
         return []

langchain_core/version.py

@@ -1,3 +1,3 @@
 """langchain-core version information and utilities."""
 
-VERSION = "1.0.0a1"
+VERSION = "1.0.0a3"

langchain_core-1.0.0a3.dist-info/METADATA

@@ -0,0 +1,77 @@
+Metadata-Version: 2.1
+Name: langchain-core
+Version: 1.0.0a3
+Summary: Building applications with LLMs through composability
+License: MIT
+Project-URL: Source Code, https://github.com/langchain-ai/langchain/tree/master/libs/core
+Project-URL: Release Notes, https://github.com/langchain-ai/langchain/releases?q=tag%3A%22langchain-core%3D%3D0%22&expanded=true
+Project-URL: repository, https://github.com/langchain-ai/langchain
+Requires-Python: >=3.10
+Requires-Dist: langsmith>=0.3.45
+Requires-Dist: tenacity!=8.4.0,<10.0.0,>=8.1.0
+Requires-Dist: jsonpatch<2.0,>=1.33
+Requires-Dist: PyYAML>=5.3
+Requires-Dist: typing-extensions>=4.7
+Requires-Dist: packaging>=23.2
+Requires-Dist: pydantic>=2.7.4
+Description-Content-Type: text/markdown
+
+# 🦜🍎️ LangChain Core
+
+[![PyPI - License](https://img.shields.io/pypi/l/langchain-core?style=flat-square)](https://opensource.org/licenses/MIT)
+[![PyPI - Downloads](https://img.shields.io/pepy/dt/langchain-core)](https://pypistats.org/packages/langchain-core)
+
+## Quick Install
+
+```bash
+pip install langchain-core
+```
+
+## What is it?
+
+LangChain Core contains the base abstractions that power the the LangChain ecosystem.
+
+These abstractions are designed to be as modular and simple as possible.
+
+The benefit of having these abstractions is that any provider can implement the required interface and then easily be used in the rest of the LangChain ecosystem.
+
+For full documentation see the [API reference](https://python.langchain.com/api_reference/core/index.html).
+
+## ⛰️ Why build on top of LangChain Core?
+
+The LangChain ecosystem is built on top of `langchain-core`. Some of the benefits:
+
+- **Modularity**: We've designed Core around abstractions that are independent of each other, and not tied to any specific model provider.
+- **Stability**: We are committed to a stable versioning scheme, and will communicate any breaking changes with advance notice and version bumps.
+- **Battle-tested**: Core components have the largest install base in the LLM ecosystem, and are used in production by many companies.
+
+## 1️⃣ Core Interface: Runnables
+
+The concept of a `Runnable` is central to LangChain Core – it is the interface that most LangChain Core components implement, giving them
+
+- A common invocation interface (`invoke()`, `batch()`, `stream()`, etc.)
+- Built-in utilities for retries, fallbacks, schemas and runtime configurability
+- Easy deployment with [LangGraph](https://github.com/langchain-ai/langgraph)
+
+For more check out the [`Runnable` docs](https://python.langchain.com/docs/concepts/runnables/). Examples of components that implement the interface include: Chat Models, Tools, Retrievers, and Output Parsers.
+
+## 📕 Releases & Versioning
+
+As `langchain-core` contains the base abstractions and runtime for the whole LangChain ecosystem, we will communicate any breaking changes with advance notice and version bumps. The exception for this is anything in `langchain_core.beta`. The reason for `langchain_core.beta` is that given the rate of change of the field, being able to move quickly is still a priority, and this module is our attempt to do so.
+
+Minor version increases will occur for:
+
+- Breaking changes for any public interfaces NOT in `langchain_core.beta`
+
+Patch version increases will occur for:
+
+- Bug fixes
+- New features
+- Any changes to private interfaces
+- Any changes to `langchain_core.beta`
+
+## 💁 Contributing
+
+As an open-source project in a rapidly developing field, we are extremely open to contributions, whether it be in the form of a new feature, improved infrastructure, or better documentation.
+
+For detailed information on how to contribute, see the [Contributing Guide](https://python.langchain.com/docs/contributing/).