langchain-core 1.0.0a8__py3-none-any.whl → 1.0.0rc1__py3-none-any.whl

langchain_core/language_models/_utils.py

@@ -19,7 +19,7 @@ def is_openai_data_block(
 ) -> bool:
     """Check whether a block contains multimodal data in OpenAI Chat Completions format.
 
-    Supports both data and ID-style blocks (e.g. ``'file_data'`` and ``'file_id'``)
+    Supports both data and ID-style blocks (e.g. `'file_data'` and `'file_id'`)
 
     If additional keys are present, they are ignored / will not affect outcome as long
     as the required keys are present and valid.
@@ -30,12 +30,12 @@ def is_openai_data_block(
             - "image": Only match image_url blocks
             - "audio": Only match input_audio blocks
             - "file": Only match file blocks
-            If None, match any valid OpenAI data block type. Note that this means that
+            If `None`, match any valid OpenAI data block type. Note that this means that
             if the block has a valid OpenAI data type but the filter_ is set to a
             different type, this function will return False.
 
     Returns:
-        True if the block is a valid OpenAI data block and matches the filter_
+        `True` if the block is a valid OpenAI data block and matches the filter_
         (if provided).
 
     """
@@ -92,18 +92,16 @@ def _parse_data_uri(uri: str) -> ParsedDataUri | None:
     If parsing fails, return None. If either MIME type or data is missing, return None.
 
     Example:
-
-        .. code-block:: python
-
-            data_uri = "data:image/jpeg;base64,/9j/4AAQSkZJRg..."
-            parsed = _parse_data_uri(data_uri)
-
-            assert parsed == {
-                "source_type": "base64",
-                "mime_type": "image/jpeg",
-                "data": "/9j/4AAQSkZJRg...",
-            }
-
+        ```python
+        data_uri = "data:image/jpeg;base64,/9j/4AAQSkZJRg..."
+        parsed = _parse_data_uri(data_uri)
+
+        assert parsed == {
+            "source_type": "base64",
+            "mime_type": "image/jpeg",
+            "data": "/9j/4AAQSkZJRg...",
+        }
+        ```
     """
     regex = r"^data:(?P<mime_type>[^;]+);base64,(?P<data>.+)$"
     match = re.match(regex, uri)
@@ -133,8 +131,8 @@ def _normalize_messages(
     - LangChain v1 standard content blocks
 
     This function extends support to:
-    - `Audio <https://platform.openai.com/docs/api-reference/chat/create>`__ and
-        `file <https://platform.openai.com/docs/api-reference/files>`__ data in OpenAI
+    - `[Audio](https://platform.openai.com/docs/api-reference/chat/create) and
+        `[file](https://platform.openai.com/docs/api-reference/files) data in OpenAI
         Chat Completions format
         - Images are technically supported but we expect chat models to handle them
             directly; this may change in the future
@@ -148,50 +146,50 @@ def _normalize_messages(
 
     ??? note "v0 Content Block Schemas"
 
-        ``URLContentBlock``:
+        `URLContentBlock`:
 
-        .. codeblock::
-
-            {
-                mime_type: NotRequired[str]
-                type: Literal['image', 'audio', 'file'],
-                source_type: Literal['url'],
-                url: str,
-            }
-
-        ``Base64ContentBlock``:
+        ```python
+        {
+            mime_type: NotRequired[str]
+            type: Literal['image', 'audio', 'file'],
+            source_type: Literal['url'],
+            url: str,
+        }
+        ```
 
-        .. codeblock::
+        `Base64ContentBlock`:
 
-            {
-                mime_type: NotRequired[str]
-                type: Literal['image', 'audio', 'file'],
-                source_type: Literal['base64'],
-                data: str,
-            }
+        ```python
+        {
+            mime_type: NotRequired[str]
+            type: Literal['image', 'audio', 'file'],
+            source_type: Literal['base64'],
+            data: str,
+        }
+        ```
 
-        ``IDContentBlock``:
+        `IDContentBlock`:
 
         (In practice, this was never used)
 
-        .. codeblock::
-
-            {
-                type: Literal['image', 'audio', 'file'],
-                source_type: Literal['id'],
-                id: str,
-            }
-
-        ``PlainTextContentBlock``:
+        ```python
+        {
+            type: Literal["image", "audio", "file"],
+            source_type: Literal["id"],
+            id: str,
+        }
+        ```
 
-        .. codeblock::
+        `PlainTextContentBlock`:
 
-            {
-                mime_type: NotRequired[str]
-                type: Literal['file'],
-                source_type: Literal['text'],
-                url: str,
-            }
+        ```python
+        {
+            mime_type: NotRequired[str]
+            type: Literal['file'],
+            source_type: Literal['text'],
+            url: str,
+        }
+        ```
 
     If a v1 message is passed in, it will be returned as-is, meaning it is safe to
     always pass in v1 messages to this function for assurance.
@@ -222,7 +220,7 @@ def _normalize_messages(
         "type": Literal['file'],
         "file": Union[
             {
-                "filename": Optional[str] = "$FILENAME",
+                "filename": str | None = "$FILENAME",
                 "file_data": str = "$BASE64_ENCODED_FILE",
             },
             {

langchain_core/language_models/base.py

@@ -110,20 +110,19 @@ class BaseLanguageModel(
 ):
     """Abstract base class for interfacing with language models.
 
-    All language model wrappers inherited from ``BaseLanguageModel``.
+    All language model wrappers inherited from `BaseLanguageModel`.
 
     """
 
     cache: BaseCache | bool | None = Field(default=None, exclude=True)
     """Whether to cache the response.
 
-    * If true, will use the global cache.
-    * If false, will not use a cache
-    * If None, will use the global cache if it's set, otherwise no cache.
-    * If instance of ``BaseCache``, will use the provided cache.
+    * If `True`, will use the global cache.
+    * If `False`, will not use a cache
+    * If `None`, will use the global cache if it's set, otherwise no cache.
+    * If instance of `BaseCache`, will use the provided cache.
 
     Caching is not currently supported for streaming methods of models.
-
     """
     verbose: bool = Field(default_factory=_get_verbosity, exclude=True, repr=False)
     """Whether to print out response text."""
@@ -144,9 +143,9 @@ class BaseLanguageModel(
 
     @field_validator("verbose", mode="before")
     def set_verbose(cls, verbose: bool | None) -> bool:  # noqa: FBT001
-        """If verbose is None, set it.
+        """If verbose is `None`, set it.
 
-        This allows users to pass in None as verbose to access the global setting.
+        This allows users to pass in `None` as verbose to access the global setting.
 
         Args:
             verbose: The verbosity setting to use.
@@ -162,7 +161,7 @@ class BaseLanguageModel(
     @property
     @override
     def InputType(self) -> TypeAlias:
-        """Get the input type for this runnable."""
+        """Get the input type for this `Runnable`."""
         # This is a version of LanguageModelInput which replaces the abstract
         # base class BaseMessage with a union of its subclasses, which makes
         # for a much better schema.
@@ -186,12 +185,12 @@ class BaseLanguageModel(
         1. Take advantage of batched calls,
         2. Need more output from the model than just the top generated value,
         3. Are building chains that are agnostic to the underlying language model
-           type (e.g., pure text completion models vs chat models).
+            type (e.g., pure text completion models vs chat models).
 
         Args:
-            prompts: List of PromptValues. A PromptValue is an object that can be
-                converted to match the format of any language model (string for pure
-                text generation models and BaseMessages for chat models).
+            prompts: List of `PromptValue` objects. A `PromptValue` is an object that
+                can be converted to match the format of any language model (string for
+                pure text generation models and `BaseMessage` objects for chat models).
             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
@@ -200,8 +199,8 @@ class BaseLanguageModel(
                 to the model provider API call.
 
         Returns:
-            An LLMResult, which contains a list of candidate Generations for each input
-            prompt and additional model provider-specific output.
+            An `LLMResult`, which contains a list of candidate `Generation` objects for
+            each input prompt and additional model provider-specific output.
 
         """
 
@@ -223,12 +222,12 @@ class BaseLanguageModel(
         1. Take advantage of batched calls,
         2. Need more output from the model than just the top generated value,
         3. Are building chains that are agnostic to the underlying language model
-           type (e.g., pure text completion models vs chat models).
+            type (e.g., pure text completion models vs chat models).
 
         Args:
-            prompts: List of PromptValues. A PromptValue is an object that can be
-                converted to match the format of any language model (string for pure
-                text generation models and BaseMessages for chat models).
+            prompts: List of `PromptValue` objects. A `PromptValue` is an object that
+                can be converted to match the format of any language model (string for
+                pure text generation models and `BaseMessage` objects for chat models).
             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
@@ -237,8 +236,8 @@ class BaseLanguageModel(
                 to the model provider API call.
 
         Returns:
-            An ``LLMResult``, which contains a list of candidate Generations for each
-            input prompt and additional model provider-specific output.
+            An `LLMResult`, which contains a list of candidate `Generation` objects for
+            each input prompt and additional model provider-specific output.
 
         """
 
@@ -294,13 +293,13 @@ class BaseLanguageModel(
         Useful for checking if an input fits in a model's context window.
 
         !!! note
-            The base implementation of ``get_num_tokens_from_messages`` ignores tool
+            The base implementation of `get_num_tokens_from_messages` ignores tool
             schemas.
 
         Args:
             messages: The message inputs to tokenize.
-            tools: If provided, sequence of dict, ``BaseModel``, function, or
-                ``BaseTools`` to be converted to tool schemas.
+            tools: If provided, sequence of dict, `BaseModel`, function, or
+                `BaseTool` objects to be converted to tool schemas.
 
         Returns:
             The sum of the number of tokens across the messages.