diff --git a/docs/_static/llama-stack-spec.html b/docs/_static/llama-stack-spec.html index edcbd311b..6b363d26a 100644 --- a/docs/_static/llama-stack-spec.html +++ b/docs/_static/llama-stack-spec.html @@ -7175,9 +7175,6 @@ "scoring_fn_type": { "$ref": "#/components/schemas/ScoringFunctionType" }, - "description": { - "type": "string" - }, "params": { "$ref": "#/components/schemas/ScoringFnParams" }, @@ -9310,7 +9307,7 @@ "properties": { "scoring_fn_type": { "$ref": "#/components/schemas/ScoringFunctionType", - "description": "The type of scoring function to register. A function type can only be registered if it is a valid type." + "description": "The type of scoring function to register." }, "params": { "$ref": "#/components/schemas/ScoringFnParams", @@ -9320,10 +9317,6 @@ "type": "string", "description": "(Optional) The ID of the scoring function to register. If not provided, a random ID will be generated." }, - "description": { - "type": "string", - "description": "(Optional) The description of the scoring function." - }, "metadata": { "type": "object", "additionalProperties": { @@ -9348,7 +9341,7 @@ } ] }, - "description": "(Optional) Any additional metadata to be associated with the scoring function." + "description": "(Optional) Any additional metadata to be associated with the scoring function. - E.g. {\"description\": \"This scoring function is used for ...\"}" } }, "additionalProperties": false, diff --git a/docs/_static/llama-stack-spec.yaml b/docs/_static/llama-stack-spec.yaml index 4b88510ba..11f317711 100644 --- a/docs/_static/llama-stack-spec.yaml +++ b/docs/_static/llama-stack-spec.yaml @@ -4937,8 +4937,6 @@ components: default: scoring_function scoring_fn_type: $ref: '#/components/schemas/ScoringFunctionType' - description: - type: string params: $ref: '#/components/schemas/ScoringFnParams' metadata: @@ -6302,8 +6300,7 @@ components: scoring_fn_type: $ref: '#/components/schemas/ScoringFunctionType' description: >- - The type of scoring function to register. A function type can only be - registered if it is a valid type. + The type of scoring function to register. params: $ref: '#/components/schemas/ScoringFnParams' description: The parameters for the scoring function. @@ -6312,10 +6309,6 @@ components: description: >- (Optional) The ID of the scoring function to register. If not provided, a random ID will be generated. - description: - type: string - description: >- - (Optional) The description of the scoring function. metadata: type: object additionalProperties: @@ -6328,6 +6321,7 @@ components: - type: object description: >- (Optional) Any additional metadata to be associated with the scoring function. + - E.g. {"description": "This scoring function is used for ..."} additionalProperties: false required: - scoring_fn_type diff --git a/llama_stack/apis/scoring_functions/scoring_functions.py b/llama_stack/apis/scoring_functions/scoring_functions.py index bbf4205b3..ba3051133 100644 --- a/llama_stack/apis/scoring_functions/scoring_functions.py +++ b/llama_stack/apis/scoring_functions/scoring_functions.py @@ -178,7 +178,7 @@ class ScoringFunctions(Protocol): Register a new scoring function with given parameters. Only valid scoring function type that can be parameterized can be registered. - :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. :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 metadata: (Optional) Any additional metadata to be associated with the scoring function.