{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/namirial/json-schema/namirial-file-prepare-request-schema.json",
  "title": "FilePrepareRequest",
  "description": "The request model for parsing documents.",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/namirial-file-api-openapi.yml#/components/schemas/FilePrepareRequest",
  "required": [
    "FileIds"
  ],
  "type": "object",
  "properties": {
    "FileIds": {
      "description": "The identifiers of the uploaded files.",
      "maxItems": 100,
      "minItems": 1,
      "type": "array",
      "items": {
        "maxLength": 36,
        "minLength": 36,
        "type": "string"
      }
    },
    "ClearAdvancedDocumentTags": {
      "description": "If true, the parsed advanced document tags are deleted from the document.",
      "type": "boolean"
    },
    "SigStringConfigurations": {
      "description": "The configurations for the parsing of SigString. The default [`sig`] is always added.",
      "maxItems": 50,
      "type": "array",
      "items": {
        "$ref": "#/$defs/FilePrepareSigStringConfiguration"
      }
    }
  },
  "$defs": {
    "FilePrepareSigStringConfiguration": {
      "description": "The configuration for parsing of a SigString.",
      "required": [
        "StartPattern"
      ],
      "type": "object",
      "properties": {
        "StartPattern": {
          "description": "Define the start pattern.",
          "maxLength": 500,
          "minLength": 0,
          "type": "string"
        },
        "EndPattern": {
          "description": "Define the end pattern.",
          "maxLength": 500,
          "minLength": 0,
          "type": "string"
        },
        "ClearSigString": {
          "description": "If true, the parsed SigString is deleted from the document",
          "type": "boolean"
        },
        "SearchEntireWordOnly": {
          "description": "If true, the patterns are only matched as a whole word.",
          "type": "boolean"
        }
      }
    }
  }
}