feat: [google-cloud-modelarmor] A new field filter_config is added to message .google.cloud.modelarmor.v1.SanitizeUserPromptRequest (#13541)

- [ ] Regenerate this pull request now.

feat: A new field `filter_config` is added to message
`.google.cloud.modelarmor.v1.SanitizeModelResponseRequest

PiperOrigin-RevId: 728704493

Source-Link:
googleapis/googleapis@d687461

Source-Link:
googleapis/googleapis-gen@cf9e7e3
Copy-Tag:
eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLW1vZGVsYXJtb3IvLk93bEJvdC55YW1sIiwiaCI6ImNmOWU3ZTM1YTc0MzM3MzBjOTQ1NDMyODVmYTU3N2VlOWE5Yzg0MDYifQ==

---------

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>

Author: gcf-owl-bot[bot]

packages/google-cloud-modelarmor/README.rst

@@ -26,12 +26,12 @@ In order to use this library, you first need to go through the following steps:
 1. `Select or create a Cloud Platform project.`_
 2. `Enable billing for your project.`_
 3. `Enable the Model Armor API.`_
-4. `Setup Authentication.`_
+4. `Set up Authentication.`_
 
 .. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project
 .. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project
 .. _Enable the Model Armor API.:  https://cloud.google.com/security-command-center/docs/model-armor-overview
-.. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html
+.. _Set up Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html
 
 Installation
 ~~~~~~~~~~~~

packages/google-cloud-modelarmor/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.1.1"  # {x-release-please-version}
+__version__ = "0.0.0"  # {x-release-please-version}

packages/google-cloud-modelarmor/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.1.1"  # {x-release-please-version}
+__version__ = "0.0.0"  # {x-release-please-version}

packages/google-cloud-modelarmor/google/cloud/modelarmor_v1/types/service.py

@@ -901,13 +901,31 @@ class SdpAdvancedConfig(proto.Message):
 class SanitizeUserPromptRequest(proto.Message):
     r"""Sanitize User Prompt request.
 
+    .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
+
     Attributes:
         name (str):
             Required. Represents resource name of
             template e.g.
             name=projects/sample-project/locations/us-central1/templates/templ01
         user_prompt_data (google.cloud.modelarmor_v1.types.DataItem):
             Required. User prompt data to sanitize.
+        filter_config (google.cloud.modelarmor_v1.types.FilterConfig):
+            Optional. Optional Filter configuration to Sanitize User
+            Prompt.
+
+            If below configuration is specified then Sanitization will
+            be performed using settings in this configuration along with
+            settings defined at template level (union of both).
+
+            If a filter setting overlaps, then the lowest threshold
+            value i.e. value with greater false positives will be
+            applied. For example, the ``filter_configuration`` defines
+            LOW_AND_ABOVE confidence level for TOXICITY, and template
+            defines HIGH confidence level, then Sanitization is
+            performed using LOW_AND_ABOVE confidence level.
+
+            This field is a member of `oneof`_ ``_filter_config``.
     """
 
     name: str = proto.Field(
@@ -919,18 +937,41 @@ class SanitizeUserPromptRequest(proto.Message):
         number=2,
         message="DataItem",
     )
+    filter_config: "FilterConfig" = proto.Field(
+        proto.MESSAGE,
+        number=3,
+        optional=True,
+        message="FilterConfig",
+    )
 
 
 class SanitizeModelResponseRequest(proto.Message):
     r"""Sanitize Model Response request.
 
+    .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
+
     Attributes:
         name (str):
             Required. Represents resource name of
             template e.g.
             name=projects/sample-project/locations/us-central1/templates/templ01
         model_response_data (google.cloud.modelarmor_v1.types.DataItem):
             Required. Model response data to sanitize.
+        filter_config (google.cloud.modelarmor_v1.types.FilterConfig):
+            Optional. Optional Filter configuration to Sanitize User
+            Prompt.
+
+            If below configuration is specified then Sanitization will
+            be performed using settings in this configuration along with
+            settings defined at template level (union of both).
+
+            If a filter overlaps, then the highest level of strictness
+            will be applied. For example, the filter_configuration
+            specifies LOW_AND_ABOVE confidence level for TOXICITY filter
+            and template uses HIGH confidence level, then Sanitization
+            is performed using LOW_AND_ABOVE confidence level.
+
+            This field is a member of `oneof`_ ``_filter_config``.
         user_prompt (str):
             Optional. User Prompt associated with Model
             response.
@@ -945,6 +986,12 @@ class SanitizeModelResponseRequest(proto.Message):
         number=2,
         message="DataItem",
     )
+    filter_config: "FilterConfig" = proto.Field(
+        proto.MESSAGE,
+        number=3,
+        optional=True,
+        message="FilterConfig",
+    )
     user_prompt: str = proto.Field(
         proto.STRING,
         number=4,

packages/google-cloud-modelarmor/noxfile.py

@@ -382,20 +382,29 @@ def docfx(session):
     ["python", "upb", "cpp"],
 )
 def prerelease_deps(session, protobuf_implementation):
-    """Run all tests with prerelease versions of dependencies installed."""
+    """
+    Run all tests with pre-release versions of dependencies installed
+    rather than the standard non pre-release versions.
+    Pre-releases versions can be installed using
+    `pip install --pre <package>`.
+    """
 
     if protobuf_implementation == "cpp" and session.python in ("3.11", "3.12", "3.13"):
         session.skip("cpp implementation is not supported in python 3.11+")
 
     # Install all dependencies
-    session.install("-e", ".[all, tests, tracing]")
+    session.install("-e", ".")
+
     unit_deps_all = UNIT_TEST_STANDARD_DEPENDENCIES + UNIT_TEST_EXTERNAL_DEPENDENCIES
+    # Install dependencies for the unit test environment
     session.install(*unit_deps_all)
+
     system_deps_all = (
         SYSTEM_TEST_STANDARD_DEPENDENCIES
         + SYSTEM_TEST_EXTERNAL_DEPENDENCIES
         + SYSTEM_TEST_EXTRAS
     )
+    # Install dependencies for the system test environment
     session.install(*system_deps_all)
 
     # Because we test minimum dependency versions on the minimum Python
@@ -417,6 +426,7 @@ def prerelease_deps(session, protobuf_implementation):
         )
     ]
 
+    # Install dependencies specified in `testing/constraints-X.txt`.
     session.install(*constraints_deps)
 
     prerel_deps = [
@@ -458,3 +468,70 @@ def prerelease_deps(session, protobuf_implementation):
             "PROTOCOL_BUFFERS_PYTHON_IMPLEMENTATION": protobuf_implementation,
         },
     )
+
+
+@nox.session(python="3.13")
+@nox.parametrize(
+    "protobuf_implementation",
+    ["python", "upb"],
+)
+def core_deps_from_source(session, protobuf_implementation):
+    """Run all tests with local versions of core dependencies installed,
+    rather than pulling core dependencies from PyPI.
+    """
+
+    # Install all dependencies
+    session.install(".")
+
+    # Install dependencies for the unit test environment
+    unit_deps_all = UNIT_TEST_STANDARD_DEPENDENCIES + UNIT_TEST_EXTERNAL_DEPENDENCIES
+    session.install(*unit_deps_all)
+
+    # Install dependencies for the system test environment
+    system_deps_all = (
+        SYSTEM_TEST_STANDARD_DEPENDENCIES
+        + SYSTEM_TEST_EXTERNAL_DEPENDENCIES
+        + SYSTEM_TEST_EXTRAS
+    )
+    session.install(*system_deps_all)
+
+    # Because we test minimum dependency versions on the minimum Python
+    # version, the first version we test with in the unit tests sessions has a
+    # constraints file containing all dependencies and extras that should be installed.
+    with open(
+        CURRENT_DIRECTORY
+        / "testing"
+        / f"constraints-{UNIT_TEST_PYTHON_VERSIONS[0]}.txt",
+        encoding="utf-8",
+    ) as constraints_file:
+        constraints_text = constraints_file.read()
+
+    # Ignore leading whitespace and comment lines.
+    constraints_deps = [
+        match.group(1)
+        for match in re.finditer(
+            r"^\s*(\S+)(?===\S+)", constraints_text, flags=re.MULTILINE
+        )
+    ]
+
+    # Install dependencies specified in `testing/constraints-X.txt`.
+    session.install(*constraints_deps)
+
+    core_dependencies_from_source = [
+        "google-api-core @ git+https://github.com/googleapis/python-api-core.git",
+        "google-auth @ git+https://github.com/googleapis/google-auth-library-python.git",
+        f"{CURRENT_DIRECTORY}/../googleapis-common-protos",
+        f"{CURRENT_DIRECTORY}/../grpc-google-iam-v1",
+        "proto-plus @ git+https://github.com/googleapis/proto-plus-python.git",
+    ]
+
+    for dep in core_dependencies_from_source:
+        session.install(dep, "--ignore-installed", "--no-deps")
+
+    session.run(
+        "py.test",
+        "tests/unit",
+        env={
+            "PROTOCOL_BUFFERS_PYTHON_IMPLEMENTATION": protobuf_implementation,
+        },
+    )

packages/google-cloud-modelarmor/samples/generated_samples/snippet_metadata_google.cloud.modelarmor.v1.json

@@ -8,7 +8,7 @@
     ],
     "language": "PYTHON",
     "name": "google-cloud-modelarmor",
-    "version": "0.1.1"
+    "version": "0.1.0"
   },
   "snippets": [
     {

packages/google-cloud-modelarmor/scripts/fixup_modelarmor_v1_keywords.py

@@ -44,8 +44,8 @@ class modelarmorCallTransformer(cst.CSTTransformer):
         'get_floor_setting': ('name', ),
         'get_template': ('name', ),
         'list_templates': ('parent', 'page_size', 'page_token', 'filter', 'order_by', ),
-        'sanitize_model_response': ('name', 'model_response_data', 'user_prompt', ),
-        'sanitize_user_prompt': ('name', 'user_prompt_data', ),
+        'sanitize_model_response': ('name', 'model_response_data', 'filter_config', 'user_prompt', ),
+        'sanitize_user_prompt': ('name', 'user_prompt_data', 'filter_config', ),
         'update_floor_setting': ('floor_setting', 'update_mask', ),
         'update_template': ('update_mask', 'template', 'request_id', ),
     }