{ "id": "modelarmor:v1", "canonicalName": "Model Armor", "title": "Model Armor API", "batchPath": "batch", "ownerName": "Google", "mtlsRootUrl": "https://modelarmor.us.rep.mtls.googleapis.com/", "rootUrl": "https://modelarmor.us.rep.googleapis.com/", "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." } } } }, "resources": { "folders": { "resources": { "locations": { "methods": { "getFloorSetting": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "path": "v1/{+name}", "httpMethod": "GET", "flatPath": "v1/folders/{foldersId}/locations/{locationsId}/floorSetting", "response": { "$ref": "FloorSetting" }, "parameters": { "name": { "location": "path", "type": "string", "description": "Required. The name of the floor setting to get, example projects/123/floorsetting.", "required": true, "pattern": "^folders/[^/]+/locations/[^/]+/floorSetting$" } }, "id": "modelarmor.folders.locations.getFloorSetting", "description": "Gets details of a single floor setting of a project" }, "updateFloorSetting": { "id": "modelarmor.folders.locations.updateFloorSetting", "description": "Updates the parameters of a single floor setting of a project", "parameters": { "name": { "pattern": "^folders/[^/]+/locations/[^/]+/floorSetting$", "description": "Identifier. The resource name.", "required": true, "type": "string", "location": "path" }, "updateMask": { "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.", "format": "google-fieldmask", "location": "query", "type": "string" } }, "request": { "$ref": "FloorSetting" }, "flatPath": "v1/folders/{foldersId}/locations/{locationsId}/floorSetting", "response": { "$ref": "FloorSetting" }, "httpMethod": "PATCH", "path": "v1/{+name}", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } } } }, "organizations": { "resources": { "locations": { "methods": { "getFloorSetting": { "parameterOrder": [ "name" ], "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "description": "Required. The name of the floor setting to get, example projects/123/floorsetting.", "required": true, "location": "path", "type": "string", "pattern": "^organizations/[^/]+/locations/[^/]+/floorSetting$" } }, "id": "modelarmor.organizations.locations.getFloorSetting", "description": "Gets details of a single floor setting of a project", "httpMethod": "GET", "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/floorSetting", "response": { "$ref": "FloorSetting" } }, "updateFloorSetting": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "path": "v1/{+name}", "httpMethod": "PATCH", "response": { "$ref": "FloorSetting" }, "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/floorSetting", "parameters": { "name": { "description": "Identifier. The resource name.", "required": true, "location": "path", "type": "string", "pattern": "^organizations/[^/]+/locations/[^/]+/floorSetting$" }, "updateMask": { "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.", "format": "google-fieldmask", "location": "query", "type": "string" } }, "request": { "$ref": "FloorSetting" }, "id": "modelarmor.organizations.locations.updateFloorSetting", "description": "Updates the parameters of a single floor setting of a project" } } } } }, "projects": { "resources": { "locations": { "methods": { "updateFloorSetting": { "parameters": { "name": { "description": "Identifier. The resource name.", "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/floorSetting$" }, "updateMask": { "location": "query", "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.", "format": "google-fieldmask" } }, "request": { "$ref": "FloorSetting" }, "id": "modelarmor.projects.locations.updateFloorSetting", "description": "Updates the parameters of a single floor setting of a project", "httpMethod": "PATCH", "response": { "$ref": "FloorSetting" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/floorSetting", "parameterOrder": [ "name" ], "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations", "response": { "$ref": "ListLocationsResponse" }, "parameters": { "extraLocationTypes": { "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" }, "filter": { "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).", "type": "string", "location": "query" }, "name": { "type": "string", "location": "path", "description": "The resource that owns the locations collection, if applicable.", "required": true, "pattern": "^projects/[^/]+$" }, "pageToken": { "location": "query", "type": "string", "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page." }, "pageSize": { "type": "integer", "location": "query", "description": "The maximum number of results to return. If not set, the service selects a default.", "format": "int32" } }, "id": "modelarmor.projects.locations.list", "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" ], "parameterOrder": [ "name" ], "path": "v1/{+name}/locations" }, "getFloorSetting": { "id": "modelarmor.projects.locations.getFloorSetting", "description": "Gets details of a single floor setting of a project", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/floorSetting$", "location": "path", "type": "string", "description": "Required. The name of the floor setting to get, example projects/123/floorsetting.", "required": true } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/floorSetting", "response": { "$ref": "FloorSetting" }, "httpMethod": "GET", "path": "v1/{+name}", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "response": { "$ref": "Location" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}", "httpMethod": "GET", "id": "modelarmor.projects.locations.get", "description": "Gets information about a location.", "parameters": { "name": { "description": "Resource name for the location.", "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}", "parameterOrder": [ "name" ] } }, "resources": { "templates": { "methods": { "sanitizeUserPrompt": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}:sanitizeUserPrompt", "parameterOrder": [ "name" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}:sanitizeUserPrompt", "response": { "$ref": "SanitizeUserPromptResponse" }, "httpMethod": "POST", "id": "modelarmor.projects.locations.templates.sanitizeUserPrompt", "description": "Sanitizes User Prompt.", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/templates/[^/]+$", "description": "Required. Represents resource name of template e.g. name=projects/sample-project/locations/us-central1/templates/templ01", "required": true, "location": "path", "type": "string" } }, "request": { "$ref": "SanitizeUserPromptRequest" } }, "sanitizeModelResponse": { "httpMethod": "POST", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}:sanitizeModelResponse", "response": { "$ref": "SanitizeModelResponseResponse" }, "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/templates/[^/]+$", "location": "path", "type": "string", "description": "Required. Represents resource name of template e.g. name=projects/sample-project/locations/us-central1/templates/templ01", "required": true } }, "request": { "$ref": "SanitizeModelResponseRequest" }, "id": "modelarmor.projects.locations.templates.sanitizeModelResponse", "description": "Sanitizes Model Response.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "path": "v1/{+name}:sanitizeModelResponse" }, "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+parent}/templates", "parameterOrder": [ "parent" ], "response": { "$ref": "ListTemplatesResponse" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/templates", "httpMethod": "GET", "id": "modelarmor.projects.locations.templates.list", "description": "Lists Templates in a given project and location.", "parameters": { "filter": { "description": "Optional. Filtering results", "type": "string", "location": "query" }, "pageSize": { "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "format": "int32", "location": "query", "type": "integer" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. Parent value for ListTemplatesRequest", "required": true, "location": "path", "type": "string" }, "pageToken": { "description": "Optional. A token identifying a page of results the server should return.", "type": "string", "location": "query" }, "orderBy": { "description": "Optional. Hint for how to order the results", "type": "string", "location": "query" } } }, "patch": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}", "parameterOrder": [ "name" ], "response": { "$ref": "Template" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}", "httpMethod": "PATCH", "id": "modelarmor.projects.locations.templates.patch", "description": "Updates the parameters of a single Template.", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/templates/[^/]+$", "location": "path", "type": "string", "description": "Identifier. name of resource", "required": true }, "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)." }, "updateMask": { "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.", "format": "google-fieldmask", "type": "string", "location": "query" } }, "request": { "$ref": "Template" } }, "get": { "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}", "response": { "$ref": "Template" }, "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/templates/[^/]+$", "description": "Required. Name of the resource", "required": true, "location": "path", "type": "string" } }, "id": "modelarmor.projects.locations.templates.get", "description": "Gets details of a single Template.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "path": "v1/{+name}" }, "create": { "parameterOrder": [ "parent" ], "path": "v1/{+parent}/templates", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "requestId": { "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).", "location": "query", "type": "string" }, "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" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "type": "string", "description": "Required. Value for parent.", "required": true } }, "request": { "$ref": "Template" }, "id": "modelarmor.projects.locations.templates.create", "description": "Creates a new Template in a given project and location.", "httpMethod": "POST", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/templates", "response": { "$ref": "Template" } }, "delete": { "parameters": { "name": { "description": "Required. Name of the resource", "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/templates/[^/]+$" }, "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)." } }, "id": "modelarmor.projects.locations.templates.delete", "description": "Deletes a single Template.", "httpMethod": "DELETE", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}", "response": { "$ref": "Empty" }, "parameterOrder": [ "name" ], "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } } } } } } }, "fullyEncodeReservedExpansion": true, "version_module": true, "ownerDomain": "google.com", "baseUrl": "https://modelarmor.us.rep.googleapis.com/", "discoveryVersion": "v1", "version": "v1", "protocol": "rest", "name": "modelarmor", "kind": "discovery#restDescription", "parameters": { "fields": { "description": "Selector specifying which fields to include in a partial response.", "location": "query", "type": "string" }, "upload_protocol": { "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "type": "string", "location": "query" }, "callback": { "location": "query", "type": "string", "description": "JSONP" }, "$.xgafv": { "description": "V1 error format.", "enum": [ "1", "2" ], "location": "query", "type": "string", "enumDescriptions": [ "v1 error format", "v2 error format" ] }, "alt": { "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "type": "string", "location": "query", "description": "Data format for response.", "enum": [ "json", "media", "proto" ], "default": "json" }, "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.", "location": "query", "type": "string" }, "oauth_token": { "type": "string", "location": "query", "description": "OAuth 2.0 token for the current user." }, "access_token": { "type": "string", "location": "query", "description": "OAuth access token." }, "uploadType": { "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "type": "string", "location": "query" }, "prettyPrint": { "description": "Returns response with indentations and line breaks.", "default": "true", "type": "boolean", "location": "query" }, "quotaUser": { "type": "string", "location": "query", "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." } }, "basePath": "", "servicePath": "", "documentationLink": "https://cloud.google.com/security-command-center/docs/model-armor-overview", "schemas": { "MultiLanguageDetection": { "properties": { "enableMultiLanguageDetection": { "description": "Required. If true, multi language detection will be enabled.", "type": "boolean" } }, "id": "MultiLanguageDetection", "description": "Metadata to enable multi language detection via template.", "type": "object" }, "DataItem": { "type": "object", "properties": { "text": { "description": "Plaintext string data for sanitization.", "type": "string" }, "byteItem": { "description": "Data provided in the form of bytes.", "$ref": "ByteDataItem" } }, "id": "DataItem", "description": "Represents Data item" }, "SdpAdvancedConfig": { "id": "SdpAdvancedConfig", "description": "Sensitive Data Protection Advanced configuration.", "properties": { "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" }, "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" } }, "type": "object" }, "TemplateMetadata": { "type": "object", "id": "TemplateMetadata", "description": "Message describing TemplateMetadata", "properties": { "logSanitizeOperations": { "description": "Optional. If true, log sanitize operations.", "type": "boolean" }, "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" }, "ignorePartialInvocationFailures": { "description": "Optional. If true, partial detector failures should be ignored.", "type": "boolean" }, "customPromptSafetyErrorCode": { "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.", "format": "int32", "type": "integer" }, "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" }, "multiLanguageDetection": { "$ref": "MultiLanguageDetection", "description": "Optional. Metadata for multi language detection." }, "customLlmResponseSafetyErrorCode": { "type": "integer", "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.", "format": "int32" }, "logTemplateOperations": { "description": "Optional. If true, log template crud operations.", "type": "boolean" }, "enforcementType": { "type": "string", "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." ], "description": "Optional. Enforcement type for Model Armor filters.", "enum": [ "ENFORCEMENT_TYPE_UNSPECIFIED", "INSPECT_ONLY", "INSPECT_AND_BLOCK" ] } } }, "SdpFindingLocation": { "type": "object", "id": "SdpFindingLocation", "description": "Location of this Sensitive Data Protection Finding within input content.", "properties": { "byteRange": { "$ref": "RangeInfo", "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." }, "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" } } }, "RaiFilterResult": { "type": "object", "properties": { "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." }, "matchState": { "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.", "enum": [ "FILTER_MATCH_STATE_UNSPECIFIED", "NO_MATCH_FOUND", "MATCH_FOUND" ], "readOnly": true, "type": "string", "enumDescriptions": [ "Unused", "Matching criteria is not achieved for filters.", "Matching criteria is achieved for the filter." ] }, "raiFilterTypeResults": { "type": "object", "additionalProperties": { "$ref": "RaiFilterTypeResult" }, "description": "The map of RAI filter results where key is RAI filter type - either of \"sexually_explicit\", \"hate_speech\", \"harassment\", \"dangerous\", \"violence\", \"sexually_suggestive\"." }, "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, "type": "string", "enumDescriptions": [ "Unused", "Filter executed successfully", "Filter execution was skipped. This can happen due to server-side error or permission issue." ] } }, "id": "RaiFilterResult", "description": "Responsible AI Result." }, "MaliciousUriFilterSettings": { "type": "object", "properties": { "filterEnforcement": { "type": "string", "enumDescriptions": [ "Same as Disabled", "Enabled", "Disabled" ], "description": "Optional. Tells whether the Malicious URI filter is enabled or disabled.", "enum": [ "MALICIOUS_URI_FILTER_ENFORCEMENT_UNSPECIFIED", "ENABLED", "DISABLED" ] } }, "id": "MaliciousUriFilterSettings", "description": "Malicious URI filter settings." }, "SanitizationResult": { "properties": { "sanitizationMetadata": { "readOnly": true, "$ref": "SanitizationMetadata", "description": "Output only. Metadata related to Sanitization." }, "filterResults": { "description": "Output only. Results for all filters where the key is the filter name - either of \"csam\", \"malicious_uris\", \"rai\", \"pi_and_jailbreak\" ,\"sdp\".", "additionalProperties": { "$ref": "FilterResult" }, "readOnly": true, "type": "object" }, "filterMatchState": { "readOnly": true, "type": "string", "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.", "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." ] }, "invocationResult": { "enumDescriptions": [ "Unused. Default value.", "All filters were invoked successfully.", "Some filters were skipped or failed.", "All filters were skipped or failed." ], "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.", "enum": [ "INVOCATION_RESULT_UNSPECIFIED", "SUCCESS", "PARTIAL", "FAILURE" ], "readOnly": true, "type": "string" } }, "id": "SanitizationResult", "description": "Sanitization result after applying all the filters on input content.", "type": "object" }, "PiAndJailbreakFilterSettings": { "type": "object", "id": "PiAndJailbreakFilterSettings", "description": "Prompt injection and Jailbreak Filter settings.", "properties": { "confidenceLevel": { "type": "string", "enumDescriptions": [ "Same as LOW_AND_ABOVE.", "Highest chance of a false positive.", "Some chance of false positives.", "Low chance of false positives." ], "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.", "enum": [ "DETECTION_CONFIDENCE_LEVEL_UNSPECIFIED", "LOW_AND_ABOVE", "MEDIUM_AND_ABOVE", "HIGH" ] }, "filterEnforcement": { "description": "Optional. Tells whether Prompt injection and Jailbreak filter is enabled or disabled.", "enum": [ "PI_AND_JAILBREAK_FILTER_ENFORCEMENT_UNSPECIFIED", "ENABLED", "DISABLED" ], "type": "string", "enumDescriptions": [ "Same as Disabled", "Enabled", "Disabled" ] } } }, "Location": { "id": "Location", "description": "A resource that represents a Google Cloud location.", "properties": { "displayName": { "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", "type": "string" }, "metadata": { "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "type": "object", "description": "Service-specific metadata. For example the available capacity at the given location." }, "name": { "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`", "type": "string" }, "locationId": { "description": "The canonical id for this location. For example: `\"us-east1\"`.", "type": "string" }, "labels": { "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", "type": "object", "additionalProperties": { "type": "string" } } }, "type": "object" }, "SanitizeModelResponseRequest": { "properties": { "streamingMode": { "type": "string", "enumDescriptions": [ "Default value.", "Buffered Streaming mode.", "Real Time Streaming mode." ], "description": "Optional. Streaming Mode for StreamSanitize* API.", "enum": [ "STREAMING_MODE_UNSPECIFIED", "STREAMING_MODE_BUFFERED", "STREAMING_MODE_REALTIME" ] }, "modelResponseData": { "$ref": "DataItem", "description": "Required. Model response data to sanitize." }, "multiLanguageDetectionMetadata": { "description": "Optional. Metadata related for multi language detection.", "$ref": "MultiLanguageDetectionMetadata" }, "userPrompt": { "description": "Optional. User Prompt associated with Model response.", "type": "string" } }, "id": "SanitizeModelResponseRequest", "description": "Sanitize Model Response request.", "type": "object" }, "VirusScanFilterResult": { "properties": { "messageItems": { "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.", "items": { "$ref": "MessageItem" } }, "scannedContentType": { "description": "Type of content scanned.", "enum": [ "SCANNED_CONTENT_TYPE_UNSPECIFIED", "UNKNOWN", "PLAINTEXT", "PDF" ], "type": "string", "enumDescriptions": [ "Unused", "Unknown content", "Plaintext", "PDF Scanning for only PDF is supported." ] }, "virusDetails": { "description": "List of Viruses identified. This field will be empty if no virus was detected.", "items": { "$ref": "VirusDetail" }, "type": "array" }, "scannedSize": { "type": "string", "description": "Size of scanned content in bytes.", "format": "int64" }, "matchState": { "enumDescriptions": [ "Unused", "Matching criteria is not achieved for filters.", "Matching criteria is achieved for the filter." ], "description": "Output only. Match status for Virus. Value is MATCH_FOUND if the data is infected with a virus.", "enum": [ "FILTER_MATCH_STATE_UNSPECIFIED", "NO_MATCH_FOUND", "MATCH_FOUND" ], "readOnly": true, "type": "string" }, "executionState": { "enumDescriptions": [ "Unused", "Filter executed successfully", "Filter execution was skipped. This can happen due to server-side error or permission issue." ], "description": "Output only. Reports whether Virus Scan was successfully executed or not.", "enum": [ "FILTER_EXECUTION_STATE_UNSPECIFIED", "EXECUTION_SUCCESS", "EXECUTION_SKIPPED" ], "readOnly": true, "type": "string" } }, "id": "VirusScanFilterResult", "description": "Virus scan results.", "type": "object" }, "SanitizeUserPromptRequest": { "id": "SanitizeUserPromptRequest", "description": "Sanitize User Prompt request.", "properties": { "multiLanguageDetectionMetadata": { "description": "Optional. Metadata related to Multi Language Detection.", "$ref": "MultiLanguageDetectionMetadata" }, "userPromptData": { "description": "Required. User prompt data to sanitize.", "$ref": "DataItem" }, "streamingMode": { "type": "string", "enumDescriptions": [ "Default value.", "Buffered Streaming mode.", "Real Time Streaming mode." ], "description": "Optional. Streaming Mode for StreamSanitize* API.", "enum": [ "STREAMING_MODE_UNSPECIFIED", "STREAMING_MODE_BUFFERED", "STREAMING_MODE_REALTIME" ] } }, "type": "object" }, "VirusDetail": { "type": "object", "id": "VirusDetail", "description": "Details of an identified virus", "properties": { "names": { "items": { "type": "string" }, "description": "Names of this Virus.", "type": "array" }, "vendor": { "description": "Name of vendor that produced this virus identification.", "type": "string" }, "threatType": { "description": "Threat type of the identified virus", "enum": [ "THREAT_TYPE_UNSPECIFIED", "UNKNOWN", "VIRUS_OR_WORM", "MALICIOUS_PROGRAM", "POTENTIALLY_HARMFUL_CONTENT", "POTENTIALLY_UNWANTED_CONTENT" ], "type": "string", "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." ] } } }, "MultiLanguageDetectionMetadata": { "id": "MultiLanguageDetectionMetadata", "description": "Message for Enabling Multi Language Detection.", "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" }, "RaiFilterTypeResult": { "id": "RaiFilterTypeResult", "description": "Detailed Filter result for each of the responsible AI Filter Types.", "properties": { "filterType": { "type": "string", "enumDescriptions": [ "Unspecified filter type.", "Sexually Explicit.", "Hate Speech.", "Harassment.", "Danger" ], "description": "Type of responsible AI filter.", "enum": [ "RAI_FILTER_TYPE_UNSPECIFIED", "SEXUALLY_EXPLICIT", "HATE_SPEECH", "HARASSMENT", "DANGEROUS" ] }, "matchState": { "readOnly": true, "type": "string", "description": "Output only. Match state for this RAI filter.", "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." ] }, "confidenceLevel": { "description": "Confidence level identified for this RAI filter.", "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." ] } }, "type": "object" }, "SanitizeModelResponseResponse": { "properties": { "sanitizationResult": { "readOnly": true, "$ref": "SanitizationResult", "description": "Output only. Sanitization Result." } }, "id": "SanitizeModelResponseResponse", "description": "Sanitized Model Response Response.", "type": "object" }, "AiPlatformFloorSetting": { "id": "AiPlatformFloorSetting", "description": "message describing AiPlatformFloorSetting", "properties": { "enableCloudLogging": { "description": "Optional. If true, log Model Armor filter results to Cloud Logging.", "type": "boolean" }, "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" } }, "type": "object" }, "FloorSettingFloorSettingMetadataMultiLanguageDetection": { "type": "object", "id": "FloorSettingFloorSettingMetadataMultiLanguageDetection", "description": "Metadata to enable multi language detection via floor setting.", "properties": { "enableMultiLanguageDetection": { "description": "Required. If true, multi language detection will be enabled.", "type": "boolean" } } }, "SanitizationMetadata": { "type": "object", "id": "SanitizationMetadata", "description": "Message describing Sanitization metadata.", "properties": { "errorCode": { "description": "Error code if any.", "format": "int64", "type": "string" }, "errorMessage": { "description": "Error message if any.", "type": "string" }, "ignorePartialInvocationFailures": { "description": "Passthrough field defined in TemplateMetadata to indicate whether to ignore partial invocation failures.", "type": "boolean" } } }, "CsamFilterResult": { "type": "object", "id": "CsamFilterResult", "description": "CSAM (Child Safety Abuse Material) Filter Result", "properties": { "executionState": { "description": "Output only. Reports whether the CSAM filter was successfully executed or not.", "enum": [ "FILTER_EXECUTION_STATE_UNSPECIFIED", "EXECUTION_SUCCESS", "EXECUTION_SKIPPED" ], "readOnly": true, "type": "string", "enumDescriptions": [ "Unused", "Filter executed successfully", "Filter execution was skipped. This can happen due to server-side error or permission issue." ] }, "messageItems": { "type": "array", "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" } }, "matchState": { "readOnly": true, "type": "string", "description": "Output only. Match state for CSAM.", "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." ] } } }, "McpServerFloorSetting": { "properties": { "enableCloudLogging": { "description": "Optional. If true, log Model Armor filter results to Cloud Logging.", "type": "boolean" }, "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" }, "apis": { "items": { "type": "string" }, "description": "Optional. List of MCP servers for which the MCP floor setting is applicable. Examples: \"bigquery.googleapis.com/mcp\", \"run.googleapis.com/mcp\" Empty list denotes that the floor setting is applicable to all MCP servers.", "type": "array" } }, "id": "McpServerFloorSetting", "description": "Message describing MCP Server Floor Setting.", "type": "object" }, "MessageItem": { "type": "object", "id": "MessageItem", "description": "Message item to report information, warning or error messages.", "properties": { "messageType": { "type": "string", "enumDescriptions": [ "Unused", "Information related message.", "Warning related message.", "Error message." ], "description": "Type of message.", "enum": [ "MESSAGE_TYPE_UNSPECIFIED", "INFO", "WARNING", "ERROR" ] }, "message": { "description": "The message content.", "type": "string" } } }, "SanitizeUserPromptResponse": { "type": "object", "id": "SanitizeUserPromptResponse", "description": "Sanitized User Prompt Response.", "properties": { "sanitizationResult": { "readOnly": true, "description": "Output only. Sanitization Result.", "$ref": "SanitizationResult" } } }, "MaliciousUriFilterResult": { "type": "object", "properties": { "maliciousUriMatchedItems": { "type": "array", "items": { "$ref": "MaliciousUriMatchedItem" }, "description": "List of Malicious URIs found in data." }, "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" }, "matchState": { "enumDescriptions": [ "Unused", "Matching criteria is not achieved for filters.", "Matching criteria is achieved for the filter." ], "readOnly": true, "type": "string", "description": "Output only. Match state for this Malicious URI. Value is MATCH_FOUND if at least one Malicious URI is found.", "enum": [ "FILTER_MATCH_STATE_UNSPECIFIED", "NO_MATCH_FOUND", "MATCH_FOUND" ] }, "executionState": { "readOnly": true, "type": "string", "description": "Output only. Reports whether Malicious URI filter was successfully executed or not.", "enum": [ "FILTER_EXECUTION_STATE_UNSPECIFIED", "EXECUTION_SUCCESS", "EXECUTION_SKIPPED" ], "enumDescriptions": [ "Unused", "Filter executed successfully", "Filter execution was skipped. This can happen due to server-side error or permission issue." ] } }, "id": "MaliciousUriFilterResult", "description": "Malicious URI Filter Result." }, "ListTemplatesResponse": { "type": "object", "properties": { "templates": { "type": "array", "items": { "$ref": "Template" }, "description": "The list of Template" }, "nextPageToken": { "description": "A token identifying a page of results the server should return.", "type": "string" }, "unreachable": { "description": "Locations that could not be reached.", "items": { "type": "string" }, "type": "array" } }, "id": "ListTemplatesResponse", "description": "Message for response to listing Templates" }, "SdpInspectResult": { "properties": { "messageItems": { "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": "array" }, "findings": { "description": "List of Sensitive Data Protection findings.", "items": { "$ref": "SdpFinding" }, "type": "array" }, "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" }, "matchState": { "readOnly": true, "type": "string", "description": "Output only. Match state for SDP Inspection. Value is MATCH_FOUND if at least one Sensitive Data Protection finding is identified.", "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." ] }, "executionState": { "readOnly": true, "type": "string", "description": "Output only. Reports whether Sensitive Data Protection inspection was successfully executed or not.", "enum": [ "FILTER_EXECUTION_STATE_UNSPECIFIED", "EXECUTION_SUCCESS", "EXECUTION_SKIPPED" ], "enumDescriptions": [ "Unused", "Filter executed successfully", "Filter execution was skipped. This can happen due to server-side error or permission issue." ] } }, "id": "SdpInspectResult", "description": "Sensitive Data Protection Inspection Result.", "type": "object" }, "SdpFilterSettings": { "type": "object", "properties": { "basicConfig": { "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.", "$ref": "SdpBasicConfig" }, "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" } }, "id": "SdpFilterSettings", "description": "Sensitive Data Protection settings." }, "Template": { "id": "Template", "description": "Message describing Template resource", "properties": { "createTime": { "readOnly": true, "type": "string", "description": "Output only. [Output only] Create time stamp", "format": "google-datetime" }, "updateTime": { "description": "Output only. [Output only] Update time stamp", "format": "google-datetime", "readOnly": true, "type": "string" }, "filterConfig": { "$ref": "FilterConfig", "description": "Required. filter configuration for this template" }, "name": { "description": "Identifier. name of resource", "type": "string" }, "labels": { "description": "Optional. Labels as key value pairs", "additionalProperties": { "type": "string" }, "type": "object" }, "templateMetadata": { "$ref": "TemplateMetadata", "description": "Optional. metadata for this template" } }, "type": "object" }, "FilterConfig": { "properties": { "sdpSettings": { "description": "Optional. Sensitive Data Protection settings.", "$ref": "SdpFilterSettings" }, "piAndJailbreakFilterSettings": { "$ref": "PiAndJailbreakFilterSettings", "description": "Optional. Prompt injection and Jailbreak filter settings." }, "maliciousUriFilterSettings": { "$ref": "MaliciousUriFilterSettings", "description": "Optional. Malicious URI filter settings." }, "raiSettings": { "$ref": "RaiFilterSettings", "description": "Optional. Responsible AI settings." } }, "id": "FilterConfig", "description": "Filters configuration.", "type": "object" }, "PiAndJailbreakFilterResult": { "type": "object", "id": "PiAndJailbreakFilterResult", "description": "Prompt injection and Jailbreak Filter Result.", "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.", "items": { "$ref": "MessageItem" }, "type": "array" }, "matchState": { "description": "Output only. Match state for Prompt injection and Jailbreak.", "enum": [ "FILTER_MATCH_STATE_UNSPECIFIED", "NO_MATCH_FOUND", "MATCH_FOUND" ], "readOnly": true, "type": "string", "enumDescriptions": [ "Unused", "Matching criteria is not achieved for filters.", "Matching criteria is achieved for the filter." ] }, "confidenceLevel": { "type": "string", "enumDescriptions": [ "Same as LOW_AND_ABOVE.", "Highest chance of a false positive.", "Some chance of false positives.", "Low chance of false positives." ], "description": "Confidence level identified for Prompt injection and Jailbreak.", "enum": [ "DETECTION_CONFIDENCE_LEVEL_UNSPECIFIED", "LOW_AND_ABOVE", "MEDIUM_AND_ABOVE", "HIGH" ] }, "executionState": { "description": "Output only. Reports whether Prompt injection and Jailbreak filter was successfully executed or not.", "enum": [ "FILTER_EXECUTION_STATE_UNSPECIFIED", "EXECUTION_SUCCESS", "EXECUTION_SKIPPED" ], "readOnly": true, "type": "string", "enumDescriptions": [ "Unused", "Filter executed successfully", "Filter execution was skipped. This can happen due to server-side error or permission issue." ] } } }, "FloorSetting": { "properties": { "updateTime": { "readOnly": true, "type": "string", "description": "Output only. [Output only] Update timestamp", "format": "google-datetime" }, "filterConfig": { "$ref": "FilterConfig", "description": "Required. ModelArmor filter configuration." }, "enableFloorSettingEnforcement": { "description": "Optional. Floor Settings enforcement status.", "type": "boolean" }, "integratedServices": { "items": { "enum": [ "INTEGRATED_SERVICE_UNSPECIFIED", "AI_PLATFORM", "GOOGLE_MCP_SERVER" ], "type": "string", "enumDescriptions": [ "Unspecified integrated service.", "AI Platform.", "Google MCP Server (via Shim Service Extension)" ] }, "description": "Optional. List of integrated services for which the floor setting is applicable.", "type": "array" }, "name": { "description": "Identifier. The resource name.", "type": "string" }, "floorSettingMetadata": { "$ref": "FloorSettingMetadata", "description": "Optional. Metadata for FloorSetting" }, "aiPlatformFloorSetting": { "$ref": "AiPlatformFloorSetting", "description": "Optional. AI Platform floor setting." }, "createTime": { "description": "Output only. [Output only] Create timestamp", "format": "google-datetime", "readOnly": true, "type": "string" }, "googleMcpServerFloorSetting": { "description": "Optional. Google MCP Server floor setting.", "$ref": "McpServerFloorSetting" } }, "id": "FloorSetting", "description": "Message describing FloorSetting resource", "type": "object" }, "SdpDeidentifyResult": { "type": "object", "id": "SdpDeidentifyResult", "description": "Sensitive Data Protection Deidentification Result.", "properties": { "matchState": { "enumDescriptions": [ "Unused", "Matching criteria is not achieved for filters.", "Matching criteria is achieved for the filter." ], "readOnly": true, "type": "string", "description": "Output only. Match state for Sensitive Data Protection Deidentification. Value is MATCH_FOUND if content is de-identified.", "enum": [ "FILTER_MATCH_STATE_UNSPECIFIED", "NO_MATCH_FOUND", "MATCH_FOUND" ] }, "infoTypes": { "type": "array", "items": { "type": "string" }, "description": "List of Sensitive Data Protection info-types that were de-identified." }, "executionState": { "readOnly": true, "type": "string", "description": "Output only. Reports whether Sensitive Data Protection deidentification was successfully executed or not.", "enum": [ "FILTER_EXECUTION_STATE_UNSPECIFIED", "EXECUTION_SUCCESS", "EXECUTION_SKIPPED" ], "enumDescriptions": [ "Unused", "Filter executed successfully", "Filter execution was skipped. This can happen due to server-side error or permission issue." ] }, "data": { "description": "De-identified data.", "$ref": "DataItem" }, "messageItems": { "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": "array" }, "transformedBytes": { "type": "string", "description": "Total size in bytes that were transformed during deidentification.", "format": "int64" } } }, "MaliciousUriMatchedItem": { "id": "MaliciousUriMatchedItem", "description": "Information regarding malicious URI and its location within the input content.", "properties": { "uri": { "description": "Malicious URI.", "type": "string" }, "locations": { "type": "array", "items": { "$ref": "RangeInfo" }, "description": "List of locations where Malicious URI is identified. The `locations` field is supported only for plaintext content i.e. ByteItemType.PLAINTEXT_UTF8" } }, "type": "object" }, "ListLocationsResponse": { "type": "object", "properties": { "nextPageToken": { "description": "The standard List next-page token.", "type": "string" }, "locations": { "items": { "$ref": "Location" }, "description": "A list of locations that matches the specified filter in the request.", "type": "array" } }, "id": "ListLocationsResponse", "description": "The response message for Locations.ListLocations." }, "Empty": { "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); }", "properties": {} }, "SdpFinding": { "type": "object", "properties": { "infoType": { "description": "Name of Sensitive Data Protection info type for this finding.", "type": "string" }, "likelihood": { "description": "Identified confidence likelihood for `info_type`.", "enum": [ "SDP_FINDING_LIKELIHOOD_UNSPECIFIED", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "type": "string", "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." ] }, "location": { "$ref": "SdpFindingLocation", "description": "Location for this finding." } }, "id": "SdpFinding", "description": "Finding corresponding to Sensitive Data Protection filter." }, "FilterResult": { "id": "FilterResult", "description": "Filter Result obtained after Sanitization operations.", "properties": { "csamFilterFilterResult": { "description": "CSAM filter results.", "$ref": "CsamFilterResult" }, "sdpFilterResult": { "$ref": "SdpFilterResult", "description": "Sensitive Data Protection results." }, "raiFilterResult": { "$ref": "RaiFilterResult", "description": "Responsible AI filter results." }, "piAndJailbreakFilterResult": { "$ref": "PiAndJailbreakFilterResult", "description": "Prompt injection and Jailbreak filter results." }, "maliciousUriFilterResult": { "description": "Malicious URI filter results.", "$ref": "MaliciousUriFilterResult" }, "virusScanFilterResult": { "$ref": "VirusScanFilterResult", "description": "Virus scan results." } }, "type": "object" }, "SdpFilterResult": { "type": "object", "properties": { "deidentifyResult": { "$ref": "SdpDeidentifyResult", "description": "Sensitive Data Protection Deidentification result if deidentification is performed." }, "inspectResult": { "description": "Sensitive Data Protection Inspection result if inspection is performed.", "$ref": "SdpInspectResult" } }, "id": "SdpFilterResult", "description": "Sensitive Data Protection filter result." }, "RaiFilterSettings": { "id": "RaiFilterSettings", "description": "Responsible AI Filter settings.", "properties": { "raiFilters": { "type": "array", "description": "Required. List of Responsible AI filters enabled for template.", "items": { "$ref": "RaiFilter" } } }, "type": "object" }, "RaiFilter": { "id": "RaiFilter", "description": "Responsible AI filter.", "properties": { "confidenceLevel": { "type": "string", "enumDescriptions": [ "Same as LOW_AND_ABOVE.", "Highest chance of a false positive.", "Some chance of false positives.", "Low chance of false positives." ], "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": { "type": "string", "enumDescriptions": [ "Unspecified filter type.", "Sexually Explicit.", "Hate Speech.", "Harassment.", "Danger" ], "description": "Required. Type of responsible AI filter.", "enum": [ "RAI_FILTER_TYPE_UNSPECIFIED", "SEXUALLY_EXPLICIT", "HATE_SPEECH", "HARASSMENT", "DANGEROUS" ] } }, "type": "object" }, "FloorSettingMetadata": { "properties": { "multiLanguageDetection": { "description": "Optional. Metadata for multi language detection.", "$ref": "FloorSettingFloorSettingMetadataMultiLanguageDetection" } }, "id": "FloorSettingMetadata", "description": "message describing FloorSetting Metadata", "type": "object" }, "RangeInfo": { "id": "RangeInfo", "description": "Half-open range interval [start, end)", "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).", "format": "int64", "type": "string" }, "end": { "description": "Index of last character (exclusive).", "format": "int64", "type": "string" } }, "type": "object" }, "SdpBasicConfig": { "id": "SdpBasicConfig", "description": "Sensitive Data Protection basic configuration.", "properties": { "filterEnforcement": { "description": "Optional. Tells whether the Sensitive Data Protection basic config is enabled or disabled.", "enum": [ "SDP_BASIC_CONFIG_ENFORCEMENT_UNSPECIFIED", "ENABLED", "DISABLED" ], "type": "string", "enumDescriptions": [ "Same as Disabled", "Enabled", "Disabled" ] } }, "type": "object" }, "ByteDataItem": { "type": "object", "id": "ByteDataItem", "description": "Represents Byte Data item.", "properties": { "byteDataType": { "description": "Required. The type of byte data", "enum": [ "BYTE_ITEM_TYPE_UNSPECIFIED", "PLAINTEXT_UTF8", "PDF", "WORD_DOCUMENT", "EXCEL_DOCUMENT", "POWERPOINT_DOCUMENT", "TXT", "CSV" ], "type": "string", "enumDescriptions": [ "Unused", "plain text", "PDF", "DOCX, DOCM, DOTX, DOTM", "XLSX, XLSM, XLTX, XLYM", "PPTX, PPTM, POTX, POTM, POT", "TXT", "CSV" ] }, "byteData": { "description": "Required. Bytes Data", "format": "byte", "type": "string" }, "fileLabel": { "description": "Optional. Label of the file. This is used to identify the file in the response.", "type": "string" } } } }, "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.", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "endpoints": [ { "location": "africa-south1", "endpointUrl": "https://modelarmor.africa-south1.rep.googleapis.com/", "description": "Regional Endpoint" }, { "description": "Regional Endpoint", "endpointUrl": "https://modelarmor.asia-east1.rep.googleapis.com/", "location": "asia-east1" }, { "description": "Regional Endpoint", "location": "asia-east2", "endpointUrl": "https://modelarmor.asia-east2.rep.googleapis.com/" }, { "description": "Regional Endpoint", "endpointUrl": "https://modelarmor.asia-northeast1.rep.googleapis.com/", "location": "asia-northeast1" }, { "description": "Regional Endpoint", "endpointUrl": "https://modelarmor.asia-northeast2.rep.googleapis.com/", "location": "asia-northeast2" }, { "endpointUrl": "https://modelarmor.asia-northeast3.rep.googleapis.com/", "location": "asia-northeast3", "description": "Regional Endpoint" }, { "description": "Regional Endpoint", "endpointUrl": "https://modelarmor.asia-south1.rep.googleapis.com/", "location": "asia-south1" }, { "description": "Regional Endpoint", "location": "asia-south2", "endpointUrl": "https://modelarmor.asia-south2.rep.googleapis.com/" }, { "location": "asia-southeast1", "endpointUrl": "https://modelarmor.asia-southeast1.rep.googleapis.com/", "description": "Regional Endpoint" }, { "description": "Regional Endpoint", "endpointUrl": "https://modelarmor.asia-southeast2.rep.googleapis.com/", "location": "asia-southeast2" }, { "location": "australia-southeast1", "endpointUrl": "https://modelarmor.australia-southeast1.rep.googleapis.com/", "description": "Regional Endpoint" }, { "description": "Regional Endpoint", "endpointUrl": "https://modelarmor.australia-southeast2.rep.googleapis.com/", "location": "australia-southeast2" }, { "endpointUrl": "https://modelarmor.europe-central2.rep.googleapis.com/", "location": "europe-central2", "description": "Regional Endpoint" }, { "description": "Regional Endpoint", "endpointUrl": "https://modelarmor.europe-north1.rep.googleapis.com/", "location": "europe-north1" }, { "location": "europe-north2", "endpointUrl": "https://modelarmor.europe-north2.rep.googleapis.com/", "description": "Regional Endpoint" }, { "location": "europe-southwest1", "endpointUrl": "https://modelarmor.europe-southwest1.rep.googleapis.com/", "description": "Regional Endpoint" }, { "description": "Regional Endpoint", "location": "europe-west1", "endpointUrl": "https://modelarmor.europe-west1.rep.googleapis.com/" }, { "description": "Regional Endpoint", "endpointUrl": "https://modelarmor.europe-west10.rep.googleapis.com/", "location": "europe-west10" }, { "location": "europe-west12", "endpointUrl": "https://modelarmor.europe-west12.rep.googleapis.com/", "description": "Regional Endpoint" }, { "description": "Regional Endpoint", "location": "europe-west2", "endpointUrl": "https://modelarmor.europe-west2.rep.googleapis.com/" }, { "description": "Regional Endpoint", "location": "europe-west3", "endpointUrl": "https://modelarmor.europe-west3.rep.googleapis.com/" }, { "endpointUrl": "https://modelarmor.europe-west4.rep.googleapis.com/", "location": "europe-west4", "description": "Regional Endpoint" }, { "description": "Regional Endpoint", "endpointUrl": "https://modelarmor.europe-west6.rep.googleapis.com/", "location": "europe-west6" }, { "description": "Regional Endpoint", "location": "europe-west8", "endpointUrl": "https://modelarmor.europe-west8.rep.googleapis.com/" }, { "description": "Regional Endpoint", "location": "europe-west9", "endpointUrl": "https://modelarmor.europe-west9.rep.googleapis.com/" }, { "description": "Regional Endpoint", "endpointUrl": "https://modelarmor.me-central1.rep.googleapis.com/", "location": "me-central1" }, { "description": "Regional Endpoint", "endpointUrl": "https://modelarmor.me-central2.rep.googleapis.com/", "location": "me-central2" }, { "description": "Regional Endpoint", "location": "me-west1", "endpointUrl": "https://modelarmor.me-west1.rep.googleapis.com/" }, { "location": "northamerica-northeast1", "endpointUrl": "https://modelarmor.northamerica-northeast1.rep.googleapis.com/", "description": "Regional Endpoint" }, { "description": "Regional Endpoint", "location": "northamerica-northeast2", "endpointUrl": "https://modelarmor.northamerica-northeast2.rep.googleapis.com/" }, { "description": "Regional Endpoint", "endpointUrl": "https://modelarmor.northamerica-south1.rep.googleapis.com/", "location": "northamerica-south1" }, { "location": "southamerica-east1", "endpointUrl": "https://modelarmor.southamerica-east1.rep.googleapis.com/", "description": "Regional Endpoint" }, { "endpointUrl": "https://modelarmor.southamerica-west1.rep.googleapis.com/", "location": "southamerica-west1", "description": "Regional Endpoint" }, { "description": "Regional Endpoint", "endpointUrl": "https://modelarmor.us-central1.rep.googleapis.com/", "location": "us-central1" }, { "description": "Regional Endpoint", "endpointUrl": "https://modelarmor.us-east1.rep.googleapis.com/", "location": "us-east1" }, { "description": "Regional Endpoint", "endpointUrl": "https://modelarmor.us-east4.rep.googleapis.com/", "location": "us-east4" }, { "description": "Regional Endpoint", "endpointUrl": "https://modelarmor.us-east5.rep.googleapis.com/", "location": "us-east5" }, { "location": "us-east7", "endpointUrl": "https://modelarmor.us-east7.rep.googleapis.com/", "description": "Regional Endpoint" }, { "location": "us-south1", "endpointUrl": "https://modelarmor.us-south1.rep.googleapis.com/", "description": "Regional Endpoint" }, { "location": "us-west1", "endpointUrl": "https://modelarmor.us-west1.rep.googleapis.com/", "description": "Regional Endpoint" }, { "description": "Regional Endpoint", "location": "us-west2", "endpointUrl": "https://modelarmor.us-west2.rep.googleapis.com/" }, { "location": "us-west3", "endpointUrl": "https://modelarmor.us-west3.rep.googleapis.com/", "description": "Regional Endpoint" }, { "endpointUrl": "https://modelarmor.us-west4.rep.googleapis.com/", "location": "us-west4", "description": "Regional Endpoint" }, { "description": "Regional Endpoint", "location": "us", "endpointUrl": "https://modelarmor.us.rep.googleapis.com/" }, { "description": "Regional Endpoint", "endpointUrl": "https://modelarmor.eu.rep.googleapis.com/", "location": "eu" } ], "revision": "20260422" }