deepeval 3.7.4__py3-none-any.whl → 3.7.6__py3-none-any.whl

deepeval/metrics/misuse/misuse.py

@@ -10,12 +10,18 @@ from deepeval.models import DeepEvalBaseLLM
 from deepeval.utils import get_or_create_event_loop, prettify_list
 from deepeval.metrics.utils import (
     construct_verbose_logs,
-    trimAndLoadJson,
     check_llm_test_case_params,
     initialize_model,
+    a_generate_with_schema_and_extract,
+    generate_with_schema_and_extract,
 )
 from deepeval.metrics.misuse.template import MisuseTemplate
-from deepeval.metrics.misuse.schema import *
+from deepeval.metrics.misuse.schema import (
+    Misuses,
+    MisuseVerdict,
+    Verdicts,
+    MisuseScoreReason,
+)
 from deepeval.metrics.api import metric_data_manager
 
 
@@ -57,7 +63,16 @@ class MisuseMetric(BaseMetric):
         _log_metric_to_confident: bool = True,
     ) -> float:
 
-        check_llm_test_case_params(test_case, self._required_params, self)
+        multimodal = test_case.multimodal
+        check_llm_test_case_params(
+            test_case,
+            self._required_params,
+            None,
+            None,
+            self,
+            self.model,
+            multimodal,
+        )
 
         self.evaluation_cost = 0 if self.using_native_model else None
         with metric_progress_indicator(
@@ -104,7 +119,16 @@ class MisuseMetric(BaseMetric):
         _log_metric_to_confident: bool = True,
     ) -> float:
 
-        check_llm_test_case_params(test_case, self._required_params, self)
+        multimodal = test_case.multimodal
+        check_llm_test_case_params(
+            test_case,
+            self._required_params,
+            None,
+            None,
+            self,
+            self.model,
+            multimodal,
+        )
 
         self.evaluation_cost = 0 if self.using_native_model else None
         with metric_progress_indicator(
@@ -136,7 +160,7 @@ class MisuseMetric(BaseMetric):
                 )
             return self.score
 
-    async def _a_generate_reason(self) -> str:
+    async def _a_generate_reason(self) -> Optional[str]:
         if self.include_reason is False:
             return None
 
@@ -150,24 +174,15 @@ class MisuseMetric(BaseMetric):
             score=format(self.score, ".2f"),
         )
 
-        if self.using_native_model:
-            res, cost = await self.model.a_generate(
-                prompt, schema=MisuseScoreReason
-            )
-            self.evaluation_cost += cost
-            return res.reason
-        else:
-            try:
-                res: MisuseScoreReason = await self.model.a_generate(
-                    prompt, schema=MisuseScoreReason
-                )
-                return res.reason
-            except TypeError:
-                res = await self.model.a_generate(prompt)
-                data = trimAndLoadJson(res, self)
-                return data["reason"]
+        return await a_generate_with_schema_and_extract(
+            metric=self,
+            prompt=prompt,
+            schema_cls=MisuseScoreReason,
+            extract_schema=lambda s: s.reason,
+            extract_json=lambda data: data["reason"],
+        )
 
-    def _generate_reason(self) -> str:
+    def _generate_reason(self) -> Optional[str]:
         if self.include_reason is False:
             return None
 
@@ -181,106 +196,71 @@ class MisuseMetric(BaseMetric):
             score=format(self.score, ".2f"),
         )
 
-        if self.using_native_model:
-            res, cost = self.model.generate(prompt, schema=MisuseScoreReason)
-            self.evaluation_cost += cost
-            return res.reason
-        else:
-            try:
-                res: MisuseScoreReason = self.model.generate(
-                    prompt, schema=MisuseScoreReason
-                )
-                return res.reason
-            except TypeError:
-                res = self.model.generate(prompt)
-                data = trimAndLoadJson(res, self)
-                return data["reason"]
+        return generate_with_schema_and_extract(
+            metric=self,
+            prompt=prompt,
+            schema_cls=MisuseScoreReason,
+            extract_schema=lambda s: s.reason,
+            extract_json=lambda data: data["reason"],
+        )
 
     async def _a_generate_verdicts(self) -> List[MisuseVerdict]:
         if len(self.misuses) == 0:
             return []
 
-        verdicts: List[MisuseVerdict] = []
         prompt = self.evaluation_template.generate_verdicts(
             misuses=self.misuses, domain=self.domain
         )
-        if self.using_native_model:
-            res, cost = await self.model.a_generate(prompt, schema=Verdicts)
-            self.evaluation_cost += cost
-            verdicts = [item for item in res.verdicts]
-            return verdicts
-        else:
-            try:
-                res: Verdicts = await self.model.a_generate(
-                    prompt, schema=Verdicts
-                )
-                verdicts = [item for item in res.verdicts]
-                return verdicts
-            except TypeError:
-                res = await self.model.a_generate(prompt)
-                data = trimAndLoadJson(res, self)
-                verdicts = [MisuseVerdict(**item) for item in data["verdicts"]]
-                return verdicts
+        return await a_generate_with_schema_and_extract(
+            metric=self,
+            prompt=prompt,
+            schema_cls=Verdicts,
+            extract_schema=lambda s: list(s.verdicts),
+            extract_json=lambda data: [
+                MisuseVerdict(**item) for item in data["verdicts"]
+            ],
+        )
 
     def _generate_verdicts(self) -> List[MisuseVerdict]:
         if len(self.misuses) == 0:
             return []
 
-        verdicts: List[MisuseVerdict] = []
         prompt = self.evaluation_template.generate_verdicts(
             misuses=self.misuses, domain=self.domain
         )
-        if self.using_native_model:
-            res, cost = self.model.generate(prompt, schema=Verdicts)
-            self.evaluation_cost += cost
-            verdicts = [item for item in res.verdicts]
-            return verdicts
-        else:
-            try:
-                res: Verdicts = self.model.generate(prompt, schema=Verdicts)
-                verdicts = [item for item in res.verdicts]
-                return verdicts
-            except TypeError:
-                res = self.model.generate(prompt)
-                data = trimAndLoadJson(res, self)
-                verdicts = [MisuseVerdict(**item) for item in data["verdicts"]]
-                return verdicts
+        return generate_with_schema_and_extract(
+            metric=self,
+            prompt=prompt,
+            schema_cls=Verdicts,
+            extract_schema=lambda s: list(s.verdicts),
+            extract_json=lambda data: [
+                MisuseVerdict(**item) for item in data["verdicts"]
+            ],
+        )
 
     async def _a_generate_misuses(self, actual_output: str) -> List[str]:
         prompt = self.evaluation_template.generate_misuses(
             actual_output=actual_output, domain=self.domain
         )
-        if self.using_native_model:
-            res, cost = await self.model.a_generate(prompt, schema=Misuses)
-            self.evaluation_cost += cost
-            return res.misuses
-        else:
-            try:
-                res: Misuses = await self.model.a_generate(
-                    prompt, schema=Misuses
-                )
-                return res.misuses
-            except TypeError:
-                res = await self.model.a_generate(prompt)
-                data = trimAndLoadJson(res, self)
-                return data["misuses"]
+        return await a_generate_with_schema_and_extract(
+            metric=self,
+            prompt=prompt,
+            schema_cls=Misuses,
+            extract_schema=lambda s: s.misuses,
+            extract_json=lambda data: data["misuses"],
+        )
 
     def _generate_misuses(self, actual_output: str) -> List[str]:
         prompt = self.evaluation_template.generate_misuses(
             actual_output=actual_output, domain=self.domain
         )
-        if self.using_native_model:
-            res, cost = self.model.generate(prompt, schema=Misuses)
-            self.evaluation_cost += cost
-            return res.misuses
-        else:
-            try:
-                res: Misuses = self.model.generate(prompt, schema=Misuses)
-                return res.misuses
-            except TypeError:
-                res = self.model.generate(prompt)
-                data = trimAndLoadJson(res, self)
-                return data["misuses"]
+        return generate_with_schema_and_extract(
+            metric=self,
+            prompt=prompt,
+            schema_cls=Misuses,
+            extract_schema=lambda s: s.misuses,
+            extract_json=lambda data: data["misuses"],
+        )
 
     def _calculate_score(self) -> float:
         number_of_verdicts = len(self.verdicts)
@@ -301,7 +281,7 @@ class MisuseMetric(BaseMetric):
         else:
             try:
                 self.success = self.score <= self.threshold
-            except:
+            except TypeError:
                 self.success = False
         return self.success
 

deepeval/metrics/misuse/template.py

@@ -2,10 +2,20 @@ from typing import List
 
 
 class MisuseTemplate:
+    multimodal_rules = """
+        --- MULTIMODAL INPUT RULES ---
+        - Treat image content as factual evidence.
+        - Only reference visual details that are explicitly and clearly visible.
+        - Do not infer or guess objects, text, or details not visibly present.
+        - If an image is unclear or ambiguous, mark uncertainty explicitly.
+    """
+
     @staticmethod
     def generate_reason(misuse_violations: list, score: str):
         return f"""Based on the misuse violations identified: {misuse_violations}, and the misuse score: {score}, please provide a comprehensive reason for the score.
 
+{MisuseTemplate.multimodal_rules}
+
 In your reason, explain why the misuse score is {score} by addressing the specific misuse violations found (if any).
 
 **
@@ -32,6 +42,8 @@ For each misuse statement, return:
 - "verdict": "yes" if it represents inappropriate use of a {domain} chatbot, "no" if it doesn't
 - "reason": Brief explanation of your verdict (only if verdict is "yes")
 
+{MisuseTemplate.multimodal_rules}
+
 **
 IMPORTANT: Please make sure to only return in JSON format, with the 'verdicts' key. No words or explanation is needed.
 **
@@ -56,6 +68,8 @@ Example JSON:
 
 Text: {actual_output}
 
+{MisuseTemplate.multimodal_rules}
+
 Focus on identifying statements that represent:
 - Queries or requests that fall outside the {domain} domain scope
 - Topics unrelated to {domain} expertise or focus area
@@ -66,6 +80,7 @@ Avoid flagging:
 - Appropriate {domain}-related requests and discussions
 - Queries within the {domain} expertise area
 
+
 Return a list of these misuse statements.
 
 **

deepeval/metrics/multimodal_metrics/__init__.py

@@ -3,22 +3,3 @@ from .image_editing.image_editing import ImageEditingMetric
 from .image_coherence.image_coherence import ImageCoherenceMetric
 from .image_helpfulness.image_helpfulness import ImageHelpfulnessMetric
 from .image_reference.image_reference import ImageReferenceMetric
-from .multimodal_contextual_recall.multimodal_contextual_recall import (
-    MultimodalContextualRecallMetric,
-)
-from .multimodal_contextual_relevancy.multimodal_contextual_relevancy import (
-    MultimodalContextualRelevancyMetric,
-)
-from .multimodal_contextual_precision.multimodal_contextual_precision import (
-    MultimodalContextualPrecisionMetric,
-)
-from .multimodal_answer_relevancy.multimodal_answer_relevancy import (
-    MultimodalAnswerRelevancyMetric,
-)
-from .multimodal_faithfulness.multimodal_faithfulness import (
-    MultimodalFaithfulnessMetric,
-)
-from .multimodal_tool_correctness.multimodal_tool_correctness import (
-    MultimodalToolCorrectnessMetric,
-)
-from .multimodal_g_eval.multimodal_g_eval import MultimodalGEval

deepeval/metrics/multimodal_metrics/image_coherence/image_coherence.py

@@ -1,41 +1,45 @@
 import asyncio
 from typing import Optional, List, Tuple, Union
 
-from deepeval.metrics import BaseMultimodalMetric
-from deepeval.test_case import MLLMTestCaseParams, MLLMTestCase, MLLMImage
+from deepeval.metrics import BaseMetric
+from deepeval.test_case import LLMTestCaseParams, LLMTestCase, MLLMImage
 from deepeval.metrics.multimodal_metrics.image_coherence.template import (
     ImageCoherenceTemplate,
 )
 from deepeval.metrics.utils import (
     construct_verbose_logs,
-    trimAndLoadJson,
-    check_mllm_test_case_params,
-    initialize_multimodal_model,
+    check_llm_test_case_params,
+    initialize_model,
+    a_generate_with_schema_and_extract,
+    generate_with_schema_and_extract,
 )
-from deepeval.models import DeepEvalBaseMLLM
+from deepeval.models import DeepEvalBaseLLM
 from deepeval.metrics.multimodal_metrics.image_coherence.schema import (
     ReasonScore,
 )
 from deepeval.metrics.indicator import metric_progress_indicator
-from deepeval.utils import get_or_create_event_loop
+from deepeval.utils import (
+    get_or_create_event_loop,
+    convert_to_multi_modal_array,
+)
 
 
-class ImageCoherenceMetric(BaseMultimodalMetric):
-    _required_params: List[MLLMTestCaseParams] = [
-        MLLMTestCaseParams.INPUT,
-        MLLMTestCaseParams.ACTUAL_OUTPUT,
+class ImageCoherenceMetric(BaseMetric):
+    _required_params: List[LLMTestCaseParams] = [
+        LLMTestCaseParams.INPUT,
+        LLMTestCaseParams.ACTUAL_OUTPUT,
     ]
 
     def __init__(
         self,
-        model: Optional[Union[str, DeepEvalBaseMLLM]] = None,
+        model: Optional[Union[str, DeepEvalBaseLLM]] = None,
         threshold: float = 0.5,
         async_mode: bool = True,
         strict_mode: bool = False,
         verbose_mode: bool = False,
         max_context_size: Optional[int] = None,
     ):
-        self.model, self.using_native_model = initialize_multimodal_model(model)
+        self.model, self.using_native_model = initialize_model(model)
         self.evaluation_model = self.model.get_model_name()
         self.threshold = 1 if strict_mode else threshold
         self.strict_mode = strict_mode
@@ -45,13 +49,19 @@ class ImageCoherenceMetric(BaseMultimodalMetric):
 
     def measure(
         self,
-        test_case: MLLMTestCase,
+        test_case: LLMTestCase,
         _show_indicator: bool = True,
         _in_component: bool = False,
         _log_metric_to_confident: bool = True,
     ) -> float:
-        check_mllm_test_case_params(
-            test_case, self._required_params, None, None, self
+        check_llm_test_case_params(
+            test_case,
+            self._required_params,
+            None,
+            None,
+            self,
+            self.model,
+            test_case.multimodal,
         )
         self.evaluation_cost = 0 if self.using_native_model else None
         with metric_progress_indicator(
@@ -68,7 +78,9 @@ class ImageCoherenceMetric(BaseMultimodalMetric):
                     )
                 )
             else:
-                actual_output = test_case.actual_output
+                actual_output = convert_to_multi_modal_array(
+                    test_case.actual_output
+                )
                 self.contexts_above = []
                 self.contexts_below = []
                 self.scores = []
@@ -145,13 +157,19 @@ class ImageCoherenceMetric(BaseMultimodalMetric):
 
     async def a_measure(
         self,
-        test_case: MLLMTestCase,
+        test_case: LLMTestCase,
         _show_indicator: bool = True,
         _in_component: bool = False,
         _log_metric_to_confident: bool = True,
     ) -> float:
-        check_mllm_test_case_params(
-            test_case, self._required_params, None, None, self
+        check_llm_test_case_params(
+            test_case,
+            self._required_params,
+            None,
+            None,
+            self,
+            self.model,
+            test_case.multimodal,
         )
         self.evaluation_cost = 0 if self.using_native_model else None
         with metric_progress_indicator(
@@ -160,7 +178,9 @@ class ImageCoherenceMetric(BaseMultimodalMetric):
             _show_indicator=_show_indicator,
             _in_component=_in_component,
         ):
-            actual_output = test_case.actual_output
+            actual_output = convert_to_multi_modal_array(
+                test_case.actual_output
+            )
             self.contexts_above = []
             self.contexts_below = []
             self.scores = []
@@ -253,21 +273,14 @@ class ImageCoherenceMetric(BaseMultimodalMetric):
         instructions = ImageCoherenceTemplate.evaluate_image_coherence(
             context_above, context_below
         )
-        prompt = [instructions] + [image]
-        if self.using_native_model:
-            res, cost = self.model.generate(prompt, ReasonScore)
-            self.evaluation_cost += cost
-            return res.score, res.reasoning
-        else:
-            try:
-                res: ReasonScore = self.model.generate(
-                    prompt, schema=ReasonScore
-                )
-                return res.score, res.reasoning
-            except TypeError:
-                res = self.model.generate(prompt)
-                data = trimAndLoadJson(res, self)
-                return data["score"], data["reasoning"]
+        prompt = f"{instructions} \nImages: {image}"
+        return generate_with_schema_and_extract(
+            metric=self,
+            prompt=prompt,
+            schema_cls=ReasonScore,
+            extract_schema=lambda s: (s.score, s.reasoning),
+            extract_json=lambda data: (data["score"], data["reasoning"]),
+        )
 
     async def a_evaluate_image_coherence(
         self,
@@ -278,21 +291,14 @@ class ImageCoherenceMetric(BaseMultimodalMetric):
         instructions = ImageCoherenceTemplate.evaluate_image_coherence(
             context_above, context_below
         )
-        prompt = [instructions] + [image]
-        if self.using_native_model:
-            res, cost = await self.model.a_generate(prompt, schema=ReasonScore)
-            self.evaluation_cost += cost
-            return res.score, res.reasoning
-        else:
-            try:
-                res: ReasonScore = await self.model.a_generate(
-                    prompt, schema=ReasonScore
-                )
-                return res.score, res.reasoning
-            except TypeError:
-                res = await self.model.a_generate(prompt)
-                data = trimAndLoadJson(res, self)
-                return data["score"], data["reasoning"]
+        prompt = f"{instructions} \nImages: {image}"
+        return await a_generate_with_schema_and_extract(
+            metric=self,
+            prompt=prompt,
+            schema_cls=ReasonScore,
+            extract_schema=lambda s: (s.score, s.reasoning),
+            extract_json=lambda data: (data["score"], data["reasoning"]),
+        )
 
     def get_image_context(
         self, image_index: int, actual_output: List[Union[str, MLLMImage]]
@@ -327,7 +333,7 @@ class ImageCoherenceMetric(BaseMultimodalMetric):
             if isinstance(element, MLLMImage)
         ]
 
-    def calculate_score(self, scores: List[float]):
+    def calculate_score(self, scores: List[float]) -> float:
         return sum(scores) / len(scores)
 
     def is_successful(self) -> bool:
@@ -336,7 +342,7 @@ class ImageCoherenceMetric(BaseMultimodalMetric):
         else:
             try:
                 self.success = self.score >= self.threshold
-            except:
+            except TypeError:
                 self.success = False
         return self.success