phoenix-oss/llama-stack-mirror
0
0
Fork 1
mirror of https://github.com/meta-llama/llama-stack.git synced 2025-08-07 19:12:09 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs

Browse source
This commit is contained in:
Xi Yan 2025-03-11 22:06:55 -07:00
parent de382e7b45
commit 98dfc99584
3 changed files with 5 additions and 18 deletions
Download patch file Download diff file Expand all files Collapse all files

11
docs/_static/llama-stack-spec.html vendored
View file

@ -7175,9 +7175,6 @@
"scoring_fn_type": { "scoring_fn_type": {
"$ref": "#/components/schemas/ScoringFunctionType" "$ref": "#/components/schemas/ScoringFunctionType"
}, },
"description": {
"type": "string"
},
"params": { "params": {
"$ref": "#/components/schemas/ScoringFnParams" "$ref": "#/components/schemas/ScoringFnParams"
}, },
@ -9310,7 +9307,7 @@
"properties": { "properties": {
"scoring_fn_type": { "scoring_fn_type": {
"$ref": "#/components/schemas/ScoringFunctionType", "$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": { "params": {
"$ref": "#/components/schemas/ScoringFnParams", "$ref": "#/components/schemas/ScoringFnParams",
@ -9320,10 +9317,6 @@
"type": "string", "type": "string",
"description": "(Optional) The ID of the scoring function to register. If not provided, a random ID will be generated." "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": { "metadata": {
"type": "object", "type": "object",
"additionalProperties": { "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, "additionalProperties": false,

10
docs/_static/llama-stack-spec.yaml vendored
View file

@ -4937,8 +4937,6 @@ components:
default: scoring_function default: scoring_function
scoring_fn_type: scoring_fn_type:
$ref: '#/components/schemas/ScoringFunctionType' $ref: '#/components/schemas/ScoringFunctionType'
description:
type: string
params: params:
$ref: '#/components/schemas/ScoringFnParams' $ref: '#/components/schemas/ScoringFnParams'
metadata: metadata:
@ -6302,8 +6300,7 @@ components:
scoring_fn_type: scoring_fn_type:
$ref: '#/components/schemas/ScoringFunctionType' $ref: '#/components/schemas/ScoringFunctionType'
description: >- description: >-
The type of scoring function to register. A function type can only be The type of scoring function to register.
registered if it is a valid type.
params: params:
$ref: '#/components/schemas/ScoringFnParams' $ref: '#/components/schemas/ScoringFnParams'
description: The parameters for the scoring function. description: The parameters for the scoring function.
@ -6312,10 +6309,6 @@ components:
description: >- description: >-
(Optional) The ID of the scoring function to register. If not provided, (Optional) The ID of the scoring function to register. If not provided,
a random ID will be generated. a random ID will be generated.
description:
type: string
description: >-
(Optional) The description of the scoring function.
metadata: metadata:
type: object type: object
additionalProperties: additionalProperties:
@ -6328,6 +6321,7 @@ components:
- type: object - type: object
description: >- description: >-
(Optional) Any additional metadata to be associated with the scoring function. (Optional) Any additional metadata to be associated with the scoring function.
- E.g. {"description": "This scoring function is used for ..."}
additionalProperties: false additionalProperties: false
required: required:
- scoring_fn_type - scoring_fn_type

2
llama_stack/apis/scoring_functions/scoring_functions.py
View file

@ -178,7 +178,7 @@ class ScoringFunctions(Protocol):
Register a new scoring function with given parameters. Register a new scoring function with given parameters.
Only valid scoring function type that can be parameterized can be registered. 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 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 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.