langchain-core 1.0.0rc3__py3-none-any.whl → 1.0.2__py3-none-any.whl

langchain_core/vectorstores/base.py

@@ -52,22 +52,22 @@ class VectorStore(ABC):
         ids: list[str] | None = None,
         **kwargs: Any,
     ) -> list[str]:
-        """Run more texts through the embeddings and add to the vectorstore.
+        """Run more texts through the embeddings and add to the `VectorStore`.
 
         Args:
-            texts: Iterable of strings to add to the vectorstore.
+            texts: Iterable of strings to add to the `VectorStore`.
             metadatas: Optional list of metadatas associated with the texts.
             ids: Optional list of IDs associated with the texts.
-            **kwargs: vectorstore specific parameters.
+            **kwargs: `VectorStore` specific parameters.
                 One of the kwargs should be `ids` which is a list of ids
                 associated with the texts.
 
         Returns:
-            List of ids from adding the texts into the vectorstore.
+            List of IDs from adding the texts into the `VectorStore`.
 
         Raises:
             ValueError: If the number of metadatas does not match the number of texts.
-            ValueError: If the number of ids does not match the number of texts.
+            ValueError: If the number of IDs does not match the number of texts.
         """
         if type(self).add_documents != VectorStore.add_documents:
             # This condition is triggered if the subclass has provided
@@ -109,11 +109,12 @@ class VectorStore(ABC):
         """Delete by vector ID or other criteria.
 
         Args:
-            ids: List of ids to delete. If `None`, delete all.
+            ids: List of IDs to delete. If `None`, delete all.
             **kwargs: Other keyword arguments that subclasses might use.
 
         Returns:
-            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)
@@ -135,12 +136,10 @@ class VectorStore(ABC):
         some IDs.
 
         Args:
-            ids: List of ids to retrieve.
+            ids: List of IDs to retrieve.
 
         Returns:
-            List of Documents.
-
-        !!! version-added "Added in version 0.2.11"
+            List of `Document` objects.
         """
         msg = f"{self.__class__.__name__} does not yet support get_by_ids."
         raise NotImplementedError(msg)
@@ -163,12 +162,10 @@ class VectorStore(ABC):
         some IDs.
 
         Args:
-            ids: List of ids to retrieve.
+            ids: List of IDs to retrieve.
 
         Returns:
-            List of Documents.
-
-        !!! version-added "Added in version 0.2.11"
+            List of `Document` objects.
         """
         return await run_in_executor(None, self.get_by_ids, ids)
 
@@ -176,11 +173,12 @@ class VectorStore(ABC):
         """Async delete by vector ID or other criteria.
 
         Args:
-            ids: List of ids to delete. If `None`, delete all.
+            ids: List of IDs to delete. If `None`, delete all.
             **kwargs: Other keyword arguments that subclasses might use.
 
         Returns:
-            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)
 
@@ -192,20 +190,20 @@ class VectorStore(ABC):
         ids: list[str] | None = None,
         **kwargs: Any,
     ) -> list[str]:
-        """Async run more texts through the embeddings and add to the vectorstore.
+        """Async run more texts through the embeddings and add to the `VectorStore`.
 
         Args:
-            texts: Iterable of strings to add to the vectorstore.
+            texts: Iterable of strings to add to the `VectorStore`.
             metadatas: Optional list of metadatas associated with the texts.
             ids: Optional list
-            **kwargs: vectorstore specific parameters.
+            **kwargs: `VectorStore` specific parameters.
 
         Returns:
-            List of ids from adding the texts into the vectorstore.
+            List of IDs from adding the texts into the `VectorStore`.
 
         Raises:
             ValueError: If the number of metadatas does not match the number of texts.
-            ValueError: If the number of ids does not match the number of texts.
+            ValueError: If the number of IDs does not match the number of texts.
         """
         if ids is not None:
             # For backward compatibility
@@ -234,13 +232,13 @@ class VectorStore(ABC):
         return await run_in_executor(None, self.add_texts, texts, metadatas, **kwargs)
 
     def add_documents(self, documents: list[Document], **kwargs: Any) -> list[str]:
-        """Add or update documents in the vectorstore.
+        """Add or update documents in the `VectorStore`.
 
         Args:
-            documents: Documents to add to the vectorstore.
+            documents: Documents to add to the `VectorStore`.
             **kwargs: Additional keyword arguments.
-                if kwargs contains ids and documents contain ids,
-                the ids in the kwargs will receive precedence.
+                if kwargs contains IDs and documents contain ids,
+                the IDs in the kwargs will receive precedence.
 
         Returns:
             List of IDs of the added texts.
@@ -266,10 +264,10 @@ class VectorStore(ABC):
     async def aadd_documents(
         self, documents: list[Document], **kwargs: Any
     ) -> list[str]:
-        """Async run more documents through the embeddings and add to the vectorstore.
+        """Async run more documents through the embeddings and add to the `VectorStore`.
 
         Args:
-            documents: Documents to add to the vectorstore.
+            documents: Documents to add to the `VectorStore`.
             **kwargs: Additional keyword arguments.
 
         Returns:
@@ -295,17 +293,17 @@ class VectorStore(ABC):
         """Return docs most similar to query using a specified search type.
 
         Args:
-            query: Input text
-            search_type: Type of search to perform. Can be "similarity",
-                "mmr", or "similarity_score_threshold".
+            query: Input text.
+            search_type: Type of search to perform. Can be `'similarity'`, `'mmr'`, or
+                `'similarity_score_threshold'`.
             **kwargs: Arguments to pass to the search method.
 
         Returns:
-            List of Documents most similar to the query.
+            List of `Document` objects most similar to the query.
 
         Raises:
-            ValueError: If search_type is not one of "similarity",
-                "mmr", or "similarity_score_threshold".
+            ValueError: If `search_type` is not one of `'similarity'`,
+                `'mmr'`, or `'similarity_score_threshold'`.
         """
         if search_type == "similarity":
             return self.similarity_search(query, **kwargs)
@@ -330,16 +328,16 @@ class VectorStore(ABC):
 
         Args:
             query: Input text.
-            search_type: Type of search to perform. Can be "similarity",
-                "mmr", or "similarity_score_threshold".
+            search_type: Type of search to perform. Can be `'similarity'`, `'mmr'`, or
+                `'similarity_score_threshold'`.
             **kwargs: Arguments to pass to the search method.
 
         Returns:
-            List of Documents most similar to the query.
+            List of `Document` objects most similar to the query.
 
         Raises:
-            ValueError: If search_type is not one of "similarity",
-                "mmr", or "similarity_score_threshold".
+            ValueError: If `search_type` is not one of `'similarity'`,
+                `'mmr'`, or `'similarity_score_threshold'`.
         """
         if search_type == "similarity":
             return await self.asimilarity_search(query, **kwargs)
@@ -364,11 +362,11 @@ class VectorStore(ABC):
 
         Args:
             query: Input text.
-            k: Number of Documents to return.
+            k: Number of `Document` objects to return.
             **kwargs: Arguments to pass to the search method.
 
         Returns:
-            List of Documents most similar to the query.
+            List of `Document` objects most similar to the query.
         """
 
     @staticmethod
@@ -423,7 +421,7 @@ class VectorStore(ABC):
             **kwargs: Arguments to pass to the search method.
 
         Returns:
-            List of Tuples of (doc, similarity_score).
+            List of Tuples of `(doc, similarity_score)`.
         """
         raise NotImplementedError
 
@@ -437,7 +435,7 @@ class VectorStore(ABC):
             **kwargs: Arguments to pass to the search method.
 
         Returns:
-            List of Tuples of (doc, similarity_score).
+            List of Tuples of `(doc, similarity_score)`.
         """
         # This is a temporary workaround to make the similarity search
         # asynchronous. The proper solution is to make the similarity search
@@ -455,19 +453,19 @@ class VectorStore(ABC):
         """Default similarity search with relevance scores.
 
         Modify if necessary in subclass.
-        Return docs and relevance scores in the range [0, 1].
+        Return docs and relevance scores in the range `[0, 1]`.
 
-        0 is dissimilar, 1 is most similar.
+        `0` is dissimilar, `1` is most similar.
 
         Args:
             query: Input text.
-            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
+            k: Number of `Document` objects to return.
+            **kwargs: kwargs to be passed to similarity search. Should include
+                `score_threshold`, An optional floating point value between `0` to `1`
+                to filter the resulting set of retrieved docs
 
         Returns:
-            List of Tuples of (doc, similarity_score)
+            List of Tuples of `(doc, similarity_score)`
         """
         relevance_score_fn = self._select_relevance_score_fn()
         docs_and_scores = self.similarity_search_with_score(query, k, **kwargs)
@@ -482,19 +480,19 @@ class VectorStore(ABC):
         """Default similarity search with relevance scores.
 
         Modify if necessary in subclass.
-        Return docs and relevance scores in the range [0, 1].
+        Return docs and relevance scores in the range `[0, 1]`.
 
-        0 is dissimilar, 1 is most similar.
+        `0` is dissimilar, `1` is most similar.
 
         Args:
             query: Input text.
-            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
+            k: Number of `Document` objects to return.
+            **kwargs: kwargs to be passed to similarity search. Should include
+                `score_threshold`, An optional floating point value between `0` to `1`
+                to filter the resulting set of retrieved docs
 
         Returns:
-            List of Tuples of (doc, similarity_score)
+            List of Tuples of `(doc, similarity_score)`
         """
         relevance_score_fn = self._select_relevance_score_fn()
         docs_and_scores = await self.asimilarity_search_with_score(query, k, **kwargs)
@@ -506,19 +504,19 @@ class VectorStore(ABC):
         k: int = 4,
         **kwargs: Any,
     ) -> list[tuple[Document, float]]:
-        """Return docs and relevance scores in the range [0, 1].
+        """Return docs and relevance scores in the range `[0, 1]`.
 
-        0 is dissimilar, 1 is most similar.
+        `0` is dissimilar, `1` is most similar.
 
         Args:
             query: Input text.
-            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.
+            k: Number of `Document` objects to return.
+            **kwargs: kwargs to be passed to similarity search. Should include
+                `score_threshold`, An optional floating point value between `0` to `1`
+                to filter the resulting set of retrieved docs
 
         Returns:
-            List of Tuples of (doc, similarity_score).
+            List of Tuples of `(doc, similarity_score)`.
         """
         score_threshold = kwargs.pop("score_threshold", None)
 
@@ -555,19 +553,19 @@ class VectorStore(ABC):
         k: int = 4,
         **kwargs: Any,
     ) -> list[tuple[Document, float]]:
-        """Async return docs and relevance scores in the range [0, 1].
+        """Async return docs and relevance scores in the range `[0, 1]`.
 
-        0 is dissimilar, 1 is most similar.
+        `0` is dissimilar, `1` is most similar.
 
         Args:
             query: Input text.
-            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
+            k: Number of `Document` objects to return.
+            **kwargs: kwargs to be passed to similarity search. Should include
+                `score_threshold`, An optional floating point value between `0` to `1`
+                to filter the resulting set of retrieved docs
 
         Returns:
-            List of Tuples of (doc, similarity_score)
+            List of Tuples of `(doc, similarity_score)`
         """
         score_threshold = kwargs.pop("score_threshold", None)
 
@@ -605,11 +603,11 @@ class VectorStore(ABC):
 
         Args:
             query: Input text.
-            k: Number of Documents to return.
+            k: Number of `Document` objects to return.
             **kwargs: Arguments to pass to the search method.
 
         Returns:
-            List of Documents most similar to the query.
+            List of `Document` objects most similar to the query.
         """
         # This is a temporary workaround to make the similarity search
         # asynchronous. The proper solution is to make the similarity search
@@ -623,11 +621,11 @@ class VectorStore(ABC):
 
         Args:
             embedding: Embedding to look up documents similar to.
-            k: Number of Documents to return.
+            k: Number of `Document` objects to return.
             **kwargs: Arguments to pass to the search method.
 
         Returns:
-            List of Documents most similar to the query vector.
+            List of `Document` objects most similar to the query vector.
         """
         raise NotImplementedError
 
@@ -638,11 +636,11 @@ class VectorStore(ABC):
 
         Args:
             embedding: Embedding to look up documents similar to.
-            k: Number of Documents to return.
+            k: Number of `Document` objects to return.
             **kwargs: Arguments to pass to the search method.
 
         Returns:
-            List of Documents most similar to the query vector.
+            List of `Document` objects most similar to the query vector.
         """
         # This is a temporary workaround to make the similarity search
         # asynchronous. The proper solution is to make the similarity search
@@ -666,15 +664,15 @@ class VectorStore(ABC):
 
         Args:
             query: Text to look up documents similar to.
-            k: Number of Documents to return.
-            fetch_k: Number of Documents to fetch to pass to MMR algorithm.
-            lambda_mult: Number between 0 and 1 that determines the degree
+            k: Number of `Document` objects to return.
+            fetch_k: Number of `Document` objects to fetch to pass to MMR algorithm.
+            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.
+                to maximum diversity and `1` to minimum diversity.
             **kwargs: Arguments to pass to the search method.
 
         Returns:
-            List of Documents selected by maximal marginal relevance.
+            List of `Document` objects selected by maximal marginal relevance.
         """
         raise NotImplementedError
 
@@ -693,15 +691,15 @@ class VectorStore(ABC):
 
         Args:
             query: Text to look up documents similar to.
-            k: Number of Documents to return.
-            fetch_k: Number of Documents to fetch to pass to MMR algorithm.
-            lambda_mult: Number between 0 and 1 that determines the degree
+            k: Number of `Document` objects to return.
+            fetch_k: Number of `Document` objects to fetch to pass to MMR algorithm.
+            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.
+                to maximum diversity and `1` to minimum diversity.
             **kwargs: Arguments to pass to the search method.
 
         Returns:
-            List of Documents selected by maximal marginal relevance.
+            List of `Document` objects selected by maximal marginal relevance.
         """
         # This is a temporary workaround to make the similarity search
         # asynchronous. The proper solution is to make the similarity search
@@ -731,15 +729,15 @@ class VectorStore(ABC):
 
         Args:
             embedding: Embedding to look up documents similar to.
-            k: Number of Documents to return.
-            fetch_k: Number of Documents to fetch to pass to MMR algorithm.
-            lambda_mult: Number between 0 and 1 that determines the degree
+            k: Number of `Document` objects to return.
+            fetch_k: Number of `Document` objects to fetch to pass to MMR algorithm.
+            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.
+                to maximum diversity and `1` to minimum diversity.
             **kwargs: Arguments to pass to the search method.
 
         Returns:
-            List of Documents selected by maximal marginal relevance.
+            List of `Document` objects selected by maximal marginal relevance.
         """
         raise NotImplementedError
 
@@ -758,15 +756,15 @@ class VectorStore(ABC):
 
         Args:
             embedding: Embedding to look up documents similar to.
-            k: Number of Documents to return.
-            fetch_k: Number of Documents to fetch to pass to MMR algorithm.
-            lambda_mult: Number between 0 and 1 that determines the degree
+            k: Number of `Document` objects to return.
+            fetch_k: Number of `Document` objects to fetch to pass to MMR algorithm.
+            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.
+                to maximum diversity and `1` to minimum diversity.
             **kwargs: Arguments to pass to the search method.
 
         Returns:
-            List of Documents selected by maximal marginal relevance.
+            List of `Document` objects selected by maximal marginal relevance.
         """
         return await run_in_executor(
             None,
@@ -785,15 +783,15 @@ class VectorStore(ABC):
         embedding: Embeddings,
         **kwargs: Any,
     ) -> Self:
-        """Return VectorStore initialized from documents and embeddings.
+        """Return `VectorStore` initialized from documents and embeddings.
 
         Args:
-            documents: List of Documents to add to the vectorstore.
+            documents: List of `Document` objects to add to the `VectorStore`.
             embedding: Embedding function to use.
             **kwargs: Additional keyword arguments.
 
         Returns:
-            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]
@@ -815,15 +813,15 @@ class VectorStore(ABC):
         embedding: Embeddings,
         **kwargs: Any,
     ) -> Self:
-        """Async return VectorStore initialized from documents and embeddings.
+        """Async return `VectorStore` initialized from documents and embeddings.
 
         Args:
-            documents: List of Documents to add to the vectorstore.
+            documents: List of `Document` objects to add to the `VectorStore`.
             embedding: Embedding function to use.
             **kwargs: Additional keyword arguments.
 
         Returns:
-            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]
@@ -849,17 +847,17 @@ class VectorStore(ABC):
         ids: list[str] | None = None,
         **kwargs: Any,
     ) -> VST:
-        """Return VectorStore initialized from texts and embeddings.
+        """Return `VectorStore` initialized from texts and embeddings.
 
         Args:
-            texts: Texts to add to the vectorstore.
+            texts: Texts to add to the `VectorStore`.
             embedding: Embedding function to use.
             metadatas: Optional list of metadatas associated with the texts.
             ids: Optional list of IDs associated with the texts.
             **kwargs: Additional keyword arguments.
 
         Returns:
-            VectorStore initialized from texts and embeddings.
+            `VectorStore` initialized from texts and embeddings.
         """
 
     @classmethod
@@ -872,17 +870,17 @@ class VectorStore(ABC):
         ids: list[str] | None = None,
         **kwargs: Any,
     ) -> Self:
-        """Async return VectorStore initialized from texts and embeddings.
+        """Async return `VectorStore` initialized from texts and embeddings.
 
         Args:
-            texts: Texts to add to the vectorstore.
+            texts: Texts to add to the `VectorStore`.
             embedding: Embedding function to use.
             metadatas: Optional list of metadatas associated with the texts.
             ids: Optional list of IDs associated with the texts.
             **kwargs: Additional keyword arguments.
 
         Returns:
-            VectorStore initialized from texts and embeddings.
+            `VectorStore` initialized from texts and embeddings.
         """
         if ids is not None:
             kwargs["ids"] = ids
@@ -898,27 +896,29 @@ class VectorStore(ABC):
         return tags
 
     def as_retriever(self, **kwargs: Any) -> VectorStoreRetriever:
-        """Return VectorStoreRetriever initialized from this VectorStore.
+        """Return `VectorStoreRetriever` initialized from this `VectorStore`.
 
         Args:
             **kwargs: Keyword arguments to pass to the search function.
                 Can include:
-                search_type: Defines the type of search that the Retriever should
-                    perform. Can be "similarity" (default), "mmr", or
-                    "similarity_score_threshold".
-                search_kwargs: Keyword arguments to pass to the search function. Can
+
+                * `search_type`: Defines the type of search that the Retriever should
+                    perform. Can be `'similarity'` (default), `'mmr'`, or
+                    `'similarity_score_threshold'`.
+                * `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
-                        fetch_k: Amount of documents to pass to MMR algorithm
-                            (Default: 20)
-                        lambda_mult: Diversity of results returned by MMR;
-                            1 for minimum diversity and 0 for maximum. (Default: 0.5)
-                        filter: Filter by document metadata
+
+                    * `k`: Amount of documents to return (Default: `4`)
+                    * `score_threshold`: Minimum relevance threshold
+                        for `similarity_score_threshold`
+                    * `fetch_k`: Amount of documents to pass to MMR algorithm
+                        (Default: `20`)
+                    * `lambda_mult`: Diversity of results returned by MMR;
+                        `1` for minimum diversity and 0 for maximum. (Default: `0.5`)
+                    * `filter`: Filter by document metadata
 
         Returns:
-            Retriever class for VectorStore.
+            Retriever class for `VectorStore`.
 
         Examples:
         ```python
@@ -958,7 +958,7 @@ class VectorStoreRetriever(BaseRetriever):
     vectorstore: VectorStore
     """VectorStore to use for retrieval."""
     search_type: str = "similarity"
-    """Type of search to perform. Defaults to "similarity"."""
+    """Type of search to perform."""
     search_kwargs: dict = Field(default_factory=dict)
     """Keyword arguments to pass to the search function."""
     allowed_search_types: ClassVar[Collection[str]] = (
@@ -983,8 +983,8 @@ class VectorStoreRetriever(BaseRetriever):
             Validated values.
 
         Raises:
-            ValueError: If search_type is not one of the allowed search types.
-            ValueError: If score_threshold is not specified with a float value(0~1)
+            ValueError: If `search_type` is not one of the allowed search types.
+            ValueError: If `score_threshold` is not specified with a float value(`0~1`)
         """
         search_type = values.get("search_type", "similarity")
         if search_type not in cls.allowed_search_types:
@@ -1072,10 +1072,10 @@ class VectorStoreRetriever(BaseRetriever):
         return docs
 
     def add_documents(self, documents: list[Document], **kwargs: Any) -> list[str]:
-        """Add documents to the vectorstore.
+        """Add documents to the `VectorStore`.
 
         Args:
-            documents: Documents to add to the vectorstore.
+            documents: Documents to add to the `VectorStore`.
             **kwargs: Other keyword arguments that subclasses might use.
 
         Returns:
@@ -1086,10 +1086,10 @@ class VectorStoreRetriever(BaseRetriever):
     async def aadd_documents(
         self, documents: list[Document], **kwargs: Any
     ) -> list[str]:
-        """Async add documents to the vectorstore.
+        """Async add documents to the `VectorStore`.
 
         Args:
-            documents: Documents to add to the vectorstore.
+            documents: Documents to add to the `VectorStore`.
             **kwargs: Other keyword arguments that subclasses might use.
 
         Returns:

langchain_core/vectorstores/in_memory.py

@@ -257,10 +257,10 @@ class InMemoryVectorStore(VectorStore):
         """Get documents by their ids.
 
         Args:
-            ids: The ids of the documents to get.
+            ids: The IDs of the documents to get.
 
         Returns:
-            A list of Document objects.
+            A list of `Document` objects.
         """
         documents = []
 
@@ -281,10 +281,10 @@ class InMemoryVectorStore(VectorStore):
         """Async get documents by their ids.
 
         Args:
-            ids: The ids of the documents to get.
+            ids: The IDs of the documents to get.
 
         Returns:
-            A list of Document objects.
+            A list of `Document` objects.
         """
         return self.get_by_ids(ids)
 

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.

langchain_core/version.py

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