social.grain.admin.startScan

Start a classifier scan. Answers once it is under way; progress is polled from getReviewStats. Requires an admin session.

Repository @grain.social did:plc:e7rftrdyz5e2rw4y6ocszew2 namespace authority
Details · procedure
Kindprocedure
Authorityadmin.grain.social
Commit rev3n2mx2lgauzbg
Indexed
cid bafyreigmzddrjsf5hez77omya23e7ccmcg6a3pytmtitj6zt43sakofemm

Checks

Valid
  • unlimited-string defs.main.input.schema.properties.classifierNo maxLength, maxGraphemes or format limits this string.
JSONDownload
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Start a classifier scan. Answers once it is under way; progress is polled from getReviewStats. Requires an admin session.",
      "errors": [
        {
          "description": "No classifier model is configured.",
          "name": "NotConfigured"
        },
        {
          "description": "A scan is already running.",
          "name": "ScanRunning"
        }
      ],
      "input": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "classifier": {
              "description": "Only this classifier; every one when left out.",
              "type": "string"
            },
            "force": {
              "description": "Rescore subjects unchanged since their last scan.",
              "type": "boolean"
            },
            "limit": {
              "description": "Stop after this many subjects.",
              "minimum": 1,
              "type": "integer"
            }
          },
          "type": "object"
        }
      },
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "started": {
              "type": "boolean"
            }
          },
          "required": [
            "started"
          ],
          "type": "object"
        }
      },
      "type": "procedure"
    }
  },
  "id": "social.grain.admin.startScan",
  "lexicon": 1
}