langchain-core 0.3.74__py3-none-any.whl → 0.3.75__py3-none-any.whl

langchain_core/_api/beta_decorator.py

@@ -144,10 +144,9 @@ def beta(
                 obj.__init__ = functools.wraps(obj.__init__)(  # type: ignore[misc]
                     warn_if_direct_instance
                 )
-                return cast("T", obj)
+                return obj
 
         elif isinstance(obj, property):
-            # note(erick): this block doesn't seem to be used?
             if not _obj_type:
                 _obj_type = "attribute"
             wrapped = None
@@ -168,6 +167,7 @@ def beta(
                     self.__orig_fget = fget
                     self.__orig_fset = fset
                     self.__orig_fdel = fdel
+                    self.__doc__ = doc
 
                 def __get__(
                     self, instance: Any, owner: Union[type, None] = None

langchain_core/_api/deprecation.py

@@ -225,7 +225,7 @@ def deprecated(
                 obj.__init__ = functools.wraps(obj.__init__)(  # type: ignore[misc]
                     warn_if_direct_instance
                 )
-                return cast("T", obj)
+                return obj
 
         elif isinstance(obj, FieldInfoV1):
             wrapped = None

langchain_core/beta/runnables/context.py

@@ -253,7 +253,7 @@ class ContextSet(RunnableSerializable):
         """
         if key is not None:
             kwargs[key] = value
-        super().__init__(  # type: ignore[call-arg]
+        super().__init__(
             keys={
                 k: _coerce_set_value(v) if v is not None else None
                 for k, v in kwargs.items()

langchain_core/callbacks/file.py

@@ -49,7 +49,7 @@ class FileCallbackHandler(BaseCallbackHandler):
         mode: The file open mode. Defaults to ``'a'`` (append).
         color: Default color for text output. Defaults to ``None``.
 
-    Note:
+    .. note::
         When not used as a context manager, a deprecation warning will be issued
         on first use. The file will be opened immediately in ``__init__`` and closed
         in ``__del__`` or when ``close()`` is called explicitly.
@@ -65,6 +65,7 @@ class FileCallbackHandler(BaseCallbackHandler):
             filename: Path to the output file.
             mode: File open mode (e.g., ``'w'``, ``'a'``, ``'x'``). Defaults to ``'a'``.
             color: Default text color for output. Defaults to ``None``.
+
         """
         self.filename = filename
         self.mode = mode
@@ -82,9 +83,10 @@ class FileCallbackHandler(BaseCallbackHandler):
         Returns:
             The FileCallbackHandler instance.
 
-        Note:
+        .. note::
             The file is already opened in ``__init__``, so this just marks that
             the handler is being used as a context manager.
+
         """
         self._file_opened_in_context = True
         return self
@@ -101,6 +103,7 @@ class FileCallbackHandler(BaseCallbackHandler):
             exc_type: Exception type if an exception occurred.
             exc_val: Exception value if an exception occurred.
             exc_tb: Exception traceback if an exception occurred.
+
         """
         self.close()
 
@@ -113,6 +116,7 @@ class FileCallbackHandler(BaseCallbackHandler):
 
         This method is safe to call multiple times and will only close
         the file if it's currently open.
+
         """
         if hasattr(self, "file") and self.file and not self.file.closed:
             self.file.close()
@@ -133,6 +137,7 @@ class FileCallbackHandler(BaseCallbackHandler):
 
         Raises:
             RuntimeError: If the file is closed or not available.
+
         """
         global _GLOBAL_DEPRECATION_WARNED  # noqa: PLW0603
         if not self._file_opened_in_context and not _GLOBAL_DEPRECATION_WARNED:
@@ -163,6 +168,7 @@ class FileCallbackHandler(BaseCallbackHandler):
             serialized: The serialized chain information.
             inputs: The inputs to the chain.
             **kwargs: Additional keyword arguments that may contain ``'name'``.
+
         """
         name = (
             kwargs.get("name")
@@ -178,6 +184,7 @@ class FileCallbackHandler(BaseCallbackHandler):
         Args:
             outputs: The outputs of the chain.
             **kwargs: Additional keyword arguments.
+
         """
         self._write("\n> Finished chain.", end="\n")
 
@@ -192,6 +199,7 @@ class FileCallbackHandler(BaseCallbackHandler):
             color: Color override for this specific output. If ``None``, uses
                 ``self.color``.
             **kwargs: Additional keyword arguments.
+
         """
         self._write(action.log, color=color or self.color)
 
@@ -213,6 +221,7 @@ class FileCallbackHandler(BaseCallbackHandler):
             observation_prefix: Optional prefix to write before the output.
             llm_prefix: Optional prefix to write after the output.
             **kwargs: Additional keyword arguments.
+
         """
         if observation_prefix is not None:
             self._write(f"\n{observation_prefix}")
@@ -232,6 +241,7 @@ class FileCallbackHandler(BaseCallbackHandler):
                 ``self.color``.
             end: String appended after the text. Defaults to ``""``.
             **kwargs: Additional keyword arguments.
+
         """
         self._write(text, color=color or self.color, end=end)
 
@@ -246,5 +256,6 @@ class FileCallbackHandler(BaseCallbackHandler):
             color: Color override for this specific output. If ``None``, uses
                 ``self.color``.
             **kwargs: Additional keyword arguments.
+
         """
         self._write(finish.log, color=color or self.color, end="\n")

langchain_core/callbacks/manager.py

@@ -11,15 +11,7 @@ from abc import ABC, abstractmethod
 from concurrent.futures import ThreadPoolExecutor
 from contextlib import asynccontextmanager, contextmanager
 from contextvars import copy_context
-from typing import (
-    TYPE_CHECKING,
-    Any,
-    Callable,
-    Optional,
-    TypeVar,
-    Union,
-    cast,
-)
+from typing import TYPE_CHECKING, Any, Callable, Optional, TypeVar, Union, cast
 from uuid import UUID
 
 from langsmith.run_helpers import get_tracing_context
@@ -92,7 +84,8 @@ def trace_as_chain_group(
         metadata (dict[str, Any], optional): The metadata to apply to all runs.
             Defaults to None.
 
-    Note: must have LANGCHAIN_TRACING_V2 env var set to true to see the trace in LangSmith.
+    .. note:
+        Must have ``LANGCHAIN_TRACING_V2`` env var set to true to see the trace in LangSmith.
 
     Returns:
         CallbackManagerForChainGroup: The callback manager for the chain group.
@@ -177,7 +170,8 @@ async def atrace_as_chain_group(
     Returns:
         AsyncCallbackManager: The async callback manager for the chain group.
 
-    Note: must have LANGCHAIN_TRACING_V2 env var set to true to see the trace in LangSmith.
+    .. note:
+        Must have ``LANGCHAIN_TRACING_V2`` env var set to true to see the trace in LangSmith.
 
     Example:
         .. code-block:: python
@@ -234,6 +228,7 @@ def shielded(func: Func) -> Func:
 
     Returns:
         Callable: The shielded function
+
     """
 
     @functools.wraps(func)
@@ -252,15 +247,17 @@ def handle_event(
 ) -> None:
     """Generic event handler for CallbackManager.
 
-    Note: This function is used by LangServe to handle events.
+    .. note::
+        This function is used by ``LangServe`` to handle events.
 
     Args:
         handlers: The list of handlers that will handle the event.
-        event_name: The name of the event (e.g., "on_llm_start").
+        event_name: The name of the event (e.g., ``'on_llm_start'``).
         ignore_condition_name: Name of the attribute defined on handler
             that if True will cause the handler to be skipped for the given event.
         *args: The arguments to pass to the event handler.
         **kwargs: The keyword arguments to pass to the event handler
+
     """
     coros: list[Coroutine[Any, Any, Any]] = []
 
@@ -415,17 +412,19 @@ async def ahandle_event(
     *args: Any,
     **kwargs: Any,
 ) -> None:
-    """Async generic event handler for AsyncCallbackManager.
+    """Async generic event handler for ``AsyncCallbackManager``.
 
-    Note: This function is used by LangServe to handle events.
+    .. note::
+        This function is used by ``LangServe`` to handle events.
 
     Args:
         handlers: The list of handlers that will handle the event.
-        event_name: The name of the event (e.g., "on_llm_start").
+        event_name: The name of the event (e.g., ``'on_llm_start'``).
         ignore_condition_name: Name of the attribute defined on handler
             that if True will cause the handler to be skipped for the given event.
         *args: The arguments to pass to the event handler.
         **kwargs: The keyword arguments to pass to the event handler.
+
     """
     for handler in [h for h in handlers if h.run_inline]:
         await _ahandle_event_for_handler(
@@ -477,6 +476,7 @@ class BaseRunManager(RunManagerMixin):
                 Defaults to None.
             inheritable_metadata (Optional[dict[str, Any]]): The inheritable metadata.
                 Defaults to None.
+
         """
         self.run_id = run_id
         self.handlers = handlers
@@ -493,6 +493,7 @@ class BaseRunManager(RunManagerMixin):
 
         Returns:
             BaseRunManager: The noop manager.
+
         """
         return cls(
             run_id=uuid.uuid4(),
@@ -545,6 +546,7 @@ class RunManager(BaseRunManager):
         Args:
             retry_state (RetryCallState): The retry state.
             **kwargs (Any): Additional keyword arguments.
+
         """
         if not self.handlers:
             return
@@ -572,6 +574,7 @@ class ParentRunManager(RunManager):
 
         Returns:
             CallbackManager: The child callback manager.
+
         """
         manager = CallbackManager(handlers=[], parent_run_id=self.run_id)
         manager.set_handlers(self.inheritable_handlers)
@@ -591,6 +594,7 @@ class AsyncRunManager(BaseRunManager, ABC):
 
         Returns:
             RunManager: The sync RunManager.
+
         """
 
     async def on_text(
@@ -606,6 +610,7 @@ class AsyncRunManager(BaseRunManager, ABC):
 
         Returns:
             Any: The result of the callback.
+
         """
         if not self.handlers:
             return
@@ -630,6 +635,7 @@ class AsyncRunManager(BaseRunManager, ABC):
         Args:
             retry_state (RetryCallState): The retry state.
             **kwargs (Any): Additional keyword arguments.
+
         """
         if not self.handlers:
             return
@@ -657,6 +663,7 @@ class AsyncParentRunManager(AsyncRunManager):
 
         Returns:
             AsyncCallbackManager: The child callback manager.
+
         """
         manager = AsyncCallbackManager(handlers=[], parent_run_id=self.run_id)
         manager.set_handlers(self.inheritable_handlers)
@@ -684,6 +691,7 @@ class CallbackManagerForLLMRun(RunManager, LLMManagerMixin):
             chunk (Optional[Union[GenerationChunk, ChatGenerationChunk]], optional):
                 The chunk. Defaults to None.
             **kwargs (Any): Additional keyword arguments.
+
         """
         if not self.handlers:
             return
@@ -705,6 +713,7 @@ class CallbackManagerForLLMRun(RunManager, LLMManagerMixin):
         Args:
             response (LLMResult): The LLM result.
             **kwargs (Any): Additional keyword arguments.
+
         """
         if not self.handlers:
             return
@@ -754,6 +763,7 @@ class AsyncCallbackManagerForLLMRun(AsyncRunManager, LLMManagerMixin):
 
         Returns:
             CallbackManagerForLLMRun: The sync RunManager.
+
         """
         return CallbackManagerForLLMRun(
             run_id=self.run_id,
@@ -780,6 +790,7 @@ class AsyncCallbackManagerForLLMRun(AsyncRunManager, LLMManagerMixin):
             chunk (Optional[Union[GenerationChunk, ChatGenerationChunk]], optional):
                 The chunk. Defaults to None.
             **kwargs (Any): Additional keyword arguments.
+
         """
         if not self.handlers:
             return
@@ -802,6 +813,7 @@ class AsyncCallbackManagerForLLMRun(AsyncRunManager, LLMManagerMixin):
         Args:
             response (LLMResult): The LLM result.
             **kwargs (Any): Additional keyword arguments.
+
         """
         if not self.handlers:
             return
@@ -856,6 +868,7 @@ class CallbackManagerForChainRun(ParentRunManager, ChainManagerMixin):
         Args:
             outputs (Union[dict[str, Any], Any]): The outputs of the chain.
             **kwargs (Any): Additional keyword arguments.
+
         """
         if not self.handlers:
             return
@@ -880,6 +893,7 @@ class CallbackManagerForChainRun(ParentRunManager, ChainManagerMixin):
         Args:
             error (Exception or KeyboardInterrupt): The error.
             **kwargs (Any): Additional keyword arguments.
+
         """
         if not self.handlers:
             return
@@ -903,6 +917,7 @@ class CallbackManagerForChainRun(ParentRunManager, ChainManagerMixin):
 
         Returns:
             Any: The result of the callback.
+
         """
         if not self.handlers:
             return
@@ -926,6 +941,7 @@ class CallbackManagerForChainRun(ParentRunManager, ChainManagerMixin):
 
         Returns:
             Any: The result of the callback.
+
         """
         if not self.handlers:
             return
@@ -970,6 +986,7 @@ class AsyncCallbackManagerForChainRun(AsyncParentRunManager, ChainManagerMixin):
         Args:
             outputs (Union[dict[str, Any], Any]): The outputs of the chain.
             **kwargs (Any): Additional keyword arguments.
+
         """
         if not self.handlers:
             return
@@ -995,6 +1012,7 @@ class AsyncCallbackManagerForChainRun(AsyncParentRunManager, ChainManagerMixin):
         Args:
             error (Exception or KeyboardInterrupt): The error.
             **kwargs (Any): Additional keyword arguments.
+
         """
         if not self.handlers:
             return
@@ -1018,6 +1036,7 @@ class AsyncCallbackManagerForChainRun(AsyncParentRunManager, ChainManagerMixin):
 
         Returns:
             Any: The result of the callback.
+
         """
         if not self.handlers:
             return
@@ -1041,6 +1060,7 @@ class AsyncCallbackManagerForChainRun(AsyncParentRunManager, ChainManagerMixin):
 
         Returns:
             Any: The result of the callback.
+
         """
         if not self.handlers:
             return
@@ -1069,6 +1089,7 @@ class CallbackManagerForToolRun(ParentRunManager, ToolManagerMixin):
         Args:
             output (Any): The output of the tool.
             **kwargs (Any): The keyword arguments to pass to the event handler
+
         """
         if not self.handlers:
             return
@@ -1093,6 +1114,7 @@ class CallbackManagerForToolRun(ParentRunManager, ToolManagerMixin):
         Args:
             error (Exception or KeyboardInterrupt): The error.
             **kwargs (Any): Additional keyword arguments.
+
         """
         if not self.handlers:
             return
@@ -1134,6 +1156,7 @@ class AsyncCallbackManagerForToolRun(AsyncParentRunManager, ToolManagerMixin):
         Args:
             output (Any): The output of the tool.
             **kwargs (Any): Additional keyword arguments.
+
         """
         if not self.handlers:
             return
@@ -1158,6 +1181,7 @@ class AsyncCallbackManagerForToolRun(AsyncParentRunManager, ToolManagerMixin):
         Args:
             error (Exception or KeyboardInterrupt): The error.
             **kwargs (Any): Additional keyword arguments.
+
         """
         if not self.handlers:
             return
@@ -1186,6 +1210,7 @@ class CallbackManagerForRetrieverRun(ParentRunManager, RetrieverManagerMixin):
         Args:
             documents (Sequence[Document]): The retrieved documents.
             **kwargs (Any): Additional keyword arguments.
+
         """
         if not self.handlers:
             return
@@ -1210,6 +1235,7 @@ class CallbackManagerForRetrieverRun(ParentRunManager, RetrieverManagerMixin):
         Args:
             error (BaseException): The error.
             **kwargs (Any): Additional keyword arguments.
+
         """
         if not self.handlers:
             return
@@ -1236,6 +1262,7 @@ class AsyncCallbackManagerForRetrieverRun(
 
         Returns:
             CallbackManagerForRetrieverRun: The sync RunManager.
+
         """
         return CallbackManagerForRetrieverRun(
             run_id=self.run_id,
@@ -1257,6 +1284,7 @@ class AsyncCallbackManagerForRetrieverRun(
         Args:
             documents (Sequence[Document]): The retrieved documents.
             **kwargs (Any): Additional keyword arguments.
+
         """
         if not self.handlers:
             return
@@ -1282,6 +1310,7 @@ class AsyncCallbackManagerForRetrieverRun(
         Args:
             error (BaseException): The error.
             **kwargs (Any): Additional keyword arguments.
+
         """
         if not self.handlers:
             return
@@ -1318,6 +1347,7 @@ class CallbackManager(BaseCallbackManager):
         Returns:
             list[CallbackManagerForLLMRun]: A callback manager for each
                 prompt as an LLM run.
+
         """
         managers = []
         for i, prompt in enumerate(prompts):
@@ -1369,6 +1399,7 @@ class CallbackManager(BaseCallbackManager):
         Returns:
             list[CallbackManagerForLLMRun]: A callback manager for each
                 list of messages as an LLM run.
+
         """
         managers = []
         for message_list in messages:
@@ -1422,6 +1453,7 @@ class CallbackManager(BaseCallbackManager):
 
         Returns:
             CallbackManagerForChainRun: The callback manager for the chain run.
+
         """
         if run_id is None:
             run_id = uuid.uuid4()
@@ -1476,6 +1508,7 @@ class CallbackManager(BaseCallbackManager):
 
         Returns:
             CallbackManagerForToolRun: The callback manager for the tool run.
+
         """
         if run_id is None:
             run_id = uuid.uuid4()
@@ -1522,6 +1555,7 @@ class CallbackManager(BaseCallbackManager):
             run_id (UUID, optional): The ID of the run. Defaults to None.
             parent_run_id (UUID, optional): The ID of the parent run. Defaults to None.
             **kwargs (Any): Additional keyword arguments.
+
         """
         if run_id is None:
             run_id = uuid.uuid4()
@@ -1569,6 +1603,7 @@ class CallbackManager(BaseCallbackManager):
             run_id: The ID of the run. Defaults to None.
 
         .. versionadded:: 0.2.14
+
         """
         if not self.handlers:
             return
@@ -1623,6 +1658,7 @@ class CallbackManager(BaseCallbackManager):
 
         Returns:
             CallbackManager: The configured callback manager.
+
         """
         return _configure(
             cls,
@@ -1657,6 +1693,7 @@ class CallbackManagerForChainGroup(CallbackManager):
             parent_run_id (Optional[UUID]): The ID of the parent run. Defaults to None.
             parent_run_manager (CallbackManagerForChainRun): The parent run manager.
             **kwargs (Any): Additional keyword arguments.
+
         """
         super().__init__(
             handlers,
@@ -1745,6 +1782,7 @@ class CallbackManagerForChainGroup(CallbackManager):
         Args:
             outputs (Union[dict[str, Any], Any]): The outputs of the chain.
             **kwargs (Any): Additional keyword arguments.
+
         """
         self.ended = True
         return self.parent_run_manager.on_chain_end(outputs, **kwargs)
@@ -1759,6 +1797,7 @@ class CallbackManagerForChainGroup(CallbackManager):
         Args:
             error (Exception or KeyboardInterrupt): The error.
             **kwargs (Any): Additional keyword arguments.
+
         """
         self.ended = True
         return self.parent_run_manager.on_chain_error(error, **kwargs)

langchain_core/chat_history.py

@@ -117,9 +117,9 @@ class BaseChatMessageHistory(ABC):
     def add_user_message(self, message: Union[HumanMessage, str]) -> None:
         """Convenience method for adding a human message string to the store.
 
-        Please note that this is a convenience method. Code should favor the
-        bulk add_messages interface instead to save on round-trips to the underlying
-        persistence layer.
+        .. note::
+            This is a convenience method. Code should favor the bulk ``add_messages``
+            interface instead to save on round-trips to the persistence layer.
 
         This method may be deprecated in a future release.
 
@@ -134,9 +134,9 @@ class BaseChatMessageHistory(ABC):
     def add_ai_message(self, message: Union[AIMessage, str]) -> None:
         """Convenience method for adding an AI message string to the store.
 
-        Please note that this is a convenience method. Code should favor the bulk
-        add_messages interface instead to save on round-trips to the underlying
-        persistence layer.
+        .. note::
+            This is a convenience method. Code should favor the bulk ``add_messages``
+            interface instead to save on round-trips to the persistence layer.
 
         This method may be deprecated in a future release.
 

langchain_core/documents/base.py

@@ -277,7 +277,7 @@ class Document(BaseMedia):
         """Pass page_content in as positional or named arg."""
         # my-py is complaining that page_content is not defined on the base class.
         # Here, we're relying on pydantic base class to handle the validation.
-        super().__init__(page_content=page_content, **kwargs)  # type: ignore[call-arg]
+        super().__init__(page_content=page_content, **kwargs)
 
     @classmethod
     def is_lc_serializable(cls) -> bool:

langchain_core/documents/compressor.py

@@ -19,17 +19,18 @@ if TYPE_CHECKING:
 class BaseDocumentCompressor(BaseModel, ABC):
     """Base class for document compressors.
 
-    This abstraction is primarily used for
-    post-processing of retrieved documents.
+    This abstraction is primarily used for post-processing of retrieved documents.
 
     Documents matching a given query are first retrieved.
+
     Then the list of documents can be further processed.
 
-    For example, one could re-rank the retrieved documents
-    using an LLM.
+    For example, one could re-rank the retrieved documents using an LLM.
+
+    .. note::
+        Users should favor using a RunnableLambda instead of sub-classing from this
+        interface.
 
-    **Note** users should favor using a RunnableLambda
-    instead of sub-classing from this interface.
     """
 
     @abstractmethod
@@ -48,6 +49,7 @@ class BaseDocumentCompressor(BaseModel, ABC):
 
         Returns:
             The compressed documents.
+
         """
 
     async def acompress_documents(
@@ -65,6 +67,7 @@ class BaseDocumentCompressor(BaseModel, ABC):
 
         Returns:
             The compressed documents.
+
         """
         return await run_in_executor(
             None, self.compress_documents, documents, query, callbacks

langchain_core/indexing/base.py

@@ -488,8 +488,8 @@ class DeleteResponse(TypedDict, total=False):
     failed: Sequence[str]
     """The IDs that failed to be deleted.
 
-    Please note that deleting an ID that
-    does not exist is **NOT** considered a failure.
+    .. warning::
+        Deleting an ID that does not exist is **NOT** considered a failure.
     """
 
     num_failed: int