langchain-core 0.3.79__py3-none-any.whl → 1.0.0__py3-none-any.whl

langchain_core/tools/structured.py

@@ -3,16 +3,13 @@
 from __future__ import annotations
 
 import textwrap
-from collections.abc import Awaitable
+from collections.abc import Awaitable, Callable
 from inspect import signature
 from typing import (
     TYPE_CHECKING,
     Annotated,
     Any,
-    Callable,
     Literal,
-    Optional,
-    Union,
 )
 
 from pydantic import Field, SkipValidation
@@ -44,9 +41,9 @@ class StructuredTool(BaseTool):
         ..., description="The tool schema."
     )
     """The input arguments' schema."""
-    func: Optional[Callable[..., Any]] = None
+    func: Callable[..., Any] | None = None
     """The function to run when the tool is called."""
-    coroutine: Optional[Callable[..., Awaitable[Any]]] = None
+    coroutine: Callable[..., Awaitable[Any]] | None = None
     """The asynchronous version of the function."""
 
     # --- Runnable ---
@@ -55,8 +52,8 @@ class StructuredTool(BaseTool):
     @override
     async def ainvoke(
         self,
-        input: Union[str, dict, ToolCall],
-        config: Optional[RunnableConfig] = None,
+        input: str | dict | ToolCall,
+        config: RunnableConfig | None = None,
         **kwargs: Any,
     ) -> Any:
         if not self.coroutine:
@@ -71,7 +68,7 @@ class StructuredTool(BaseTool):
         self,
         *args: Any,
         config: RunnableConfig,
-        run_manager: Optional[CallbackManagerForToolRun] = None,
+        run_manager: CallbackManagerForToolRun | None = None,
         **kwargs: Any,
     ) -> Any:
         """Use the tool.
@@ -98,7 +95,7 @@ class StructuredTool(BaseTool):
         self,
         *args: Any,
         config: RunnableConfig,
-        run_manager: Optional[AsyncCallbackManagerForToolRun] = None,
+        run_manager: AsyncCallbackManagerForToolRun | None = None,
         **kwargs: Any,
     ) -> Any:
         """Use the tool asynchronously.
@@ -128,12 +125,12 @@ class StructuredTool(BaseTool):
     @classmethod
     def from_function(
         cls,
-        func: Optional[Callable] = None,
-        coroutine: Optional[Callable[..., Awaitable[Any]]] = None,
-        name: Optional[str] = None,
-        description: Optional[str] = None,
+        func: Callable | None = None,
+        coroutine: Callable[..., Awaitable[Any]] | None = None,
+        name: str | None = None,
+        description: str | None = None,
         return_direct: bool = False,  # noqa: FBT001,FBT002
-        args_schema: Optional[ArgsSchema] = None,
+        args_schema: ArgsSchema | None = None,
         infer_schema: bool = True,  # noqa: FBT001,FBT002
         *,
         response_format: Literal["content", "content_and_artifact"] = "content",
@@ -152,22 +149,17 @@ class StructuredTool(BaseTool):
             description: The description of the tool.
                 Defaults to the function docstring.
             return_direct: Whether to return the result directly or as a callback.
-                Defaults to False.
-            args_schema: The schema of the tool's input arguments. Defaults to None.
+            args_schema: The schema of the tool's input arguments.
             infer_schema: Whether to infer the schema from the function's signature.
-                Defaults to True.
-            response_format: The tool response format. If "content" then the output of
-                the tool is interpreted as the contents of a ToolMessage. If
-                "content_and_artifact" then the output is expected to be a two-tuple
-                corresponding to the (content, artifact) of a ToolMessage.
-                Defaults to "content".
-            parse_docstring: if ``infer_schema`` and ``parse_docstring``, will attempt
+            response_format: The tool response format. If `"content"` then the output of
+                the tool is interpreted as the contents of a `ToolMessage`. If
+                `"content_and_artifact"` then the output is expected to be a two-tuple
+                corresponding to the `(content, artifact)` of a `ToolMessage`.
+            parse_docstring: if `infer_schema` and `parse_docstring`, will attempt
                 to parse parameter descriptions from Google Style function docstrings.
-                Defaults to False.
-            error_on_invalid_docstring: if ``parse_docstring`` is provided, configure
-                whether to raise ValueError on invalid Google Style docstrings.
-                Defaults to False.
-            kwargs: Additional arguments to pass to the tool
+            error_on_invalid_docstring: if `parse_docstring` is provided, configure
+                whether to raise `ValueError` on invalid Google Style docstrings.
+            **kwargs: Additional arguments to pass to the tool
 
         Returns:
             The tool.
@@ -176,18 +168,17 @@ class StructuredTool(BaseTool):
             ValueError: If the function is not provided.
             ValueError: If the function does not have a docstring and description
                 is not provided.
-            TypeError: If the ``args_schema`` is not a ``BaseModel`` or dict.
+            TypeError: If the `args_schema` is not a `BaseModel` or dict.
 
         Examples:
-
-            .. code-block:: python
-
-                def add(a: int, b: int) -> int:
-                    \"\"\"Add two numbers\"\"\"
-                    return a + b
-                tool = StructuredTool.from_function(add)
-                tool.run(1, 2) # 3
-
+            ```python
+            def add(a: int, b: int) -> int:
+                \"\"\"Add two numbers\"\"\"
+                return a + b
+            tool = StructuredTool.from_function(add)
+            tool.run(1, 2) # 3
+
+            ```
         """
         if func is not None:
             source_function = func

langchain_core/tracers/__init__.py

@@ -1,12 +1,4 @@
-"""**Tracers** are classes for tracing runs.
-
-**Class hierarchy:**
-
-.. code-block::
-
-    BaseCallbackHandler --> BaseTracer --> <name>Tracer  # Examples: LangChainTracer, RootListenersTracer
-                                       --> <name>  # Examples: LogStreamCallbackHandler
-"""  # noqa: E501
+"""**Tracers** are classes for tracing runs."""
 
 from typing import TYPE_CHECKING
 

langchain_core/tracers/base.py

@@ -8,8 +8,6 @@ from abc import ABC, abstractmethod
 from typing import (
     TYPE_CHECKING,
     Any,
-    Optional,
-    Union,
 )
 
 from typing_extensions import override
@@ -57,10 +55,10 @@ class BaseTracer(_TracerCore, BaseCallbackHandler, ABC):
         messages: list[list[BaseMessage]],
         *,
         run_id: UUID,
-        tags: Optional[list[str]] = None,
-        parent_run_id: Optional[UUID] = None,
-        metadata: Optional[dict[str, Any]] = None,
-        name: Optional[str] = None,
+        tags: list[str] | None = None,
+        parent_run_id: UUID | None = None,
+        metadata: dict[str, Any] | None = None,
+        name: str | None = None,
         **kwargs: Any,
     ) -> Run:
         """Start a trace for an LLM run.
@@ -69,11 +67,11 @@ class BaseTracer(_TracerCore, BaseCallbackHandler, ABC):
             serialized: The serialized model.
             messages: The messages to start the chat with.
             run_id: The run ID.
-            tags: The tags for the run. Defaults to None.
-            parent_run_id: The parent run ID. Defaults to None.
-            metadata: The metadata for the run. Defaults to None.
+            tags: The tags for the run.
+            parent_run_id: The parent run ID.
+            metadata: The metadata for the run.
             name: The name of the run.
-            kwargs: Additional arguments.
+            **kwargs: Additional arguments.
 
         Returns:
             The run.
@@ -98,10 +96,10 @@ class BaseTracer(_TracerCore, BaseCallbackHandler, ABC):
         prompts: list[str],
         *,
         run_id: UUID,
-        tags: Optional[list[str]] = None,
-        parent_run_id: Optional[UUID] = None,
-        metadata: Optional[dict[str, Any]] = None,
-        name: Optional[str] = None,
+        tags: list[str] | None = None,
+        parent_run_id: UUID | None = None,
+        metadata: dict[str, Any] | None = None,
+        name: str | None = None,
         **kwargs: Any,
     ) -> Run:
         """Start a trace for an LLM run.
@@ -110,11 +108,11 @@ class BaseTracer(_TracerCore, BaseCallbackHandler, ABC):
             serialized: The serialized model.
             prompts: The prompts to start the LLM with.
             run_id: The run ID.
-            tags: The tags for the run. Defaults to None.
-            parent_run_id: The parent run ID. Defaults to None.
-            metadata: The metadata for the run. Defaults to None.
+            tags: The tags for the run.
+            parent_run_id: The parent run ID.
+            metadata: The metadata for the run.
             name: The name of the run.
-            kwargs: Additional arguments.
+            **kwargs: Additional arguments.
 
         Returns:
             The run.
@@ -138,19 +136,19 @@ class BaseTracer(_TracerCore, BaseCallbackHandler, ABC):
         self,
         token: str,
         *,
-        chunk: Optional[Union[GenerationChunk, ChatGenerationChunk]] = None,
+        chunk: GenerationChunk | ChatGenerationChunk | None = None,
         run_id: UUID,
-        parent_run_id: Optional[UUID] = None,
+        parent_run_id: UUID | None = None,
         **kwargs: Any,
     ) -> Run:
         """Run on new LLM token. Only available when streaming is enabled.
 
         Args:
             token: The token.
-            chunk: The chunk. Defaults to None.
+            chunk: The chunk.
             run_id: The run ID.
-            parent_run_id: The parent run ID. Defaults to None.
-            kwargs: Additional arguments.
+            parent_run_id: The parent run ID.
+            **kwargs: Additional arguments.
 
         Returns:
             The run.
@@ -179,7 +177,7 @@ class BaseTracer(_TracerCore, BaseCallbackHandler, ABC):
         Args:
             retry_state: The retry state.
             run_id: The run ID.
-            kwargs: Additional arguments.
+            **kwargs: Additional arguments.
 
         Returns:
             The run.
@@ -196,7 +194,7 @@ class BaseTracer(_TracerCore, BaseCallbackHandler, ABC):
         Args:
             response: The response.
             run_id: The run ID.
-            kwargs: Additional arguments.
+            **kwargs: Additional arguments.
 
         Returns:
             The run.
@@ -223,7 +221,7 @@ class BaseTracer(_TracerCore, BaseCallbackHandler, ABC):
         Args:
             error: The error.
             run_id: The run ID.
-            kwargs: Additional arguments.
+            **kwargs: Additional arguments.
 
         Returns:
             The run.
@@ -244,11 +242,11 @@ class BaseTracer(_TracerCore, BaseCallbackHandler, ABC):
         inputs: dict[str, Any],
         *,
         run_id: UUID,
-        tags: Optional[list[str]] = None,
-        parent_run_id: Optional[UUID] = None,
-        metadata: Optional[dict[str, Any]] = None,
-        run_type: Optional[str] = None,
-        name: Optional[str] = None,
+        tags: list[str] | None = None,
+        parent_run_id: UUID | None = None,
+        metadata: dict[str, Any] | None = None,
+        run_type: str | None = None,
+        name: str | None = None,
         **kwargs: Any,
     ) -> Run:
         """Start a trace for a chain run.
@@ -257,12 +255,12 @@ class BaseTracer(_TracerCore, BaseCallbackHandler, ABC):
             serialized: The serialized chain.
             inputs: The inputs for the chain.
             run_id: The run ID.
-            tags: The tags for the run. Defaults to None.
-            parent_run_id: The parent run ID. Defaults to None.
-            metadata: The metadata for the run. Defaults to None.
-            run_type: The type of the run. Defaults to None.
+            tags: The tags for the run.
+            parent_run_id: The parent run ID.
+            metadata: The metadata for the run.
+            run_type: The type of the run.
             name: The name of the run.
-            kwargs: Additional arguments.
+            **kwargs: Additional arguments.
 
         Returns:
             The run.
@@ -288,7 +286,7 @@ class BaseTracer(_TracerCore, BaseCallbackHandler, ABC):
         outputs: dict[str, Any],
         *,
         run_id: UUID,
-        inputs: Optional[dict[str, Any]] = None,
+        inputs: dict[str, Any] | None = None,
         **kwargs: Any,
     ) -> Run:
         """End a trace for a chain run.
@@ -296,8 +294,8 @@ class BaseTracer(_TracerCore, BaseCallbackHandler, ABC):
         Args:
             outputs: The outputs for the chain.
             run_id: The run ID.
-            inputs: The inputs for the chain. Defaults to None.
-            kwargs: Additional arguments.
+            inputs: The inputs for the chain.
+            **kwargs: Additional arguments.
 
         Returns:
             The run.
@@ -316,7 +314,7 @@ class BaseTracer(_TracerCore, BaseCallbackHandler, ABC):
         self,
         error: BaseException,
         *,
-        inputs: Optional[dict[str, Any]] = None,
+        inputs: dict[str, Any] | None = None,
         run_id: UUID,
         **kwargs: Any,
     ) -> Run:
@@ -324,9 +322,9 @@ class BaseTracer(_TracerCore, BaseCallbackHandler, ABC):
 
         Args:
             error: The error.
-            inputs: The inputs for the chain. Defaults to None.
+            inputs: The inputs for the chain.
             run_id: The run ID.
-            kwargs: Additional arguments.
+            **kwargs: Additional arguments.
 
         Returns:
             The run.
@@ -346,11 +344,11 @@ class BaseTracer(_TracerCore, BaseCallbackHandler, ABC):
         input_str: str,
         *,
         run_id: UUID,
-        tags: Optional[list[str]] = None,
-        parent_run_id: Optional[UUID] = None,
-        metadata: Optional[dict[str, Any]] = None,
-        name: Optional[str] = None,
-        inputs: Optional[dict[str, Any]] = None,
+        tags: list[str] | None = None,
+        parent_run_id: UUID | None = None,
+        metadata: dict[str, Any] | None = None,
+        name: str | None = None,
+        inputs: dict[str, Any] | None = None,
         **kwargs: Any,
     ) -> Run:
         """Start a trace for a tool run.
@@ -359,12 +357,12 @@ class BaseTracer(_TracerCore, BaseCallbackHandler, ABC):
             serialized: The serialized tool.
             input_str: The input string.
             run_id: The run ID.
-            tags: The tags for the run. Defaults to None.
-            parent_run_id: The parent run ID. Defaults to None.
-            metadata: The metadata for the run. Defaults to None.
+            tags: The tags for the run.
+            parent_run_id: The parent run ID.
+            metadata: The metadata for the run.
             name: The name of the run.
             inputs: The inputs for the tool.
-            kwargs: Additional arguments.
+            **kwargs: Additional arguments.
 
         Returns:
             The run.
@@ -391,7 +389,7 @@ class BaseTracer(_TracerCore, BaseCallbackHandler, ABC):
         Args:
             output: The output for the tool.
             run_id: The run ID.
-            kwargs: Additional arguments.
+            **kwargs: Additional arguments.
 
         Returns:
             The run.
@@ -417,7 +415,7 @@ class BaseTracer(_TracerCore, BaseCallbackHandler, ABC):
         Args:
             error: The error.
             run_id: The run ID.
-            kwargs: Additional arguments.
+            **kwargs: Additional arguments.
 
         Returns:
             The run.
@@ -436,10 +434,10 @@ class BaseTracer(_TracerCore, BaseCallbackHandler, ABC):
         query: str,
         *,
         run_id: UUID,
-        parent_run_id: Optional[UUID] = None,
-        tags: Optional[list[str]] = None,
-        metadata: Optional[dict[str, Any]] = None,
-        name: Optional[str] = None,
+        parent_run_id: UUID | None = None,
+        tags: list[str] | None = None,
+        metadata: dict[str, Any] | None = None,
+        name: str | None = None,
         **kwargs: Any,
     ) -> Run:
         """Run when the Retriever starts running.
@@ -448,11 +446,11 @@ class BaseTracer(_TracerCore, BaseCallbackHandler, ABC):
             serialized: The serialized retriever.
             query: The query.
             run_id: The run ID.
-            parent_run_id: The parent run ID. Defaults to None.
-            tags: The tags for the run. Defaults to None.
-            metadata: The metadata for the run. Defaults to None.
+            parent_run_id: The parent run ID.
+            tags: The tags for the run.
+            metadata: The metadata for the run.
             name: The name of the run.
-            kwargs: Additional arguments.
+            **kwargs: Additional arguments.
 
         Returns:
             The run.
@@ -484,7 +482,7 @@ class BaseTracer(_TracerCore, BaseCallbackHandler, ABC):
         Args:
             error: The error.
             run_id: The run ID.
-            kwargs: Additional arguments.
+            **kwargs: Additional arguments.
 
         Returns:
             The run.
@@ -506,7 +504,7 @@ class BaseTracer(_TracerCore, BaseCallbackHandler, ABC):
         Args:
             documents: The documents.
             run_id: The run ID.
-            kwargs: Additional arguments.
+            **kwargs: Additional arguments.
 
         Returns:
             The run.
@@ -565,10 +563,10 @@ class AsyncBaseTracer(_TracerCore, AsyncCallbackHandler, ABC):
         messages: list[list[BaseMessage]],
         *,
         run_id: UUID,
-        parent_run_id: Optional[UUID] = None,
-        tags: Optional[list[str]] = None,
-        metadata: Optional[dict[str, Any]] = None,
-        name: Optional[str] = None,
+        parent_run_id: UUID | None = None,
+        tags: list[str] | None = None,
+        metadata: dict[str, Any] | None = None,
+        name: str | None = None,
         **kwargs: Any,
     ) -> Any:
         chat_model_run = self._create_chat_model_run(
@@ -595,9 +593,9 @@ class AsyncBaseTracer(_TracerCore, AsyncCallbackHandler, ABC):
         prompts: list[str],
         *,
         run_id: UUID,
-        parent_run_id: Optional[UUID] = None,
-        tags: Optional[list[str]] = None,
-        metadata: Optional[dict[str, Any]] = None,
+        parent_run_id: UUID | None = None,
+        tags: list[str] | None = None,
+        metadata: dict[str, Any] | None = None,
         **kwargs: Any,
     ) -> None:
         llm_run = self._create_llm_run(
@@ -617,9 +615,9 @@ class AsyncBaseTracer(_TracerCore, AsyncCallbackHandler, ABC):
         self,
         token: str,
         *,
-        chunk: Optional[Union[GenerationChunk, ChatGenerationChunk]] = None,
+        chunk: GenerationChunk | ChatGenerationChunk | None = None,
         run_id: UUID,
-        parent_run_id: Optional[UUID] = None,
+        parent_run_id: UUID | None = None,
         **kwargs: Any,
     ) -> None:
         llm_run = self._llm_run_with_token_event(
@@ -649,8 +647,8 @@ class AsyncBaseTracer(_TracerCore, AsyncCallbackHandler, ABC):
         response: LLMResult,
         *,
         run_id: UUID,
-        parent_run_id: Optional[UUID] = None,
-        tags: Optional[list[str]] = None,
+        parent_run_id: UUID | None = None,
+        tags: list[str] | None = None,
         **kwargs: Any,
     ) -> None:
         llm_run = self._complete_llm_run(
@@ -666,8 +664,8 @@ class AsyncBaseTracer(_TracerCore, AsyncCallbackHandler, ABC):
         error: BaseException,
         *,
         run_id: UUID,
-        parent_run_id: Optional[UUID] = None,
-        tags: Optional[list[str]] = None,
+        parent_run_id: UUID | None = None,
+        tags: list[str] | None = None,
         **kwargs: Any,
     ) -> None:
         llm_run = self._errored_llm_run(
@@ -684,11 +682,11 @@ class AsyncBaseTracer(_TracerCore, AsyncCallbackHandler, ABC):
         inputs: dict[str, Any],
         *,
         run_id: UUID,
-        tags: Optional[list[str]] = None,
-        parent_run_id: Optional[UUID] = None,
-        metadata: Optional[dict[str, Any]] = None,
-        run_type: Optional[str] = None,
-        name: Optional[str] = None,
+        tags: list[str] | None = None,
+        parent_run_id: UUID | None = None,
+        metadata: dict[str, Any] | None = None,
+        run_type: str | None = None,
+        name: str | None = None,
         **kwargs: Any,
     ) -> None:
         chain_run = self._create_chain_run(
@@ -711,7 +709,7 @@ class AsyncBaseTracer(_TracerCore, AsyncCallbackHandler, ABC):
         outputs: dict[str, Any],
         *,
         run_id: UUID,
-        inputs: Optional[dict[str, Any]] = None,
+        inputs: dict[str, Any] | None = None,
         **kwargs: Any,
     ) -> None:
         chain_run = self._complete_chain_run(
@@ -727,7 +725,7 @@ class AsyncBaseTracer(_TracerCore, AsyncCallbackHandler, ABC):
         self,
         error: BaseException,
         *,
-        inputs: Optional[dict[str, Any]] = None,
+        inputs: dict[str, Any] | None = None,
         run_id: UUID,
         **kwargs: Any,
     ) -> None:
@@ -746,11 +744,11 @@ class AsyncBaseTracer(_TracerCore, AsyncCallbackHandler, ABC):
         input_str: str,
         *,
         run_id: UUID,
-        tags: Optional[list[str]] = None,
-        parent_run_id: Optional[UUID] = None,
-        metadata: Optional[dict[str, Any]] = None,
-        name: Optional[str] = None,
-        inputs: Optional[dict[str, Any]] = None,
+        tags: list[str] | None = None,
+        parent_run_id: UUID | None = None,
+        metadata: dict[str, Any] | None = None,
+        name: str | None = None,
+        inputs: dict[str, Any] | None = None,
         **kwargs: Any,
     ) -> None:
         tool_run = self._create_tool_run(
@@ -787,8 +785,8 @@ class AsyncBaseTracer(_TracerCore, AsyncCallbackHandler, ABC):
         error: BaseException,
         *,
         run_id: UUID,
-        parent_run_id: Optional[UUID] = None,
-        tags: Optional[list[str]] = None,
+        parent_run_id: UUID | None = None,
+        tags: list[str] | None = None,
         **kwargs: Any,
     ) -> None:
         tool_run = self._errored_tool_run(
@@ -805,10 +803,10 @@ class AsyncBaseTracer(_TracerCore, AsyncCallbackHandler, ABC):
         query: str,
         *,
         run_id: UUID,
-        parent_run_id: Optional[UUID] = None,
-        tags: Optional[list[str]] = None,
-        metadata: Optional[dict[str, Any]] = None,
-        name: Optional[str] = None,
+        parent_run_id: UUID | None = None,
+        tags: list[str] | None = None,
+        metadata: dict[str, Any] | None = None,
+        name: str | None = None,
         **kwargs: Any,
     ) -> None:
         retriever_run = self._create_retrieval_run(
@@ -832,8 +830,8 @@ class AsyncBaseTracer(_TracerCore, AsyncCallbackHandler, ABC):
         error: BaseException,
         *,
         run_id: UUID,
-        parent_run_id: Optional[UUID] = None,
-        tags: Optional[list[str]] = None,
+        parent_run_id: UUID | None = None,
+        tags: list[str] | None = None,
         **kwargs: Any,
     ) -> None:
         retrieval_run = self._errored_retrieval_run(
@@ -852,8 +850,8 @@ class AsyncBaseTracer(_TracerCore, AsyncCallbackHandler, ABC):
         documents: Sequence[Document],
         *,
         run_id: UUID,
-        parent_run_id: Optional[UUID] = None,
-        tags: Optional[list[str]] = None,
+        parent_run_id: UUID | None = None,
+        tags: list[str] | None = None,
         **kwargs: Any,
     ) -> None:
         retrieval_run = self._complete_retrieval_run(
@@ -882,7 +880,7 @@ class AsyncBaseTracer(_TracerCore, AsyncCallbackHandler, ABC):
         self,
         run: Run,
         token: str,
-        chunk: Optional[Union[GenerationChunk, ChatGenerationChunk]],
+        chunk: GenerationChunk | ChatGenerationChunk | None,
     ) -> None:
         """Process new LLM token."""