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

langchain_core/vectorstores/in_memory.py

@@ -4,17 +4,15 @@ from __future__ import annotations
 
 import json
 import uuid
+from collections.abc import Callable
 from pathlib import Path
 from typing import (
     TYPE_CHECKING,
     Any,
-    Callable,
-    Optional,
 )
 
 from typing_extensions import override
 
-from langchain_core._api import deprecated
 from langchain_core.documents import Document
 from langchain_core.load import dumpd, load
 from langchain_core.vectorstores import VectorStore
@@ -25,7 +23,13 @@ if TYPE_CHECKING:
     from collections.abc import Iterator, Sequence
 
     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):
@@ -34,127 +38,124 @@ class InMemoryVectorStore(VectorStore):
     Uses a dictionary, and computes cosine similarity for search using numpy.
 
     Setup:
-        Install ``langchain-core``.
-
-        .. code-block:: bash
+        Install `langchain-core`.
 
-            pip install -U langchain-core
+        ```bash
+        pip install -U langchain-core
+        ```
 
     Key init args — indexing params:
         embedding_function: Embeddings
             Embedding function to use.
 
     Instantiate:
-        .. code-block:: python
+        ```python
+        from langchain_core.vectorstores import InMemoryVectorStore
+        from langchain_openai import OpenAIEmbeddings
 
-            from langchain_core.vectorstores import InMemoryVectorStore
-            from langchain_openai import OpenAIEmbeddings
-
-            vector_store = InMemoryVectorStore(OpenAIEmbeddings())
+        vector_store = InMemoryVectorStore(OpenAIEmbeddings())
+        ```
 
     Add Documents:
-        .. code-block:: python
-
-            from langchain_core.documents import Document
+        ```python
+        from langchain_core.documents import Document
 
-            document_1 = Document(id="1", page_content="foo", metadata={"baz": "bar"})
-            document_2 = Document(id="2", page_content="thud", metadata={"bar": "baz"})
-            document_3 = Document(id="3", page_content="i will be deleted :(")
+        document_1 = Document(id="1", page_content="foo", metadata={"baz": "bar"})
+        document_2 = Document(id="2", page_content="thud", metadata={"bar": "baz"})
+        document_3 = Document(id="3", page_content="i will be deleted :(")
 
-            documents = [document_1, document_2, document_3]
-            vector_store.add_documents(documents=documents)
+        documents = [document_1, document_2, document_3]
+        vector_store.add_documents(documents=documents)
+        ```
 
     Inspect documents:
-        .. code-block:: python
-
-            top_n = 10
-            for index, (id, doc) in enumerate(vector_store.store.items()):
-                if index < top_n:
-                    # docs have keys 'id', 'vector', 'text', 'metadata'
-                    print(f"{id}: {doc['text']}")
-                else:
-                    break
+        ```python
+        top_n = 10
+        for index, (id, doc) in enumerate(vector_store.store.items()):
+            if index < top_n:
+                # docs have keys 'id', 'vector', 'text', 'metadata'
+                print(f"{id}: {doc['text']}")
+            else:
+                break
+        ```
 
     Delete Documents:
-        .. code-block:: python
-
-            vector_store.delete(ids=["3"])
+        ```python
+        vector_store.delete(ids=["3"])
+        ```
 
     Search:
-        .. code-block:: python
-
-            results = vector_store.similarity_search(query="thud",k=1)
-            for doc in results:
-                print(f"* {doc.page_content} [{doc.metadata}]")
-
-        .. code-block:: none
+        ```python
+        results = vector_store.similarity_search(query="thud", k=1)
+        for doc in results:
+            print(f"* {doc.page_content} [{doc.metadata}]")
+        ```
 
-            * thud [{'bar': 'baz'}]
+        ```txt
+        * thud [{'bar': 'baz'}]
+        ```
 
     Search with filter:
-        .. code-block:: python
+        ```python
+        def _filter_function(doc: Document) -> bool:
+            return doc.metadata.get("bar") == "baz"
 
-            def _filter_function(doc: Document) -> bool:
-                return doc.metadata.get("bar") == "baz"
-
-            results = vector_store.similarity_search(
-                query="thud", k=1, filter=_filter_function
-            )
-            for doc in results:
-                print(f"* {doc.page_content} [{doc.metadata}]")
 
-        .. code-block:: none
-
-            * thud [{'bar': 'baz'}]
+        results = vector_store.similarity_search(
+            query="thud", k=1, filter=_filter_function
+        )
+        for doc in results:
+            print(f"* {doc.page_content} [{doc.metadata}]")
+        ```
 
+        ```txt
+        * thud [{'bar': 'baz'}]
+        ```
 
     Search with score:
-        .. code-block:: python
-
-            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}]")
-
-        .. code-block:: none
+        ```python
+        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}]")
+        ```
 
-            * [SIM=0.832268] foo [{'baz': 'bar'}]
+        ```txt
+        * [SIM=0.832268] foo [{'baz': 'bar'}]
+        ```
 
     Async:
-        .. code-block:: python
+        ```python
+        # add documents
+        # await vector_store.aadd_documents(documents=documents)
 
-            # add documents
-            # await vector_store.aadd_documents(documents=documents)
+        # delete documents
+        # await vector_store.adelete(ids=["3"])
 
-            # delete documents
-            # await vector_store.adelete(ids=["3"])
+        # search
+        # results = vector_store.asimilarity_search(query="thud", k=1)
 
-            # search
-            # results = vector_store.asimilarity_search(query="thud", k=1)
+        # search with score
+        results = await vector_store.asimilarity_search_with_score(query="qux", k=1)
+        for doc, score in results:
+            print(f"* [SIM={score:3f}] {doc.page_content} [{doc.metadata}]")
+        ```
 
-            # search with score
-            results = await vector_store.asimilarity_search_with_score(query="qux", k=1)
-            for doc,score in results:
-                print(f"* [SIM={score:3f}] {doc.page_content} [{doc.metadata}]")
-
-        .. code-block:: none
-
-            * [SIM=0.832268] foo [{'baz': 'bar'}]
+        ```txt
+        * [SIM=0.832268] foo [{'baz': 'bar'}]
+        ```
 
     Use as Retriever:
-        .. code-block:: python
-
-            retriever = vector_store.as_retriever(
-                search_type="mmr",
-                search_kwargs={"k": 1, "fetch_k": 2, "lambda_mult": 0.5},
-            )
-            retriever.invoke("thud")
-
-        .. code-block:: none
-
-            [Document(id='2', metadata={'bar': 'baz'}, page_content='thud')]
+        ```python
+        retriever = vector_store.as_retriever(
+            search_type="mmr",
+            search_kwargs={"k": 1, "fetch_k": 2, "lambda_mult": 0.5},
+        )
+        retriever.invoke("thud")
+        ```
 
+        ```txt
+        [Document(id='2', metadata={'bar': 'baz'}, page_content='thud')]
+        ```
     """
 
     def __init__(self, embedding: Embeddings) -> None:
@@ -174,23 +175,22 @@ class InMemoryVectorStore(VectorStore):
         return self.embedding
 
     @override
-    def delete(self, ids: Optional[Sequence[str]] = None, **kwargs: Any) -> None:
+    def delete(self, ids: Sequence[str] | None = None, **kwargs: Any) -> None:
         if ids:
             for _id in ids:
                 self.store.pop(_id, None)
 
     @override
-    async def adelete(self, ids: Optional[Sequence[str]] = None, **kwargs: Any) -> None:
+    async def adelete(self, ids: Sequence[str] | None = None, **kwargs: Any) -> None:
         self.delete(ids)
 
     @override
     def add_documents(
         self,
         documents: list[Document],
-        ids: Optional[list[str]] = None,
+        ids: list[str] | None = None,
         **kwargs: Any,
     ) -> list[str]:
-        """Add documents to the store."""
         texts = [doc.page_content for doc in documents]
         vectors = self.embedding.embed_documents(texts)
 
@@ -201,13 +201,13 @@ class InMemoryVectorStore(VectorStore):
             )
             raise ValueError(msg)
 
-        id_iterator: Iterator[Optional[str]] = (
+        id_iterator: Iterator[str | None] = (
             iter(ids) if ids else iter(doc.id for doc in documents)
         )
 
         ids_ = []
 
-        for doc, vector in zip(documents, vectors):
+        for doc, vector in zip(documents, vectors, strict=False):
             doc_id = next(id_iterator)
             doc_id_ = doc_id or str(uuid.uuid4())
             ids_.append(doc_id_)
@@ -222,9 +222,8 @@ class InMemoryVectorStore(VectorStore):
 
     @override
     async def aadd_documents(
-        self, documents: list[Document], ids: Optional[list[str]] = None, **kwargs: Any
+        self, documents: list[Document], ids: list[str] | None = 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)
 
@@ -235,12 +234,12 @@ class InMemoryVectorStore(VectorStore):
             )
             raise ValueError(msg)
 
-        id_iterator: Iterator[Optional[str]] = (
+        id_iterator: Iterator[str | None] = (
             iter(ids) if ids else iter(doc.id for doc in documents)
         )
         ids_: list[str] = []
 
-        for doc, vector in zip(documents, vectors):
+        for doc, vector in zip(documents, vectors, strict=False):
             doc_id = next(id_iterator)
             doc_id_ = doc_id or str(uuid.uuid4())
             ids_.append(doc_id_)
@@ -277,76 +276,6 @@ class InMemoryVectorStore(VectorStore):
                 )
         return documents
 
-    @deprecated(
-        alternative="VectorStore.add_documents",
-        message=(
-            "This was a beta API that was added in 0.2.11. It'll be removed in 0.3.0."
-        ),
-        since="0.2.29",
-        removal="1.0",
-    )
-    def upsert(self, items: Sequence[Document], /, **_kwargs: Any) -> UpsertResponse:
-        """[DEPRECATED] Upsert documents into the store.
-
-        Args:
-            items: The documents to upsert.
-
-        Returns:
-            The upsert response.
-        """
-        vectors = self.embedding.embed_documents([item.page_content for item in items])
-        ids = []
-        for item, vector in zip(items, vectors):
-            doc_id = item.id or str(uuid.uuid4())
-            ids.append(doc_id)
-            self.store[doc_id] = {
-                "id": doc_id,
-                "vector": vector,
-                "text": item.page_content,
-                "metadata": item.metadata,
-            }
-        return {
-            "succeeded": ids,
-            "failed": [],
-        }
-
-    @deprecated(
-        alternative="VectorStore.aadd_documents",
-        message=(
-            "This was a beta API that was added in 0.2.11. It'll be removed in 0.3.0."
-        ),
-        since="0.2.29",
-        removal="1.0",
-    )
-    async def aupsert(
-        self, items: Sequence[Document], /, **_kwargs: Any
-    ) -> UpsertResponse:
-        """[DEPRECATED] Upsert documents into the store.
-
-        Args:
-            items: The documents to upsert.
-
-        Returns:
-            The upsert response.
-        """
-        vectors = await self.embedding.aembed_documents(
-            [item.page_content for item in items]
-        )
-        ids = []
-        for item, vector in zip(items, vectors):
-            doc_id = item.id or str(uuid.uuid4())
-            ids.append(doc_id)
-            self.store[doc_id] = {
-                "id": doc_id,
-                "vector": vector,
-                "text": item.page_content,
-                "metadata": item.metadata,
-            }
-        return {
-            "succeeded": ids,
-            "failed": [],
-        }
-
     @override
     async def aget_by_ids(self, ids: Sequence[str], /) -> list[Document]:
         """Async get documents by their ids.
@@ -363,7 +292,7 @@ class InMemoryVectorStore(VectorStore):
         self,
         embedding: list[float],
         k: int = 4,
-        filter: Optional[Callable[[Document], bool]] = None,  # noqa: A002
+        filter: Callable[[Document], bool] | None = None,  # noqa: A002
     ) -> list[tuple[Document, float, list[float]]]:
         # get all docs with fixed order in list
         docs = list(self.store.values())
@@ -372,7 +301,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:
@@ -402,7 +335,7 @@ class InMemoryVectorStore(VectorStore):
         self,
         embedding: list[float],
         k: int = 4,
-        filter: Optional[Callable[[Document], bool]] = None,  # noqa: A002
+        filter: Callable[[Document], bool] | None = None,  # noqa: A002
         **_kwargs: Any,
     ) -> list[tuple[Document, float]]:
         """Search for the most similar documents to the given embedding.
@@ -490,7 +423,7 @@ class InMemoryVectorStore(VectorStore):
         fetch_k: int = 20,
         lambda_mult: float = 0.5,
         *,
-        filter: Optional[Callable[[Document], bool]] = None,
+        filter: Callable[[Document], bool] | None = None,
         **kwargs: Any,
     ) -> list[Document]:
         prefetch_hits = self._similarity_search_with_score_by_vector(
@@ -499,14 +432,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),
@@ -558,7 +489,7 @@ class InMemoryVectorStore(VectorStore):
         cls,
         texts: list[str],
         embedding: Embeddings,
-        metadatas: Optional[list[dict]] = None,
+        metadatas: list[dict] | None = None,
         **kwargs: Any,
     ) -> InMemoryVectorStore:
         store = cls(
@@ -573,7 +504,7 @@ class InMemoryVectorStore(VectorStore):
         cls,
         texts: list[str],
         embedding: Embeddings,
-        metadatas: Optional[list[dict]] = None,
+        metadatas: list[dict] | None = None,
         **kwargs: Any,
     ) -> InMemoryVectorStore:
         store = cls(
@@ -591,13 +522,13 @@ class InMemoryVectorStore(VectorStore):
         Args:
             path: The path to load the vector store from.
             embedding: The embedding to use.
-            kwargs: Additional arguments to pass to the constructor.
+            **kwargs: Additional arguments to pass to the constructor.
 
         Returns:
             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 +542,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

@@ -1,4 +1,4 @@
-"""Internal utilities for the in memory implementation of VectorStore.
+"""Internal utilities for the in memory implementation of `VectorStore`.
 
 These are part of a private API, and users should not use them directly
 as they can change without notice.
@@ -8,12 +8,24 @@ from __future__ import annotations
 
 import logging
 import warnings
-from typing import TYPE_CHECKING, Union
+from typing import TYPE_CHECKING
 
-if TYPE_CHECKING:
+try:
     import numpy as np
 
-    Matrix = Union[list[list[float]], list[np.ndarray], np.ndarray]
+    _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 = 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`."
@@ -104,8 +112,8 @@ def maximal_marginal_relevance(
     Args:
         query_embedding: The query embedding.
         embedding_list: A list of embeddings.
-        lambda_mult: The lambda parameter for MMR. Default is 0.5.
-        k: The number of embeddings to return. Default is 4.
+        lambda_mult: The lambda parameter for MMR.
+        k: The number of embeddings to return.
 
     Returns:
         A list of indices of the embeddings to return.
@@ -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 = "0.4.0.dev0"
+VERSION = "1.0.0"

langchain_core-1.0.0.dist-info/METADATA

@@ -0,0 +1,68 @@
+Metadata-Version: 2.4
+Name: langchain-core
+Version: 1.0.0
+Summary: Building applications with LLMs through composability
+Project-URL: homepage, https://docs.langchain.com/
+Project-URL: repository, https://github.com/langchain-ai/langchain/tree/master/libs/core
+Project-URL: changelog, https://github.com/langchain-ai/langchain/releases?q=%22langchain-core%3D%3D1%22
+Project-URL: twitter, https://x.com/LangChainAI
+Project-URL: slack, https://www.langchain.com/join-community
+Project-URL: reddit, https://www.reddit.com/r/LangChain/
+License: MIT
+Requires-Python: <4.0.0,>=3.10.0
+Requires-Dist: jsonpatch<2.0.0,>=1.33.0
+Requires-Dist: langsmith<1.0.0,>=0.3.45
+Requires-Dist: packaging<26.0.0,>=23.2.0
+Requires-Dist: pydantic<3.0.0,>=2.7.4
+Requires-Dist: pyyaml<7.0.0,>=5.3.0
+Requires-Dist: tenacity!=8.4.0,<10.0.0,>=8.1.0
+Requires-Dist: typing-extensions<5.0.0,>=4.7.0
+Description-Content-Type: text/markdown
+
+# 🦜🍎️ LangChain Core
+
+[![PyPI - Version](https://img.shields.io/pypi/v/langchain-core?label=%20)](https://pypi.org/project/langchain-core/#history)
+[![PyPI - License](https://img.shields.io/pypi/l/langchain-core)](https://opensource.org/licenses/MIT)
+[![PyPI - Downloads](https://img.shields.io/pepy/dt/langchain-core)](https://pypistats.org/packages/langchain-core)
+[![Twitter](https://img.shields.io/twitter/url/https/twitter.com/langchainai.svg?style=social&label=Follow%20%40LangChainAI)](https://twitter.com/langchainai)
+
+Looking for the JS/TS version? Check out [LangChain.js](https://github.com/langchain-ai/langchainjs).
+
+To help you ship LangChain apps to production faster, check out [LangSmith](https://smith.langchain.com).
+[LangSmith](https://smith.langchain.com) is a unified developer platform for building, testing, and monitoring LLM applications.
+
+## Quick Install
+
+```bash
+pip install langchain-core
+```
+
+## 🤔 What is this?
+
+LangChain Core contains the base abstractions that power 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.
+
+## ⛰️ 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.
+
+## 📖 Documentation
+
+For full documentation, see the [API reference](https://reference.langchain.com/python/langchain_core/).
+
+## 📕 Releases & Versioning
+
+See our [Releases](https://docs.langchain.com/oss/python/release-policy) and [Versioning](https://docs.langchain.com/oss/python/versioning) policies.
+
+## 💁 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://docs.langchain.com/oss/python/contributing/overview).