Properties
| Name | Type | Description |
|---|---|---|
| name | string | This is the name of the scorecard. It is only for user reference and will not be used for any evaluation. |
| description | string | This is the description of the scorecard. It is only for user reference and will not be used for any evaluation. |
| metrics | array | These are the metrics that will be used to evaluate the scorecard. Each metric will have a set of conditions and points that will be used to generate the score. |
| assistantIds | array | These are the assistant IDs that this scorecard is linked to. When linked to assistants, this scorecard will be available for evaluation during those assistants' calls. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/UpdateScorecardDTO",
"title": "UpdateScorecardDTO",
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "This is the name of the scorecard. It is only for user reference and will not be used for any evaluation.",
"maxLength": 80
},
"description": {
"type": "string",
"description": "This is the description of the scorecard. It is only for user reference and will not be used for any evaluation.",
"maxLength": 500
},
"metrics": {
"description": "These are the metrics that will be used to evaluate the scorecard.\nEach metric will have a set of conditions and points that will be used to generate the score.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ScorecardMetric"
}
},
"assistantIds": {
"description": "These are the assistant IDs that this scorecard is linked to.\nWhen linked to assistants, this scorecard will be available for evaluation during those assistants' calls.",
"type": "array",
"items": {
"type": "string"
}
}
}
}