langchain-core 0.4.0.dev0__py3-none-any.whl → 1.0.0a2__py3-none-any.whl

langchain_core/language_models/base.py

@@ -23,6 +23,7 @@ from langchain_core._api import deprecated
 from langchain_core.caches import BaseCache
 from langchain_core.callbacks import Callbacks
 from langchain_core.messages import (
+    AIMessage,
     AnyMessage,
     BaseMessage,
     MessageLikeRepresentation,
@@ -31,7 +32,6 @@ from langchain_core.messages import (
 from langchain_core.prompt_values import PromptValue
 from langchain_core.runnables import Runnable, RunnableSerializable
 from langchain_core.utils import get_pydantic_field_names
-from langchain_core.v1.messages import AIMessage as AIMessageV1
 
 if TYPE_CHECKING:
     from langchain_core.outputs import LLMResult
@@ -58,8 +58,8 @@ class LangSmithParams(TypedDict, total=False):
 def get_tokenizer() -> Any:
     """Get a GPT-2 tokenizer instance.
 
-    This function is cached to avoid re-loading the tokenizer
-    every time it is called.
+    This function is cached to avoid re-loading the tokenizer every time it is called.
+
     """
     try:
         from transformers import GPT2TokenizerFast  # type: ignore[import-not-found]
@@ -86,9 +86,7 @@ def _get_token_ids_default_method(text: str) -> list[int]:
 LanguageModelInput = Union[PromptValue, str, Sequence[MessageLikeRepresentation]]
 LanguageModelOutput = Union[BaseMessage, str]
 LanguageModelLike = Runnable[LanguageModelInput, LanguageModelOutput]
-LanguageModelOutputVar = TypeVar(
-    "LanguageModelOutputVar", BaseMessage, str, AIMessageV1
-)
+LanguageModelOutputVar = TypeVar("LanguageModelOutputVar", AIMessage, str)
 
 
 def _get_verbosity() -> bool:
@@ -102,7 +100,8 @@ 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: Union[BaseCache, bool, None] = Field(default=None, exclude=True)
@@ -111,9 +110,10 @@ class BaseLanguageModel(
     * 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 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."""
@@ -143,6 +143,7 @@ class BaseLanguageModel(
 
         Returns:
             The verbosity setting to use.
+
         """
         if verbose is None:
             return _get_verbosity()
@@ -198,7 +199,8 @@ class BaseLanguageModel(
 
         Returns:
             An LLMResult, which contains a list of candidate Generations for each input
-                prompt and additional model provider-specific output.
+            prompt and additional model provider-specific output.
+
         """
 
     @abstractmethod
@@ -232,8 +234,9 @@ 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 Generations for each
+            input prompt and additional model provider-specific output.
+
         """
 
     def with_structured_output(
@@ -251,8 +254,8 @@ class BaseLanguageModel(
     ) -> str:
         """Pass a single string input to the model and return a string.
 
-         Use this method when passing in raw text. If you want to pass in specific
-            types of chat messages, use predict_messages.
+        Use this method when passing in raw text. If you want to pass in specific types
+        of chat messages, use predict_messages.
 
         Args:
             text: String input to pass to the model.
@@ -263,6 +266,7 @@ class BaseLanguageModel(
 
         Returns:
             Top model prediction as a string.
+
         """
 
     @deprecated("0.1.7", alternative="invoke", removal="1.0")
@@ -277,7 +281,7 @@ class BaseLanguageModel(
         """Pass a message sequence to the model and return a message.
 
         Use this method when passing in chat messages. If you want to pass in raw text,
-            use predict.
+        use predict.
 
         Args:
             messages: A sequence of chat messages corresponding to a single model input.
@@ -288,6 +292,7 @@ class BaseLanguageModel(
 
         Returns:
             Top model prediction as a message.
+
         """
 
     @deprecated("0.1.7", alternative="ainvoke", removal="1.0")
@@ -298,7 +303,7 @@ class BaseLanguageModel(
         """Asynchronously pass a string to the model and return a string.
 
         Use this method when calling pure text generation models and only the top
-            candidate generation is needed.
+        candidate generation is needed.
 
         Args:
             text: String input to pass to the model.
@@ -309,6 +314,7 @@ class BaseLanguageModel(
 
         Returns:
             Top model prediction as a string.
+
         """
 
     @deprecated("0.1.7", alternative="ainvoke", removal="1.0")
@@ -322,8 +328,8 @@ class BaseLanguageModel(
     ) -> BaseMessage:
         """Asynchronously pass messages to the model and return a message.
 
-        Use this method when calling chat models and only the top
-            candidate generation is needed.
+        Use this method when calling chat models and only the top candidate generation
+        is needed.
 
         Args:
             messages: A sequence of chat messages corresponding to a single model input.
@@ -334,6 +340,7 @@ class BaseLanguageModel(
 
         Returns:
             Top model prediction as a message.
+
         """
 
     @property
@@ -349,7 +356,8 @@ class BaseLanguageModel(
 
         Returns:
             A list of ids corresponding to the tokens in the text, in order they occur
-                in the text.
+            in the text.
+
         """
         if self.custom_get_token_ids is not None:
             return self.custom_get_token_ids(text)
@@ -365,6 +373,7 @@ class BaseLanguageModel(
 
         Returns:
             The integer number of tokens in the text.
+
         """
         return len(self.get_token_ids(text))
 
@@ -377,16 +386,18 @@ 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 schemas.
+        .. note::
+            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
+                ``BaseTools`` to be converted to tool schemas.
 
         Returns:
             The sum of the number of tokens across the messages.
+
         """
         if tools is not None:
             warnings.warn(
@@ -399,6 +410,7 @@ class BaseLanguageModel(
     def _all_required_field_names(cls) -> set:
         """DEPRECATED: Kept for backwards compatibility.
 
-        Use get_pydantic_field_names.
+        Use ``get_pydantic_field_names``.
+
         """
         return get_pydantic_field_names(cls)