Get revscoring goodfaith prediction

POST	`/service/lw/inference/v1/models/{wiki}-goodfaith:predict`

Get a score from the Revscoring Goodfaith model (previously hosted on ORES) for a given Wiki revision id.

Examples

curl

Anonymous access

# Get a score from the Revscoring Goodfaith model for the revision 12345 of English Wikipedia.
$ curl https://api.wikimedia.org/service/lw/inference/v1/models/enwiki-goodfaith:predict -X POST -d '{"rev_id": 12345}'

Logged in access

# Get a score from the Revscoring Goodfaith model for the revision 12345 of English Wikipedia.
$ curl https://api.wikimedia.org/service/lw/inference/v1/models/enwiki-goodfaith:predict -X POST -d '{"rev_id": 12345}' -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Python

# Python 3
# Get a score from the Revscoring Goodfaith model for the revision 12345 of English Wikipedia.

import json
import requests

use_auth = False
inference_url = 'https://api.wikimedia.org/service/lw/inference/v1/models/enwiki-goodfaith:predict'

if use_auth:
  headers: {
      'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
      'User-Agent': 'YOUR_APP_NAME (YOUR_EMAIL_OR_CONTACT_PAGE)'
  }
else:
  headers = {}
data = {"rev_id": 12345 }
response = requests.post(inference_url, headers=headers, data=json.dumps(data))
print(response.json())

URI Parameters

`wiki` required	Wiki code:`arwiki` (Arabic), `bswiki` (Bosnian), `cawiki` (Catalan), `cswiki` (Czech), `dewiki` (German), `enwiki` (English), `eswiki` (Spanish), `eswikibooks` (Spanish Wikibooks), `eswikiquote` (Spanish Wikiquote), `etwiki` (Estonian), `fawiki` (Persian), `fiwiki` (Finnish), `frwiki` (French), `hewiki` (Hebrew), `hiwiki` (Hindi), `huwiki` (Hungarian), `itwiki` (Italian), `jawiki` (Japanese), `kowiki` (Korean), `lvwiki` (Latvian), `nlwiki` (Dutch), `nowiki` (Norwegian), `plwiki` (Polish), `ptwiki` (Portuguese), `rowiki` (Romanian), `ruwiki` (Russian), `sqwiki` (Albanian), `srwiki` (Serbian), `svwiki` (Swedish), `ukwiki` (Ukrainian), `wikidatawiki` (Wikidata) or `zhwiki` (Chinese).

POST Parameters

`rev_id` required	Wiki Revision id: integer related to a certain revision id for the Wiki set in the URI parameter.
`extended_output`	Whether or not the response should include the extended output of the model (like the list of features used etc..). Either true or false. Default: false

Responses

200

Success: Revision id found. Returns a Revscoring score object.

Example

{
  "enwiki": {
    "models": {
      "goodfaith": {
        "version": "0.5.1"
      }
    },
    "scores": {
      "12345": {
        "goodfaith": {
          "score": {
            "prediction": true,
            "probability": {
              "false": 0.07396339218373627,
              "true": 0.9260366078162637
            }
          }
        }
      }
    }
  }
}