langchain-core 1.0.0a6__py3-none-any.whl → 1.0.3__py3-none-any.whl

langchain_core/indexing/base.py

@@ -5,7 +5,7 @@ from __future__ import annotations
 import abc
 import time
 from abc import ABC, abstractmethod
-from typing import TYPE_CHECKING, Any, Optional, TypedDict
+from typing import TYPE_CHECKING, Any, TypedDict
 
 from typing_extensions import override
 
@@ -25,7 +25,7 @@ class RecordManager(ABC):
     The record manager abstraction is used by the langchain indexing API.
 
     The record manager keeps track of which documents have been
-    written into a vectorstore and when they were written.
+    written into a `VectorStore` and when they were written.
 
     The indexing API computes hashes for each document and stores the hash
     together with the write time and the source id in the record manager.
@@ -37,7 +37,7 @@ class RecordManager(ABC):
     already been indexed, and to only index new documents.
 
     The main benefit of this abstraction is that it works across many vectorstores.
-    To be supported, a vectorstore needs to only support the ability to add and
+    To be supported, a `VectorStore` needs to only support the ability to add and
     delete documents by ID. Using the record manager, the indexing API will
     be able to delete outdated documents and avoid redundant indexing of documents
     that have already been indexed.
@@ -45,13 +45,13 @@ class RecordManager(ABC):
     The main constraints of this abstraction are:
 
     1. It relies on the time-stamps to determine which documents have been
-       indexed and which have not. This means that the time-stamps must be
-       monotonically increasing. The timestamp should be the timestamp
-       as measured by the server to minimize issues.
+        indexed and which have not. This means that the time-stamps must be
+        monotonically increasing. The timestamp should be the timestamp
+        as measured by the server to minimize issues.
     2. The record manager is currently implemented separately from the
-       vectorstore, which means that the overall system becomes distributed
-       and may create issues with consistency. For example, writing to
-       record manager succeeds, but corresponding writing to vectorstore fails.
+        vectorstore, which means that the overall system becomes distributed
+        and may create issues with consistency. For example, writing to
+        record manager succeeds, but corresponding writing to `VectorStore` fails.
     """
 
     def __init__(
@@ -61,7 +61,7 @@ class RecordManager(ABC):
         """Initialize the record manager.
 
         Args:
-            namespace (str): The namespace for the record manager.
+            namespace: The namespace for the record manager.
         """
         self.namespace = namespace
 
@@ -100,8 +100,8 @@ class RecordManager(ABC):
         self,
         keys: Sequence[str],
         *,
-        group_ids: Optional[Sequence[Optional[str]]] = None,
-        time_at_least: Optional[float] = None,
+        group_ids: Sequence[str | None] | None = None,
+        time_at_least: float | None = None,
     ) -> None:
         """Upsert records into the database.
 
@@ -128,8 +128,8 @@ class RecordManager(ABC):
         self,
         keys: Sequence[str],
         *,
-        group_ids: Optional[Sequence[Optional[str]]] = None,
-        time_at_least: Optional[float] = None,
+        group_ids: Sequence[str | None] | None = None,
+        time_at_least: float | None = None,
     ) -> None:
         """Asynchronously upsert records into the database.
 
@@ -177,10 +177,10 @@ class RecordManager(ABC):
     def list_keys(
         self,
         *,
-        before: Optional[float] = None,
-        after: Optional[float] = None,
-        group_ids: Optional[Sequence[str]] = None,
-        limit: Optional[int] = None,
+        before: float | None = None,
+        after: float | None = None,
+        group_ids: Sequence[str] | None = None,
+        limit: int | None = None,
     ) -> list[str]:
         """List records in the database based on the provided filters.
 
@@ -198,10 +198,10 @@ class RecordManager(ABC):
     async def alist_keys(
         self,
         *,
-        before: Optional[float] = None,
-        after: Optional[float] = None,
-        group_ids: Optional[Sequence[str]] = None,
-        limit: Optional[int] = None,
+        before: float | None = None,
+        after: float | None = None,
+        group_ids: Sequence[str] | None = None,
+        limit: int | None = None,
     ) -> list[str]:
         """Asynchronously list records in the database based on the provided filters.
 
@@ -233,7 +233,7 @@ class RecordManager(ABC):
 
 
 class _Record(TypedDict):
-    group_id: Optional[str]
+    group_id: str | None
     updated_at: float
 
 
@@ -244,7 +244,7 @@ class InMemoryRecordManager(RecordManager):
         """Initialize the in-memory record manager.
 
         Args:
-            namespace (str): The namespace for the record manager.
+            namespace: The namespace for the record manager.
         """
         super().__init__(namespace)
         # Each key points to a dictionary
@@ -270,18 +270,18 @@ class InMemoryRecordManager(RecordManager):
         self,
         keys: Sequence[str],
         *,
-        group_ids: Optional[Sequence[Optional[str]]] = None,
-        time_at_least: Optional[float] = None,
+        group_ids: Sequence[str | None] | None = None,
+        time_at_least: float | None = None,
     ) -> None:
         """Upsert records into the database.
 
         Args:
             keys: A list of record keys to upsert.
             group_ids: A list of group IDs corresponding to the keys.
-                Defaults to None.
+
             time_at_least: Optional timestamp. Implementation can use this
                 to optionally verify that the timestamp IS at least this time
-                in the system that stores. Defaults to None.
+                in the system that stores.
                 E.g., use to validate that the time in the postgres database
                 is equal to or larger than the given timestamp, if not
                 raise an error.
@@ -307,18 +307,18 @@ class InMemoryRecordManager(RecordManager):
         self,
         keys: Sequence[str],
         *,
-        group_ids: Optional[Sequence[Optional[str]]] = None,
-        time_at_least: Optional[float] = None,
+        group_ids: Sequence[str | None] | None = None,
+        time_at_least: float | None = None,
     ) -> None:
         """Async upsert records into the database.
 
         Args:
             keys: A list of record keys to upsert.
             group_ids: A list of group IDs corresponding to the keys.
-                Defaults to None.
+
             time_at_least: Optional timestamp. Implementation can use this
                 to optionally verify that the timestamp IS at least this time
-                in the system that stores. Defaults to None.
+                in the system that stores.
                 E.g., use to validate that the time in the postgres database
                 is equal to or larger than the given timestamp, if not
                 raise an error.
@@ -352,22 +352,22 @@ class InMemoryRecordManager(RecordManager):
     def list_keys(
         self,
         *,
-        before: Optional[float] = None,
-        after: Optional[float] = None,
-        group_ids: Optional[Sequence[str]] = None,
-        limit: Optional[int] = None,
+        before: float | None = None,
+        after: float | None = None,
+        group_ids: Sequence[str] | None = None,
+        limit: int | None = None,
     ) -> list[str]:
         """List records in the database based on the provided filters.
 
         Args:
             before: Filter to list records updated before this time.
-                Defaults to None.
+
             after: Filter to list records updated after this time.
-                Defaults to None.
+
             group_ids: Filter to list records with specific group IDs.
-                Defaults to None.
+
             limit: optional limit on the number of records to return.
-                Defaults to None.
+
 
         Returns:
             A list of keys for the matching records.
@@ -388,22 +388,22 @@ class InMemoryRecordManager(RecordManager):
     async def alist_keys(
         self,
         *,
-        before: Optional[float] = None,
-        after: Optional[float] = None,
-        group_ids: Optional[Sequence[str]] = None,
-        limit: Optional[int] = None,
+        before: float | None = None,
+        after: float | None = None,
+        group_ids: Sequence[str] | None = None,
+        limit: int | None = None,
     ) -> list[str]:
         """Async list records in the database based on the provided filters.
 
         Args:
             before: Filter to list records updated before this time.
-                Defaults to None.
+
             after: Filter to list records updated after this time.
-                Defaults to None.
+
             group_ids: Filter to list records with specific group IDs.
-                Defaults to None.
+
             limit: optional limit on the number of records to return.
-                Defaults to None.
+
 
         Returns:
             A list of keys for the matching records.
@@ -460,7 +460,7 @@ class UpsertResponse(TypedDict):
 class DeleteResponse(TypedDict, total=False):
     """A generic response for delete operation.
 
-    The fields in this response are optional and whether the vectorstore
+    The fields in this response are optional and whether the `VectorStore`
     returns them or not is up to the implementation.
     """
 
@@ -485,7 +485,7 @@ class DeleteResponse(TypedDict, total=False):
     failed: Sequence[str]
     """The IDs that failed to be deleted.
 
-    .. warning::
+    !!! warning
         Deleting an ID that does not exist is **NOT** considered a failure.
     """
 
@@ -508,8 +508,6 @@ class DocumentIndex(BaseRetriever):
     1. Storing document in the index.
     2. Fetching document by ID.
     3. Searching for document using a query.
-
-    .. versionadded:: 0.2.29
     """
 
     @abc.abstractmethod
@@ -520,40 +518,40 @@ class DocumentIndex(BaseRetriever):
         if it is provided. If the ID is not provided, the upsert method is free
         to generate an ID for the content.
 
-        When an ID is specified and the content already exists in the vectorstore,
+        When an ID is specified and the content already exists in the `VectorStore`,
         the upsert method should update the content with the new data. If the content
-        does not exist, the upsert method should add the item to the vectorstore.
+        does not exist, the upsert method should add the item to the `VectorStore`.
 
         Args:
-            items: Sequence of documents to add to the vectorstore.
+            items: Sequence of documents to add to the `VectorStore`.
             **kwargs: Additional keyword arguments.
 
         Returns:
-            UpsertResponse: A response object that contains the list of IDs that were
-            successfully added or updated in the vectorstore and the list of IDs that
+            A response object that contains the list of IDs that were
+            successfully added or updated in the `VectorStore` and the list of IDs that
             failed to be added or updated.
         """
 
     async def aupsert(
         self, items: Sequence[Document], /, **kwargs: Any
     ) -> UpsertResponse:
-        """Add or update documents in the vectorstore. Async version of upsert.
+        """Add or update documents in the `VectorStore`. Async version of `upsert`.
 
         The upsert functionality should utilize the ID field of the item
         if it is provided. If the ID is not provided, the upsert method is free
         to generate an ID for the item.
 
-        When an ID is specified and the item already exists in the vectorstore,
+        When an ID is specified and the item already exists in the `VectorStore`,
         the upsert method should update the item with the new data. If the item
-        does not exist, the upsert method should add the item to the vectorstore.
+        does not exist, the upsert method should add the item to the `VectorStore`.
 
         Args:
-            items: Sequence of documents to add to the vectorstore.
+            items: Sequence of documents to add to the `VectorStore`.
             **kwargs: Additional keyword arguments.
 
         Returns:
-            UpsertResponse: A response object that contains the list of IDs that were
-            successfully added or updated in the vectorstore and the list of IDs that
+            A response object that contains the list of IDs that were
+            successfully added or updated in the `VectorStore` and the list of IDs that
             failed to be added or updated.
         """
         return await run_in_executor(
@@ -564,36 +562,36 @@ class DocumentIndex(BaseRetriever):
         )
 
     @abc.abstractmethod
-    def delete(self, ids: Optional[list[str]] = None, **kwargs: Any) -> DeleteResponse:
+    def delete(self, ids: list[str] | None = None, **kwargs: Any) -> DeleteResponse:
         """Delete by IDs or other criteria.
 
         Calling delete without any input parameters should raise a ValueError!
 
         Args:
-            ids: List of ids to delete.
-            kwargs: Additional keyword arguments. This is up to the implementation.
+            ids: List of IDs to delete.
+            **kwargs: Additional keyword arguments. This is up to the implementation.
                 For example, can include an option to delete the entire index,
                 or else issue a non-blocking delete etc.
 
         Returns:
-            DeleteResponse: A response object that contains the list of IDs that were
+            A response object that contains the list of IDs that were
             successfully deleted and the list of IDs that failed to be deleted.
         """
 
     async def adelete(
-        self, ids: Optional[list[str]] = None, **kwargs: Any
+        self, ids: list[str] | None = None, **kwargs: Any
     ) -> DeleteResponse:
         """Delete by IDs or other criteria. Async variant.
 
         Calling adelete without any input parameters should raise a ValueError!
 
         Args:
-            ids: List of ids to delete.
-            kwargs: Additional keyword arguments. This is up to the implementation.
+            ids: List of IDs to delete.
+            **kwargs: Additional keyword arguments. This is up to the implementation.
                 For example, can include an option to delete the entire index.
 
         Returns:
-            DeleteResponse: A response object that contains the list of IDs that were
+            A response object that contains the list of IDs that were
             successfully deleted and the list of IDs that failed to be deleted.
         """
         return await run_in_executor(
@@ -624,10 +622,10 @@ class DocumentIndex(BaseRetriever):
 
         Args:
             ids: List of IDs to get.
-            kwargs: Additional keyword arguments. These are up to the implementation.
+            **kwargs: Additional keyword arguments. These are up to the implementation.
 
         Returns:
-            list[Document]: List of documents that were found.
+            List of documents that were found.
         """
 
     async def aget(
@@ -650,10 +648,10 @@ class DocumentIndex(BaseRetriever):
 
         Args:
             ids: List of IDs to get.
-            kwargs: Additional keyword arguments. These are up to the implementation.
+            **kwargs: Additional keyword arguments. These are up to the implementation.
 
         Returns:
-            list[Document]: List of documents that were found.
+            List of documents that were found.
         """
         return await run_in_executor(
             None,

langchain_core/indexing/in_memory.py

@@ -3,7 +3,7 @@
 import operator
 import uuid
 from collections.abc import Sequence
-from typing import Any, Optional, cast
+from typing import Any, cast
 
 from pydantic import Field
 from typing_extensions import override
@@ -23,8 +23,6 @@ class InMemoryDocumentIndex(DocumentIndex):
 
     It provides a simple search API that returns documents by the number of
     counts the given query appears in the document.
-
-    .. versionadded:: 0.2.29
     """
 
     store: dict[str, Document] = Field(default_factory=dict)
@@ -60,14 +58,14 @@ class InMemoryDocumentIndex(DocumentIndex):
         return UpsertResponse(succeeded=ok_ids, failed=[])
 
     @override
-    def delete(self, ids: Optional[list[str]] = None, **kwargs: Any) -> DeleteResponse:
+    def delete(self, ids: list[str] | None = None, **kwargs: Any) -> DeleteResponse:
         """Delete by IDs.
 
         Args:
-            ids: List of ids to delete.
+            ids: List of IDs to delete.
 
         Raises:
-            ValueError: If ids is None.
+            ValueError: If IDs is None.
 
         Returns:
             A response object that contains the list of IDs that were successfully

langchain_core/language_models/__init__.py

@@ -1,45 +1,30 @@
 """Language models.
 
-**Language Model** is a type of model that can generate text or complete
-text prompts.
+LangChain has two main classes to work with language models: chat models and
+"old-fashioned" LLMs.
 
-LangChain has two main classes to work with language models: **Chat Models**
-and "old-fashioned" **LLMs**.
-
-**Chat Models**
+**Chat models**
 
 Language models that use a sequence of messages as inputs and return chat messages
-as outputs (as opposed to using plain text). These are traditionally newer models (
-older models are generally LLMs, see below). Chat models support the assignment of
-distinct roles to conversation messages, helping to distinguish messages from the AI,
-users, and instructions such as system messages.
+as outputs (as opposed to using plain text).
 
-The key abstraction for chat models is `BaseChatModel`. Implementations
-should inherit from this class. Please see LangChain how-to guides with more
-information on how to implement a custom chat model.
+Chat models support the assignment of distinct roles to conversation messages, helping
+to distinguish messages from the AI, users, and instructions such as system messages.
 
-To implement a custom Chat Model, inherit from `BaseChatModel`. See
-the following guide for more information on how to implement a custom Chat Model:
+The key abstraction for chat models is `BaseChatModel`. Implementations should inherit
+from this class.
 
-https://python.langchain.com/docs/how_to/custom_chat_model/
+See existing [chat model integrations](https://docs.langchain.com/oss/python/integrations/chat).
 
 **LLMs**
 
 Language models that takes a string as input and returns a string.
-These are traditionally older models (newer models generally are Chat Models,
-see below).
-
-Although the underlying models are string in, string out, the LangChain wrappers
-also allow these models to take messages as input. This gives them the same interface
-as Chat Models. When messages are passed in as input, they will be formatted into a
-string under the hood before being passed to the underlying model.
-
-To implement a custom LLM, inherit from `BaseLLM` or `LLM`.
-Please see the following guide for more information on how to implement a custom LLM:
-
-https://python.langchain.com/docs/how_to/custom_llm/
-
+These are traditionally older models (newer models generally are chat models).
 
+Although the underlying models are string in, string out, the LangChain wrappers also
+allow these models to take messages as input. This gives them the same interface as
+chat models. When messages are passed in as input, they will be formatted into a string
+under the hood before being passed to the underlying model.
 """
 
 from typing import TYPE_CHECKING