AiSanitizerPluginConfig

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AiSanitizerPluginConfig",
  "title": "AiSanitizerPluginConfig",
  "x-speakeasy-entity": "PluginAiSanitizer",
  "properties": {
    "config": {
      "type": "object",
      "properties": {
        "allow_all_conversation_history": {
          "description": "If false, will ignore all previous chat messages from the conversation history.",
          "type": "boolean",
          "default": true
        },
        "anonymize": {
          "description": "List of types to be anonymized",
          "type": "array",
          "items": {
            "enum": [
              "all",
              "all_and_credentials",
              "bank",
              "credentials",
              "creditcard",
              "crypto",
              "custom",
              "date",
              "domain",
              "driverlicense",
              "email",
              "general",
              "ip",
              "medical",
              "nationalid",
              "nrp",
              "passport",
              "phone",
              "ssn",
              "url"
            ],
            "type": "string"
          },
          "default": [
            "all_and_credentials"
          ]
        },
        "block_if_detected": {
          "description": "Whether to block requests containing PII data",
          "type": "boolean",
          "default": false
        },
        "custom_patterns": {
          "description": "List of custom patterns to be used for anonymization",
          "type": "array",
          "items": {
            "properties": {
              "name": {
                "type": "string"
              },
              "regex": {
                "type": "string"
              },
              "score": {
                "type": "number",
                "default": 0.5,
                "maximum": 1,
                "minimum": 0
              }
            },
            "required": [
              "name",
              "regex"
            ],
            "type": "object"
          },
          "minLength": 1
        },
        "host": {
          "description": "The host of the sanitizer",
          "type": "string",
          "default": "localhost"
        },
        "keepalive_timeout": {
          "description": "The keepalive timeout for the established http connnection",
          "type": "number",
          "default": 60000
        },
        "port": {
          "description": "The port of the sanitizer",
          "type": "number",
          "default": 8080
        },
        "recover_redacted": {
          "description": "Whether to recover redacted data. This doesn't apply to the redacted output.",
          "type": "boolean",
          "default": true
        },
        "redact_type": {
          "description": "What value to be used to redacted to",
          "type": "string",
          "default": "placeholder",
          "enum": [
            "placeholder",
            "synthetic"
          ]
        },
        "sanitization_mode": {
          "description": "The sanitization mode to use for the request",
          "type": "string",
          "default": "INPUT",
          "enum": [
            "BOTH",
            "INPUT",
            "OUTPUT"
          ]
        },
        "scheme": {
          "description": "The protocol can be http and https",
          "type": "string",
          "default": "http"
        },
        "skip_logging_sanitized_items": {
          "description": "Whether to log sanitized items in the Kong log plugins. Turn it on if you want to hide sensitive data from logs.",
          "type": "boolean",
          "default": false
        },
        "stop_on_error": {
          "description": "Stop processing if an error occurs.",
          "type": "boolean",
          "default": true
        },
        "timeout": {
          "description": "Connection timeout with the sanitizer",
          "type": "number",
          "default": 10000
        }
      }
    },
    "consumer": {
      "description": "If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        }
      }
    },
    "consumer_group": {
      "description": "If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        }
      }
    },
    "name": {
      "const": "ai-sanitizer"
    },
    "protocols": {
      "description": "A set of strings representing HTTP protocols.",
      "type": "array",
      "items": {
        "enum": [
          "grpc",
          "grpcs",
          "http",
          "https"
        ],
        "type": "string"
      },
      "format": "set",
      "default": [
        "grpc",
        "grpcs",
        "http",
        "https"
      ]
    },
    "route": {
      "description": "If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        }
      }
    },
    "service": {
      "description": "If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        }
      }
    }
  }
}