merge description with metadata

This commit is contained in:
Xi Yan 2025-03-11 22:06:22 -07:00
parent 2bb6ca818a
commit de382e7b45

View file

@ -125,14 +125,13 @@ ScoringFnParams = register_schema(
class CommonScoringFnFields(BaseModel): class CommonScoringFnFields(BaseModel):
scoring_fn_type: ScoringFunctionType scoring_fn_type: ScoringFunctionType
description: Optional[str] = None
params: Optional[ScoringFnParams] = Field( 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 for benchmark eval, these can be overridden for app eval",
default=None, default=None,
) )
metadata: Dict[str, Any] = Field( metadata: Dict[str, Any] = Field(
default_factory=dict, 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, scoring_fn_type: ScoringFunctionType,
params: Optional[ScoringFnParams] = None, params: Optional[ScoringFnParams] = None,
scoring_fn_id: Optional[str] = None, scoring_fn_id: Optional[str] = None,
description: Optional[str] = None,
metadata: Optional[Dict[str, Any]] = None, metadata: Optional[Dict[str, Any]] = None,
) -> ScoringFn: ) -> 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 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 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 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 ..."}
""" """
... ...