google-cloud-modelarmor 0.7.2__tar.gz → 0.7.4__tar.gz

{google_cloud_modelarmor-0.7.2/google_cloud_modelarmor.egg-info → google_cloud_modelarmor-0.7.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: google-cloud-modelarmor
-Version: 0.7.2
+Version: 0.7.4
 Summary: Google Cloud Modelarmor API client library
 Home-page: https://github.com/googleapis/google-cloud-python/tree/main/packages/google-cloud-modelarmor
 Author: Google LLC

{google_cloud_modelarmor-0.7.2 → google_cloud_modelarmor-0.7.4}/google/cloud/modelarmor/__init__.py

@@ -30,10 +30,18 @@ from google.cloud.modelarmor_v1.types.service import (
     DataItem,
     DeleteTemplateRequest,
     DetectionConfidenceLevel,
+    Dictionary,
+    ExclusionRule,
     FilterConfig,
     FilterExecutionState,
     FilterMatchState,
     FilterResult,
+    FilterRule,
+    FilterRuleSet,
+    FilterRuleSettings,
+    FilterVersionAlias,
+    FilterVersionConfig,
+    FilterVersionSelector,
     FloorSetting,
     GetFloorSettingRequest,
     GetTemplateRequest,
@@ -42,6 +50,8 @@ from google.cloud.modelarmor_v1.types.service import (
     ListTemplatesResponse,
     MaliciousUriFilterResult,
     MaliciousUriFilterSettings,
+    MatchingScope,
+    McpServerFloorSetting,
     MessageItem,
     Modality,
     MultiLanguageDetectionMetadata,
@@ -51,6 +61,8 @@ from google.cloud.modelarmor_v1.types.service import (
     RaiFilterSettings,
     RaiFilterType,
     RangeInfo,
+    Regex,
+    RuleFilterType,
     SanitizationResult,
     SanitizeModelResponseRequest,
     SanitizeModelResponseResponse,
@@ -73,6 +85,7 @@ from google.cloud.modelarmor_v1.types.service import (
     UpdateTemplateRequest,
     VirusDetail,
     VirusScanFilterResult,
+    WordList,
 )
 
 __all__ = (
@@ -84,8 +97,15 @@ __all__ = (
     "CsamFilterResult",
     "DataItem",
     "DeleteTemplateRequest",
+    "Dictionary",
+    "ExclusionRule",
     "FilterConfig",
     "FilterResult",
+    "FilterRule",
+    "FilterRuleSet",
+    "FilterRuleSettings",
+    "FilterVersionConfig",
+    "FilterVersionSelector",
     "FloorSetting",
     "GetFloorSettingRequest",
     "GetTemplateRequest",
@@ -93,6 +113,7 @@ __all__ = (
     "ListTemplatesResponse",
     "MaliciousUriFilterResult",
     "MaliciousUriFilterSettings",
+    "McpServerFloorSetting",
     "MessageItem",
     "MultiLanguageDetectionMetadata",
     "PiAndJailbreakFilterResult",
@@ -100,6 +121,7 @@ __all__ = (
     "RaiFilterResult",
     "RaiFilterSettings",
     "RangeInfo",
+    "Regex",
     "SanitizationResult",
     "SanitizeModelResponseRequest",
     "SanitizeModelResponseResponse",
@@ -120,12 +142,16 @@ __all__ = (
     "UpdateTemplateRequest",
     "VirusDetail",
     "VirusScanFilterResult",
+    "WordList",
     "DetectionConfidenceLevel",
     "FilterExecutionState",
     "FilterMatchState",
+    "FilterVersionAlias",
     "InvocationResult",
+    "MatchingScope",
     "Modality",
     "RaiFilterType",
+    "RuleFilterType",
     "SdpFindingLikelihood",
     "StreamingMode",
 )

{google_cloud_modelarmor-0.7.2 → google_cloud_modelarmor-0.7.4}/google/cloud/modelarmor/gapic_version.py

@@ -13,4 +13,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-__version__ = "0.7.2"  # {x-release-please-version}
+__version__ = "0.7.4"  # {x-release-please-version}

{google_cloud_modelarmor-0.7.2 → google_cloud_modelarmor-0.7.4}/google/cloud/modelarmor_v1/__init__.py

@@ -40,10 +40,18 @@ from .types.service import (
     DataItem,
     DeleteTemplateRequest,
     DetectionConfidenceLevel,
+    Dictionary,
+    ExclusionRule,
     FilterConfig,
     FilterExecutionState,
     FilterMatchState,
     FilterResult,
+    FilterRule,
+    FilterRuleSet,
+    FilterRuleSettings,
+    FilterVersionAlias,
+    FilterVersionConfig,
+    FilterVersionSelector,
     FloorSetting,
     GetFloorSettingRequest,
     GetTemplateRequest,
@@ -52,6 +60,8 @@ from .types.service import (
     ListTemplatesResponse,
     MaliciousUriFilterResult,
     MaliciousUriFilterSettings,
+    MatchingScope,
+    McpServerFloorSetting,
     MessageItem,
     Modality,
     MultiLanguageDetectionMetadata,
@@ -61,6 +71,8 @@ from .types.service import (
     RaiFilterSettings,
     RaiFilterType,
     RangeInfo,
+    Regex,
+    RuleFilterType,
     SanitizationResult,
     SanitizeModelResponseRequest,
     SanitizeModelResponseResponse,
@@ -83,6 +95,7 @@ from .types.service import (
     UpdateTemplateRequest,
     VirusDetail,
     VirusScanFilterResult,
+    WordList,
 )
 
 __all__ = (
@@ -94,10 +107,18 @@ __all__ = (
     "DataItem",
     "DeleteTemplateRequest",
     "DetectionConfidenceLevel",
+    "Dictionary",
+    "ExclusionRule",
     "FilterConfig",
     "FilterExecutionState",
     "FilterMatchState",
     "FilterResult",
+    "FilterRule",
+    "FilterRuleSet",
+    "FilterRuleSettings",
+    "FilterVersionAlias",
+    "FilterVersionConfig",
+    "FilterVersionSelector",
     "FloorSetting",
     "GetFloorSettingRequest",
     "GetTemplateRequest",
@@ -106,6 +127,8 @@ __all__ = (
     "ListTemplatesResponse",
     "MaliciousUriFilterResult",
     "MaliciousUriFilterSettings",
+    "MatchingScope",
+    "McpServerFloorSetting",
     "MessageItem",
     "Modality",
     "ModelArmorClient",
@@ -116,6 +139,8 @@ __all__ = (
     "RaiFilterSettings",
     "RaiFilterType",
     "RangeInfo",
+    "Regex",
+    "RuleFilterType",
     "SanitizationResult",
     "SanitizeModelResponseRequest",
     "SanitizeModelResponseResponse",
@@ -138,6 +163,7 @@ __all__ = (
     "UpdateTemplateRequest",
     "VirusDetail",
     "VirusScanFilterResult",
+    "WordList",
 )
 
 api_core.check_python_version("google.cloud.modelarmor_v1")

{google_cloud_modelarmor-0.7.2/google/cloud/modelarmor_v1beta → google_cloud_modelarmor-0.7.4/google/cloud/modelarmor_v1}/gapic_version.py

@@ -13,4 +13,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-__version__ = "0.7.2"  # {x-release-please-version}
+__version__ = "0.7.4"  # {x-release-please-version}

{google_cloud_modelarmor-0.7.2 → google_cloud_modelarmor-0.7.4}/google/cloud/modelarmor_v1/types/__init__.py

@@ -21,10 +21,18 @@ from .service import (
     DataItem,
     DeleteTemplateRequest,
     DetectionConfidenceLevel,
+    Dictionary,
+    ExclusionRule,
     FilterConfig,
     FilterExecutionState,
     FilterMatchState,
     FilterResult,
+    FilterRule,
+    FilterRuleSet,
+    FilterRuleSettings,
+    FilterVersionAlias,
+    FilterVersionConfig,
+    FilterVersionSelector,
     FloorSetting,
     GetFloorSettingRequest,
     GetTemplateRequest,
@@ -33,6 +41,8 @@ from .service import (
     ListTemplatesResponse,
     MaliciousUriFilterResult,
     MaliciousUriFilterSettings,
+    MatchingScope,
+    McpServerFloorSetting,
     MessageItem,
     Modality,
     MultiLanguageDetectionMetadata,
@@ -42,6 +52,8 @@ from .service import (
     RaiFilterSettings,
     RaiFilterType,
     RangeInfo,
+    Regex,
+    RuleFilterType,
     SanitizationResult,
     SanitizeModelResponseRequest,
     SanitizeModelResponseResponse,
@@ -64,6 +76,7 @@ from .service import (
     UpdateTemplateRequest,
     VirusDetail,
     VirusScanFilterResult,
+    WordList,
 )
 
 __all__ = (
@@ -73,8 +86,15 @@ __all__ = (
     "CsamFilterResult",
     "DataItem",
     "DeleteTemplateRequest",
+    "Dictionary",
+    "ExclusionRule",
     "FilterConfig",
     "FilterResult",
+    "FilterRule",
+    "FilterRuleSet",
+    "FilterRuleSettings",
+    "FilterVersionConfig",
+    "FilterVersionSelector",
     "FloorSetting",
     "GetFloorSettingRequest",
     "GetTemplateRequest",
@@ -82,6 +102,7 @@ __all__ = (
     "ListTemplatesResponse",
     "MaliciousUriFilterResult",
     "MaliciousUriFilterSettings",
+    "McpServerFloorSetting",
     "MessageItem",
     "MultiLanguageDetectionMetadata",
     "PiAndJailbreakFilterResult",
@@ -89,6 +110,7 @@ __all__ = (
     "RaiFilterResult",
     "RaiFilterSettings",
     "RangeInfo",
+    "Regex",
     "SanitizationResult",
     "SanitizeModelResponseRequest",
     "SanitizeModelResponseResponse",
@@ -109,12 +131,16 @@ __all__ = (
     "UpdateTemplateRequest",
     "VirusDetail",
     "VirusScanFilterResult",
+    "WordList",
     "DetectionConfidenceLevel",
     "FilterExecutionState",
     "FilterMatchState",
+    "FilterVersionAlias",
     "InvocationResult",
+    "MatchingScope",
     "Modality",
     "RaiFilterType",
+    "RuleFilterType",
     "SdpFindingLikelihood",
     "StreamingMode",
 )

{google_cloud_modelarmor-0.7.2 → google_cloud_modelarmor-0.7.4}/google/cloud/modelarmor_v1/types/service.py

@@ -19,6 +19,7 @@ from typing import MutableMapping, MutableSequence
 
 import google.protobuf.field_mask_pb2 as field_mask_pb2  # type: ignore
 import google.protobuf.timestamp_pb2 as timestamp_pb2  # type: ignore
+import google.type.date_pb2 as date_pb2  # type: ignore
 import proto  # type: ignore
 
 __protobuf__ = proto.module(
@@ -32,8 +33,13 @@ __protobuf__ = proto.module(
         "InvocationResult",
         "StreamingMode",
         "Modality",
+        "FilterVersionAlias",
+        "MatchingScope",
+        "RuleFilterType",
+        "FilterVersionSelector",
         "Template",
         "FloorSetting",
+        "McpServerFloorSetting",
         "AiPlatformFloorSetting",
         "ListTemplatesRequest",
         "ListTemplatesResponse",
@@ -54,6 +60,7 @@ __protobuf__ = proto.module(
         "SanitizeModelResponseRequest",
         "SanitizeUserPromptResponse",
         "SanitizeModelResponseResponse",
+        "FilterVersionConfig",
         "SanitizationResult",
         "MultiLanguageDetectionMetadata",
         "FilterResult",
@@ -67,6 +74,13 @@ __protobuf__ = proto.module(
         "SdpContentLocation",
         "SdpFinding",
         "SdpRedactResult",
+        "WordList",
+        "Dictionary",
+        "Regex",
+        "ExclusionRule",
+        "FilterRule",
+        "FilterRuleSet",
+        "FilterRuleSettings",
         "PiAndJailbreakFilterResult",
         "MaliciousUriFilterResult",
         "VirusScanFilterResult",
@@ -228,8 +242,9 @@ class StreamingMode(proto.Enum):
 
 
 class Modality(proto.Enum):
-    r"""This enum is used in the TemplateMetadata message to indicate
-    the modality supported for sanitize API calls.
+    r"""This enum is used in the TemplateMetadata and
+    FloorSettingMetadata messages to indicate the modality supported
+    for sanitize API calls.
 
     Values:
         MODALITY_UNSPECIFIED (0):
@@ -252,6 +267,134 @@ class Modality(proto.Enum):
     MODALITY_IMAGE = 2
 
 
+class FilterVersionAlias(proto.Enum):
+    r"""Enum for Filter Version Aliases.
+    These aliases provide a way to always point to a specific track
+    without needing to update the version in templates.
+
+    Values:
+        FILTER_VERSION_ALIAS_UNSPECIFIED (0):
+            The default value. If used, it will resolve to the
+            ``STABLE`` alias.
+        FILTER_VERSION_ALIAS_STABLE (1):
+            ``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.
+        FILTER_VERSION_ALIAS_LATEST (2):
+            ``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.
+        FILTER_VERSION_ALIAS_LEGACY (3):
+            ``LEGACY`` alias could be used for sanitization operations
+            for a transition period. New templates cannot be created
+            with this version.
+        FILTER_VERSION_ALIAS_RETIRED (4):
+            ``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.
+    """
+
+    FILTER_VERSION_ALIAS_UNSPECIFIED = 0
+    FILTER_VERSION_ALIAS_STABLE = 1
+    FILTER_VERSION_ALIAS_LATEST = 2
+    FILTER_VERSION_ALIAS_LEGACY = 3
+    FILTER_VERSION_ALIAS_RETIRED = 4
+
+
+class MatchingScope(proto.Enum):
+    r"""Defines the scope of the match for a rule.
+
+    Additional values may be added to this enum in the future.
+
+    Values:
+        MATCHING_SCOPE_UNSPECIFIED (0):
+            Unspecified matching scope.
+        MATCHING_SCOPE_FULL_MATCH (1):
+            Full match.
+
+            - Dictionary: the dictionary match covers the
+              entire input content
+            - Regular expression: the regular expression
+              pattern matches the entire input content
+        MATCHING_SCOPE_PARTIAL_MATCH (2):
+            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
+    """
+
+    MATCHING_SCOPE_UNSPECIFIED = 0
+    MATCHING_SCOPE_FULL_MATCH = 1
+    MATCHING_SCOPE_PARTIAL_MATCH = 2
+
+
+class RuleFilterType(proto.Enum):
+    r"""Model Armor Filter types supported for rules.
+
+    Values:
+        RULE_FILTER_TYPE_UNSPECIFIED (0):
+            Unspecified filter type.
+        PROMPT_INJECTION_AND_JAILBREAK (1):
+            Prompt injection and jailbreak filter.
+        RESPONSIBLE_AI (2):
+            Responsible AI filter.
+    """
+
+    RULE_FILTER_TYPE_UNSPECIFIED = 0
+    PROMPT_INJECTION_AND_JAILBREAK = 1
+    RESPONSIBLE_AI = 2
+
+
+class FilterVersionSelector(proto.Message):
+    r"""Represents the configuration for selecting a Filter Version.
+    Allows customers to choose to use either a specific version or a
+    predefined alias.
+
+    This message has `oneof`_ fields (mutually exclusive fields).
+    For each oneof, at most one member field can be set at the same time.
+    Setting any member of the oneof automatically clears all other
+    members.
+
+    .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
+
+    Attributes:
+        version (str):
+            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.
+
+            This field is a member of `oneof`_ ``version_spec``.
+        alias (google.cloud.modelarmor_v1.types.FilterVersionAlias):
+            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.
+
+            This field is a member of `oneof`_ ``version_spec``.
+    """
+
+    version: str = proto.Field(
+        proto.STRING,
+        number=1,
+        oneof="version_spec",
+    )
+    alias: "FilterVersionAlias" = proto.Field(
+        proto.ENUM,
+        number=2,
+        oneof="version_spec",
+        enum="FilterVersionAlias",
+    )
+
+
 class Template(proto.Message):
     r"""Message describing Template resource
 
@@ -274,6 +417,8 @@ class Template(proto.Message):
     class TemplateMetadata(proto.Message):
         r"""Message describing TemplateMetadata
 
+        .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
+
         Attributes:
             ignore_partial_invocation_failures (bool):
                 Optional. If true, partial detector failures
@@ -306,9 +451,27 @@ class Template(proto.Message):
             multi_language_detection (google.cloud.modelarmor_v1.types.Template.TemplateMetadata.MultiLanguageDetection):
                 Optional. Metadata for multi language
                 detection.
+            filter_version_selector (google.cloud.modelarmor_v1.types.FilterVersionSelector):
+                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``.
+
+                This field is a member of `oneof`_ ``_filter_version_selector``.
             modalities (MutableSequence[google.cloud.modelarmor_v1.types.Modality]):
                 Optional. Specifies the modalities to scan.
-                If empty, only text modality will be scanned.
+                If not specified or empty, only text modality
+                will be scanned.
+            data_residency_compliant (bool):
+                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.
+
+                This field is a member of `oneof`_ ``_data_residency_compliant``.
         """
 
         class EnforcementType(proto.Enum):
@@ -384,11 +547,22 @@ class Template(proto.Message):
                 message="Template.TemplateMetadata.MultiLanguageDetection",
             )
         )
+        filter_version_selector: "FilterVersionSelector" = proto.Field(
+            proto.MESSAGE,
+            number=10,
+            optional=True,
+            message="FilterVersionSelector",
+        )
         modalities: MutableSequence["Modality"] = proto.RepeatedField(
             proto.ENUM,
             number=11,
             enum="Modality",
         )
+        data_residency_compliant: bool = proto.Field(
+            proto.BOOL,
+            number=12,
+            optional=True,
+        )
 
     name: str = proto.Field(
         proto.STRING,
@@ -448,6 +622,10 @@ class FloorSetting(proto.Message):
             This field is a member of `oneof`_ ``_ai_platform_floor_setting``.
         floor_setting_metadata (google.cloud.modelarmor_v1.types.FloorSetting.FloorSettingMetadata):
             Optional. Metadata for FloorSetting
+        google_mcp_server_floor_setting (google.cloud.modelarmor_v1.types.McpServerFloorSetting):
+            Optional. Google MCP Server floor setting.
+
+            This field is a member of `oneof`_ ``_google_mcp_server_floor_setting``.
     """
 
     class IntegratedService(proto.Enum):
@@ -458,10 +636,14 @@ class FloorSetting(proto.Message):
                 Unspecified integrated service.
             AI_PLATFORM (1):
                 AI Platform.
+            GOOGLE_MCP_SERVER (2):
+                Google MCP Server (via Shim Service
+                Extension)
         """
 
         INTEGRATED_SERVICE_UNSPECIFIED = 0
         AI_PLATFORM = 1
+        GOOGLE_MCP_SERVER = 2
 
     class FloorSettingMetadata(proto.Message):
         r"""message describing FloorSetting Metadata
@@ -533,6 +715,56 @@ class FloorSetting(proto.Message):
         number=8,
         message=FloorSettingMetadata,
     )
+    google_mcp_server_floor_setting: "McpServerFloorSetting" = proto.Field(
+        proto.MESSAGE,
+        number=9,
+        optional=True,
+        message="McpServerFloorSetting",
+    )
+
+
+class McpServerFloorSetting(proto.Message):
+    r"""Message describing MCP Server Floor Setting.
+
+    This message has `oneof`_ fields (mutually exclusive fields).
+    For each oneof, at most one member field can be set at the same time.
+    Setting any member of the oneof automatically clears all other
+    members.
+
+    .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
+
+    Attributes:
+        inspect_only (bool):
+            Optional. If true, Model Armor filters will
+            be run in inspect only mode. No action will be
+            taken on the request.
+
+            This field is a member of `oneof`_ ``enforcement_type``.
+        inspect_and_block (bool):
+            Optional. If true, Model Armor filters will
+            be run in inspect and block mode. Requests that
+            trip Model Armor filters will be blocked.
+
+            This field is a member of `oneof`_ ``enforcement_type``.
+        enable_cloud_logging (bool):
+            Optional. If true, log Model Armor filter
+            results to Cloud Logging.
+    """
+
+    inspect_only: bool = proto.Field(
+        proto.BOOL,
+        number=1,
+        oneof="enforcement_type",
+    )
+    inspect_and_block: bool = proto.Field(
+        proto.BOOL,
+        number=2,
+        oneof="enforcement_type",
+    )
+    enable_cloud_logging: bool = proto.Field(
+        proto.BOOL,
+        number=3,
+    )
 
 
 class AiPlatformFloorSetting(proto.Message):
@@ -865,6 +1097,10 @@ class FilterConfig(proto.Message):
             filter settings.
         malicious_uri_filter_settings (google.cloud.modelarmor_v1.types.MaliciousUriFilterSettings):
             Optional. Malicious URI filter settings.
+        filter_rule_settings (google.cloud.modelarmor_v1.types.FilterRuleSettings):
+            Optional. Settings for customizing filter
+            rules. Note: This field is not supported in
+            FloorSetting and Streaming Sanitization APIs.
     """
 
     rai_settings: "RaiFilterSettings" = proto.Field(
@@ -887,6 +1123,11 @@ class FilterConfig(proto.Message):
         number=4,
         message="MaliciousUriFilterSettings",
     )
+    filter_rule_settings: "FilterRuleSettings" = proto.Field(
+        proto.MESSAGE,
+        number=7,
+        message="FilterRuleSettings",
+    )
 
 
 class PiAndJailbreakFilterSettings(proto.Message):
@@ -1251,6 +1492,66 @@ class SanitizeModelResponseResponse(proto.Message):
     )
 
 
+class FilterVersionConfig(proto.Message):
+    r"""Message describing a Filter Version Configuration.
+
+    .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
+
+    Attributes:
+        filter_version (str):
+            Output only. The identifier for this specific
+            version.
+        filter_version_alias (google.cloud.modelarmor_v1.types.FilterVersionAlias):
+            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.
+
+            This field is a member of `oneof`_ ``_filter_version_alias``.
+        release_date (google.type.date_pb2.Date):
+            Output only. The date when this version was
+            released.
+
+            This field is a member of `oneof`_ ``_release_date``.
+        projected_deprecation_date (google.type.date_pb2.Date):
+            Output only. The estimated date when this
+            version is projected to be deprecated.
+
+            This field is a member of `oneof`_ ``_projected_deprecation_date``.
+        message_items (MutableSequence[google.cloud.modelarmor_v1.types.MessageItem]):
+            Output only. Extra information regarding this
+            filter version
+    """
+
+    filter_version: str = proto.Field(
+        proto.STRING,
+        number=1,
+    )
+    filter_version_alias: "FilterVersionAlias" = proto.Field(
+        proto.ENUM,
+        number=2,
+        optional=True,
+        enum="FilterVersionAlias",
+    )
+    release_date: date_pb2.Date = proto.Field(
+        proto.MESSAGE,
+        number=3,
+        optional=True,
+        message=date_pb2.Date,
+    )
+    projected_deprecation_date: date_pb2.Date = proto.Field(
+        proto.MESSAGE,
+        number=4,
+        optional=True,
+        message=date_pb2.Date,
+    )
+    message_items: MutableSequence["MessageItem"] = proto.RepeatedField(
+        proto.MESSAGE,
+        number=5,
+        message="MessageItem",
+    )
+
+
 class SanitizationResult(proto.Message):
     r"""Sanitization result after applying all the filters on input
     content.
@@ -1270,7 +1571,7 @@ class SanitizationResult(proto.Message):
         filter_results (MutableMapping[str, google.cloud.modelarmor_v1.types.FilterResult]):
             Output only. Results for all filters where the key is the
             filter name - either of "csam", "malicious_uris", "rai",
-            "pi_and_jailbreak" ,"sdp".
+            "pi_and_jailbreak", "sdp".
         invocation_result (google.cloud.modelarmor_v1.types.InvocationResult):
             Output only. A field indicating the outcome
             of the invocation, irrespective of match status.
@@ -1299,6 +1600,10 @@ class SanitizationResult(proto.Message):
             stream_chunk_processed (google.cloud.modelarmor_v1.types.DataItem):
                 Output only. The stream chunk processed by
                 the Sanitization service.
+            filter_version_config (google.cloud.modelarmor_v1.types.FilterVersionConfig):
+                Output only. Provides details about the
+                Filter Version configuration used to sanitize
+                this request.
         """
 
         error_code: int = proto.Field(
@@ -1318,6 +1623,11 @@ class SanitizationResult(proto.Message):
             number=4,
             message="DataItem",
         )
+        filter_version_config: "FilterVersionConfig" = proto.Field(
+            proto.MESSAGE,
+            number=6,
+            message="FilterVersionConfig",
+        )
 
     filter_match_state: "FilterMatchState" = proto.Field(
         proto.ENUM,
@@ -1347,11 +1657,20 @@ class MultiLanguageDetectionMetadata(proto.Message):
 
     Attributes:
         source_language (str):
-            Optional. Optional Source language of the
-            user prompt.
-            If multi-language detection is enabled but
-            language is not set in that case we would
-            automatically detect the source language.
+            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>`__.
         enable_multi_language_detection (bool):
             Optional. Enable detection of multi-language
             prompts and responses.
@@ -1462,9 +1781,10 @@ class RaiFilterResult(proto.Message):
             equal to or higher than the confidence level defined in
             configuration.
         rai_filter_type_results (MutableMapping[str, google.cloud.modelarmor_v1.types.RaiFilterResult.RaiFilterTypeResult]):
-            The map of RAI filter results where key is RAI filter type -
-            either of "sexually_explicit", "hate_speech", "harassment",
-            "dangerous", "violence", "sexually_suggestive".
+            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".
     """
 
     class RaiFilterTypeResult(proto.Message):
@@ -1674,6 +1994,9 @@ class ByteDataItem(proto.Message):
             Required. The type of byte data
         byte_data (bytes):
             Required. Bytes Data
+        file_label (str):
+            Optional. Label of the file. This is used to
+            identify the file in the response.
     """
 
     class ByteItemType(proto.Enum):
@@ -1719,6 +2042,10 @@ class ByteDataItem(proto.Message):
         proto.BYTES,
         number=2,
     )
+    file_label: str = proto.Field(
+        proto.STRING,
+        number=3,
+    )
 
 
 class SdpDeidentifyResult(proto.Message):
@@ -1995,6 +2322,189 @@ class SdpRedactResult(proto.Message):
     )
 
 
+class WordList(proto.Message):
+    r"""Message defining a list of words or phrases.
+
+    Attributes:
+        words (MutableSequence[str]):
+            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.
+    """
+
+    words: MutableSequence[str] = proto.RepeatedField(
+        proto.STRING,
+        number=1,
+    )
+
+
+class Dictionary(proto.Message):
+    r"""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>`__.
+
+
+    .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
+
+    Attributes:
+        word_list (google.cloud.modelarmor_v1.types.WordList):
+            Message defining a list of words or phrases.
+
+            This field is a member of `oneof`_ ``source``.
+    """
+
+    word_list: "WordList" = proto.Field(
+        proto.MESSAGE,
+        number=1,
+        oneof="source",
+        message="WordList",
+    )
+
+
+class Regex(proto.Message):
+    r"""Message defining a custom regular expression.
+
+    Attributes:
+        pattern (str):
+            Required. The regular expression pattern.
+    """
+
+    pattern: str = proto.Field(
+        proto.STRING,
+        number=1,
+    )
+
+
+class ExclusionRule(proto.Message):
+    r"""The rule that specifies conditions when filter detections are
+    excluded from results.
+
+    This message has `oneof`_ fields (mutually exclusive fields).
+    For each oneof, at most one member field can be set at the same time.
+    Setting any member of the oneof automatically clears all other
+    members.
+
+    .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
+
+    Attributes:
+        dictionary (google.cloud.modelarmor_v1.types.Dictionary):
+            Dictionary which defines the rule.
+
+            This field is a member of `oneof`_ ``type``.
+        regex (google.cloud.modelarmor_v1.types.Regex):
+            Regular expression which defines the rule.
+
+            This field is a member of `oneof`_ ``type``.
+        matching_scope (google.cloud.modelarmor_v1.types.MatchingScope):
+            Optional. Specifies the scope of the input that should be
+            matched against the exclusion rule. If unspecified, defaults
+            to MATCHING_SCOPE_PARTIAL_MATCH.
+
+            This field is a member of `oneof`_ ``_matching_scope``.
+    """
+
+    dictionary: "Dictionary" = proto.Field(
+        proto.MESSAGE,
+        number=1,
+        oneof="type",
+        message="Dictionary",
+    )
+    regex: "Regex" = proto.Field(
+        proto.MESSAGE,
+        number=2,
+        oneof="type",
+        message="Regex",
+    )
+    matching_scope: "MatchingScope" = proto.Field(
+        proto.ENUM,
+        number=3,
+        optional=True,
+        enum="MatchingScope",
+    )
+
+
+class FilterRule(proto.Message):
+    r"""A single rule to be applied to filters, specified in
+    ``FilterRuleSet``.
+
+
+    .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
+
+    Attributes:
+        exclusion_rule (google.cloud.modelarmor_v1.types.ExclusionRule):
+            Exclusion rule.
+
+            This field is a member of `oneof`_ ``type``.
+    """
+
+    exclusion_rule: "ExclusionRule" = proto.Field(
+        proto.MESSAGE,
+        number=1,
+        oneof="type",
+        message="ExclusionRule",
+    )
+
+
+class FilterRuleSet(proto.Message):
+    r"""A set of rules that modifies the behavior of specific filters
+    based on the rules defined within the set.
+
+    Attributes:
+        filter_types (MutableSequence[google.cloud.modelarmor_v1.types.RuleFilterType]):
+            Required. List of filters this rule set is
+            applied to.
+        rules (MutableSequence[google.cloud.modelarmor_v1.types.FilterRule]):
+            Required. Set of rules to be applied to
+            filterTypes.
+    """
+
+    filter_types: MutableSequence["RuleFilterType"] = proto.RepeatedField(
+        proto.ENUM,
+        number=1,
+        enum="RuleFilterType",
+    )
+    rules: MutableSequence["FilterRule"] = proto.RepeatedField(
+        proto.MESSAGE,
+        number=2,
+        message="FilterRule",
+    )
+
+
+class FilterRuleSettings(proto.Message):
+    r"""Settings for customizing filter rules.
+
+    Attributes:
+        rule_sets (MutableSequence[google.cloud.modelarmor_v1.types.FilterRuleSet]):
+            Optional. List of rule sets to be applied to
+            filters.
+    """
+
+    rule_sets: MutableSequence["FilterRuleSet"] = proto.RepeatedField(
+        proto.MESSAGE,
+        number=1,
+        message="FilterRuleSet",
+    )
+
+
 class PiAndJailbreakFilterResult(proto.Message):
     r"""Prompt injection and Jailbreak Filter Result.
 

{google_cloud_modelarmor-0.7.2/google/cloud/modelarmor_v1 → google_cloud_modelarmor-0.7.4/google/cloud/modelarmor_v1beta}/gapic_version.py

@@ -13,4 +13,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-__version__ = "0.7.2"  # {x-release-please-version}
+__version__ = "0.7.4"  # {x-release-please-version}

{google_cloud_modelarmor-0.7.2 → google_cloud_modelarmor-0.7.4/google_cloud_modelarmor.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: google-cloud-modelarmor
-Version: 0.7.2
+Version: 0.7.4
 Summary: Google Cloud Modelarmor API client library
 Home-page: https://github.com/googleapis/google-cloud-python/tree/main/packages/google-cloud-modelarmor
 Author: Google LLC

{google_cloud_modelarmor-0.7.2 → google_cloud_modelarmor-0.7.4}/tests/unit/gapic/modelarmor_v1/test_model_armor.py

@@ -6864,6 +6864,26 @@ def test_create_template_rest_call_success(request_type):
                 "confidence_level": 1,
             },
             "malicious_uri_filter_settings": {"filter_enforcement": 1},
+            "filter_rule_settings": {
+                "rule_sets": [
+                    {
+                        "filter_types": [1],
+                        "rules": [
+                            {
+                                "exclusion_rule": {
+                                    "dictionary": {
+                                        "word_list": {
+                                            "words": ["words_value1", "words_value2"]
+                                        }
+                                    },
+                                    "regex": {"pattern": "pattern_value"},
+                                    "matching_scope": 1,
+                                }
+                            }
+                        ],
+                    }
+                ]
+            },
         },
         "template_metadata": {
             "ignore_partial_invocation_failures": True,
@@ -6875,7 +6895,9 @@ def test_create_template_rest_call_success(request_type):
             "log_sanitize_operations": True,
             "enforcement_type": 1,
             "multi_language_detection": {"enable_multi_language_detection": True},
+            "filter_version_selector": {"version": "version_value", "alias": 1},
             "modalities": [1],
+            "data_residency_compliant": True,
         },
     }
     # The version of a generated dependency at test runtime may differ from the version used during generation.
@@ -7096,6 +7118,26 @@ def test_update_template_rest_call_success(request_type):
                 "confidence_level": 1,
             },
             "malicious_uri_filter_settings": {"filter_enforcement": 1},
+            "filter_rule_settings": {
+                "rule_sets": [
+                    {
+                        "filter_types": [1],
+                        "rules": [
+                            {
+                                "exclusion_rule": {
+                                    "dictionary": {
+                                        "word_list": {
+                                            "words": ["words_value1", "words_value2"]
+                                        }
+                                    },
+                                    "regex": {"pattern": "pattern_value"},
+                                    "matching_scope": 1,
+                                }
+                            }
+                        ],
+                    }
+                ]
+            },
         },
         "template_metadata": {
             "ignore_partial_invocation_failures": True,
@@ -7107,7 +7149,9 @@ def test_update_template_rest_call_success(request_type):
             "log_sanitize_operations": True,
             "enforcement_type": 1,
             "multi_language_detection": {"enable_multi_language_detection": True},
+            "filter_version_selector": {"version": "version_value", "alias": 1},
             "modalities": [1],
+            "data_residency_compliant": True,
         },
     }
     # The version of a generated dependency at test runtime may differ from the version used during generation.
@@ -7569,6 +7613,26 @@ def test_update_floor_setting_rest_call_success(request_type):
                 "confidence_level": 1,
             },
             "malicious_uri_filter_settings": {"filter_enforcement": 1},
+            "filter_rule_settings": {
+                "rule_sets": [
+                    {
+                        "filter_types": [1],
+                        "rules": [
+                            {
+                                "exclusion_rule": {
+                                    "dictionary": {
+                                        "word_list": {
+                                            "words": ["words_value1", "words_value2"]
+                                        }
+                                    },
+                                    "regex": {"pattern": "pattern_value"},
+                                    "matching_scope": 1,
+                                }
+                            }
+                        ],
+                    }
+                ]
+            },
         },
         "enable_floor_setting_enforcement": True,
         "integrated_services": [1],
@@ -7580,6 +7644,11 @@ def test_update_floor_setting_rest_call_success(request_type):
         "floor_setting_metadata": {
             "multi_language_detection": {"enable_multi_language_detection": True}
         },
+        "google_mcp_server_floor_setting": {
+            "inspect_only": True,
+            "inspect_and_block": True,
+            "enable_cloud_logging": True,
+        },
     }
     # The version of a generated dependency at test runtime may differ from the version used during generation.
     # Delete any fields which are not present in the current runtime dependency