AiGcpModelArmorPluginConfig

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AiGcpModelArmorPluginConfig",
  "title": "AiGcpModelArmorPluginConfig",
  "x-speakeasy-entity": "PluginAiGcpModelArmor",
  "properties": {
    "config": {
      "type": "object",
      "properties": {
        "enable_multi_language_detection": {
          "description": "Enables multi-language detection mode. Must be used with 'source_language'.",
          "type": "boolean",
          "default": false
        },
        "gcp_metadata_url": {
          "description": "Custom metadata URL for GCP authentication. Useful for restricted network environments or custom GCP endpoints. If null, Kong will use the default Google metadata endpoint.",
          "type": "string",
          "x-referenceable": true
        },
        "gcp_oauth_token_url": {
          "description": "Custom OAuth token URL for GCP authentication. Useful for restricted network environments or custom GCP endpoints. If null, Kong will use the default Google OAuth token endpoint.",
          "type": "string",
          "x-referenceable": true
        },
        "gcp_service_account_json": {
          "description": "Set this field to the full JSON of the GCP service account to authenticate, if required. If null (and gcp_use_service_account is true), Kong will attempt to read from environment variable `GCP_SERVICE_ACCOUNT` or from the instance/container metadata service.",
          "type": "string",
          "x-encrypted": true,
          "x-referenceable": true
        },
        "gcp_use_service_account": {
          "description": "Use service account auth for GCP-based providers and models.",
          "type": "boolean",
          "default": false
        },
        "guarding_mode": {
          "description": "The guardrail mode to use for the request",
          "type": "string",
          "default": "INPUT",
          "enum": [
            "BOTH",
            "INPUT",
            "OUTPUT"
          ]
        },
        "location_id": {
          "description": "GCP Location ID for the GCP Model Armor subscription.",
          "type": "string"
        },
        "log_blocked_content": {
          "description": "Whether to log prompts and responses that are blocked by the guardrail.",
          "type": "boolean",
          "default": false
        },
        "project_id": {
          "description": "GCP Project ID for the GCP Model Armor subscription.",
          "type": "string"
        },
        "request_failure_message": {
          "description": "The message to return when a failure occurs on the request phase.",
          "type": "string",
          "default": "Request was filtered by GCP Model Armor"
        },
        "response_buffer_size": {
          "description": "The amount of bytes receiving from upstream to be buffered before sending to the model armor service. This only applies to the response content guard.",
          "type": "number",
          "default": 100
        },
        "response_failure_message": {
          "description": "The message to return when a failure occurs on the response phase.",
          "type": "string",
          "default": "Response was filtered by GCP Model Armor"
        },
        "reveal_failure_categories": {
          "description": "Whether to reveal failure categories in the response to the caller.",
          "type": "boolean",
          "default": false
        },
        "source_language": {
          "description": "Source language (ISO code) to use when 'enable_multi_language_detection' is enabled.",
          "type": "string"
        },
        "stop_on_error": {
          "description": "Stop processing if an error occurs.",
          "type": "boolean",
          "default": true
        },
        "template_id": {
          "description": "GCP Model Armor Template ID to enforce.",
          "type": "string"
        },
        "text_source": {
          "description": "Select where to pick the 'text' for the GCP Model Armor Services request.",
          "type": "string",
          "default": "last_message",
          "enum": [
            "concatenate_all_content",
            "concatenate_user_content",
            "last_message"
          ]
        },
        "timeout": {
          "description": "Connection timeout with the GCP Model Armor service",
          "type": "number",
          "default": 10000
        }
      },
      "required": [
        "location_id",
        "project_id",
        "template_id"
      ]
    },
    "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-gcp-model-armor"
    },
    "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"
        }
      }
    }
  },
  "required": [
    "config"
  ]
}