{ "documentationLink": "https://cloud.google.com/security-command-center/docs/model-armor-overview", "version_module": true, "endpoints": [ { "endpointUrl": "https://modelarmor.us-central1.rep.googleapis.com/", "description": "Regional Endpoint", "location": "us-central1" }, { "location": "us-east1", "endpointUrl": "https://modelarmor.us-east1.rep.googleapis.com/", "description": "Regional Endpoint" }, { "endpointUrl": "https://modelarmor.us-east7.rep.googleapis.com/", "description": "Regional Endpoint", "location": "us-east7" }, { "location": "us-west1", "endpointUrl": "https://modelarmor.us-west1.rep.googleapis.com/", "description": "Regional Endpoint" }, { "location": "europe-west1", "endpointUrl": "https://modelarmor.europe-west1.rep.googleapis.com/", "description": "Regional Endpoint" }, { "endpointUrl": "https://modelarmor.europe-west4.rep.googleapis.com/", "description": "Regional Endpoint", "location": "europe-west4" }, { "location": "us-east4", "endpointUrl": "https://modelarmor.us-east4.rep.googleapis.com/", "description": "Regional Endpoint" }, { "location": "asia-southeast1", "endpointUrl": "https://modelarmor.asia-southeast1.rep.googleapis.com/", "description": "Regional Endpoint" }, { "endpointUrl": "https://modelarmor.europe-west2.rep.googleapis.com/", "description": "Regional Endpoint", "location": "europe-west2" }, { "endpointUrl": "https://modelarmor.europe-west3.rep.googleapis.com/", "description": "Regional Endpoint", "location": "europe-west3" }, { "endpointUrl": "https://modelarmor.asia-south1.rep.googleapis.com/", "description": "Regional Endpoint", "location": "asia-south1" }, { "endpointUrl": "https://modelarmor.europe-southwest1.rep.googleapis.com/", "description": "Regional Endpoint", "location": "europe-southwest1" }, { "endpointUrl": "https://modelarmor.asia-northeast1.rep.googleapis.com/", "description": "Regional Endpoint", "location": "asia-northeast1" }, { "endpointUrl": "https://modelarmor.asia-northeast3.rep.googleapis.com/", "description": "Regional Endpoint", "location": "asia-northeast3" }, { "location": "australia-southeast1", "endpointUrl": "https://modelarmor.australia-southeast1.rep.googleapis.com/", "description": "Regional Endpoint" }, { "endpointUrl": "https://modelarmor.australia-southeast2.rep.googleapis.com/", "description": "Regional Endpoint", "location": "australia-southeast2" }, { "location": "northamerica-northeast1", "endpointUrl": "https://modelarmor.northamerica-northeast1.rep.googleapis.com/", "description": "Regional Endpoint" }, { "endpointUrl": "https://modelarmor.northamerica-northeast2.rep.googleapis.com/", "description": "Regional Endpoint", "location": "northamerica-northeast2" }, { "endpointUrl": "https://modelarmor.europe-west9.rep.googleapis.com/", "description": "Regional Endpoint", "location": "europe-west9" }, { "endpointUrl": "https://modelarmor.southamerica-east1.rep.googleapis.com/", "description": "Regional Endpoint", "location": "southamerica-east1" }, { "location": "us", "endpointUrl": "https://modelarmor.us.rep.googleapis.com/", "description": "Regional Endpoint" }, { "location": "eu", "endpointUrl": "https://modelarmor.eu.rep.googleapis.com/", "description": "Regional Endpoint" } ], "canonicalName": "Model Armor", "rootUrl": "https://modelarmor.us-central1.rep.googleapis.com/", "protocol": "rest", "schemas": { "VirusDetail": { "type": "object", "description": "Details of an identified virus", "id": "VirusDetail", "properties": { "threatType": { "enumDescriptions": [ "Unused", "Unable to categorize threat", "Virus or Worm threat.", "Malicious program. E.g. Spyware, Trojan.", "Potentially harmful content. E.g. Injected code, Macro", "Potentially unwanted content. E.g. Adware." ], "type": "string", "description": "Threat type of the identified virus", "enum": [ "THREAT_TYPE_UNSPECIFIED", "UNKNOWN", "VIRUS_OR_WORM", "MALICIOUS_PROGRAM", "POTENTIALLY_HARMFUL_CONTENT", "POTENTIALLY_UNWANTED_CONTENT" ] }, "names": { "description": "Names of this Virus.", "type": "array", "items": { "type": "string" } }, "vendor": { "type": "string", "description": "Name of vendor that produced this virus identification." } } }, "RaiFilterTypeResult": { "type": "object", "id": "RaiFilterTypeResult", "description": "Detailed Filter result for each of the responsible AI Filter Types.", "properties": { "confidenceLevel": { "description": "Confidence level identified for this RAI filter.", "type": "string", "enumDescriptions": [ "Same as LOW_AND_ABOVE.", "Highest chance of a false positive.", "Some chance of false positives.", "Low chance of false positives." ], "enum": [ "DETECTION_CONFIDENCE_LEVEL_UNSPECIFIED", "LOW_AND_ABOVE", "MEDIUM_AND_ABOVE", "HIGH" ] }, "filterType": { "type": "string", "enumDescriptions": [ "Unspecified filter type.", "Sexually Explicit.", "Hate Speech.", "Harassment.", "Danger" ], "enum": [ "RAI_FILTER_TYPE_UNSPECIFIED", "SEXUALLY_EXPLICIT", "HATE_SPEECH", "HARASSMENT", "DANGEROUS" ], "description": "Type of responsible AI filter." }, "matchState": { "readOnly": true, "type": "string", "enumDescriptions": [ "Unused", "Matching criteria is not achieved for filters.", "Matching criteria is achieved for the filter." ], "description": "Output only. Match state for this RAI filter.", "enum": [ "FILTER_MATCH_STATE_UNSPECIFIED", "NO_MATCH_FOUND", "MATCH_FOUND" ] } } }, "PiAndJailbreakFilterSettings": { "description": "Prompt injection and Jailbreak Filter settings.", "type": "object", "id": "PiAndJailbreakFilterSettings", "properties": { "filterEnforcement": { "type": "string", "enumDescriptions": [ "Same as Disabled", "Enabled", "Disabled" ], "description": "Optional. Tells whether Prompt injection and Jailbreak filter is enabled or disabled.", "enum": [ "PI_AND_JAILBREAK_FILTER_ENFORCEMENT_UNSPECIFIED", "ENABLED", "DISABLED" ] }, "confidenceLevel": { "enum": [ "DETECTION_CONFIDENCE_LEVEL_UNSPECIFIED", "LOW_AND_ABOVE", "MEDIUM_AND_ABOVE", "HIGH" ], "type": "string", "description": "Optional. Confidence level for this filter. Confidence level is used to determine the threshold for the filter. If detection confidence is equal to or greater than the specified level, a positive match is reported. Confidence level will only be used if the filter is enabled.", "enumDescriptions": [ "Same as LOW_AND_ABOVE.", "Highest chance of a false positive.", "Some chance of false positives.", "Low chance of false positives." ] } } }, "RaiFilterResult": { "id": "RaiFilterResult", "description": "Responsible AI Result.", "properties": { "raiFilterTypeResults": { "additionalProperties": { "$ref": "RaiFilterTypeResult" }, "type": "object", "description": "The map of RAI filter results where the key is the RAI filter type and the value is the RAI filter's result. Allowed keys are \"sexually_explicit\", \"hate_speech\", \"harassment\", and \"dangerous\"." }, "executionState": { "description": "Output only. Reports whether the RAI filter was successfully executed or not.", "enum": [ "FILTER_EXECUTION_STATE_UNSPECIFIED", "EXECUTION_SUCCESS", "EXECUTION_SKIPPED" ], "readOnly": true, "enumDescriptions": [ "Unused", "Filter executed successfully", "Filter execution was skipped. This can happen due to server-side error or permission issue." ], "type": "string" }, "messageItems": { "description": "Optional messages corresponding to the result. A message can provide warnings or error details. For example, if execution state is skipped then this field provides related reason/explanation.", "type": "array", "items": { "$ref": "MessageItem" } }, "matchState": { "readOnly": true, "enum": [ "FILTER_MATCH_STATE_UNSPECIFIED", "NO_MATCH_FOUND", "MATCH_FOUND" ], "enumDescriptions": [ "Unused", "Matching criteria is not achieved for filters.", "Matching criteria is achieved for the filter." ], "type": "string", "description": "Output only. Overall filter match state for RAI. Value is MATCH_FOUND if at least one RAI filter confidence level is equal to or higher than the confidence level defined in configuration." } }, "type": "object" }, "TemplateMetadata": { "description": "Message describing TemplateMetadata", "type": "object", "properties": { "multiLanguageDetection": { "$ref": "MultiLanguageDetection", "description": "Optional. Metadata for multi language detection." }, "filterVersionSelector": { "$ref": "FilterVersionSelector", "description": "Optional. Specifies the configuration for the Filter version to be used. If this field is populated, it takes precedence over any values set in the deprecated `filter_version` fields within `RaiFilterSettings`, `PiAndJailbreakFilterSettings`." }, "customLlmResponseSafetyErrorMessage": { "description": "Optional. Indicates the custom error message set by the user to be returned to the end user if the LLM response trips Model Armor filters.", "type": "string" }, "modalities": { "description": "Optional. Specifies the modalities to scan. If not specified or empty, only text modality will be scanned.", "type": "array", "items": { "enumDescriptions": [ "Unspecified modality. If specified, all modalities will be sanitized.", "Represents text modality. If specified, it will sanitize text fields, and text extracted from rich text files (like PDFs, DOCs) and plain text files (like TXT).", "Represents image modality. If specified, it will sanitize image files. The visual content and the text content in the image will be sanitized depending on the filter configuration." ], "enum": [ "MODALITY_UNSPECIFIED", "MODALITY_TEXT", "MODALITY_IMAGE" ], "type": "string" } }, "customPromptSafetyErrorCode": { "format": "int32", "description": "Optional. Indicates the custom error code set by the user to be returned to the end user by the service extension if the prompt trips Model Armor filters.", "type": "integer" }, "enforcementType": { "enum": [ "ENFORCEMENT_TYPE_UNSPECIFIED", "INSPECT_ONLY", "INSPECT_AND_BLOCK" ], "enumDescriptions": [ "Default value. Same as INSPECT_AND_BLOCK.", "Model Armor filters will run in inspect only mode. No action will be taken on the request.", "Model Armor filters will run in inspect and block mode. Requests that trip Model Armor filters will be blocked." ], "type": "string", "description": "Optional. Enforcement type for Model Armor filters." }, "logTemplateOperations": { "type": "boolean", "description": "Optional. If true, log template crud operations." }, "ignorePartialInvocationFailures": { "type": "boolean", "description": "Optional. If true, partial detector failures should be ignored." }, "customPromptSafetyErrorMessage": { "description": "Optional. Indicates the custom error message set by the user to be returned to the end user if the prompt trips Model Armor filters.", "type": "string" }, "customLlmResponseSafetyErrorCode": { "description": "Optional. Indicates the custom error code set by the user to be returned to the end user if the LLM response trips Model Armor filters.", "type": "integer", "format": "int32" }, "dataResidencyCompliant": { "description": "Optional. Indicates whether the template is subject to data residency compliance. If true (default for new templates), the template is subject to data residency compliance. If false, the template bypasses data residency compliance checks.", "type": "boolean" }, "logSanitizeOperations": { "description": "Optional. If true, log sanitize operations.", "type": "boolean" } }, "id": "TemplateMetadata" }, "Location": { "properties": { "metadata": { "type": "object", "description": "Service-specific metadata. For example the available capacity at the given location.", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" } }, "labels": { "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", "additionalProperties": { "type": "string" }, "type": "object" }, "locationId": { "description": "The canonical id for this location. For example: `\"us-east1\"`.", "type": "string" }, "displayName": { "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", "type": "string" }, "name": { "type": "string", "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`" } }, "description": "A resource that represents a Google Cloud location.", "type": "object", "id": "Location" }, "WordList": { "type": "object", "description": "Message defining a list of words or phrases.", "properties": { "words": { "items": { "type": "string" }, "type": "array", "description": "Required. Words or phrases defining the dictionary. The dictionary must contain at least one phrase and every phrase must contain at least two characters that are letters or digits." } }, "id": "WordList" }, "FilterResult": { "type": "object", "id": "FilterResult", "description": "Filter Result obtained after Sanitization operations.", "properties": { "sdpFilterResult": { "description": "Sensitive Data Protection results.", "$ref": "SdpFilterResult" }, "maliciousUriFilterResult": { "description": "Malicious URI filter results.", "$ref": "MaliciousUriFilterResult" }, "virusScanFilterResult": { "$ref": "VirusScanFilterResult", "description": "Virus scan results." }, "raiFilterResult": { "$ref": "RaiFilterResult", "description": "Responsible AI filter results." }, "piAndJailbreakFilterResult": { "description": "Prompt injection and Jailbreak filter results.", "$ref": "PiAndJailbreakFilterResult" }, "csamFilterFilterResult": { "$ref": "CsamFilterResult", "description": "CSAM filter results." } } }, "SdpContentLocation": { "description": "Precise location of the finding within a document, record, image, or metadata container.", "id": "SdpContentLocation", "type": "object", "properties": { "imageFindingLocation": { "$ref": "SdpImageFindingLocation", "description": "Location within an image's pixels." }, "containerName": { "type": "string", "description": "Name of the container where the finding is located. The top level name is the source file name or table name. Nested names could be absent if the embedded object has no string identifier (for example, an image contained within a document)." } } }, "FilterVersionConfig": { "properties": { "projectedDeprecationDate": { "$ref": "Date", "readOnly": true, "description": "Output only. The estimated date when this version is projected to be deprecated." }, "messageItems": { "description": "Output only. Extra information regarding this filter version", "readOnly": true, "items": { "$ref": "MessageItem" }, "type": "array" }, "filterVersionAlias": { "type": "string", "enumDescriptions": [ "The default value. If used, it will resolve to the `STABLE` alias.", "`STABLE` alias points to the most recent stable model version. Using this alias means no code changes are required when a new model becomes the stable version.", "`LATEST` alias points to the newest model version available. This version is subject to frequent revisions and offers SLO guarantees but does not assure stability, providing the most current security protections.", "`LEGACY` alias could be used for sanitization operations for a transition period. New templates cannot be created with this version.", "`RETIRED` alias could be used for versions that are no longer available to be used. While new templates cannot be created with this alias, any existing template or request using `RETIRED` version will fall back to the current `STABLE` version for sanitization operations." ], "description": "Output only. The alias associated with this version, if any (e.g., \"STABLE\", \"LATEST\"). This will be populated if this version is currently mapped to an alias.", "enum": [ "FILTER_VERSION_ALIAS_UNSPECIFIED", "FILTER_VERSION_ALIAS_STABLE", "FILTER_VERSION_ALIAS_LATEST", "FILTER_VERSION_ALIAS_LEGACY", "FILTER_VERSION_ALIAS_RETIRED" ], "readOnly": true }, "releaseDate": { "description": "Output only. The date when this version was released.", "readOnly": true, "$ref": "Date" }, "filterVersion": { "description": "Output only. The identifier for this specific version.", "type": "string", "readOnly": true } }, "type": "object", "description": "Message describing a Filter Version Configuration.", "id": "FilterVersionConfig" }, "Empty": { "properties": {}, "type": "object", "id": "Empty", "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }" }, "SdpImageFindingLocation": { "type": "object", "description": "Location of the finding within an image.", "properties": { "boundingBoxes": { "items": { "$ref": "SdpBoundingBox" }, "type": "array", "description": "Bounding boxes locating the pixels within the image containing the finding." } }, "id": "SdpImageFindingLocation" }, "MessageItem": { "type": "object", "properties": { "messageType": { "enum": [ "MESSAGE_TYPE_UNSPECIFIED", "INFO", "WARNING", "ERROR" ], "type": "string", "description": "Type of message.", "enumDescriptions": [ "Unused", "Information related message.", "Warning related message.", "Error message." ] }, "message": { "description": "The message content.", "type": "string" } }, "id": "MessageItem", "description": "Message item to report information, warning or error messages." }, "SdpBasicConfig": { "properties": { "filterEnforcement": { "enum": [ "SDP_BASIC_CONFIG_ENFORCEMENT_UNSPECIFIED", "ENABLED", "DISABLED" ], "enumDescriptions": [ "Same as Disabled", "Enabled", "Disabled" ], "description": "Optional. Tells whether the Sensitive Data Protection basic config is enabled or disabled.", "type": "string" } }, "type": "object", "id": "SdpBasicConfig", "description": "Sensitive Data Protection basic configuration." }, "SdpAdvancedConfig": { "description": "Sensitive Data Protection Advanced configuration.", "id": "SdpAdvancedConfig", "type": "object", "properties": { "deidentifyTemplate": { "description": "Optional. Optional Sensitive Data Protection Deidentify template resource name. If provided then DeidentifyContent action is performed during Sanitization using this template and inspect template. The De-identified data will be returned in SdpDeidentifyResult. Note that all info-types present in the deidentify template must be present in inspect template. e.g. `projects/{project}/locations/{location}/deidentifyTemplates/{deidentify_template}`", "type": "string" }, "inspectTemplate": { "description": "Optional. Sensitive Data Protection inspect template resource name If only inspect template is provided (de-identify template not provided), then Sensitive Data Protection InspectContent action is performed during Sanitization. All Sensitive Data Protection findings identified during inspection will be returned as SdpFinding in SdpInsepctionResult. e.g. `projects/{project}/locations/{location}/inspectTemplates/{inspect_template}`", "type": "string" } } }, "SdpFilterResult": { "properties": { "inspectResult": { "description": "Sensitive Data Protection Inspection result if inspection is performed.", "$ref": "SdpInspectResult" }, "redactResult": { "description": "Sensitive Data Protection Redaction result if redaction is performed. This is primarily used for image redaction.", "$ref": "SdpRedactResult" }, "deidentifyResult": { "description": "Sensitive Data Protection Deidentification result if deidentification is performed.", "$ref": "SdpDeidentifyResult" } }, "description": "Sensitive Data Protection filter result.", "id": "SdpFilterResult", "type": "object" }, "SdpFinding": { "properties": { "likelihood": { "enumDescriptions": [ "Default value; same as POSSIBLE.", "Highest chance of a false positive.", "High chance of a false positive.", "Some matching signals. The default value.", "Low chance of a false positive.", "Confidence level is high. Lowest chance of a false positive." ], "enum": [ "SDP_FINDING_LIKELIHOOD_UNSPECIFIED", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "description": "Identified confidence likelihood for `info_type`.", "type": "string" }, "location": { "description": "Location for this finding.", "$ref": "SdpFindingLocation" }, "infoType": { "description": "Name of Sensitive Data Protection info type for this finding.", "type": "string" } }, "description": "Finding corresponding to Sensitive Data Protection filter.", "id": "SdpFinding", "type": "object" }, "Template": { "id": "Template", "properties": { "templateMetadata": { "$ref": "TemplateMetadata", "description": "Optional. metadata for this template" }, "name": { "description": "Identifier. name of resource", "type": "string" }, "createTime": { "type": "string", "format": "google-datetime", "readOnly": true, "description": "Output only. [Output only] Create time stamp" }, "updateTime": { "description": "Output only. [Output only] Update time stamp", "readOnly": true, "format": "google-datetime", "type": "string" }, "filterConfig": { "description": "Required. filter configuration for this template", "$ref": "FilterConfig" }, "labels": { "description": "Optional. Labels as key value pairs", "additionalProperties": { "type": "string" }, "type": "object" } }, "type": "object", "description": "Message describing Template resource" }, "FilterRule": { "id": "FilterRule", "type": "object", "description": "A single rule to be applied to filters, specified in `FilterRuleSet`.", "properties": { "exclusionRule": { "description": "Exclusion rule.", "$ref": "ExclusionRule" } } }, "FilterConfig": { "properties": { "csamFilterSettings": { "description": "Optional. Child sexual abuse material (CSAM) filter settings.", "$ref": "CsamFilterSettings" }, "sdpSettings": { "$ref": "SdpFilterSettings", "description": "Optional. Sensitive Data Protection settings." }, "raiSettings": { "description": "Optional. Responsible AI settings.", "$ref": "RaiFilterSettings" }, "piAndJailbreakFilterSettings": { "$ref": "PiAndJailbreakFilterSettings", "description": "Optional. Prompt injection and Jailbreak filter settings." }, "maliciousUriFilterSettings": { "description": "Optional. Malicious URI filter settings.", "$ref": "MaliciousUriFilterSettings" }, "filterRuleSettings": { "$ref": "FilterRuleSettings", "description": "Optional. Settings for customizing filter rules. Note: This field is not supported in FloorSetting." } }, "type": "object", "id": "FilterConfig", "description": "Filters configuration." }, "FloorSettingMetadata": { "id": "FloorSettingMetadata", "description": "message describing FloorSetting Metadata", "type": "object", "properties": { "multiLanguageDetection": { "$ref": "FloorSettingFloorSettingMetadataMultiLanguageDetection", "description": "Optional. Metadata for multi language detection." } } }, "ListLocationsResponse": { "id": "ListLocationsResponse", "type": "object", "description": "The response message for Locations.ListLocations.", "properties": { "locations": { "items": { "$ref": "Location" }, "description": "A list of locations that matches the specified filter in the request.", "type": "array" }, "nextPageToken": { "description": "The standard List next-page token.", "type": "string" } } }, "Dictionary": { "type": "object", "description": "Message defining a custom dictionary of words or phrases for syntactic match. Dictionary words are case-insensitive and all characters other than letters and digits in the unicode [Basic Multilingual Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane) will be replaced with whitespace when scanning for matches. For example, the dictionary phrase `Sam Johnson` will match all three phrases `sam johnson`, `Sam, Johnson`, and `Sam (Johnson)`. Additionally, the characters surrounding any match must be of a different type than the adjacent characters within the word, so letters must be next to non-letters and digits must be next to non-digits. For example, the dictionary word `jen` will match the first three letters of the text `jen123` but will return no matches for `jennifer`. Dictionary words containing a large number of characters that are not letters or digits may result in unexpected matches because such characters are treated as whitespace. For details about the size limits of dictionaries, see [Quotas and limits](https://docs.cloud.google.com/model-armor/quotas).", "properties": { "wordList": { "description": "Message defining a list of words or phrases.", "$ref": "WordList" } }, "id": "Dictionary" }, "AiPlatformFloorSetting": { "id": "AiPlatformFloorSetting", "description": "message describing AiPlatformFloorSetting", "type": "object", "properties": { "enableCloudLogging": { "type": "boolean", "description": "Optional. If true, log Model Armor filter results to Cloud Logging." }, "inspectOnly": { "description": "Optional. If true, Model Armor filters will be run in inspect only mode. No action will be taken on the request.", "type": "boolean" }, "inspectAndBlock": { "description": "Optional. If true, Model Armor filters will be run in inspect and block mode. Requests that trip Model Armor filters will be blocked.", "type": "boolean" } } }, "McpServerFloorSetting": { "properties": { "enableCloudLogging": { "description": "Optional. If true, log Model Armor filter results to Cloud Logging.", "type": "boolean" }, "inspectOnly": { "type": "boolean", "description": "Optional. If true, Model Armor filters will be run in inspect only mode. No action will be taken on the request." }, "inspectAndBlock": { "description": "Optional. If true, Model Armor filters will be run in inspect and block mode. Requests that trip Model Armor filters will be blocked.", "type": "boolean" } }, "description": "Message describing MCP Server Floor Setting.", "type": "object", "id": "McpServerFloorSetting" }, "MultiLanguageDetection": { "properties": { "enableMultiLanguageDetection": { "type": "boolean", "description": "Required. If true, multi language detection will be enabled." } }, "id": "MultiLanguageDetection", "description": "Metadata to enable multi language detection via template.", "type": "object" }, "SdpRedactResult": { "description": "Sensitive Data Protection Redaction Result.", "id": "SdpRedactResult", "type": "object", "properties": { "extractedImageText": { "description": "The extracted text from the image.", "type": "string" }, "executionState": { "enumDescriptions": [ "Unused", "Filter executed successfully", "Filter execution was skipped. This can happen due to server-side error or permission issue." ], "enum": [ "FILTER_EXECUTION_STATE_UNSPECIFIED", "EXECUTION_SUCCESS", "EXECUTION_SKIPPED" ], "readOnly": true, "description": "Output only. Reports whether Sensitive Data Protection redaction was successfully executed or not.", "type": "string" }, "matchState": { "type": "string", "readOnly": true, "enumDescriptions": [ "Unused", "Matching criteria is not achieved for filters.", "Matching criteria is achieved for the filter." ], "description": "Output only. Match state for Sensitive Data Protection Redaction. Value is MATCH_FOUND if content is redacted.", "enum": [ "FILTER_MATCH_STATE_UNSPECIFIED", "NO_MATCH_FOUND", "MATCH_FOUND" ] }, "messageItems": { "items": { "$ref": "MessageItem" }, "description": "Output only. Optional messages corresponding to the result. A message can provide warnings or error details. For example, if execution state is skipped then this field provides related reason/explanation.", "type": "array", "readOnly": true }, "redactedImage": { "type": "string", "readOnly": true, "format": "byte", "description": "Output only. The redacted image. The type will be the same as the original image." }, "findings": { "description": "Output only. The findings. This field is populated in the response only when include_findings in the SDP template is set to true.", "readOnly": true, "items": { "$ref": "SdpFinding" }, "type": "array" } } }, "FilterRuleSet": { "id": "FilterRuleSet", "type": "object", "properties": { "rules": { "type": "array", "items": { "$ref": "FilterRule" }, "description": "Required. Set of rules to be applied to filterTypes." }, "filterTypes": { "items": { "enumDescriptions": [ "Unspecified filter type.", "Prompt injection and jailbreak filter.", "Responsible AI filter." ], "enum": [ "RULE_FILTER_TYPE_UNSPECIFIED", "PROMPT_INJECTION_AND_JAILBREAK", "RESPONSIBLE_AI" ], "type": "string" }, "description": "Required. List of filters this rule set is applied to.", "type": "array" } }, "description": "A set of rules that modifies the behavior of specific filters based on the rules defined within the set." }, "ListTemplatesResponse": { "properties": { "nextPageToken": { "description": "A token identifying a page of results the server should return.", "type": "string" }, "templates": { "items": { "$ref": "Template" }, "description": "The list of Template", "type": "array" }, "unreachable": { "description": "Locations that could not be reached.", "type": "array", "items": { "type": "string" } } }, "type": "object", "id": "ListTemplatesResponse", "description": "Message for response to listing Templates" }, "RangeInfo": { "properties": { "start": { "description": "For proto3, value cannot be set to 0 unless the field is optional. Ref: https://protobuf.dev/programming-guides/proto3/#default Index of first character (inclusive).", "type": "string", "format": "int64" }, "end": { "format": "int64", "type": "string", "description": "Index of last character (exclusive)." } }, "description": "Half-open range interval [start, end)", "type": "object", "id": "RangeInfo" }, "MaliciousUriMatchedItem": { "type": "object", "description": "Information regarding malicious URI and its location within the input content.", "id": "MaliciousUriMatchedItem", "properties": { "locations": { "description": "List of locations where Malicious URI is identified. The `locations` field is supported only for plaintext content i.e. ByteItemType.PLAINTEXT_UTF8", "type": "array", "items": { "$ref": "RangeInfo" } }, "uri": { "type": "string", "description": "Malicious URI." } } }, "CsamFilterSettings": { "id": "CsamFilterSettings", "properties": { "filterEnforcement": { "type": "string", "enum": [ "CSAM_FILTER_ENFORCEMENT_UNSPECIFIED", "ENABLED", "DISABLED" ], "description": "Optional. Specifies whether the CSAM filter is enabled or disabled.", "enumDescriptions": [ "Unused. Default value. If unspecified, defaults to ENABLED (with HIGH confidence), except for Data Residency (DRZ) compliant resources in regions where CSAM detection is unsupported, where it defaults to DISABLED.", "Enables CSAM detection filtering for user prompts and model responses.", "Disables CSAM detection filtering for user prompts and model responses." ] }, "confidenceLevel": { "description": "Optional. Confidence level for this CSAM filter. This field is used to determine the threshold for the filter. If detection confidence is greater than or equal to the specified level, a positive match is reported. Confidence level will only be used if the filter is enabled.", "type": "string", "enum": [ "DETECTION_CONFIDENCE_LEVEL_UNSPECIFIED", "LOW_AND_ABOVE", "MEDIUM_AND_ABOVE", "HIGH" ], "enumDescriptions": [ "Same as LOW_AND_ABOVE.", "Highest chance of a false positive.", "Some chance of false positives.", "Low chance of false positives." ] } }, "type": "object", "description": "Child sexual abuse material (CSAM) filter settings." }, "SanitizeUserPromptResponse": { "id": "SanitizeUserPromptResponse", "type": "object", "properties": { "sanitizationResult": { "description": "Output only. Sanitization Result.", "$ref": "SanitizationResult", "readOnly": true } }, "description": "Sanitized User Prompt Response." }, "SdpInspectResult": { "id": "SdpInspectResult", "type": "object", "properties": { "executionState": { "enumDescriptions": [ "Unused", "Filter executed successfully", "Filter execution was skipped. This can happen due to server-side error or permission issue." ], "type": "string", "description": "Output only. Reports whether Sensitive Data Protection inspection was successfully executed or not.", "readOnly": true, "enum": [ "FILTER_EXECUTION_STATE_UNSPECIFIED", "EXECUTION_SUCCESS", "EXECUTION_SKIPPED" ] }, "matchState": { "enumDescriptions": [ "Unused", "Matching criteria is not achieved for filters.", "Matching criteria is achieved for the filter." ], "enum": [ "FILTER_MATCH_STATE_UNSPECIFIED", "NO_MATCH_FOUND", "MATCH_FOUND" ], "type": "string", "description": "Output only. Match state for SDP Inspection. Value is MATCH_FOUND if at least one Sensitive Data Protection finding is identified.", "readOnly": true }, "extractedImageText": { "type": "string", "description": "Contains text extracted from the image, if applicable." }, "findings": { "description": "List of Sensitive Data Protection findings.", "type": "array", "items": { "$ref": "SdpFinding" } }, "findingsTruncated": { "description": "If true, then there is possibility that more findings were identified and the findings returned are a subset of all findings. The findings list might be truncated because the input items were too large, or because the server reached the maximum amount of resources allowed for a single API call.", "type": "boolean" }, "messageItems": { "description": "Optional messages corresponding to the result. A message can provide warnings or error details. For example, if execution state is skipped then this field provides related reason/explanation.", "items": { "$ref": "MessageItem" }, "type": "array" } }, "description": "Sensitive Data Protection Inspection Result." }, "CsamFilterResult": { "type": "object", "properties": { "messageItems": { "description": "Optional messages corresponding to the result. A message can provide warnings or error details. For example, if execution state is skipped then this field provides related reason/explanation.", "type": "array", "items": { "$ref": "MessageItem" } }, "matchState": { "enum": [ "FILTER_MATCH_STATE_UNSPECIFIED", "NO_MATCH_FOUND", "MATCH_FOUND" ], "enumDescriptions": [ "Unused", "Matching criteria is not achieved for filters.", "Matching criteria is achieved for the filter." ], "description": "Output only. Match state for CSAM.", "readOnly": true, "type": "string" }, "executionState": { "readOnly": true, "type": "string", "description": "Output only. Reports whether the CSAM filter was successfully executed or not.", "enumDescriptions": [ "Unused", "Filter executed successfully", "Filter execution was skipped. This can happen due to server-side error or permission issue." ], "enum": [ "FILTER_EXECUTION_STATE_UNSPECIFIED", "EXECUTION_SUCCESS", "EXECUTION_SKIPPED" ] } }, "description": "CSAM (Child Safety Abuse Material) Filter Result", "id": "CsamFilterResult" }, "SdpDeidentifyResult": { "id": "SdpDeidentifyResult", "properties": { "data": { "$ref": "DataItem", "description": "De-identified data." }, "executionState": { "type": "string", "enum": [ "FILTER_EXECUTION_STATE_UNSPECIFIED", "EXECUTION_SUCCESS", "EXECUTION_SKIPPED" ], "description": "Output only. Reports whether Sensitive Data Protection deidentification was successfully executed or not.", "enumDescriptions": [ "Unused", "Filter executed successfully", "Filter execution was skipped. This can happen due to server-side error or permission issue." ], "readOnly": true }, "messageItems": { "type": "array", "items": { "$ref": "MessageItem" }, "description": "Optional messages corresponding to the result. A message can provide warnings or error details. For example, if execution state is skipped then this field provides related reason/explanation." }, "transformedBytes": { "type": "string", "format": "int64", "description": "Total size in bytes that were transformed during deidentification." }, "infoTypes": { "items": { "type": "string" }, "description": "List of Sensitive Data Protection info-types that were de-identified.", "type": "array" }, "matchState": { "enum": [ "FILTER_MATCH_STATE_UNSPECIFIED", "NO_MATCH_FOUND", "MATCH_FOUND" ], "enumDescriptions": [ "Unused", "Matching criteria is not achieved for filters.", "Matching criteria is achieved for the filter." ], "readOnly": true, "description": "Output only. Match state for Sensitive Data Protection Deidentification. Value is MATCH_FOUND if content is de-identified.", "type": "string" } }, "type": "object", "description": "Sensitive Data Protection Deidentification Result." }, "SanitizeModelResponseRequest": { "properties": { "streamingMode": { "enumDescriptions": [ "Default value.", "Buffered Streaming mode.", "Real Time Streaming mode." ], "enum": [ "STREAMING_MODE_UNSPECIFIED", "STREAMING_MODE_BUFFERED", "STREAMING_MODE_REALTIME" ], "description": "Optional. Streaming Mode for StreamSanitize* API.", "type": "string" }, "modelResponseData": { "description": "Required. Model response data to sanitize.", "$ref": "DataItem" }, "userPrompt": { "description": "Optional. User Prompt associated with Model response.", "type": "string" }, "multiLanguageDetectionMetadata": { "description": "Optional. Metadata related for multi language detection.", "$ref": "MultiLanguageDetectionMetadata" } }, "type": "object", "id": "SanitizeModelResponseRequest", "description": "Sanitize Model Response request." }, "RaiFilter": { "description": "Responsible AI filter.", "properties": { "confidenceLevel": { "enumDescriptions": [ "Same as LOW_AND_ABOVE.", "Highest chance of a false positive.", "Some chance of false positives.", "Low chance of false positives." ], "type": "string", "description": "Optional. Confidence level for this RAI filter. During data sanitization, if data is classified under this filter with a confidence level equal to or greater than the specified level, a positive match is reported. If the confidence level is unspecified (i.e., 0), the system will use a reasonable default level based on the `filter_type`.", "enum": [ "DETECTION_CONFIDENCE_LEVEL_UNSPECIFIED", "LOW_AND_ABOVE", "MEDIUM_AND_ABOVE", "HIGH" ] }, "filterType": { "description": "Required. Type of responsible AI filter.", "enum": [ "RAI_FILTER_TYPE_UNSPECIFIED", "SEXUALLY_EXPLICIT", "HATE_SPEECH", "HARASSMENT", "DANGEROUS" ], "enumDescriptions": [ "Unspecified filter type.", "Sexually Explicit.", "Hate Speech.", "Harassment.", "Danger" ], "type": "string" } }, "type": "object", "id": "RaiFilter" }, "SanitizeUserPromptRequest": { "description": "Sanitize User Prompt request.", "id": "SanitizeUserPromptRequest", "type": "object", "properties": { "userPromptData": { "description": "Required. User prompt data to sanitize.", "$ref": "DataItem" }, "multiLanguageDetectionMetadata": { "description": "Optional. Metadata related to Multi Language Detection.", "$ref": "MultiLanguageDetectionMetadata" }, "streamingMode": { "description": "Optional. Streaming Mode for StreamSanitize* API.", "type": "string", "enumDescriptions": [ "Default value.", "Buffered Streaming mode.", "Real Time Streaming mode." ], "enum": [ "STREAMING_MODE_UNSPECIFIED", "STREAMING_MODE_BUFFERED", "STREAMING_MODE_REALTIME" ] } } }, "Regex": { "id": "Regex", "description": "Message defining a custom regular expression.", "properties": { "pattern": { "type": "string", "description": "Required. The regular expression pattern." } }, "type": "object" }, "MaliciousUriFilterSettings": { "properties": { "filterEnforcement": { "description": "Optional. Tells whether the Malicious URI filter is enabled or disabled.", "type": "string", "enumDescriptions": [ "Same as Disabled", "Enabled", "Disabled" ], "enum": [ "MALICIOUS_URI_FILTER_ENFORCEMENT_UNSPECIFIED", "ENABLED", "DISABLED" ] } }, "id": "MaliciousUriFilterSettings", "type": "object", "description": "Malicious URI filter settings." }, "MaliciousUriFilterResult": { "type": "object", "properties": { "messageItems": { "description": "Optional messages corresponding to the result. A message can provide warnings or error details. For example, if execution state is skipped then this field provides related reason/explanation.", "type": "array", "items": { "$ref": "MessageItem" } }, "matchState": { "enum": [ "FILTER_MATCH_STATE_UNSPECIFIED", "NO_MATCH_FOUND", "MATCH_FOUND" ], "readOnly": true, "description": "Output only. Match state for this Malicious URI. Value is MATCH_FOUND if at least one Malicious URI is found.", "type": "string", "enumDescriptions": [ "Unused", "Matching criteria is not achieved for filters.", "Matching criteria is achieved for the filter." ] }, "maliciousUriMatchedItems": { "type": "array", "items": { "$ref": "MaliciousUriMatchedItem" }, "description": "List of Malicious URIs found in data." }, "executionState": { "readOnly": true, "type": "string", "enum": [ "FILTER_EXECUTION_STATE_UNSPECIFIED", "EXECUTION_SUCCESS", "EXECUTION_SKIPPED" ], "description": "Output only. Reports whether Malicious URI filter was successfully executed or not.", "enumDescriptions": [ "Unused", "Filter executed successfully", "Filter execution was skipped. This can happen due to server-side error or permission issue." ] } }, "description": "Malicious URI Filter Result.", "id": "MaliciousUriFilterResult" }, "Date": { "id": "Date", "type": "object", "properties": { "day": { "format": "int32", "type": "integer", "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant." }, "year": { "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", "format": "int32", "type": "integer" }, "month": { "format": "int32", "type": "integer", "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day." } }, "description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp" }, "FilterVersionSelector": { "type": "object", "id": "FilterVersionSelector", "description": "Represents the configuration for selecting a Filter Version. Allows customers to choose to use either a specific version or a predefined alias.", "properties": { "alias": { "enum": [ "FILTER_VERSION_ALIAS_UNSPECIFIED", "FILTER_VERSION_ALIAS_STABLE", "FILTER_VERSION_ALIAS_LATEST", "FILTER_VERSION_ALIAS_LEGACY", "FILTER_VERSION_ALIAS_RETIRED" ], "description": "Allows customers to use a predefined alias that dynamically points to a specific version based on internal upgrades. This offers flexibility and reduces the need for template updates.", "enumDescriptions": [ "The default value. If used, it will resolve to the `STABLE` alias.", "`STABLE` alias points to the most recent stable model version. Using this alias means no code changes are required when a new model becomes the stable version.", "`LATEST` alias points to the newest model version available. This version is subject to frequent revisions and offers SLO guarantees but does not assure stability, providing the most current security protections.", "`LEGACY` alias could be used for sanitization operations for a transition period. New templates cannot be created with this version.", "`RETIRED` alias could be used for versions that are no longer available to be used. While new templates cannot be created with this alias, any existing template or request using `RETIRED` version will fall back to the current `STABLE` version for sanitization operations." ], "type": "string" }, "version": { "type": "string", "description": "Allows customers to pin to a specific, immutable Filter Version. This provides stability, as this will not change after a version upgrade. Expected format is a case-sensitive string, e.g., \"v1\", \"v2\". Requests providing an invalid or non-existent version string will be rejected with an `INVALID_ARGUMENT` error." } } }, "ExclusionRule": { "id": "ExclusionRule", "description": "The rule that specifies conditions when filter detections are excluded from results.", "type": "object", "properties": { "matchingScope": { "type": "string", "description": "Optional. Specifies the scope of the input that should be matched against the exclusion rule. If unspecified, defaults to MATCHING_SCOPE_PARTIAL_MATCH.", "enumDescriptions": [ "Unspecified matching scope.", "Full match. - Dictionary: the dictionary match covers the entire input content - Regular expression: the regular expression pattern matches the entire input content", "Partial match. - Dictionary: at least one of the tokens in the input content matches - Regular expression: substring of the input content matches the regular expression pattern" ], "enum": [ "MATCHING_SCOPE_UNSPECIFIED", "MATCHING_SCOPE_FULL_MATCH", "MATCHING_SCOPE_PARTIAL_MATCH" ] }, "regex": { "description": "Regular expression which defines the rule.", "$ref": "Regex" }, "dictionary": { "description": "Dictionary which defines the rule.", "$ref": "Dictionary" } } }, "SanitizationResult": { "description": "Sanitization result after applying all the filters on input content.", "type": "object", "properties": { "invocationResult": { "enum": [ "INVOCATION_RESULT_UNSPECIFIED", "SUCCESS", "PARTIAL", "FAILURE" ], "description": "Output only. A field indicating the outcome of the invocation, irrespective of match status. It can have the following three values: SUCCESS: All filters were executed successfully. PARTIAL: Some filters were skipped or failed execution. FAILURE: All filters were skipped or failed execution.", "enumDescriptions": [ "Unused. Default value.", "All filters were invoked successfully.", "Some filters were skipped or failed.", "All filters were skipped or failed." ], "readOnly": true, "type": "string" }, "sanitizationMetadata": { "readOnly": true, "$ref": "SanitizationMetadata", "description": "Output only. Metadata related to Sanitization." }, "filterMatchState": { "description": "Output only. Overall filter match state for Sanitization. The state can have below two values. 1) NO_MATCH_FOUND: No filters in configuration satisfy matching criteria. In other words, input passed all filters. 2) MATCH_FOUND: At least one filter in configuration satisfies matching. In other words, input did not pass one or more filters.", "readOnly": true, "enum": [ "FILTER_MATCH_STATE_UNSPECIFIED", "NO_MATCH_FOUND", "MATCH_FOUND" ], "type": "string", "enumDescriptions": [ "Unused", "Matching criteria is not achieved for filters.", "Matching criteria is achieved for the filter." ] }, "filterResults": { "readOnly": true, "type": "object", "additionalProperties": { "$ref": "FilterResult" }, "description": "Output only. Results for all filters where the key is the filter name - either of \"csam\", \"malicious_uris\", \"rai\", \"pi_and_jailbreak\", \"sdp\"." } }, "id": "SanitizationResult" }, "VirusScanFilterResult": { "description": "Virus scan results.", "type": "object", "properties": { "scannedSize": { "description": "Size of scanned content in bytes.", "format": "int64", "type": "string" }, "matchState": { "enum": [ "FILTER_MATCH_STATE_UNSPECIFIED", "NO_MATCH_FOUND", "MATCH_FOUND" ], "description": "Output only. Match status for Virus. Value is MATCH_FOUND if the data is infected with a virus.", "enumDescriptions": [ "Unused", "Matching criteria is not achieved for filters.", "Matching criteria is achieved for the filter." ], "readOnly": true, "type": "string" }, "messageItems": { "items": { "$ref": "MessageItem" }, "type": "array", "description": "Optional messages corresponding to the result. A message can provide warnings or error details. For example, if execution status is skipped then this field provides related reason/explanation." }, "executionState": { "description": "Output only. Reports whether Virus Scan was successfully executed or not.", "enumDescriptions": [ "Unused", "Filter executed successfully", "Filter execution was skipped. This can happen due to server-side error or permission issue." ], "type": "string", "readOnly": true, "enum": [ "FILTER_EXECUTION_STATE_UNSPECIFIED", "EXECUTION_SUCCESS", "EXECUTION_SKIPPED" ] }, "virusDetails": { "description": "List of Viruses identified. This field will be empty if no virus was detected.", "items": { "$ref": "VirusDetail" }, "type": "array" }, "scannedContentType": { "description": "Type of content scanned.", "type": "string", "enumDescriptions": [ "Unused", "Unknown content", "Plaintext", "PDF Scanning for only PDF is supported." ], "enum": [ "SCANNED_CONTENT_TYPE_UNSPECIFIED", "UNKNOWN", "PLAINTEXT", "PDF" ] } }, "id": "VirusScanFilterResult" }, "FloorSetting": { "type": "object", "description": "Message describing FloorSetting resource", "properties": { "updateTime": { "format": "google-datetime", "description": "Output only. [Output only] Update timestamp", "readOnly": true, "type": "string" }, "filterConfig": { "description": "Required. ModelArmor filter configuration.", "$ref": "FilterConfig" }, "name": { "description": "Identifier. The resource name.", "type": "string" }, "enableFloorSettingEnforcement": { "type": "boolean", "description": "Optional. Floor Settings enforcement status." }, "floorSettingMetadata": { "$ref": "FloorSettingMetadata", "description": "Optional. Metadata for FloorSetting" }, "aiPlatformFloorSetting": { "$ref": "AiPlatformFloorSetting", "description": "Optional. AI Platform floor setting." }, "integratedServices": { "items": { "enumDescriptions": [ "Unspecified integrated service.", "AI Platform.", "Google MCP Server (via Shim Service Extension)" ], "enum": [ "INTEGRATED_SERVICE_UNSPECIFIED", "AI_PLATFORM", "GOOGLE_MCP_SERVER" ], "type": "string" }, "description": "Optional. List of integrated services for which the floor setting is applicable.", "type": "array" }, "googleMcpServerFloorSetting": { "$ref": "McpServerFloorSetting", "description": "Optional. Google MCP Server floor setting." }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. [Output only] Create timestamp", "type": "string" } }, "id": "FloorSetting" }, "PiAndJailbreakFilterResult": { "id": "PiAndJailbreakFilterResult", "description": "Prompt injection and Jailbreak Filter Result.", "properties": { "matchState": { "type": "string", "readOnly": true, "enum": [ "FILTER_MATCH_STATE_UNSPECIFIED", "NO_MATCH_FOUND", "MATCH_FOUND" ], "enumDescriptions": [ "Unused", "Matching criteria is not achieved for filters.", "Matching criteria is achieved for the filter." ], "description": "Output only. Match state for Prompt injection and Jailbreak." }, "executionState": { "enum": [ "FILTER_EXECUTION_STATE_UNSPECIFIED", "EXECUTION_SUCCESS", "EXECUTION_SKIPPED" ], "type": "string", "description": "Output only. Reports whether Prompt injection and Jailbreak filter was successfully executed or not.", "enumDescriptions": [ "Unused", "Filter executed successfully", "Filter execution was skipped. This can happen due to server-side error or permission issue." ], "readOnly": true }, "confidenceLevel": { "description": "Confidence level identified for Prompt injection and Jailbreak.", "enum": [ "DETECTION_CONFIDENCE_LEVEL_UNSPECIFIED", "LOW_AND_ABOVE", "MEDIUM_AND_ABOVE", "HIGH" ], "type": "string", "enumDescriptions": [ "Same as LOW_AND_ABOVE.", "Highest chance of a false positive.", "Some chance of false positives.", "Low chance of false positives." ] }, "messageItems": { "type": "array", "items": { "$ref": "MessageItem" }, "description": "Optional messages corresponding to the result. A message can provide warnings or error details. For example, if execution state is skipped then this field provides related reason/explanation." } }, "type": "object" }, "FloorSettingFloorSettingMetadataMultiLanguageDetection": { "type": "object", "properties": { "enableMultiLanguageDetection": { "type": "boolean", "description": "Required. If true, multi language detection will be enabled." } }, "description": "Metadata to enable multi language detection via floor setting.", "id": "FloorSettingFloorSettingMetadataMultiLanguageDetection" }, "DataItem": { "type": "object", "id": "DataItem", "description": "Represents Data item", "properties": { "text": { "type": "string", "description": "Plaintext string data for sanitization." }, "byteItem": { "$ref": "ByteDataItem", "description": "Data provided in the form of bytes." } } }, "RaiFilterSettings": { "id": "RaiFilterSettings", "description": "Responsible AI Filter settings.", "type": "object", "properties": { "raiFilters": { "type": "array", "description": "Required. List of Responsible AI filters enabled for template.", "items": { "$ref": "RaiFilter" } } } }, "MultiLanguageDetectionMetadata": { "id": "MultiLanguageDetectionMetadata", "properties": { "sourceLanguage": { "description": "Optional. Optional Source language of the user prompt. If multi-language detection is enabled and this field is not set, the source language will be automatically detected. When a source language is provided, Model Armor uses it to sanitize the input. In that case the system does not perform auto-detection and relies solely on the specified language. This string field accepts a language code from the ISO-639 standard. For a list of languages supported by Model Armor, see [Model Armor supported languages] (https://cloud.google.com/security-command-center/docs/model-armor-overview#languages-supported). For a comprehensive list of language codes, see [ISO-639](https://cloud.google.com/translate/docs/languages#nmt).", "type": "string" }, "enableMultiLanguageDetection": { "description": "Optional. Enable detection of multi-language prompts and responses.", "type": "boolean" } }, "type": "object", "description": "Message for Enabling Multi Language Detection." }, "SanitizationMetadata": { "description": "Message describing Sanitization metadata.", "type": "object", "id": "SanitizationMetadata", "properties": { "errorMessage": { "description": "Error message if any.", "type": "string" }, "errorCode": { "description": "Error code if any.", "type": "string", "format": "int64" }, "streamChunkProcessed": { "description": "Output only. The stream chunk processed by the Sanitization service.", "readOnly": true, "$ref": "DataItem" }, "filterVersionConfig": { "description": "Output only. Provides details about the Filter Version configuration used to sanitize this request.", "readOnly": true, "$ref": "FilterVersionConfig" }, "ignorePartialInvocationFailures": { "description": "Passthrough field defined in TemplateMetadata to indicate whether to ignore partial invocation failures.", "type": "boolean" } } }, "ByteDataItem": { "id": "ByteDataItem", "description": "Represents Byte Data item.", "properties": { "fileLabel": { "description": "Optional. Label of the file. This is used to identify the file in the response.", "type": "string" }, "byteData": { "format": "byte", "type": "string", "description": "Required. Bytes Data" }, "byteDataType": { "enumDescriptions": [ "Unused", "plain text", "PDF", "DOCX, DOCM, DOTX, DOTM", "XLSX, XLSM, XLTX, XLYM", "PPTX, PPTM, POTX, POTM, POT", "TXT", "CSV", "IMAGE" ], "type": "string", "description": "Required. The type of byte data", "enum": [ "BYTE_ITEM_TYPE_UNSPECIFIED", "PLAINTEXT_UTF8", "PDF", "WORD_DOCUMENT", "EXCEL_DOCUMENT", "POWERPOINT_DOCUMENT", "TXT", "CSV", "IMAGE" ] } }, "type": "object" }, "SdpFindingLocation": { "properties": { "byteRange": { "description": "Zero-based byte offsets delimiting the finding. These are relative to the finding's containing element. Note that when the content is not textual, this references the UTF-8 encoded textual representation of the content. Note: Omitted if content is an image.", "$ref": "RangeInfo" }, "codepointRange": { "description": "Unicode character offsets delimiting the finding. These are relative to the finding's containing element. Provided when the content is text. Note: Omitted if content is an image.", "$ref": "RangeInfo" }, "contentLocations": { "type": "array", "description": "List of nested objects pointing to the precise location of the finding within an image, file or record. For example, a single finding might be detected in two separate bounding boxes within an image (e.g., if it wraps across a line or is partially obscured). In such cases, content_locations would contain two SdpContentLocation entries, each with an image_finding_location pointing to a different bounding box.", "items": { "$ref": "SdpContentLocation" } } }, "description": "Location of this Sensitive Data Protection Finding within input content.", "id": "SdpFindingLocation", "type": "object" }, "SdpFilterSettings": { "type": "object", "id": "SdpFilterSettings", "description": "Sensitive Data Protection settings.", "properties": { "basicConfig": { "$ref": "SdpBasicConfig", "description": "Optional. Basic Sensitive Data Protection configuration inspects the content for sensitive data using a fixed set of six info-types. Sensitive Data Protection templates cannot be used with basic configuration. Only Sensitive Data Protection inspection operation is supported with basic configuration." }, "advancedConfig": { "description": "Optional. Advanced Sensitive Data Protection configuration which enables use of Sensitive Data Protection templates. Supports both Sensitive Data Protection inspection and de-identification operations.", "$ref": "SdpAdvancedConfig" } } }, "FilterRuleSettings": { "properties": { "ruleSets": { "type": "array", "items": { "$ref": "FilterRuleSet" }, "description": "Optional. List of rule sets to be applied to filters." } }, "id": "FilterRuleSettings", "type": "object", "description": "Settings for customizing filter rules." }, "SdpBoundingBox": { "description": "Bounding box encompassing a finding within an image.", "type": "object", "id": "SdpBoundingBox", "properties": { "height": { "type": "integer", "description": "Height of the bounding box in pixels.", "format": "int32" }, "width": { "format": "int32", "type": "integer", "description": "Width of the bounding box in pixels." }, "top": { "type": "integer", "format": "int32", "description": "Top coordinate of the bounding box. (0,0) is upper left." }, "left": { "type": "integer", "format": "int32", "description": "Left coordinate of the bounding box. (0,0) is upper left." } } }, "SanitizeModelResponseResponse": { "id": "SanitizeModelResponseResponse", "properties": { "sanitizationResult": { "$ref": "SanitizationResult", "description": "Output only. Sanitization Result.", "readOnly": true } }, "type": "object", "description": "Sanitized Model Response Response." } }, "description": "Model Armor helps you protect against risks like prompt injection, harmful content, and data leakage in generative AI applications by letting you define policies that filter user prompts and model responses.", "baseUrl": "https://modelarmor.us-central1.rep.googleapis.com/", "discoveryVersion": "v1", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "resources": { "projects": { "resources": { "locations": { "methods": { "getFloorSetting": { "description": "Gets details of a single floor setting of a project", "httpMethod": "GET", "response": { "$ref": "FloorSetting" }, "parameterOrder": [ "name" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/floorSetting", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}", "id": "modelarmor.projects.locations.getFloorSetting", "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/floorSetting$", "location": "path", "required": true, "description": "Required. The name of the floor setting to get, example projects/123/floorsetting." } } }, "updateFloorSetting": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/floorSetting", "path": "v1/{+name}", "parameters": { "name": { "type": "string", "description": "Identifier. The resource name.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/floorSetting$", "required": true }, "updateMask": { "location": "query", "format": "google-fieldmask", "description": "Optional. Field mask is used to specify the fields to be overwritten in the FloorSetting resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", "type": "string" } }, "parameterOrder": [ "name" ], "httpMethod": "PATCH", "id": "modelarmor.projects.locations.updateFloorSetting", "response": { "$ref": "FloorSetting" }, "request": { "$ref": "FloorSetting" }, "description": "Updates the parameters of a single floor setting of a project" }, "list": { "parameters": { "filter": { "location": "query", "type": "string", "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160)." }, "name": { "location": "path", "description": "The resource that owns the locations collection, if applicable.", "pattern": "^projects/[^/]+$", "required": true, "type": "string" }, "pageSize": { "description": "The maximum number of results to return. If not set, the service selects a default.", "location": "query", "type": "integer", "format": "int32" }, "extraLocationTypes": { "repeated": true, "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "type": "string", "location": "query" }, "pageToken": { "type": "string", "location": "query", "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page." } }, "response": { "$ref": "ListLocationsResponse" }, "flatPath": "v1/projects/{projectsId}/locations", "parameterOrder": [ "name" ], "description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "modelarmor.projects.locations.list", "httpMethod": "GET", "path": "v1/{+name}/locations" }, "get": { "response": { "$ref": "Location" }, "httpMethod": "GET", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "required": true, "description": "Resource name for the location.", "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets information about a location.", "id": "modelarmor.projects.locations.get", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}", "parameterOrder": [ "name" ], "path": "v1/{+name}" } }, "resources": { "templates": { "methods": { "create": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/templates", "id": "modelarmor.projects.locations.templates.create", "parameters": { "parent": { "required": true, "type": "string", "description": "Required. Value for parent.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$" }, "requestId": { "type": "string", "location": "query", "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server stores the request ID for 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000)." }, "templateId": { "type": "string", "location": "query", "description": "Required. Id of the requesting object If auto-generating Id server-side, remove this field and template_id from the method_signature of Create RPC" } }, "description": "Creates a new Template in a given project and location.", "path": "v1/{+parent}/templates", "request": { "$ref": "Template" }, "httpMethod": "POST", "parameterOrder": [ "parent" ], "response": { "$ref": "Template" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "path": "v1/{+name}", "parameters": { "name": { "description": "Required. Name of the resource", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/templates/[^/]+$", "type": "string" }, "requestId": { "location": "query", "type": "string", "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server stores the request ID for 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000)." } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}", "id": "modelarmor.projects.locations.templates.delete", "description": "Deletes a single Template.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "response": { "$ref": "Empty" }, "httpMethod": "DELETE" }, "get": { "id": "modelarmor.projects.locations.templates.get", "description": "Gets details of a single Template.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}", "httpMethod": "GET", "parameterOrder": [ "name" ], "parameters": { "name": { "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/templates/[^/]+$", "description": "Required. Name of the resource" } }, "response": { "$ref": "Template" }, "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { "httpMethod": "PATCH", "path": "v1/{+name}", "id": "modelarmor.projects.locations.templates.patch", "response": { "$ref": "Template" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates the parameters of a single Template.", "request": { "$ref": "Template" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}", "parameterOrder": [ "name" ], "parameters": { "updateMask": { "location": "query", "format": "google-fieldmask", "description": "Required. Field mask is used to specify the fields to be overwritten in the Template resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", "type": "string" }, "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/templates/[^/]+$", "location": "path", "required": true, "description": "Identifier. name of resource" }, "requestId": { "location": "query", "type": "string", "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server stores the request ID for 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000)." } } }, "sanitizeUserPrompt": { "path": "v1/{+name}:sanitizeUserPrompt", "id": "modelarmor.projects.locations.templates.sanitizeUserPrompt", "request": { "$ref": "SanitizeUserPromptRequest" }, "httpMethod": "POST", "parameterOrder": [ "name" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}:sanitizeUserPrompt", "response": { "$ref": "SanitizeUserPromptResponse" }, "parameters": { "name": { "required": true, "location": "path", "type": "string", "description": "Required. Represents resource name of template e.g. name=projects/sample-project/locations/us-central1/templates/templ01", "pattern": "^projects/[^/]+/locations/[^/]+/templates/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Sanitizes User Prompt." }, "sanitizeModelResponse": { "httpMethod": "POST", "request": { "$ref": "SanitizeModelResponseRequest" }, "path": "v1/{+name}:sanitizeModelResponse", "response": { "$ref": "SanitizeModelResponseResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "description": "Sanitizes Model Response.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}:sanitizeModelResponse", "id": "modelarmor.projects.locations.templates.sanitizeModelResponse", "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/templates/[^/]+$", "description": "Required. Represents resource name of template e.g. name=projects/sample-project/locations/us-central1/templates/templ01", "location": "path", "type": "string" } } }, "list": { "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/templates", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists Templates in a given project and location.", "response": { "$ref": "ListTemplatesResponse" }, "parameterOrder": [ "parent" ], "id": "modelarmor.projects.locations.templates.list", "path": "v1/{+parent}/templates", "parameters": { "filter": { "location": "query", "description": "Optional. Filtering results", "type": "string" }, "orderBy": { "type": "string", "description": "Optional. Hint for how to order the results", "location": "query" }, "pageToken": { "location": "query", "type": "string", "description": "Optional. A token identifying a page of results the server should return." }, "parent": { "required": true, "location": "path", "description": "Required. Parent value for ListTemplatesRequest", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string" }, "pageSize": { "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "location": "query", "type": "integer", "format": "int32" } } } } } } } } }, "folders": { "resources": { "locations": { "methods": { "getFloorSetting": { "response": { "$ref": "FloorSetting" }, "parameters": { "name": { "type": "string", "location": "path", "required": true, "pattern": "^folders/[^/]+/locations/[^/]+/floorSetting$", "description": "Required. The name of the floor setting to get, example projects/123/floorsetting." } }, "id": "modelarmor.folders.locations.getFloorSetting", "parameterOrder": [ "name" ], "description": "Gets details of a single floor setting of a project", "path": "v1/{+name}", "httpMethod": "GET", "flatPath": "v1/folders/{foldersId}/locations/{locationsId}/floorSetting", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "updateFloorSetting": { "parameters": { "updateMask": { "location": "query", "type": "string", "format": "google-fieldmask", "description": "Optional. Field mask is used to specify the fields to be overwritten in the FloorSetting resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten." }, "name": { "type": "string", "pattern": "^folders/[^/]+/locations/[^/]+/floorSetting$", "required": true, "location": "path", "description": "Identifier. The resource name." } }, "description": "Updates the parameters of a single floor setting of a project", "response": { "$ref": "FloorSetting" }, "request": { "$ref": "FloorSetting" }, "path": "v1/{+name}", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "modelarmor.folders.locations.updateFloorSetting", "flatPath": "v1/folders/{foldersId}/locations/{locationsId}/floorSetting", "httpMethod": "PATCH" } } } } }, "organizations": { "resources": { "locations": { "methods": { "getFloorSetting": { "id": "modelarmor.organizations.locations.getFloorSetting", "parameters": { "name": { "location": "path", "type": "string", "description": "Required. The name of the floor setting to get, example projects/123/floorsetting.", "required": true, "pattern": "^organizations/[^/]+/locations/[^/]+/floorSetting$" } }, "response": { "$ref": "FloorSetting" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "path": "v1/{+name}", "description": "Gets details of a single floor setting of a project", "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/floorSetting", "httpMethod": "GET" }, "updateFloorSetting": { "response": { "$ref": "FloorSetting" }, "parameters": { "updateMask": { "location": "query", "format": "google-fieldmask", "type": "string", "description": "Optional. Field mask is used to specify the fields to be overwritten in the FloorSetting resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten." }, "name": { "description": "Identifier. The resource name.", "type": "string", "pattern": "^organizations/[^/]+/locations/[^/]+/floorSetting$", "required": true, "location": "path" } }, "parameterOrder": [ "name" ], "httpMethod": "PATCH", "path": "v1/{+name}", "id": "modelarmor.organizations.locations.updateFloorSetting", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/floorSetting", "description": "Updates the parameters of a single floor setting of a project", "request": { "$ref": "FloorSetting" } } } } } } }, "ownerDomain": "google.com", "mtlsRootUrl": "https://modelarmor.us-central1.rep.mtls.googleapis.com/", "id": "modelarmor:v1", "servicePath": "", "basePath": "", "kind": "discovery#restDescription", "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." } } } }, "revision": "20261028", "version": "v1", "parameters": { "uploadType": { "location": "query", "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, "oauth_token": { "description": "OAuth 2.0 token for the current user.", "location": "query", "type": "string" }, "prettyPrint": { "description": "Returns response with indentations and line breaks.", "location": "query", "default": "true", "type": "boolean" }, "access_token": { "description": "OAuth access token.", "type": "string", "location": "query" }, "callback": { "location": "query", "description": "JSONP", "type": "string" }, "alt": { "type": "string", "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "location": "query", "default": "json", "enum": [ "json", "media", "proto" ], "description": "Data format for response." }, "key": { "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", "type": "string", "location": "query" }, "$.xgafv": { "type": "string", "description": "V1 error format.", "location": "query", "enum": [ "1", "2" ], "enumDescriptions": [ "v1 error format", "v2 error format" ] }, "quotaUser": { "type": "string", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", "location": "query" }, "upload_protocol": { "type": "string", "location": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, "fields": { "type": "string", "description": "Selector specifying which fields to include in a partial response.", "location": "query" } }, "ownerName": "Google", "batchPath": "batch", "name": "modelarmor", "fullyEncodeReservedExpansion": true, "title": "Model Armor API" }