From de382e7b45cac81f2dfd7000220481ca5a9090af Mon Sep 17 00:00:00 2001
From: Xi Yan <xiyan@meta.com>
Date: Tue, 11 Mar 2025 22:06:22 -0700
Subject: [PATCH] merge description with metadata

---
 llama_stack/apis/scoring_functions/scoring_functions.py | 8 +++-----
 1 file changed, 3 insertions(+), 5 deletions(-)

diff --git a/llama_stack/apis/scoring_functions/scoring_functions.py b/llama_stack/apis/scoring_functions/scoring_functions.py
index 1241712c1..bbf4205b3 100644
--- a/llama_stack/apis/scoring_functions/scoring_functions.py
+++ b/llama_stack/apis/scoring_functions/scoring_functions.py
@@ -125,14 +125,13 @@ ScoringFnParams = register_schema(
 
 class CommonScoringFnFields(BaseModel):
     scoring_fn_type: ScoringFunctionType
-    description: Optional[str] = None
     params: Optional[ScoringFnParams] = Field(
         description="The parameters for the scoring function for benchmark eval, these can be overridden for app eval",
         default=None,
     )
     metadata: Dict[str, Any] = Field(
         default_factory=dict,
-        description="Any additional metadata for this definition",
+        description="Any additional metadata for this definition (e.g. description)",
     )
 
 
@@ -173,7 +172,6 @@ class ScoringFunctions(Protocol):
         scoring_fn_type: ScoringFunctionType,
         params: Optional[ScoringFnParams] = None,
         scoring_fn_id: Optional[str] = None,
-        description: Optional[str] = None,
         metadata: Optional[Dict[str, Any]] = None,
     ) -> ScoringFn:
         """
@@ -183,7 +181,7 @@ class ScoringFunctions(Protocol):
         :param scoring_fn_type: The type of scoring function to register. A function type can only be registered if it is a valid type.
         :param params: The parameters for the scoring function.
         :param scoring_fn_id: (Optional) The ID of the scoring function to register. If not provided, a random ID will be generated.
-        :param description: (Optional) The description of the scoring function.
-        :param metadata: (Optional) Any additional metadata to be associated with the scoring function.
+        :param metadata: (Optional) Any additional metadata to be associated with the scoring function. 
+            - E.g. {"description": "This scoring function is used for ..."}
         """
         ...