revision_score.current.yaml

title: mediawiki/revision/score
description: Represents a MW Revision Score event (from ORES).
$id: /mediawiki/revision/score/1.0.0
$schema: https://json-schema.org/draft-07/schema#
type: object
allOf:
  ### revision-score does not include all revision/common fields, so we
  ### don't include revision/commmon schema, and instead specifically list
  ### the ones we need.
  - $ref: /mediawiki/common/1.0.0
  - properties:
      page_id:
        $ref: /mediawiki/revision/common/1.0.0#/properties/page_id
      page_title:
        $ref: /mediawiki/revision/common/1.0.0#/properties/page_title
      page_namespace:
        $ref: /mediawiki/revision/common/1.0.0#/properties/page_namespace
      rev_id:
        $ref: /mediawiki/revision/common/1.0.0#/properties/rev_id
      rev_parent_id:
        $ref: /mediawiki/revision/common/1.0.0#/properties/rev_parent_id
      rev_timestamp:
        $ref: /mediawiki/revision/common/1.0.0#/properties/rev_timestamp

      scores:
        description: >
          List of ORES score objects. Each model here was used to score this revision.  Example:
          {
            "model_name": "awesomeness",
            "model_version": "1.0.1",
            "prediction": ["yes", "mostly"],
            "probability": [
              {"name": "yes",    "value": 0.99},
              {"name": "mostly", "value": 0.90},
              {"name": "hardly", "value": 0.01}
            ]
          }
        type: array
        items:
          type: object
          properties:
            model_name:
              description: The name of the model used for this score.
              type: string
            model_version:
              description: The version of the model used for this score.
              type: string
            prediction:
              description: A list of predictions made by this model.
              type: array
              items:
                type: string
            probability:
              description: >
                A list of probabilities made by this model.
                Each element is an object with a probability 'name' and a probability 'value'.
              type: array
              items:
                type: object
                properties:
                  name:
                    type: string
                  value:
                    type: number
                required:
                  - name
                  - value
          required:
            - model_name
            - model_version
            - prediction
            - probability
      errors:
        description: >
          Errors that occured when models attempted to score this revision.
        type: array
        items:
          type: object
          properties:
            model_name:
              description: The name of the model that encountered this error.
              type: string
            model_version:
              description: The version of the model that encountered this error.
              type: string
            type:
              description: The short name of this error
              type: string
            message:
              description: A human-readable explanation of what went wrong
              type: string
          required:
            - model_name
            - model_version
            - type
            - message

required:
  - page_id
  - page_title
  - page_namespace
  - rev_id
  - rev_timestamp