DeidentificationContent

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/azure-health/json-schema/azure-health-deidentification-content-schema.json",
  "title": "DeidentificationContent",
  "description": "Request body for de-identification operation.",
  "x-generated": "2026-11-05",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/azure-health-deid-api-openapi.yml#/components/schemas/DeidentificationContent",
  "type": "object",
  "properties": {
    "inputText": {
      "type": "string",
      "description": "Input text to de-identify.",
      "maxLength": 48000
    },
    "operation": {
      "type": "string",
      "description": "Operation to perform on the input documents.",
      "default": "Surrogate",
      "enum": [
        "Redact",
        "Surrogate",
        "Tag"
      ],
      "x-ms-enum": {
        "name": "DeidentificationOperationType",
        "modelAsString": true,
        "values": [
          {
            "name": "Redact",
            "value": "Redact",
            "description": "Redact Operation will remove all entities of PHI and replace them with a placeholder value."
          },
          {
            "name": "Surrogate",
            "value": "Surrogate",
            "description": "Surrogation Operation will replace all entities of PHI with a surrogate value."
          },
          {
            "name": "Tag",
            "value": "Tag",
            "description": "Tag Operation will detect all entities of PHI, their type, and return their locations in the document."
          }
        ]
      }
    },
    "customizations": {
      "$ref": "#/$defs/DeidentificationCustomizationOptions",
      "description": "Customization parameters to override default service behaviors."
    }
  },
  "required": [
    "inputText"
  ],
  "$defs": {
    "DeidentificationCustomizationOptions": {
      "type": "object",
      "description": "Customizations options to override default service behaviors for synchronous usage.",
      "properties": {
        "redactionFormat": {
          "type": "string",
          "description": "Format of the redacted output. Only valid when Operation is Redact. \nPlease refer to https://learn.microsoft.com/azure/healthcare-apis/deidentification/redaction-format for more details.",
          "minLength": 1,
          "maxLength": 16
        },
        "surrogateLocale": {
          "type": "string",
          "description": "Locale in which the output surrogates are written.",
          "default": "en-US"
        }
      }
    }
  }
}