Merge pull request #327 from shijinpjlab/dev_front

feat: add required fileds

Author: shijinpjlab

app_gradio/app.py

@@ -247,32 +247,38 @@ def generate_llm_config_dataframe(llm_list):
 
 def suggest_fields_dataframe(rule_list, llm_list):
     """Suggest required field mappings based on selected evaluators"""
+    from dingo.io.input import RequiredField
+
     suggested_fields = set()
 
-    # Fields required by rule evaluators
-    rule_type_mapping = get_rule_type_mapping()
-    data_column_mapping = get_data_column_mapping()
+    # Get rule and llm name maps
+    rule_name_map = Model.get_rule_name_map()
+    llm_name_map = Model.get_llm_name_map()
 
+    # Fields required by rule evaluators
     for rule in rule_list:
-        # Find which type this rule belongs to
-        for rule_type, rules in rule_type_mapping.items():
-            if rule in rules:
-                if rule_type in data_column_mapping:
-                    suggested_fields.update(data_column_mapping[rule_type])
-                break
+        if rule in rule_name_map:
+            rule_class = rule_name_map[rule]
+            if hasattr(rule_class, '_required_fields'):
+                for field in rule_class._required_fields:
+                    if isinstance(field, RequiredField):
+                        suggested_fields.add(field.value)
 
     # Fields required by LLM evaluators
-    llm_column_mapping = get_llm_column_mapping()
     for llm in llm_list:
-        if llm in llm_column_mapping:
-            suggested_fields.update(llm_column_mapping[llm])
-
-    # Generate suggested fields rows
+        if llm in llm_name_map:
+            llm_class = llm_name_map[llm]
+            if hasattr(llm_class, '_required_fields'):
+                for field in llm_class._required_fields:
+                    if isinstance(field, RequiredField):
+                        suggested_fields.add(field.value)
+
+    # Generate suggested fields rows - Required Field and Dataset Column both with same value
     rows = []
     for field in sorted(suggested_fields):
         rows.append([field, field])
 
-    return gr.update(value=rows if rows else [["content", "content"]])
+    return gr.update(value=rows)
 
 
 def get_rule_type_mapping():
@@ -405,11 +411,11 @@ def get_data_column_mapping():
                     # Field mapping configuration
                     gr.Markdown("**EvalPipline.fields** - Field Mapping")
                     fields_dataframe = gr.Dataframe(
-                        value=[["content", "content"]],
-                        headers=["Field Key", "Dataset Column"],
+                        value=[],
+                        headers=["Required Field", "Dataset Column"],
                         datatype=["str", "str"],
                         column_count=(2, "fixed"),
-                        row_count=(1, "dynamic"),
+                        row_count=(0, "dynamic"),
                         label="Field Mappings (add/remove rows as needed)",
                         interactive=True
                     )

dingo/io/input/__init__.py

@@ -1 +1,2 @@
 from dingo.io.input.data import Data  # noqa E402.
+from dingo.io.input.required_field import RequiredField  # noqa E402.

dingo/io/input/required_field.py

@@ -0,0 +1,8 @@
+from enum import Enum
+
+
+class RequiredField(Enum):
+    CONTENT = "content"
+    PROMPT = "prompt"
+    CONTEXT = "context"
+    IMAGE = "image"

dingo/model/llm/agent/agent_hallucination.py

@@ -16,7 +16,7 @@
 import json
 from typing import Any, Dict, List
 
-from dingo.io import Data
+from dingo.io.input import Data, RequiredField
 from dingo.io.output.eval_detail import EvalDetail, QualityLabel
 from dingo.model import Model
 from dingo.model.llm.agent.base_agent import BaseAgent
@@ -96,6 +96,8 @@ class AgentHallucination(BaseAgent):
 {{"claims": ["claim 1", "claim 2", ...]}}
 """
 
+    _required_fields = [RequiredField.CONTENT, RequiredField.CONTEXT]
+
     @classmethod
     def eval(cls, input_data: Data) -> EvalDetail:
         """

dingo/model/llm/agent/base_agent.py

@@ -13,7 +13,7 @@
 from abc import abstractmethod
 from typing import Any, Dict, List
 
-from dingo.io import Data
+from dingo.io.input import Data, RequiredField
 from dingo.io.output.eval_detail import EvalDetail, QualityLabel
 from dingo.model.llm.agent.tools import ToolRegistry
 from dingo.model.llm.base_openai import BaseOpenAI
@@ -48,6 +48,8 @@ class BaseAgent(BaseOpenAI):
     max_iterations: int = 5
     use_agent_executor: bool = False  # Opt-in to LangChain agent path
 
+    _required_fields = [RequiredField.CONTENT]
+
     @classmethod
     @abstractmethod
     def plan_execution(cls, input_data: Data) -> List[Dict[str, Any]]:

dingo/model/llm/agent/tools/base_tool.py

@@ -11,6 +11,8 @@
 
 from pydantic import BaseModel
 
+from dingo.io.input import RequiredField
+
 
 class ToolConfig(BaseModel):
     """Base configuration for tools"""
@@ -39,6 +41,8 @@ class BaseTool(ABC):
     description: str = None
     config: ToolConfig = ToolConfig()
 
+    _required_fields = [RequiredField.CONTENT]
+
     @classmethod
     @abstractmethod
     def execute(cls, **kwargs) -> Dict[str, Any]:

dingo/model/llm/agent/tools/tavily_search.py

@@ -21,6 +21,7 @@
 
 from pydantic import Field
 
+from dingo.io.input import RequiredField
 from dingo.model.llm.agent.tools.base_tool import BaseTool, ToolConfig
 from dingo.model.llm.agent.tools.tool_registry import tool_register
 from dingo.utils import log
@@ -76,6 +77,8 @@ class TavilySearch(BaseTool):
     description = "Search the web for factual information using Tavily AI"
     config: TavilyConfig = TavilyConfig()
 
+    _required_fields = [RequiredField.IMAGE]
+
     @classmethod
     def execute(cls, query: str, **kwargs) -> Dict[str, Any]:
         """

dingo/model/llm/base_lmdeploy_apiclient.py

@@ -5,7 +5,7 @@
 from pydantic import ValidationError
 
 from dingo.config.input_args import EvaluatorLLMArgs
-from dingo.io import Data
+from dingo.io.input import Data, RequiredField
 from dingo.io.output.eval_detail import EvalDetail, QualityLabel
 from dingo.model.llm.base import BaseLLM
 from dingo.model.response.response_class import ResponseScoreReason
@@ -15,6 +15,7 @@
 
 class BaseLmdeployApiClient(BaseLLM):
     dynamic_config = EvaluatorLLMArgs()
+    _required_fields = [RequiredField.CONTENT]  # Default, override in subclasses
 
     # @classmethod
     # def set_prompt(cls, prompt):

dingo/model/llm/base_openai.py

@@ -5,7 +5,7 @@
 from pydantic import ValidationError
 
 from dingo.config.input_args import EvaluatorLLMArgs
-from dingo.io import Data
+from dingo.io.input import Data, RequiredField
 from dingo.io.output.eval_detail import EvalDetail, QualityLabel
 from dingo.model.llm.base import BaseLLM
 from dingo.model.response.response_class import ResponseScoreReason
@@ -15,6 +15,7 @@
 
 class BaseOpenAI(BaseLLM):
     dynamic_config = EvaluatorLLMArgs()
+    _required_fields = [RequiredField.CONTENT]  # Default, override in subclasses
 
     # Embedding 模型配置（用于 RAG 相关评估器）
     embedding_model = None

dingo/model/llm/compare/llm_code_compare.py

@@ -2,7 +2,7 @@
 import re
 from typing import List
 
-from dingo.io import Data
+from dingo.io.input import Data, RequiredField
 from dingo.io.output.eval_detail import EvalDetail
 from dingo.model import Model
 from dingo.model.llm.base_openai import BaseOpenAI
@@ -25,6 +25,7 @@ class LLMCodeCompare(BaseOpenAI):
         'evaluation_results': ''
     }
 
+    _required_fields = [RequiredField.CONTENT]
     prompt = """
 你是一位专业的代码块识别评估专家,擅长分析 HTML 代码和 Markdown 文本中的代码块。现在我会提供三段内容：