Openapi.Yml Classifier Evaluation Metrics Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-comprehend/refs/heads/main/json-structure/openapi.yml-classifier-evaluation-metrics-structure.json",
  "name": "ClassifierEvaluationMetrics",
  "description": "Describes the result metrics for the test data associated with an documentation classifier.",
  "type": "object",
  "properties": {
    "Accuracy": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Double"
        },
        {
          "description": "The fraction of the labels that were correct recognized. It is computed by dividing the number of labels in the test documents that were correctly recognized by the total number of labels in the test documents."
        }
      ]
    },
    "Precision": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Double"
        },
        {
          "description": "A measure of the usefulness of the classifier results in the test data. High precision means that the classifier returned substantially more relevant results than irrelevant ones."
        }
      ]
    },
    "Recall": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Double"
        },
        {
          "description": "A measure of how complete the classifier results are for the test data. High recall means that the classifier returned most of the relevant results. "
        }
      ]
    },
    "F1Score": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Double"
        },
        {
          "description": "A measure of how accurate the classifier results are for the test data. It is derived from the <code>Precision</code> and <code>Recall</code> values. The <code>F1Score</code> is the harmonic average of the two scores. The highest score is 1, and the worst score is 0. "
        }
      ]
    },
    "MicroPrecision": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Double"
        },
        {
          "description": "A measure of the usefulness of the recognizer results in the test data. High precision means that the recognizer returned substantially more relevant results than irrelevant ones. Unlike the Precision metric which comes from averaging the precision of all available labels, this is based on the overall score of all precision scores added together."
        }
      ]
    },
    "MicroRecall": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Double"
        },
        {
          "description": "A measure of how complete the classifier results are for the test data. High recall means that the classifier returned most of the relevant results. Specifically, this indicates how many of the correct categories in the text that the model can predict. It is a percentage of correct categories in the text that can found. Instead of averaging the recall scores of all labels (as with Recall), micro Recall is based on the overall score of all recall scores added together."
        }
      ]
    },
    "MicroF1Score": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Double"
        },
        {
          "description": "A measure of how accurate the classifier results are for the test data. It is a combination of the <code>Micro Precision</code> and <code>Micro Recall</code> values. The <code>Micro F1Score</code> is the harmonic mean of the two scores. The highest score is 1, and the worst score is 0."
        }
      ]
    },
    "HammingLoss": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Double"
        },
        {
          "description": "Indicates the fraction of labels that are incorrectly predicted. Also seen as the fraction of wrong labels compared to the total number of labels. Scores closer to zero are better."
        }
      ]
    }
  }
}