langchain-core 1.0.3__py3-none-any.whl → 1.0.4__py3-none-any.whl

langchain_core/language_models/llms.py

@@ -651,9 +651,12 @@ class BaseLLM(BaseLanguageModel[str], ABC):
 
         Args:
             prompts: The prompts to generate from.
-            stop: Stop words to use when generating. Model output is cut off at the
-                first occurrence of any of the stop substrings.
-                If stop tokens are not supported consider raising NotImplementedError.
+            stop: Stop words to use when generating.
+
+                Model output is cut off at the first occurrence of any of these
+                substrings.
+
+                If stop tokens are not supported consider raising `NotImplementedError`.
             run_manager: Callback manager for the run.
 
         Returns:
@@ -671,9 +674,12 @@ class BaseLLM(BaseLanguageModel[str], ABC):
 
         Args:
             prompts: The prompts to generate from.
-            stop: Stop words to use when generating. Model output is cut off at the
-                first occurrence of any of the stop substrings.
-                If stop tokens are not supported consider raising NotImplementedError.
+            stop: Stop words to use when generating.
+
+                Model output is cut off at the first occurrence of any of these
+                substrings.
+
+                If stop tokens are not supported consider raising `NotImplementedError`.
             run_manager: Callback manager for the run.
 
         Returns:
@@ -705,11 +711,14 @@ class BaseLLM(BaseLanguageModel[str], ABC):
 
         Args:
             prompt: The prompt to generate from.
-            stop: Stop words to use when generating. Model output is cut off at the
-                first occurrence of any of these substrings.
+            stop: Stop words to use when generating.
+
+                Model output is cut off at the first occurrence of any of these
+                substrings.
             run_manager: Callback manager for the run.
-            **kwargs: Arbitrary additional keyword arguments. These are usually passed
-                to the model provider API call.
+            **kwargs: Arbitrary additional keyword arguments.
+
+                These are usually passed to the model provider API call.
 
         Yields:
             Generation chunks.
@@ -731,11 +740,14 @@ class BaseLLM(BaseLanguageModel[str], ABC):
 
         Args:
             prompt: The prompt to generate from.
-            stop: Stop words to use when generating. Model output is cut off at the
-                first occurrence of any of these substrings.
+            stop: Stop words to use when generating.
+
+                Model output is cut off at the first occurrence of any of these
+                substrings.
             run_manager: Callback manager for the run.
-            **kwargs: Arbitrary additional keyword arguments. These are usually passed
-                to the model provider API call.
+            **kwargs: Arbitrary additional keyword arguments.
+
+                These are usually passed to the model provider API call.
 
         Yields:
             Generation chunks.
@@ -846,10 +858,14 @@ class BaseLLM(BaseLanguageModel[str], ABC):
 
         Args:
             prompts: List of string prompts.
-            stop: Stop words to use when generating. Model output is cut off at the
-                first occurrence of any of these substrings.
-            callbacks: `Callbacks` to pass through. Used for executing additional
-                functionality, such as logging or streaming, throughout generation.
+            stop: Stop words to use when generating.
+
+                Model output is cut off at the first occurrence of any of these
+                substrings.
+            callbacks: `Callbacks` to pass through.
+
+                Used for executing additional functionality, such as logging or
+                streaming, throughout generation.
             tags: List of tags to associate with each prompt. If provided, the length
                 of the list must match the length of the prompts list.
             metadata: List of metadata dictionaries to associate with each prompt. If
@@ -859,8 +875,9 @@ class BaseLLM(BaseLanguageModel[str], ABC):
                 length of the list must match the length of the prompts list.
             run_id: List of run IDs to associate with each prompt. If provided, the
                 length of the list must match the length of the prompts list.
-            **kwargs: Arbitrary additional keyword arguments. These are usually passed
-                to the model provider API call.
+            **kwargs: Arbitrary additional keyword arguments.
+
+                These are usually passed to the model provider API call.
 
         Raises:
             ValueError: If prompts is not a list.
@@ -1116,10 +1133,14 @@ class BaseLLM(BaseLanguageModel[str], ABC):
 
         Args:
             prompts: List of string prompts.
-            stop: Stop words to use when generating. Model output is cut off at the
-                first occurrence of any of these substrings.
-            callbacks: `Callbacks` to pass through. Used for executing additional
-                functionality, such as logging or streaming, throughout generation.
+            stop: Stop words to use when generating.
+
+                Model output is cut off at the first occurrence of any of these
+                substrings.
+            callbacks: `Callbacks` to pass through.
+
+                Used for executing additional functionality, such as logging or
+                streaming, throughout generation.
             tags: List of tags to associate with each prompt. If provided, the length
                 of the list must match the length of the prompts list.
             metadata: List of metadata dictionaries to associate with each prompt. If
@@ -1129,8 +1150,9 @@ class BaseLLM(BaseLanguageModel[str], ABC):
                 length of the list must match the length of the prompts list.
             run_id: List of run IDs to associate with each prompt. If provided, the
                 length of the list must match the length of the prompts list.
-            **kwargs: Arbitrary additional keyword arguments. These are usually passed
-                to the model provider API call.
+            **kwargs: Arbitrary additional keyword arguments.
+
+                These are usually passed to the model provider API call.
 
         Raises:
             ValueError: If the length of `callbacks`, `tags`, `metadata`, or
@@ -1410,12 +1432,16 @@ class LLM(BaseLLM):
 
         Args:
             prompt: The prompt to generate from.
-            stop: Stop words to use when generating. Model output is cut off at the
-                first occurrence of any of the stop substrings.
-                If stop tokens are not supported consider raising NotImplementedError.
+            stop: Stop words to use when generating.
+
+                Model output is cut off at the first occurrence of any of these
+                substrings.
+
+                If stop tokens are not supported consider raising `NotImplementedError`.
             run_manager: Callback manager for the run.
-            **kwargs: Arbitrary additional keyword arguments. These are usually passed
-                to the model provider API call.
+            **kwargs: Arbitrary additional keyword arguments.
+
+                These are usually passed to the model provider API call.
 
         Returns:
             The model output as a string. SHOULD NOT include the prompt.
@@ -1436,12 +1462,16 @@ class LLM(BaseLLM):
 
         Args:
             prompt: The prompt to generate from.
-            stop: Stop words to use when generating. Model output is cut off at the
-                first occurrence of any of the stop substrings.
-                If stop tokens are not supported consider raising NotImplementedError.
+            stop: Stop words to use when generating.
+
+                Model output is cut off at the first occurrence of any of these
+                substrings.
+
+                If stop tokens are not supported consider raising `NotImplementedError`.
             run_manager: Callback manager for the run.
-            **kwargs: Arbitrary additional keyword arguments. These are usually passed
-                to the model provider API call.
+            **kwargs: Arbitrary additional keyword arguments.
+
+                These are usually passed to the model provider API call.
 
         Returns:
             The model output as a string. SHOULD NOT include the prompt.

langchain_core/messages/ai.py

@@ -50,7 +50,7 @@ class InputTokenDetails(TypedDict, total=False):
 
     May also hold extra provider-specific keys.
 
-    !!! version-added "Added in version 0.3.9"
+    !!! version-added "Added in `langchain-core` 0.3.9"
 
     """
 
@@ -85,7 +85,7 @@ class OutputTokenDetails(TypedDict, total=False):
 
     May also hold extra provider-specific keys.
 
-    !!! version-added "Added in version 0.3.9"
+    !!! version-added "Added in `langchain-core` 0.3.9"
 
     """
 
@@ -123,7 +123,7 @@ class UsageMetadata(TypedDict):
         }
         ```
 
-    !!! warning "Behavior changed in 0.3.9"
+    !!! warning "Behavior changed in `langchain-core` 0.3.9"
         Added `input_token_details` and `output_token_details`.
 
     !!! note "LangSmith SDK"

langchain_core/messages/base.py

@@ -199,7 +199,7 @@ class BaseMessage(Serializable):
     def content_blocks(self) -> list[types.ContentBlock]:
         r"""Load content blocks from the message content.
 
-        !!! version-added "Added in version 1.0.0"
+        !!! version-added "Added in `langchain-core` 1.0.0"
 
         """
         # Needed here to avoid circular import, as these classes import BaseMessages

langchain_core/messages/content.py

@@ -867,7 +867,7 @@ def _get_data_content_block_types() -> tuple[str, ...]:
     Example: ("image", "video", "audio", "text-plain", "file")
 
     Note that old style multimodal blocks type literals with new style blocks.
-    Speficially, "image", "audio", and "file".
+    Specifically, "image", "audio", and "file".
 
     See the docstring of `_normalize_messages` in `language_models._utils` for details.
     """
@@ -906,7 +906,7 @@ def is_data_content_block(block: dict) -> bool:
 
         # 'text' is checked to support v0 PlainTextContentBlock types
         # We must guard against new style TextContentBlock which also has 'text' `type`
-        # by ensuring the presense of `source_type`
+        # by ensuring the presence of `source_type`
         if block["type"] == "text" and "source_type" not in block:  # noqa: SIM103  # This is more readable
             return False
 

langchain_core/messages/utils.py

@@ -328,12 +328,16 @@ def _convert_to_message(message: MessageLikeRepresentation) -> BaseMessage:
     """
     if isinstance(message, BaseMessage):
         message_ = message
-    elif isinstance(message, str):
-        message_ = _create_message_from_message_type("human", message)
-    elif isinstance(message, Sequence) and len(message) == 2:
-        # mypy doesn't realise this can't be a string given the previous branch
-        message_type_str, template = message  # type: ignore[misc]
-        message_ = _create_message_from_message_type(message_type_str, template)
+    elif isinstance(message, Sequence):
+        if isinstance(message, str):
+            message_ = _create_message_from_message_type("human", message)
+        else:
+            try:
+                message_type_str, template = message
+            except ValueError as e:
+                msg = "Message as a sequence must be (role string, template)"
+                raise NotImplementedError(msg) from e
+            message_ = _create_message_from_message_type(message_type_str, template)
     elif isinstance(message, dict):
         msg_kwargs = message.copy()
         try:
@@ -1097,7 +1101,7 @@ def convert_to_openai_messages(
         # ]
         ```
 
-    !!! version-added "Added in version 0.3.11"
+    !!! version-added "Added in `langchain-core` 0.3.11"
 
     """  # noqa: E501
     if text_format not in {"string", "block"}:
@@ -1697,7 +1701,7 @@ def count_tokens_approximately(
     Warning:
         This function does not currently support counting image tokens.
 
-    !!! version-added "Added in version 0.3.46"
+    !!! version-added "Added in `langchain-core` 0.3.46"
 
     """
     token_count = 0.0

langchain_core/output_parsers/openai_tools.py

@@ -15,7 +15,11 @@ from langchain_core.messages.tool import tool_call as create_tool_call
 from langchain_core.output_parsers.transform import BaseCumulativeTransformOutputParser
 from langchain_core.outputs import ChatGeneration, Generation
 from langchain_core.utils.json import parse_partial_json
-from langchain_core.utils.pydantic import TypeBaseModel
+from langchain_core.utils.pydantic import (
+    TypeBaseModel,
+    is_pydantic_v1_subclass,
+    is_pydantic_v2_subclass,
+)
 
 logger = logging.getLogger(__name__)
 
@@ -323,7 +327,15 @@ class PydanticToolsParser(JsonOutputToolsParser):
             return None if self.first_tool_only else []
 
         json_results = [json_results] if self.first_tool_only else json_results
-        name_dict = {tool.__name__: tool for tool in self.tools}
+        name_dict_v2: dict[str, TypeBaseModel] = {
+            tool.model_config.get("title") or tool.__name__: tool
+            for tool in self.tools
+            if is_pydantic_v2_subclass(tool)
+        }
+        name_dict_v1: dict[str, TypeBaseModel] = {
+            tool.__name__: tool for tool in self.tools if is_pydantic_v1_subclass(tool)
+        }
+        name_dict: dict[str, TypeBaseModel] = {**name_dict_v2, **name_dict_v1}
         pydantic_objects = []
         for res in json_results:
             if not isinstance(res["args"], dict):

langchain_core/outputs/generation.py

@@ -20,8 +20,7 @@ class Generation(Serializable):
 
     LangChain users working with chat models will usually access information via
     `AIMessage` (returned from runnable interfaces) or `LLMResult` (available
-    via callbacks). Please refer the `AIMessage` and `LLMResult` schema documentation
-    for more information.
+    via callbacks). Please refer to `AIMessage` and `LLMResult` for more information.
     """
 
     text: str
@@ -34,11 +33,13 @@ class Generation(Serializable):
     """
     type: Literal["Generation"] = "Generation"
     """Type is used exclusively for serialization purposes.
-    Set to "Generation" for this class."""
+
+    Set to "Generation" for this class.
+    """
 
     @classmethod
     def is_lc_serializable(cls) -> bool:
-        """Return True as this class is serializable."""
+        """Return `True` as this class is serializable."""
         return True
 
     @classmethod
@@ -52,7 +53,7 @@ class Generation(Serializable):
 
 
 class GenerationChunk(Generation):
-    """Generation chunk, which can be concatenated with other Generation chunks."""
+    """`GenerationChunk`, which can be concatenated with other Generation chunks."""
 
     def __add__(self, other: GenerationChunk) -> GenerationChunk:
         """Concatenate two `GenerationChunk`s.

langchain_core/prompt_values.py

@@ -30,7 +30,7 @@ class PromptValue(Serializable, ABC):
 
     @classmethod
     def is_lc_serializable(cls) -> bool:
-        """Return True as this class is serializable."""
+        """Return `True` as this class is serializable."""
         return True
 
     @classmethod
@@ -48,7 +48,7 @@ class PromptValue(Serializable, ABC):
 
     @abstractmethod
     def to_messages(self) -> list[BaseMessage]:
-        """Return prompt as a list of Messages."""
+        """Return prompt as a list of messages."""
 
 
 class StringPromptValue(PromptValue):

langchain_core/prompts/base.py

@@ -46,23 +46,27 @@ class BasePromptTemplate(
 
     input_variables: list[str]
     """A list of the names of the variables whose values are required as inputs to the
-    prompt."""
+    prompt.
+    """
     optional_variables: list[str] = Field(default=[])
     """A list of the names of the variables for placeholder or `MessagePlaceholder` that
     are optional.
 
-    These variables are auto inferred from the prompt and user need not provide them."""
+    These variables are auto inferred from the prompt and user need not provide them.
+    """
     input_types: typing.Dict[str, Any] = Field(default_factory=dict, exclude=True)  # noqa: UP006
     """A dictionary of the types of the variables the prompt template expects.
 
-    If not provided, all variables are assumed to be strings."""
+    If not provided, all variables are assumed to be strings.
+    """
     output_parser: BaseOutputParser | None = None
     """How to parse the output of calling an LLM on this formatted prompt."""
     partial_variables: Mapping[str, Any] = Field(default_factory=dict)
     """A dictionary of the partial variables the prompt template carries.
 
-    Partial variables populate the template so that you don't need to
-    pass them in every time you call the prompt."""
+    Partial variables populate the template so that you don't need to pass them in every
+    time you call the prompt.
+    """
     metadata: typing.Dict[str, Any] | None = None  # noqa: UP006
     """Metadata to be used for tracing."""
     tags: list[str] | None = None
@@ -107,7 +111,7 @@ class BasePromptTemplate(
 
     @classmethod
     def is_lc_serializable(cls) -> bool:
-        """Return True as this class is serializable."""
+        """Return `True` as this class is serializable."""
         return True
 
     model_config = ConfigDict(
@@ -129,7 +133,7 @@ class BasePromptTemplate(
         """Get the input schema for the prompt.
 
         Args:
-            config: configuration for the prompt.
+            config: Configuration for the prompt.
 
         Returns:
             The input schema for the prompt.
@@ -197,8 +201,8 @@ class BasePromptTemplate(
         """Invoke the prompt.
 
         Args:
-            input: Dict, input to the prompt.
-            config: RunnableConfig, configuration for the prompt.
+            input: Input to the prompt.
+            config: Configuration for the prompt.
 
         Returns:
             The output of the prompt.
@@ -223,8 +227,8 @@ class BasePromptTemplate(
         """Async invoke the prompt.
 
         Args:
-            input: Dict, input to the prompt.
-            config: RunnableConfig, configuration for the prompt.
+            input: Input to the prompt.
+            config: Configuration for the prompt.
 
         Returns:
             The output of the prompt.
@@ -244,7 +248,7 @@ class BasePromptTemplate(
 
     @abstractmethod
     def format_prompt(self, **kwargs: Any) -> PromptValue:
-        """Create Prompt Value.
+        """Create `PromptValue`.
 
         Args:
             **kwargs: Any arguments to be passed to the prompt template.
@@ -254,7 +258,7 @@ class BasePromptTemplate(
         """
 
     async def aformat_prompt(self, **kwargs: Any) -> PromptValue:
-        """Async create Prompt Value.
+        """Async create `PromptValue`.
 
         Args:
             **kwargs: Any arguments to be passed to the prompt template.
@@ -268,7 +272,7 @@ class BasePromptTemplate(
         """Return a partial of the prompt template.
 
         Args:
-            **kwargs: partial variables to set.
+            **kwargs: Partial variables to set.
 
         Returns:
             A partial of the prompt template.
@@ -298,9 +302,9 @@ class BasePromptTemplate(
             A formatted string.
 
         Example:
-        ```python
-        prompt.format(variable1="foo")
-        ```
+            ```python
+            prompt.format(variable1="foo")
+            ```
         """
 
     async def aformat(self, **kwargs: Any) -> FormatOutputType:
@@ -313,9 +317,9 @@ class BasePromptTemplate(
             A formatted string.
 
         Example:
-        ```python
-        await prompt.aformat(variable1="foo")
-        ```
+            ```python
+            await prompt.aformat(variable1="foo")
+            ```
         """
         return self.format(**kwargs)
 
@@ -350,9 +354,9 @@ class BasePromptTemplate(
             NotImplementedError: If the prompt type is not implemented.
 
         Example:
-        ```python
-        prompt.save(file_path="path/prompt.yaml")
-        ```
+            ```python
+            prompt.save(file_path="path/prompt.yaml")
+            ```
         """
         if self.partial_variables:
             msg = "Cannot save prompt with partial variables."
@@ -404,23 +408,23 @@ def format_document(doc: Document, prompt: BasePromptTemplate[str]) -> str:
 
     First, this pulls information from the document from two sources:
 
-    1. page_content:
-        This takes the information from the `document.page_content`
-        and assigns it to a variable named `page_content`.
-    2. metadata:
-        This takes information from `document.metadata` and assigns
-        it to variables of the same name.
+    1. `page_content`:
+        This takes the information from the `document.page_content` and assigns it to a
+        variable named `page_content`.
+    2. `metadata`:
+        This takes information from `document.metadata` and assigns it to variables of
+        the same name.
 
     Those variables are then passed into the `prompt` to produce a formatted string.
 
     Args:
-        doc: Document, the page_content and metadata will be used to create
+        doc: `Document`, the `page_content` and `metadata` will be used to create
             the final string.
-        prompt: BasePromptTemplate, will be used to format the page_content
-            and metadata into the final string.
+        prompt: `BasePromptTemplate`, will be used to format the `page_content`
+            and `metadata` into the final string.
 
     Returns:
-        string of the document formatted.
+        String of the document formatted.
 
     Example:
         ```python
@@ -431,7 +435,6 @@ def format_document(doc: Document, prompt: BasePromptTemplate[str]) -> str:
         prompt = PromptTemplate.from_template("Page {page}: {page_content}")
         format_document(doc, prompt)
         >>> "Page 1: This is a joke"
-
         ```
     """
     return prompt.format(**_get_document_info(doc, prompt))
@@ -442,22 +445,22 @@ async def aformat_document(doc: Document, prompt: BasePromptTemplate[str]) -> st
 
     First, this pulls information from the document from two sources:
 
-    1. page_content:
-        This takes the information from the `document.page_content`
-        and assigns it to a variable named `page_content`.
-    2. metadata:
-        This takes information from `document.metadata` and assigns
-        it to variables of the same name.
+    1. `page_content`:
+        This takes the information from the `document.page_content` and assigns it to a
+        variable named `page_content`.
+    2. `metadata`:
+        This takes information from `document.metadata` and assigns it to variables of
+        the same name.
 
     Those variables are then passed into the `prompt` to produce a formatted string.
 
     Args:
-        doc: Document, the page_content and metadata will be used to create
+        doc: `Document`, the `page_content` and `metadata` will be used to create
             the final string.
-        prompt: BasePromptTemplate, will be used to format the page_content
-            and metadata into the final string.
+        prompt: `BasePromptTemplate`, will be used to format the `page_content`
+            and `metadata` into the final string.
 
     Returns:
-        string of the document formatted.
+        String of the document formatted.
     """
     return await prompt.aformat(**_get_document_info(doc, prompt))