langchain-core 1.0.0a8__py3-none-any.whl → 1.0.0rc2__py3-none-any.whl

langchain_core/vectorstores/base.py

@@ -3,21 +3,7 @@
 One of the most common ways to store and search over unstructured data is to
 embed it and store the resulting embedding vectors, and then query the store
 and retrieve the data that are 'most similar' to the embedded query.
-
-**Class hierarchy:**
-
-.. code-block::
-
-    VectorStore --> <name>  # Examples: Annoy, FAISS, Milvus
-
-    BaseRetriever --> VectorStoreRetriever --> <name>Retriever  # Example: VespaRetriever
-
-**Main helpers:**
-
-.. code-block::
-
-    Embeddings, Document
-"""  # noqa: E501
+"""
 
 from __future__ import annotations
 
@@ -123,12 +109,11 @@ class VectorStore(ABC):
         """Delete by vector ID or other criteria.
 
         Args:
-            ids: List of ids to delete. If None, delete all. Default is None.
+            ids: List of ids to delete. If `None`, delete all.
             **kwargs: Other keyword arguments that subclasses might use.
 
         Returns:
-            Optional[bool]: True if deletion is successful,
-            False otherwise, None if not implemented.
+            True if deletion is successful, False otherwise, None if not implemented.
         """
         msg = "delete method must be implemented by subclass."
         raise NotImplementedError(msg)
@@ -191,12 +176,11 @@ class VectorStore(ABC):
         """Async delete by vector ID or other criteria.
 
         Args:
-            ids: List of ids to delete. If None, delete all. Default is None.
+            ids: List of ids to delete. If `None`, delete all.
             **kwargs: Other keyword arguments that subclasses might use.
 
         Returns:
-            Optional[bool]: True if deletion is successful,
-            False otherwise, None if not implemented.
+            True if deletion is successful, False otherwise, None if not implemented.
         """
         return await run_in_executor(None, self.delete, ids, **kwargs)
 
@@ -213,7 +197,6 @@ class VectorStore(ABC):
         Args:
             texts: Iterable of strings to add to the vectorstore.
             metadatas: Optional list of metadatas associated with the texts.
-                Default is None.
             ids: Optional list
             **kwargs: vectorstore specific parameters.
 
@@ -255,7 +238,7 @@ class VectorStore(ABC):
 
         Args:
             documents: Documents to add to the vectorstore.
-            kwargs: Additional keyword arguments.
+            **kwargs: Additional keyword arguments.
                 if kwargs contains ids and documents contain ids,
                 the ids in the kwargs will receive precedence.
 
@@ -287,7 +270,7 @@ class VectorStore(ABC):
 
         Args:
             documents: Documents to add to the vectorstore.
-            kwargs: Additional keyword arguments.
+            **kwargs: Additional keyword arguments.
 
         Returns:
             List of IDs of the added texts.
@@ -381,7 +364,7 @@ class VectorStore(ABC):
 
         Args:
             query: Input text.
-            k: Number of Documents to return. Defaults to 4.
+            k: Number of Documents to return.
             **kwargs: Arguments to pass to the search method.
 
         Returns:
@@ -478,7 +461,7 @@ class VectorStore(ABC):
 
         Args:
             query: Input text.
-            k: Number of Documents to return. Defaults to 4.
+            k: Number of Documents to return.
             **kwargs: kwargs to be passed to similarity search. Should include:
                 score_threshold: Optional, a floating point value between 0 to 1 to
                     filter the resulting set of retrieved docs
@@ -505,7 +488,7 @@ class VectorStore(ABC):
 
         Args:
             query: Input text.
-            k: Number of Documents to return. Defaults to 4.
+            k: Number of Documents to return.
             **kwargs: kwargs to be passed to similarity search. Should include:
                 score_threshold: Optional, a floating point value between 0 to 1 to
                     filter the resulting set of retrieved docs
@@ -529,7 +512,7 @@ class VectorStore(ABC):
 
         Args:
             query: Input text.
-            k: Number of Documents to return. Defaults to 4.
+            k: Number of Documents to return.
             **kwargs: kwargs to be passed to similarity search. Should include:
                 score_threshold: Optional, a floating point value between 0 to 1 to
                     filter the resulting set of retrieved docs.
@@ -578,7 +561,7 @@ class VectorStore(ABC):
 
         Args:
             query: Input text.
-            k: Number of Documents to return. Defaults to 4.
+            k: Number of Documents to return.
             **kwargs: kwargs to be passed to similarity search. Should include:
                 score_threshold: Optional, a floating point value between 0 to 1 to
                     filter the resulting set of retrieved docs
@@ -622,7 +605,7 @@ class VectorStore(ABC):
 
         Args:
             query: Input text.
-            k: Number of Documents to return. Defaults to 4.
+            k: Number of Documents to return.
             **kwargs: Arguments to pass to the search method.
 
         Returns:
@@ -640,7 +623,7 @@ class VectorStore(ABC):
 
         Args:
             embedding: Embedding to look up documents similar to.
-            k: Number of Documents to return. Defaults to 4.
+            k: Number of Documents to return.
             **kwargs: Arguments to pass to the search method.
 
         Returns:
@@ -655,7 +638,7 @@ class VectorStore(ABC):
 
         Args:
             embedding: Embedding to look up documents similar to.
-            k: Number of Documents to return. Defaults to 4.
+            k: Number of Documents to return.
             **kwargs: Arguments to pass to the search method.
 
         Returns:
@@ -683,13 +666,11 @@ class VectorStore(ABC):
 
         Args:
             query: Text to look up documents similar to.
-            k: Number of Documents to return. Defaults to 4.
+            k: Number of Documents to return.
             fetch_k: Number of Documents to fetch to pass to MMR algorithm.
-                Default is 20.
             lambda_mult: Number between 0 and 1 that determines the degree
                 of diversity among the results with 0 corresponding
                 to maximum diversity and 1 to minimum diversity.
-                Defaults to 0.5.
             **kwargs: Arguments to pass to the search method.
 
         Returns:
@@ -712,13 +693,11 @@ class VectorStore(ABC):
 
         Args:
             query: Text to look up documents similar to.
-            k: Number of Documents to return. Defaults to 4.
+            k: Number of Documents to return.
             fetch_k: Number of Documents to fetch to pass to MMR algorithm.
-                Default is 20.
             lambda_mult: Number between 0 and 1 that determines the degree
                 of diversity among the results with 0 corresponding
                 to maximum diversity and 1 to minimum diversity.
-                Defaults to 0.5.
             **kwargs: Arguments to pass to the search method.
 
         Returns:
@@ -752,13 +731,11 @@ class VectorStore(ABC):
 
         Args:
             embedding: Embedding to look up documents similar to.
-            k: Number of Documents to return. Defaults to 4.
+            k: Number of Documents to return.
             fetch_k: Number of Documents to fetch to pass to MMR algorithm.
-                Default is 20.
             lambda_mult: Number between 0 and 1 that determines the degree
                 of diversity among the results with 0 corresponding
                 to maximum diversity and 1 to minimum diversity.
-                Defaults to 0.5.
             **kwargs: Arguments to pass to the search method.
 
         Returns:
@@ -781,13 +758,11 @@ class VectorStore(ABC):
 
         Args:
             embedding: Embedding to look up documents similar to.
-            k: Number of Documents to return. Defaults to 4.
+            k: Number of Documents to return.
             fetch_k: Number of Documents to fetch to pass to MMR algorithm.
-                Default is 20.
             lambda_mult: Number between 0 and 1 that determines the degree
                 of diversity among the results with 0 corresponding
                 to maximum diversity and 1 to minimum diversity.
-                Defaults to 0.5.
             **kwargs: Arguments to pass to the search method.
 
         Returns:
@@ -815,10 +790,10 @@ class VectorStore(ABC):
         Args:
             documents: List of Documents to add to the vectorstore.
             embedding: Embedding function to use.
-            kwargs: Additional keyword arguments.
+            **kwargs: Additional keyword arguments.
 
         Returns:
-            VectorStore: VectorStore initialized from documents and embeddings.
+            VectorStore initialized from documents and embeddings.
         """
         texts = [d.page_content for d in documents]
         metadatas = [d.metadata for d in documents]
@@ -845,10 +820,10 @@ class VectorStore(ABC):
         Args:
             documents: List of Documents to add to the vectorstore.
             embedding: Embedding function to use.
-            kwargs: Additional keyword arguments.
+            **kwargs: Additional keyword arguments.
 
         Returns:
-            VectorStore: VectorStore initialized from documents and embeddings.
+            VectorStore initialized from documents and embeddings.
         """
         texts = [d.page_content for d in documents]
         metadatas = [d.metadata for d in documents]
@@ -880,12 +855,11 @@ class VectorStore(ABC):
             texts: Texts to add to the vectorstore.
             embedding: Embedding function to use.
             metadatas: Optional list of metadatas associated with the texts.
-                Default is None.
             ids: Optional list of IDs associated with the texts.
-            kwargs: Additional keyword arguments.
+            **kwargs: Additional keyword arguments.
 
         Returns:
-            VectorStore: VectorStore initialized from texts and embeddings.
+            VectorStore initialized from texts and embeddings.
         """
 
     @classmethod
@@ -904,12 +878,11 @@ class VectorStore(ABC):
             texts: Texts to add to the vectorstore.
             embedding: Embedding function to use.
             metadatas: Optional list of metadatas associated with the texts.
-                Default is None.
             ids: Optional list of IDs associated with the texts.
-            kwargs: Additional keyword arguments.
+            **kwargs: Additional keyword arguments.
 
         Returns:
-            VectorStore: VectorStore initialized from texts and embeddings.
+            VectorStore initialized from texts and embeddings.
         """
         if ids is not None:
             kwargs["ids"] = ids
@@ -930,12 +903,11 @@ class VectorStore(ABC):
         Args:
             **kwargs: Keyword arguments to pass to the search function.
                 Can include:
-                search_type (Optional[str]): Defines the type of search that
-                    the Retriever should perform.
-                    Can be "similarity" (default), "mmr", or
+                search_type: Defines the type of search that the Retriever should
+                    perform. Can be "similarity" (default), "mmr", or
                     "similarity_score_threshold".
-                search_kwargs (Optional[Dict]): Keyword arguments to pass to the
-                    search function. Can include things like:
+                search_kwargs: Keyword arguments to pass to the search function. Can
+                    include things like:
                         k: Amount of documents to return (Default: 4)
                         score_threshold: Minimum relevance threshold
                             for similarity_score_threshold
@@ -946,39 +918,35 @@ class VectorStore(ABC):
                         filter: Filter by document metadata
 
         Returns:
-            VectorStoreRetriever: Retriever class for VectorStore.
+            Retriever class for VectorStore.
 
         Examples:
+        ```python
+        # 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}
+        )
 
-        .. code-block:: python
-
-            # 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}
-            )
-
-            # 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}
-            )
-
-            # 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},
-            )
+        # 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})
 
-            # Only get the single most similar document from the dataset
-            docsearch.as_retriever(search_kwargs={"k": 1})
+        # 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},
+        )
 
-            # Use a filter to only retrieve documents from a specific paper
-            docsearch.as_retriever(
-                search_kwargs={"filter": {"paper_title": "GPT-4 Technical Report"}}
-            )
+        # Only get the single most similar document from the dataset
+        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"}}
+        )
+        ```
         """
         tags = kwargs.pop("tags", None) or [*self._get_retriever_tags()]
         return VectorStoreRetriever(vectorstore=self, tags=tags, **kwargs)
@@ -1012,7 +980,7 @@ class VectorStoreRetriever(BaseRetriever):
             values: Values to validate.
 
         Returns:
-            Values: Validated values.
+            Validated values.
 
         Raises:
             ValueError: If search_type is not one of the allowed search types.

langchain_core/vectorstores/in_memory.py

@@ -38,126 +38,124 @@ class InMemoryVectorStore(VectorStore):
     Uses a dictionary, and computes cosine similarity for search using numpy.
 
     Setup:
-        Install ``langchain-core``.
+        Install `langchain-core`.
 
-        .. code-block:: bash
-
-            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
-
-            from langchain_core.vectorstores import InMemoryVectorStore
-            from langchain_openai import OpenAIEmbeddings
+        ```python
+        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}]")
+        ```python
+        results = vector_store.similarity_search(query="thud", k=1)
+        for doc in results:
+            print(f"* {doc.page_content} [{doc.metadata}]")
+        ```
 
-        .. code-block::
-
-            * thud [{'bar': 'baz'}]
+        ```txt
+        * thud [{'bar': 'baz'}]
+        ```
 
     Search with filter:
-        .. code-block:: python
-
-            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}]")
+        ```python
+        def _filter_function(doc: Document) -> bool:
+            return doc.metadata.get("bar") == "baz"
 
-        .. code-block::
 
-            * 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::
+        ```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
-
-            # add documents
-            # await vector_store.aadd_documents(documents=documents)
-
-            # delete documents
-            # await vector_store.adelete(ids=["3"])
+        ```python
+        # add documents
+        # await vector_store.aadd_documents(documents=documents)
 
-            # search
-            # results = vector_store.asimilarity_search(query="thud", k=1)
+        # delete documents
+        # await vector_store.adelete(ids=["3"])
 
-            # 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
+        # results = vector_store.asimilarity_search(query="thud", k=1)
 
-        .. code-block::
+        # 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}]")
+        ```
 
-            * [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::
-
-            [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:
@@ -524,7 +522,7 @@ 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.

langchain_core/vectorstores/utils.py

@@ -112,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.

langchain_core/version.py

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

{langchain_core-1.0.0a8.dist-info → langchain_core-1.0.0rc2.dist-info}/METADATA

@@ -1,10 +1,13 @@
 Metadata-Version: 2.4
 Name: langchain-core
-Version: 1.0.0a8
+Version: 1.0.0rc2
 Summary: Building applications with LLMs through composability
-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
+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
@@ -18,8 +21,15 @@ 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 - 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
 
@@ -27,16 +37,14 @@ Description-Content-Type: text/markdown
 pip install langchain-core
 ```
 
-## What is it?
+## 🤔 What is this?
 
-LangChain Core contains the base abstractions that power the the LangChain ecosystem.
+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.
 
-For full documentation see the [API reference](https://reference.langchain.com/python/).
-
 ## ⛰️ Why build on top of LangChain Core?
 
 The LangChain ecosystem is built on top of `langchain-core`. Some of the benefits:
@@ -45,12 +53,16 @@ The LangChain ecosystem is built on top of `langchain-core`. Some of the benefit
 - **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 Policy](https://docs.langchain.com/oss/python/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).
+For detailed information on how to contribute, see the [Contributing Guide](https://docs.langchain.com/oss/python/contributing/overview).