From 58d9cb12767b2da2d140e3aab37aac7561c27ad1 Mon Sep 17 00:00:00 2001
From: Xi Yan <xiyan@meta.com>
Date: Tue, 11 Mar 2025 22:46:52 -0700
Subject: [PATCH] docs

---
 docs/_static/llama-stack-spec.html                      | 9 +++++----
 docs/_static/llama-stack-spec.yaml                      | 8 +++++---
 llama_stack/apis/scoring_functions/scoring_functions.py | 8 +++++++-
 3 files changed, 17 insertions(+), 8 deletions(-)

diff --git a/docs/_static/llama-stack-spec.html b/docs/_static/llama-stack-spec.html
index 13acd6c0c..a3ff2c181 100644
--- a/docs/_static/llama-stack-spec.html
+++ b/docs/_static/llama-stack-spec.html
@@ -7201,11 +7201,11 @@
                             "context_recall",
                             "context_relevancy"
                         ],
-                        "title": "ScoringFunctionType",
-                        "description": "A type of scoring function. Each type is a criteria for evaluating answers."
+                        "description": "The type of scoring function."
                     },
                     "params": {
-                        "$ref": "#/components/schemas/ScoringFnParams"
+                        "$ref": "#/components/schemas/ScoringFnParams",
+                        "description": "(Optional) The parameters for the scoring function."
                     },
                     "metadata": {
                         "type": "object",
@@ -7230,7 +7230,8 @@
                                     "type": "object"
                                 }
                             ]
-                        }
+                        },
+                        "description": "(Optional) Any additional metadata for this definition (e.g. description)."
                     }
                 },
                 "additionalProperties": false,
diff --git a/docs/_static/llama-stack-spec.yaml b/docs/_static/llama-stack-spec.yaml
index d7d0107f3..fed0e4a85 100644
--- a/docs/_static/llama-stack-spec.yaml
+++ b/docs/_static/llama-stack-spec.yaml
@@ -4976,11 +4976,11 @@ components:
             - context_precision
             - context_recall
             - context_relevancy
-          title: ScoringFunctionType
-          description: >-
-            A type of scoring function. Each type is a criteria for evaluating answers.
+          description: The type of scoring function.
         params:
           $ref: '#/components/schemas/ScoringFnParams'
+          description: >-
+            (Optional) The parameters for the scoring function.
         metadata:
           type: object
           additionalProperties:
@@ -4991,6 +4991,8 @@ components:
               - type: string
               - type: array
               - type: object
+          description: >-
+            (Optional) Any additional metadata for this definition (e.g. description).
       additionalProperties: false
       required:
         - identifier
diff --git a/llama_stack/apis/scoring_functions/scoring_functions.py b/llama_stack/apis/scoring_functions/scoring_functions.py
index f67226eb1..8f16468b2 100644
--- a/llama_stack/apis/scoring_functions/scoring_functions.py
+++ b/llama_stack/apis/scoring_functions/scoring_functions.py
@@ -153,9 +153,15 @@ ScoringFnParams = register_schema(
 
 
 class CommonScoringFnFields(BaseModel):
+    """
+    :param scoring_fn_type: The type of scoring function.
+    :param params: (Optional) The parameters for the scoring function.
+    :param metadata: (Optional) Any additional metadata for this definition (e.g. description).
+    """
+
     scoring_fn_type: ScoringFunctionType
     params: Optional[ScoringFnParams] = Field(
-        description="The parameters for the scoring function for benchmark eval, these can be overridden for app eval",
+        description="The parameters for the scoring function.",
         default=None,
     )
     metadata: Dict[str, Any] = Field(