beta.audit.wordlift.io

{
  "type": "object",
  "properties": {
    "reportId": {
      "type": "string",
      "description": "Identifier of the report currently open in the page."
    },
    "businessRole": {
      "type": "string",
      "description": "The organization's operating role in the reviewer's words, e.g. destination-organization, merchant, marketplace."
    },
    "primaryEntityIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "maxItems": 80,
      "description": "Entity ids from this report to promote as the business's primary objects (at most 80)."
    },
    "demotedEntityIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "maxItems": 80,
      "description": "Entity ids from this report to demote as peripheral (at most 80)."
    },
    "terminology": {
      "type": "array",
      "maxItems": 40,
      "items": {
        "type": "object",
        "properties": {
          "term": {
            "type": "string",
            "description": "A word the site uses."
          },
          "meaning": {
            "type": "string",
            "description": "What it means for this business."
          }
        },
        "required": [
          "term",
          "meaning"
        ],
        "additionalProperties": false
      },
      "description": "Business vocabulary the machine could not know (at most 40 entries). Each entry replaces any machine term of the same name in the lexical graph."
    },
    "terminologyDecisions": {
      "type": "array",
      "maxItems": 40,
      "items": {
        "type": "object",
        "properties": {
          "term": {
            "type": "string",
            "description": "A term currently in the report's lexical graph."
          },
          "decision": {
            "type": "string",
            "enum": [
              "confirm",
              "replace",
              "reject"
            ],
            "description": "confirm keeps the machine's term as reviewed; replace redefines it (meaning required); reject removes it from the lexical graph."
          },
          "meaning": {
            "type": "string",
            "description": "The business's own definition; required when decision is replace."
          }
        },
        "required": [
          "term",
          "decision"
        ],
        "additionalProperties": false
      },
      "description": "Judgments about the machine's own vocabulary (at most 40 entries)."
    },
    "relationDecisions": {
      "type": "array",
      "maxItems": 80,
      "items": {
        "type": "object",
        "properties": {
          "from": {
            "type": "string",
            "description": "The entity id the relation starts from, as inspect-business-model lists it."
          },
          "kind": {
            "type": "string",
            "enum": [
              "offers",
              "located-in",
              "provided-by",
              "part-of",
              "serves",
              "brand"
            ]
          },
          "to": {
            "type": "string",
            "description": "The entity id the relation points to."
          },
          "decision": {
            "type": "string",
            "enum": [
              "confirm",
              "reject"
            ],
            "description": "confirm makes a relation read from the text the reviewer's word; reject takes any relation out of the model."
          }
        },
        "required": [
          "from",
          "kind",
          "to",
          "decision"
        ],
        "additionalProperties": false
      },
      "description": "Judgments about how two entities relate (at most 80): confirm the relations read from the text that are right, reject the ones that are wrong."
    },
    "actionDecisions": {
      "type": "array",
      "maxItems": 80,
      "items": {
        "type": "object",
        "properties": {
          "actionId": {
            "type": "string",
            "description": "An action id from this report's capability map."
          },
          "decision": {
            "type": "string",
            "enum": [
              "confirm",
              "reject"
            ]
          },
          "boundary": {
            "type": "string",
            "enum": [
              "owned",
              "partner-handoff",
              "informational-only",
              "not-applicable"
            ],
            "description": "Who is responsible: the site itself, a partner it hands off to, information only, or nobody."
          },
          "rationale": {
            "type": "string",
            "description": "Why, in one or two sentences."
          },
          "partner": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string",
                "description": "The partner's name."
              },
              "url": {
                "type": "string",
                "description": "The partner's website, when it has one."
              }
            },
            "required": [
              "name"
            ],
            "additionalProperties": false,
            "description": "For a partner handoff: who runs the action. Published as its provider."
          }
        },
        "required": [
          "actionId",
          "decision"
        ],
        "additionalProperties": false
      }
    }
  },
  "additionalProperties": false
}