judgeval 0.7.1__py3-none-any.whl → 0.9.0__py3-none-any.whl

judgeval/judges/mixture_of_judges.py

@@ -1,287 +0,0 @@
-"""
-Implementation for Mixture of Judges model through Judgeval
-
-Enables client to use multiple models to generate responses and then aggregate them into a single response.
-"""
-
-import pydantic
-from typing import List, Union
-from judgeval.judges import JudgevalJudge
-from judgeval.common.utils import (
-    get_completion_multiple_models,
-    get_chat_completion,
-    aget_completion_multiple_models,
-    aget_chat_completion,
-)
-from judgeval.common.logger import judgeval_logger
-from judgeval.constants import DEFAULT_GPT_MODEL
-
-
-def build_dynamic_mixture_prompt(
-    judge_responses: List[str],
-    custom_system_prompt: Union[str, None] = None,
-    custom_conversation_history: Union[List[dict], None] = None,
-) -> List[dict]:
-    """
-    Dynamically builds a prompt to mix judge responses together for the Mixture of Judges model.
-
-    In this implementation, we simply concatenate the judge responses into a formatted string, then
-    pass it into a default prompt template. This template can be customized by providing a custom prompt.
-
-    Args:
-        judge_responses (List[str]): List of responses from individual judges to be synthesized
-        custom_system_prompt (str, optional): Custom system prompt to override the default one. Defaults to None.
-        custom_conversation_history (List[dict], optional): Custom conversation history to override the default one. Defaults to None.
-    """
-    formatted_responses = "\n".join(
-        [
-            f"# Judge {i + 1}'s response: #\n{response}"
-            for i, response in enumerate(judge_responses)
-        ]
-    )
-
-    # This is the default prompt for the Mixture of Judges model
-    """
-    You are tasked with synthesizing responses from multiple expert judges. You will receive N individual answers on the same topic. Your job is to:
-
-    1. Analyze and compare the key points, patterns, and agreements between the answers.
-    2. Identify the consensus by focusing on areas where most or all of the answers align. Consider common reasoning and frequently mentioned conclusions.
-    3. Condense the responses into a single, coherent, and concise answer that represents the collective judgment of the group.
-    4. When opinions differ or contradict, highlight the most supported viewpoint while briefly acknowledging the dissenting perspectives.
-    5. Ensure the final answer is balanced and clear, providing a comprehensive summary that captures the wisdom of all judges while avoiding repetition.
-
-    ## Start of Judge Responses ##
-    {{judge_responses}}
-    ## End of Judge Responses ##
-    Synthesized response:
-    """
-
-    default_conversation = [  # inject the judge responses into the default prompt
-        {
-            "role": "system",
-            "content": "You are tasked with synthesizing responses from multiple expert judges. You will receive N individual answers on the same topic. Your job is to:\n1. Analyze and compare the key points, patterns, and agreements between the answers.\n2. Identify the consensus by focusing on areas where most or all of the answers align. Consider common reasoning and frequently mentioned conclusions.\n3. Condense the responses into a single, coherent, and concise answer that represents the collective judgment of the group.\n4. When opinions differ or contradict, highlight the most supported viewpoint while briefly acknowledging the dissenting perspectives.\n5. Ensure the final answer is balanced and clear, providing a comprehensive summary that captures the wisdom of all judges while avoiding repetition.\n\n**IMPORTANT**: IF THE JUDGE RESPONSES ARE IN JSON FORMAT, YOU MUST RESPOND USING THE SAME JSON FORMAT THAT THE RESPONSES ARE IN. If the judge responses are in JSON, you MUST RESPOND IN VALID JSON FORMAT. ",
-        },
-        {
-            "role": "user",
-            "content": '## Start of Judge Responses ## \n# Judge 1\'s response: #\n{\n"claims": [\n{\n"claim": "A 30-day full refund is offered.",\n"quote": "We offer a 30-day full refund at no extra cost."\n},\n{\n"claim": "The 30-day full refund comes at no extra cost.",\n"quote": "We offer a 30-day full refund at no extra cost."\n}\n]\n}\n\n# Judge 2\'s response: #\n{\n    "claims": [\n        {\n            "claim": "A full refund is offered within 30 days.",\n            "quote": "We offer a 30-day full refund at no extra cost."\n        },\n        {\n            "claim": "The 30-day full refund is offered at no extra cost.",\n            "quote": "We offer a 30-day full refund at no extra cost."\n        }\n    ]\n}\n# Judge 3\'s response: #\n {\n    "claims": [\n        {\n            "claim": "A 30-day full refund is offered.",\n            "quote": "We offer a 30-day full refund at no extra cost."\n        },\n        {\n            "claim": "The 30-day full refund is offered at no extra cost.",\n            "quote": "We offer a 30-day full refund at no extra cost."\n        }\n    ]\n}\n## End of Judge Responses ##\nSynthesized response:',
-        },
-        {
-            "role": "assistant",
-            "content": 'The consensus among the judges is clear and unanimous. All three judges agree that a 30-day full refund is offered, and this refund is available at no extra cost. This conclusion is consistently supported by their statements, as each of their claims is directly quoted as: "We offer a 30-day full refund at no extra cost." There are no dissenting perspectives or opposing views provided in any of the responses, indicating complete alignment on this topic.\n\nJSON:\n{\n    "claims": [\n        {\n            "claim": "A full refund is offered within 30 days.",\n            "quote": "We offer a 30-day full refund at no extra cost."\n        },\n        {\n            "claim": "The 30-day full refund is offered at no extra cost.",\n            "quote": "We offer a 30-day full refund at no extra cost."\n        }\n    ]\n}',
-        },
-        {
-            "role": "user",
-            "content": "## Start of Judge Responses ##\n# Judge 1's response: # \nThe capital of France is Paris.\n\n# Judge 2's response: #\nThe capital of France is Paris.\n\n# Judge 3's response: # \nThe capital of France is Paris. It's one of the most popular tourist destinations in the world, known for its art, culture, and history. It's also famous for its iconic landmarks such as the Eiffel Tower, Louvre Museum, and Notre-Dame Cathedral.\n\n## End of Judge Responses ##\nSynthesized response:",
-        },
-        {
-            "role": "assistant",
-            "content": "The capital of France is Paris. It is widely recognized as one of the world's most popular tourist destinations, celebrated for its rich art, culture, and history. Paris is renowned for its iconic landmarks, including the Eiffel Tower, Louvre Museum, and Notre-Dame Cathedral.",
-        },
-        {
-            "role": "user",
-            "content": f"## Start of Judge Responses ##\n{formatted_responses}\n## End of Judge Responses ##\nSynthesized response:\n",
-        },
-    ]
-
-    # If a custom system prompt is provided, validate and use it
-    if custom_system_prompt is not None:
-        if not isinstance(custom_system_prompt, str):
-            judgeval_logger.error(
-                f"TypeError: Custom system prompt must be a string. Received: {type(custom_system_prompt)}."
-            )
-            raise TypeError(
-                f"Custom system prompt must be a string. Received: {type(custom_system_prompt)}."
-            )
-        if not custom_system_prompt:
-            raise ValueError("Custom system prompt cannot be empty")
-        # Override the default system prompt, but also add special instructions for handling JSON
-        default_conversation[0]["content"] = (
-            custom_system_prompt
-            + "\n\n**IMPORTANT**: IF THE JUDGE RESPONSES ARE IN JSON FORMAT, YOU MUST RESPOND USING THE SAME JSON FORMAT THAT THE RESPONSES ARE IN. If the judge responses are in JSON, you MUST RESPOND IN VALID JSON FORMAT."
-        )
-
-    # If a custom conversation history is provided, append the judge responses to it
-    if custom_conversation_history is not None:
-        # Validate custom conversation history format
-        for message in custom_conversation_history:
-            if not isinstance(message, dict):
-                raise TypeError(
-                    f"Custom conversation history must be a list of dictionaries. Received: {message}."
-                )
-
-            if "role" not in message or "content" not in message:
-                raise ValueError("Each message must have 'role' and 'content' keys")
-
-            if not isinstance(message["role"], str) or not isinstance(
-                message["content"], str
-            ):
-                raise TypeError(
-                    f"Message role and content must be strings. Received: {type(message['role'])}, {type(message['content'])}."
-                )
-
-            if message["role"] not in ["system", "user", "assistant"]:
-                raise ValueError(
-                    f"Message role must be one of: 'system', 'user', 'assistant'. Received: {message['role']}."
-                )
-
-        judge_responses_prompt = {
-            "role": "user",
-            "content": f"## Start of Judge Responses ##\n{formatted_responses}\n## End of Judge Responses ##\nSynthesized response:\n",
-        }
-        return custom_conversation_history + [judge_responses_prompt]
-
-    # Otherwise return the default conversation with system prompt and examples
-    # No customization, return the default conversation with system prompt and examples
-    return default_conversation
-
-
-BASE_CONVERSATION = [
-    {"role": "system", "content": "You are a helpful assistant."},
-]  # for string inputs, we need to add the user query to a base conversation, since LiteLLM only accepts a list of dictionaries as a chat history
-
-
-class MixtureOfJudges(JudgevalJudge):
-    """
-    IMPORTANT: When supplying custom prompts and conversation histories for aggregation, supply them in the following format:
-    in kwargs:
-    {
-        "custom_prompt": "Your custom prompt here",
-        "custom_conversation": [
-            {"role": "system", "content": "System message 1"},
-            {"role": "user", "content": "User message 1"},
-            {"role": "assistant", "content": "Assistant message 1"},
-            ...
-        ]
-    }
-    """
-
-    def __init__(
-        self,
-        models: List[str] = [
-            "QWEN",
-            "LLAMA3_70B_INSTRUCT_TURBO",
-            "MISTRAL_8x22B_INSTRUCT",
-        ],
-        aggregator: str = DEFAULT_GPT_MODEL,
-        **kwargs,
-    ):
-        """
-        `models` are the individual judge models to be used for generating responses.
-        `aggregator` is the model that will aggregate the responses from the individual judges.
-
-        kwargs include "custom_prompt" and "custom_conversation" for customizing the prompt for the Mixture of Judges model.
-        """
-        self.models = models
-        self.aggregator = aggregator
-        self.kwargs = kwargs
-        super().__init__(model_name=models)
-
-    def generate(
-        self,
-        input: Union[str, List[dict]],
-        response_schema: Union[pydantic.BaseModel, None] = None,
-        aggregation_schema: Union[pydantic.BaseModel, None] = None,
-        **kwargs,
-    ) -> str:
-        """
-        Args:
-            input (Union[str, List[Mapping[str, str]]]): Input query or conversation history to the model.
-            response_schema (pydantic.BaseModel): Response schema for individual judge models.
-            aggregation_schema (pydantic.BaseModel): Response schema for the aggregator model.
-            kwargs: Additional keyword arguments.
-        """
-
-        # Convert input to conversation format if needed
-        if isinstance(input, str):
-            convo = BASE_CONVERSATION + [{"role": "user", "content": input}]
-        elif isinstance(input, list):
-            convo = input
-        else:
-            judgeval_logger.error(f"Invalid input type received: {type(input)}")
-            raise TypeError(
-                f"Input must be a string or a list of dictionaries. Input type of: {type(input)}"
-            )
-
-        try:
-            responses = get_completion_multiple_models(
-                models=self.models,
-                messages=[convo] * len(self.models),
-                response_formats=[response_schema] * len(self.models),
-            )
-        except Exception:
-            raise
-
-        compiled_mixture_prompt = build_dynamic_mixture_prompt(
-            responses,
-            self.kwargs.get("custom_prompt"),
-            self.kwargs.get("custom_conversation"),
-        )
-
-        try:
-            mixed_response = get_chat_completion(
-                model_type=self.aggregator,
-                messages=compiled_mixture_prompt,
-                response_format=aggregation_schema,
-            )
-        except Exception:
-            raise
-
-        return mixed_response
-
-    async def a_generate(
-        self,
-        input: Union[str, List[dict]],
-        response_schema: Union[pydantic.BaseModel, None] = None,
-        aggregation_schema: Union[pydantic.BaseModel, None] = None,
-        **kwargs,
-    ) -> str:
-        """
-        Args:
-            input (Union[str, List[Mapping[str, str]]]): Input query or conversation history to the model.
-            response_schema (pydantic.BaseModel): Response schema for individual judge models.
-            aggregation_schema (pydantic.BaseModel): Response schema for the aggregator model.
-            kwargs: Additional keyword arguments.
-        """
-
-        # Convert input to conversation format if needed
-        if isinstance(input, str):
-            convo = BASE_CONVERSATION + [{"role": "user", "content": input}]
-        elif isinstance(input, list):
-            convo = input
-        else:
-            judgeval_logger.error(f"Invalid input type received: {type(input)}")
-            raise TypeError(
-                f"Input must be a string or a list of dictionaries. Input type of: {type(input)}"
-            )
-
-        try:
-            responses = await aget_completion_multiple_models(
-                models=self.models,
-                messages=[convo] * len(self.models),
-                response_formats=[response_schema] * len(self.models),
-            )
-        except Exception:
-            raise
-
-        compiled_mixture_prompt = build_dynamic_mixture_prompt(
-            responses,
-            self.kwargs.get("custom_prompt"),
-            self.kwargs.get("custom_conversation"),
-        )
-
-        try:
-            mixed_response = await aget_chat_completion(
-                model_type=self.aggregator,
-                messages=compiled_mixture_prompt,
-                response_format=aggregation_schema,
-            )
-        except Exception:
-            raise
-
-        return mixed_response
-
-    def load_model(self):
-        return self.models
-
-    def get_model_name(self) -> List[str]:
-        return self.models

judgeval/judgment_client.py

@@ -1,267 +0,0 @@
-"""
-Implements the JudgmentClient to interact with the Judgment API.
-"""
-
-from __future__ import annotations
-import os
-import importlib.util
-from pathlib import Path
-from uuid import uuid4
-from typing import Optional, List, Dict, Union
-
-from judgeval.data import (
-    ScoringResult,
-    Example,
-)
-from judgeval.scorers import (
-    APIScorerConfig,
-    BaseScorer,
-)
-from judgeval.data.evaluation_run import EvaluationRun
-from judgeval.run_evaluation import (
-    run_eval,
-    assert_test,
-)
-from judgeval.common.api import JudgmentApiClient
-from judgeval.common.exceptions import JudgmentAPIError
-from judgeval.common.utils import validate_api_key
-from pydantic import BaseModel
-from judgeval.common.logger import judgeval_logger
-
-
-from judgeval.constants import DEFAULT_GPT_MODEL
-
-
-class EvalRunRequestBody(BaseModel):
-    eval_name: str
-    project_name: str
-
-
-class DeleteEvalRunRequestBody(BaseModel):
-    eval_names: List[str]
-    project_name: str
-
-
-class SingletonMeta(type):
-    _instances: Dict[type, "JudgmentClient"] = {}
-
-    def __call__(cls, *args, **kwargs):
-        if cls not in cls._instances:
-            instance = super().__call__(*args, **kwargs)
-            cls._instances[cls] = instance
-        return cls._instances[cls]
-
-
-class JudgmentClient(metaclass=SingletonMeta):
-    def __init__(
-        self,
-        api_key: Optional[str] = os.getenv("JUDGMENT_API_KEY"),
-        organization_id: Optional[str] = os.getenv("JUDGMENT_ORG_ID"),
-    ):
-        if not api_key:
-            raise ValueError(
-                "api_key parameter must be provided. Please provide a valid API key value or set the JUDGMENT_API_KEY environment variable."
-            )
-
-        if not organization_id:
-            raise ValueError(
-                "organization_id parameter must be provided. Please provide a valid organization ID value or set the JUDGMENT_ORG_ID environment variable."
-            )
-
-        self.judgment_api_key = api_key
-        self.organization_id = organization_id
-        self.api_client = JudgmentApiClient(api_key, organization_id)
-
-        # Verify API key is valid
-        result, response = validate_api_key(api_key)
-        if not result:
-            # May be bad to output their invalid API key...
-            raise JudgmentAPIError(f"Issue with passed in Judgment API key: {response}")
-        else:
-            judgeval_logger.info("Successfully initialized JudgmentClient!")
-
-    def run_evaluation(
-        self,
-        examples: List[Example],
-        scorers: List[Union[APIScorerConfig, BaseScorer]],
-        model: Optional[str] = DEFAULT_GPT_MODEL,
-        project_name: str = "default_project",
-        eval_run_name: str = "default_eval_run",
-        show_url: bool = True,
-    ) -> List[ScoringResult]:
-        """
-        Executes an evaluation of `Example`s using one or more `Scorer`s
-
-        Args:
-            examples (List[Example]): The examples to evaluate
-            scorers (List[Union[APIScorerConfig, BaseScorer]]): A list of scorers to use for evaluation
-            model (str): The model used as a judge when using LLM as a Judge
-            project_name (str): The name of the project the evaluation results belong to
-            eval_run_name (str): A name for this evaluation run
-
-        Returns:
-            List[ScoringResult]: The results of the evaluation
-        """
-
-        try:
-            eval = EvaluationRun(
-                project_name=project_name,
-                eval_name=eval_run_name,
-                examples=examples,
-                scorers=scorers,
-                model=model,
-                organization_id=self.organization_id,
-            )
-            return run_eval(
-                eval,
-                self.judgment_api_key,
-                show_url=show_url,
-            )
-        except ValueError as e:
-            raise ValueError(
-                f"Please check your EvaluationRun object, one or more fields are invalid: \n{str(e)}"
-            )
-        except Exception as e:
-            raise Exception(f"An unexpected error occurred during evaluation: {str(e)}")
-
-    def create_project(self, project_name: str) -> bool:
-        """
-        Creates a project on the server.
-        """
-        try:
-            self.api_client.create_project(project_name)
-            return True
-        except Exception as e:
-            judgeval_logger.error(f"Error creating project: {e}")
-            return False
-
-    def delete_project(self, project_name: str) -> bool:
-        """
-        Deletes a project from the server. Which also deletes all evaluations and traces associated with the project.
-        """
-        self.api_client.delete_project(project_name)
-        return True
-
-    def assert_test(
-        self,
-        examples: List[Example],
-        scorers: List[Union[APIScorerConfig, BaseScorer]],
-        model: Optional[str] = DEFAULT_GPT_MODEL,
-        project_name: str = "default_test",
-        eval_run_name: str = str(uuid4()),
-    ) -> None:
-        """
-        Asserts a test by running the evaluation and checking the results for success
-
-        Args:
-            examples (List[Example]): The examples to evaluate.
-            scorers (List[Union[APIScorerConfig, BaseScorer]]): A list of scorers to use for evaluation
-            model (str): The model used as a judge when using LLM as a Judge
-            project_name (str): The name of the project the evaluation results belong to
-            eval_run_name (str): A name for this evaluation run
-        """
-
-        results: List[ScoringResult]
-
-        results = self.run_evaluation(
-            examples=examples,
-            scorers=scorers,
-            model=model,
-            project_name=project_name,
-            eval_run_name=eval_run_name,
-        )
-        assert_test(results)
-
-    def _extract_scorer_name(self, scorer_file_path: str) -> str:
-        """Extract scorer name from the scorer file by importing it."""
-        try:
-            spec = importlib.util.spec_from_file_location(
-                "scorer_module", scorer_file_path
-            )
-            if spec is None or spec.loader is None:
-                raise ImportError(f"Could not load spec from {scorer_file_path}")
-
-            module = importlib.util.module_from_spec(spec)
-            spec.loader.exec_module(module)
-
-            for attr_name in dir(module):
-                attr = getattr(module, attr_name)
-                if (
-                    isinstance(attr, type)
-                    and any("Scorer" in str(base) for base in attr.__mro__)
-                    and attr.__module__ == "scorer_module"
-                ):
-                    try:
-                        # Instantiate the scorer and get its name
-                        scorer_instance = attr()
-                        if hasattr(scorer_instance, "name"):
-                            return scorer_instance.name
-                    except Exception:
-                        # Skip if instantiation fails
-                        continue
-
-            raise AttributeError("No scorer class found or could be instantiated")
-        except Exception as e:
-            judgeval_logger.warning(f"Could not extract scorer name: {e}")
-            return Path(scorer_file_path).stem
-
-    def upload_custom_scorer(
-        self,
-        scorer_file_path: str,
-        requirements_file_path: Optional[str] = None,
-        unique_name: Optional[str] = None,
-    ) -> bool:
-        """
-        Upload custom ExampleScorer from files to backend.
-
-        Args:
-            scorer_file_path: Path to Python file containing CustomScorer class
-            requirements_file_path: Optional path to requirements.txt
-            unique_name: Optional unique identifier (auto-detected from scorer.name if not provided)
-
-        Returns:
-            bool: True if upload successful
-
-        Raises:
-            ValueError: If scorer file is invalid
-            FileNotFoundError: If scorer file doesn't exist
-        """
-        import os
-
-        if not os.path.exists(scorer_file_path):
-            raise FileNotFoundError(f"Scorer file not found: {scorer_file_path}")
-
-        # Auto-detect scorer name if not provided
-        if unique_name is None:
-            unique_name = self._extract_scorer_name(scorer_file_path)
-            judgeval_logger.info(f"Auto-detected scorer name: '{unique_name}'")
-
-        # Read scorer code
-        with open(scorer_file_path, "r") as f:
-            scorer_code = f.read()
-
-        # Read requirements (optional)
-        requirements_text = ""
-        if requirements_file_path and os.path.exists(requirements_file_path):
-            with open(requirements_file_path, "r") as f:
-                requirements_text = f.read()
-
-        try:
-            response = self.api_client.upload_custom_scorer(
-                scorer_name=unique_name,
-                scorer_code=scorer_code,
-                requirements_text=requirements_text,
-            )
-
-            if response.get("status") == "success":
-                judgeval_logger.info(
-                    f"Successfully uploaded custom scorer: {unique_name}"
-                )
-                return True
-            else:
-                judgeval_logger.error(f"Failed to upload custom scorer: {unique_name}")
-                return False
-
-        except Exception as e:
-            judgeval_logger.error(f"Error uploading custom scorer: {e}")
-            raise