langchain 0.3.26__py3-none-any.whl → 0.4.0.dev0__py3-none-any.whl

langchain/evaluation/schema.py

@@ -34,7 +34,7 @@ class EvaluatorType(str, Enum):
     """The pairwise string evaluator, which predicts the preferred prediction from
     between two models."""
     SCORE_STRING = "score_string"
-    """The scored string evaluator, which gives a score between 1 and 10 
+    """The scored string evaluator, which gives a score between 1 and 10
     to a prediction."""
     LABELED_PAIRWISE_STRING = "labeled_pairwise_string"
     """The labeled pairwise string evaluator, which predicts the preferred prediction
@@ -109,25 +109,27 @@ class _EvalArgsMixin:
     def _check_evaluation_args(
         self,
         reference: Optional[str] = None,
-        input: Optional[str] = None,
+        input_: Optional[str] = None,
     ) -> None:
         """Check if the evaluation arguments are valid.
 
         Args:
             reference (Optional[str], optional): The reference label.
-            input (Optional[str], optional): The input string.
+            input_ (Optional[str], optional): The input string.
         Raises:
             ValueError: If the evaluator requires an input string but none is provided,
                 or if the evaluator requires a reference label but none is provided.
         """
-        if self.requires_input and input is None:
-            raise ValueError(f"{self.__class__.__name__} requires an input string.")
-        elif input is not None and not self.requires_input:
-            warn(self._skip_input_warning)
+        if self.requires_input and input_ is None:
+            msg = f"{self.__class__.__name__} requires an input string."
+            raise ValueError(msg)
+        if input_ is not None and not self.requires_input:
+            warn(self._skip_input_warning, stacklevel=3)
         if self.requires_reference and reference is None:
-            raise ValueError(f"{self.__class__.__name__} requires a reference string.")
-        elif reference is not None and not self.requires_reference:
-            warn(self._skip_reference_warning)
+            msg = f"{self.__class__.__name__} requires a reference string."
+            raise ValueError(msg)
+        if reference is not None and not self.requires_reference:
+            warn(self._skip_reference_warning, stacklevel=3)
 
 
 class StringEvaluator(_EvalArgsMixin, ABC):
@@ -150,7 +152,7 @@ class StringEvaluator(_EvalArgsMixin, ABC):
         *,
         prediction: Union[str, Any],
         reference: Optional[Union[str, Any]] = None,
-        input: Optional[Union[str, Any]] = None,
+        input: Optional[Union[str, Any]] = None,  # noqa: A002
         **kwargs: Any,
     ) -> dict:
         """Evaluate Chain or LLM output, based on optional input and label.
@@ -173,7 +175,7 @@ class StringEvaluator(_EvalArgsMixin, ABC):
         *,
         prediction: Union[str, Any],
         reference: Optional[Union[str, Any]] = None,
-        input: Optional[Union[str, Any]] = None,
+        input: Optional[Union[str, Any]] = None,  # noqa: A002
         **kwargs: Any,
     ) -> dict:
         """Asynchronously evaluate Chain or LLM output, based on optional input and label.
@@ -204,7 +206,7 @@ class StringEvaluator(_EvalArgsMixin, ABC):
         *,
         prediction: str,
         reference: Optional[str] = None,
-        input: Optional[str] = None,
+        input: Optional[str] = None,  # noqa: A002
         **kwargs: Any,
     ) -> dict:
         """Evaluate Chain or LLM output, based on optional input and label.
@@ -217,9 +219,12 @@ class StringEvaluator(_EvalArgsMixin, ABC):
         Returns:
             dict: The evaluation results containing the score or value.
         """  # noqa: E501
-        self._check_evaluation_args(reference=reference, input=input)
+        self._check_evaluation_args(reference=reference, input_=input)
         return self._evaluate_strings(
-            prediction=prediction, reference=reference, input=input, **kwargs
+            prediction=prediction,
+            reference=reference,
+            input=input,
+            **kwargs,
         )
 
     async def aevaluate_strings(
@@ -227,7 +232,7 @@ class StringEvaluator(_EvalArgsMixin, ABC):
         *,
         prediction: str,
         reference: Optional[str] = None,
-        input: Optional[str] = None,
+        input: Optional[str] = None,  # noqa: A002
         **kwargs: Any,
     ) -> dict:
         """Asynchronously evaluate Chain or LLM output, based on optional input and label.
@@ -240,9 +245,12 @@ class StringEvaluator(_EvalArgsMixin, ABC):
         Returns:
             dict: The evaluation results containing the score or value.
         """  # noqa: E501
-        self._check_evaluation_args(reference=reference, input=input)
+        self._check_evaluation_args(reference=reference, input_=input)
         return await self._aevaluate_strings(
-            prediction=prediction, reference=reference, input=input, **kwargs
+            prediction=prediction,
+            reference=reference,
+            input=input,
+            **kwargs,
         )
 
 
@@ -256,7 +264,7 @@ class PairwiseStringEvaluator(_EvalArgsMixin, ABC):
         prediction: str,
         prediction_b: str,
         reference: Optional[str] = None,
-        input: Optional[str] = None,
+        input: Optional[str] = None,  # noqa: A002
         **kwargs: Any,
     ) -> dict:
         """Evaluate the output string pairs.
@@ -277,7 +285,7 @@ class PairwiseStringEvaluator(_EvalArgsMixin, ABC):
         prediction: str,
         prediction_b: str,
         reference: Optional[str] = None,
-        input: Optional[str] = None,
+        input: Optional[str] = None,  # noqa: A002
         **kwargs: Any,
     ) -> dict:
         """Asynchronously evaluate the output string pairs.
@@ -307,7 +315,7 @@ class PairwiseStringEvaluator(_EvalArgsMixin, ABC):
         prediction: str,
         prediction_b: str,
         reference: Optional[str] = None,
-        input: Optional[str] = None,
+        input: Optional[str] = None,  # noqa: A002
         **kwargs: Any,
     ) -> dict:
         """Evaluate the output string pairs.
@@ -321,7 +329,7 @@ class PairwiseStringEvaluator(_EvalArgsMixin, ABC):
         Returns:
             dict: A dictionary containing the preference, scores, and/or other information.
         """  # noqa: E501
-        self._check_evaluation_args(reference=reference, input=input)
+        self._check_evaluation_args(reference=reference, input_=input)
         return self._evaluate_string_pairs(
             prediction=prediction,
             prediction_b=prediction_b,
@@ -336,7 +344,7 @@ class PairwiseStringEvaluator(_EvalArgsMixin, ABC):
         prediction: str,
         prediction_b: str,
         reference: Optional[str] = None,
-        input: Optional[str] = None,
+        input: Optional[str] = None,  # noqa: A002
         **kwargs: Any,
     ) -> dict:
         """Asynchronously evaluate the output string pairs.
@@ -350,7 +358,7 @@ class PairwiseStringEvaluator(_EvalArgsMixin, ABC):
         Returns:
             dict: A dictionary containing the preference, scores, and/or other information.
         """  # noqa: E501
-        self._check_evaluation_args(reference=reference, input=input)
+        self._check_evaluation_args(reference=reference, input_=input)
         return await self._aevaluate_string_pairs(
             prediction=prediction,
             prediction_b=prediction_b,
@@ -374,7 +382,7 @@ class AgentTrajectoryEvaluator(_EvalArgsMixin, ABC):
         *,
         prediction: str,
         agent_trajectory: Sequence[tuple[AgentAction, str]],
-        input: str,
+        input: str,  # noqa: A002
         reference: Optional[str] = None,
         **kwargs: Any,
     ) -> dict:
@@ -396,7 +404,7 @@ class AgentTrajectoryEvaluator(_EvalArgsMixin, ABC):
         *,
         prediction: str,
         agent_trajectory: Sequence[tuple[AgentAction, str]],
-        input: str,
+        input: str,  # noqa: A002
         reference: Optional[str] = None,
         **kwargs: Any,
     ) -> dict:
@@ -427,7 +435,7 @@ class AgentTrajectoryEvaluator(_EvalArgsMixin, ABC):
         *,
         prediction: str,
         agent_trajectory: Sequence[tuple[AgentAction, str]],
-        input: str,
+        input: str,  # noqa: A002
         reference: Optional[str] = None,
         **kwargs: Any,
     ) -> dict:
@@ -443,7 +451,7 @@ class AgentTrajectoryEvaluator(_EvalArgsMixin, ABC):
         Returns:
             dict: The evaluation result.
         """
-        self._check_evaluation_args(reference=reference, input=input)
+        self._check_evaluation_args(reference=reference, input_=input)
         return self._evaluate_agent_trajectory(
             prediction=prediction,
             input=input,
@@ -457,7 +465,7 @@ class AgentTrajectoryEvaluator(_EvalArgsMixin, ABC):
         *,
         prediction: str,
         agent_trajectory: Sequence[tuple[AgentAction, str]],
-        input: str,
+        input: str,  # noqa: A002
         reference: Optional[str] = None,
         **kwargs: Any,
     ) -> dict:
@@ -473,7 +481,7 @@ class AgentTrajectoryEvaluator(_EvalArgsMixin, ABC):
         Returns:
             dict: The evaluation result.
         """
-        self._check_evaluation_args(reference=reference, input=input)
+        self._check_evaluation_args(reference=reference, input_=input)
         return await self._aevaluate_agent_trajectory(
             prediction=prediction,
             input=input,

langchain/evaluation/scoring/__init__.py

@@ -28,4 +28,4 @@ from langchain.evaluation.scoring.eval_chain import (
     ScoreStringEvalChain,
 )
 
-__all__ = ["ScoreStringEvalChain", "LabeledScoreStringEvalChain"]
+__all__ = ["LabeledScoreStringEvalChain", "ScoreStringEvalChain"]

langchain/evaluation/scoring/eval_chain.py

@@ -11,6 +11,7 @@ from langchain_core.language_models import BaseLanguageModel
 from langchain_core.output_parsers import BaseOutputParser
 from langchain_core.prompts.prompt import PromptTemplate
 from pydantic import ConfigDict, Field
+from typing_extensions import override
 
 from langchain.chains.constitutional_ai.models import ConstitutionalPrinciple
 from langchain.chains.llm import LLMChain
@@ -69,7 +70,7 @@ def resolve_criteria(
             Criteria.DEPTH,
         ]
         return {k.value: _SUPPORTED_CRITERIA[k] for k in _default_criteria}
-    elif isinstance(criteria, Criteria):
+    if isinstance(criteria, Criteria):
         criteria_ = {criteria.value: _SUPPORTED_CRITERIA[criteria]}
     elif isinstance(criteria, str):
         if criteria in _SUPPORTED_CRITERIA:
@@ -86,11 +87,12 @@ def resolve_criteria(
         }
     else:
         if not criteria:
-            raise ValueError(
+            msg = (
                 "Criteria cannot be empty. "
                 "Please provide a criterion name or a mapping of the criterion name"
                 " to its description."
             )
+            raise ValueError(msg)
         criteria_ = dict(criteria)
     return criteria_
 
@@ -131,12 +133,13 @@ class ScoreStringResultOutputParser(BaseOutputParser[dict]):
         if match:
             verdict = match.group(1)
 
-        if not match or verdict not in list("123456789") + ["10"]:
-            raise ValueError(
+        if not match or verdict not in [*list("123456789"), "10"]:
+            msg = (
                 f"Invalid output: {text}. "
                 "Output must contain a double bracketed string\
                  with the verdict between 1 and 10."
             )
+            raise ValueError(msg)
 
         return {
             "reasoning": text,
@@ -172,7 +175,7 @@ class ScoreStringEvalChain(StringEvaluator, LLMEvalChain, LLMChain):
 
     output_key: str = "results"  #: :meta private:
     output_parser: BaseOutputParser = Field(
-        default_factory=ScoreStringResultOutputParser
+        default_factory=ScoreStringResultOutputParser,
     )
     normalize_by: Optional[float] = None
     """The value to normalize the score by, if specified."""
@@ -184,6 +187,7 @@ class ScoreStringEvalChain(StringEvaluator, LLMEvalChain, LLMChain):
     )
 
     @classmethod
+    @override
     def is_lc_serializable(cls) -> bool:
         return False
 
@@ -259,16 +263,17 @@ class ScoreStringEvalChain(StringEvaluator, LLMEvalChain, LLMChain):
         if not (hasattr(llm, "model_name") and not llm.model_name.startswith("gpt-4")):
             logger.warning(
                 "This chain was only tested with GPT-4. \
-Performance may be significantly worse with other models."
+Performance may be significantly worse with other models.",
             )
 
         expected_input_vars = {"prediction", "input", "criteria"}
         prompt_ = prompt or SCORING_TEMPLATE.partial(reference="")
         if expected_input_vars != set(prompt_.input_variables):
-            raise ValueError(
+            msg = (
                 f"Input variables should be {expected_input_vars}, "
                 f"but got {prompt_.input_variables}"
             )
+            raise ValueError(msg)
         criteria_ = resolve_criteria(criteria)
         criteria_str = "\n".join(
             f"{k}: {v}" if v else k for k, v in criteria_.items()
@@ -289,7 +294,7 @@ Performance may be significantly worse with other models."
     def _prepare_input(
         self,
         prediction: str,
-        input: Optional[str],
+        input_: Optional[str],
         reference: Optional[str],
     ) -> dict:
         """Prepare the input for the chain.
@@ -297,20 +302,20 @@ Performance may be significantly worse with other models."
         Args:
             prediction (str): The output string from the first model.
             prediction_b (str): The output string from the second model.
-            input (str, optional): The input or task string.
+            input_ (str, optional): The input or task string.
             reference (str, optional): The reference string, if any.
 
         Returns:
             dict: The prepared input for the chain.
 
         """
-        input_ = {
+        input_dict = {
             "prediction": prediction,
-            "input": input,
+            "input": input_,
         }
         if self.requires_reference:
-            input_["reference"] = reference
-        return input_
+            input_dict["reference"] = reference
+        return input_dict
 
     def _prepare_output(self, result: dict) -> dict:
         """Prepare the output."""
@@ -321,6 +326,7 @@ Performance may be significantly worse with other models."
             parsed["score"] = parsed["score"] / self.normalize_by
         return parsed
 
+    @override
     def _evaluate_strings(
         self,
         *,
@@ -358,7 +364,8 @@ Performance may be significantly worse with other models."
         )
         return self._prepare_output(result)
 
-    async def _aevaluate_string_pairs(
+    @override
+    async def _aevaluate_strings(
         self,
         *,
         prediction: str,
@@ -448,10 +455,11 @@ class LabeledScoreStringEvalChain(ScoreStringEvalChain):
         }
         prompt_ = prompt or SCORING_TEMPLATE_WITH_REFERENCE
         if expected_input_vars != set(prompt_.input_variables):
-            raise ValueError(
+            msg = (
                 f"Input variables should be {expected_input_vars}, "
                 f"but got {prompt_.input_variables}"
             )
+            raise ValueError(msg)
         criteria_ = resolve_criteria(criteria)
         criteria_str = "\n".join(f"{k}: {v}" for k, v in criteria_.items()).strip()
         criteria_str = (

langchain/evaluation/scoring/prompt.py

@@ -5,7 +5,6 @@ and answers the question. The prompt is based on the paper from
 Zheng, et. al. https://arxiv.org/abs/2306.05685
 """
 
-# flake8: noqa
 from langchain_core.prompts.chat import ChatPromptTemplate
 
 SYSTEM_MESSAGE = "You are a helpful assistant."

langchain/evaluation/string_distance/base.py

@@ -10,6 +10,7 @@ from langchain_core.callbacks.manager import (
 )
 from langchain_core.utils import pre_init
 from pydantic import Field
+from typing_extensions import override
 
 from langchain.chains.base import Chain
 from langchain.evaluation.schema import PairwiseStringEvaluator, StringEvaluator
@@ -28,11 +29,12 @@ def _load_rapidfuzz() -> Any:
     """
     try:
         import rapidfuzz
-    except ImportError:
-        raise ImportError(
+    except ImportError as e:
+        msg = (
             "Please install the rapidfuzz library to use the FuzzyMatchStringEvaluator."
             "Please install it with `pip install rapidfuzz`."
         )
+        raise ImportError(msg) from e
     return rapidfuzz.distance
 
 
@@ -104,7 +106,7 @@ class _RapidFuzzChainMixin(Chain):
         return result
 
     @staticmethod
-    def _get_metric(distance: str, normalize_score: bool = False) -> Callable:
+    def _get_metric(distance: str, *, normalize_score: bool = False) -> Callable:
         """
         Get the distance metric function based on the distance type.
 
@@ -128,15 +130,15 @@ class _RapidFuzzChainMixin(Chain):
             StringDistance.INDEL: rf_distance.Indel,
         }
         if distance not in module_map:
-            raise ValueError(
+            msg = (
                 f"Invalid distance metric: {distance}"
                 f"\nMust be one of: {list(StringDistance)}"
             )
+            raise ValueError(msg)
         module = module_map[distance]
         if normalize_score:
             return module.normalized_distance
-        else:
-            return module.distance
+        return module.distance
 
     @property
     def metric(self) -> Callable:
@@ -147,7 +149,8 @@ class _RapidFuzzChainMixin(Chain):
             Callable: The distance metric function.
         """
         return _RapidFuzzChainMixin._get_metric(
-            self.distance, normalize_score=self.normalize_score
+            self.distance,
+            normalize_score=self.normalize_score,
         )
 
     def compute_metric(self, a: str, b: str) -> float:
@@ -221,6 +224,7 @@ class StringDistanceEvalChain(StringEvaluator, _RapidFuzzChainMixin):
         """
         return f"{self.distance.value}_distance"
 
+    @override
     def _call(
         self,
         inputs: dict[str, Any],
@@ -239,6 +243,7 @@ class StringDistanceEvalChain(StringEvaluator, _RapidFuzzChainMixin):
         """
         return {"score": self.compute_metric(inputs["reference"], inputs["prediction"])}
 
+    @override
     async def _acall(
         self,
         inputs: dict[str, Any],
@@ -258,6 +263,7 @@ class StringDistanceEvalChain(StringEvaluator, _RapidFuzzChainMixin):
         """
         return {"score": self.compute_metric(inputs["reference"], inputs["prediction"])}
 
+    @override
     def _evaluate_strings(
         self,
         *,
@@ -293,6 +299,7 @@ class StringDistanceEvalChain(StringEvaluator, _RapidFuzzChainMixin):
 
         return self._prepare_output(result)
 
+    @override
     async def _aevaluate_strings(
         self,
         *,
@@ -352,6 +359,7 @@ class PairwiseStringDistanceEvalChain(PairwiseStringEvaluator, _RapidFuzzChainMi
         """
         return f"pairwise_{self.distance.value}_distance"
 
+    @override
     def _call(
         self,
         inputs: dict[str, Any],
@@ -369,9 +377,10 @@ class PairwiseStringDistanceEvalChain(PairwiseStringEvaluator, _RapidFuzzChainMi
             Dict[str, Any]: The evaluation results containing the score.
         """
         return {
-            "score": self.compute_metric(inputs["prediction"], inputs["prediction_b"])
+            "score": self.compute_metric(inputs["prediction"], inputs["prediction_b"]),
         }
 
+    @override
     async def _acall(
         self,
         inputs: dict[str, Any],
@@ -389,9 +398,10 @@ class PairwiseStringDistanceEvalChain(PairwiseStringEvaluator, _RapidFuzzChainMi
             Dict[str, Any]: The evaluation results containing the score.
         """
         return {
-            "score": self.compute_metric(inputs["prediction"], inputs["prediction_b"])
+            "score": self.compute_metric(inputs["prediction"], inputs["prediction_b"]),
         }
 
+    @override
     def _evaluate_string_pairs(
         self,
         *,
@@ -426,6 +436,7 @@ class PairwiseStringDistanceEvalChain(PairwiseStringEvaluator, _RapidFuzzChainMi
         )
         return self._prepare_output(result)
 
+    @override
     async def _aevaluate_string_pairs(
         self,
         *,

langchain/globals.py

@@ -16,7 +16,9 @@ _debug: bool = False
 _llm_cache: Optional["BaseCache"] = None
 
 
-def set_verbose(value: bool) -> None:
+def set_verbose(
+    value: bool,  # noqa: FBT001
+) -> None:
     """Set a new value for the `verbose` global setting."""
     import langchain
 
@@ -37,7 +39,7 @@ def set_verbose(value: bool) -> None:
         # have migrated to using `set_verbose()` here.
         langchain.verbose = value
 
-    global _verbose
+    global _verbose  # noqa: PLW0603
     _verbose = value
 
 
@@ -64,14 +66,15 @@ def get_verbose() -> bool:
         # In the meantime, the `verbose` setting is considered True if either the old
         # or the new value are True. This accommodates users who haven't migrated
         # to using `set_verbose()` yet. Those users are getting deprecation warnings
-        # directing them to use `set_verbose()` when they import `langhchain.verbose`.
+        # directing them to use `set_verbose()` when they import `langchain.verbose`.
         old_verbose = langchain.verbose
 
-    global _verbose
     return _verbose or old_verbose
 
 
-def set_debug(value: bool) -> None:
+def set_debug(
+    value: bool,  # noqa: FBT001
+) -> None:
     """Set a new value for the `debug` global setting."""
     import langchain
 
@@ -90,7 +93,7 @@ def set_debug(value: bool) -> None:
         # have migrated to using `set_debug()` here.
         langchain.debug = value
 
-    global _debug
+    global _debug  # noqa: PLW0603
     _debug = value
 
 
@@ -115,10 +118,9 @@ def get_debug() -> bool:
         # In the meantime, the `debug` setting is considered True if either the old
         # or the new value are True. This accommodates users who haven't migrated
         # to using `set_debug()` yet. Those users are getting deprecation warnings
-        # directing them to use `set_debug()` when they import `langhchain.debug`.
+        # directing them to use `set_debug()` when they import `langchain.debug`.
         old_debug = langchain.debug
 
-    global _debug
     return _debug or old_debug
 
 
@@ -143,7 +145,7 @@ def set_llm_cache(value: Optional["BaseCache"]) -> None:
         # once all users have migrated to using `set_llm_cache()` here.
         langchain.llm_cache = value
 
-    global _llm_cache
+    global _llm_cache  # noqa: PLW0603
     _llm_cache = value
 
 
@@ -172,8 +174,7 @@ def get_llm_cache() -> "BaseCache":
         # or the old value if both are falsy. This accommodates users
         # who haven't migrated to using `set_llm_cache()` yet.
         # Those users are getting deprecation warnings directing them
-        # to use `set_llm_cache()` when they import `langhchain.llm_cache`.
+        # to use `set_llm_cache()` when they import `langchain.llm_cache`.
         old_llm_cache = langchain.llm_cache
 
-    global _llm_cache
     return _llm_cache or old_llm_cache

langchain/graphs/__init__.py

@@ -44,14 +44,14 @@ def __getattr__(name: str) -> Any:
 
 
 __all__ = [
+    "ArangoGraph",
+    "FalkorDBGraph",
+    "HugeGraph",
+    "KuzuGraph",
     "MemgraphGraph",
-    "NetworkxEntityGraph",
-    "Neo4jGraph",
     "NebulaGraph",
+    "Neo4jGraph",
     "NeptuneGraph",
-    "KuzuGraph",
-    "HugeGraph",
+    "NetworkxEntityGraph",
     "RdfGraph",
-    "ArangoGraph",
-    "FalkorDBGraph",
 ]

langchain/graphs/graph_document.py

@@ -27,7 +27,7 @@ def __getattr__(name: str) -> Any:
 
 
 __all__ = [
+    "GraphDocument",
     "Node",
     "Relationship",
-    "GraphDocument",
 ]

langchain/graphs/networkx_graph.py

@@ -30,7 +30,7 @@ def __getattr__(name: str) -> Any:
 
 __all__ = [
     "KnowledgeTriple",
-    "parse_triples",
-    "get_entities",
     "NetworkxEntityGraph",
+    "get_entities",
+    "parse_triples",
 ]