google-cloud-modelarmor 0.2.0__tar.gz → 0.2.2__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (39) hide show
  1. {google_cloud_modelarmor-0.2.0/google_cloud_modelarmor.egg-info → google_cloud_modelarmor-0.2.2}/PKG-INFO +91 -2
  2. google_cloud_modelarmor-0.2.2/README.rst +197 -0
  3. {google_cloud_modelarmor-0.2.0 → google_cloud_modelarmor-0.2.2}/google/cloud/modelarmor/__init__.py +1 -1
  4. {google_cloud_modelarmor-0.2.0 → google_cloud_modelarmor-0.2.2}/google/cloud/modelarmor/gapic_version.py +2 -2
  5. {google_cloud_modelarmor-0.2.0 → google_cloud_modelarmor-0.2.2}/google/cloud/modelarmor_v1/__init__.py +1 -1
  6. {google_cloud_modelarmor-0.2.0 → google_cloud_modelarmor-0.2.2}/google/cloud/modelarmor_v1/gapic_version.py +2 -2
  7. {google_cloud_modelarmor-0.2.0/tests/unit → google_cloud_modelarmor-0.2.2/google/cloud/modelarmor_v1/services}/__init__.py +1 -1
  8. {google_cloud_modelarmor-0.2.0 → google_cloud_modelarmor-0.2.2}/google/cloud/modelarmor_v1/services/model_armor/__init__.py +1 -1
  9. {google_cloud_modelarmor-0.2.0 → google_cloud_modelarmor-0.2.2}/google/cloud/modelarmor_v1/services/model_armor/async_client.py +1 -1
  10. {google_cloud_modelarmor-0.2.0 → google_cloud_modelarmor-0.2.2}/google/cloud/modelarmor_v1/services/model_armor/client.py +1 -1
  11. {google_cloud_modelarmor-0.2.0 → google_cloud_modelarmor-0.2.2}/google/cloud/modelarmor_v1/services/model_armor/pagers.py +1 -1
  12. {google_cloud_modelarmor-0.2.0 → google_cloud_modelarmor-0.2.2}/google/cloud/modelarmor_v1/services/model_armor/transports/__init__.py +1 -1
  13. {google_cloud_modelarmor-0.2.0 → google_cloud_modelarmor-0.2.2}/google/cloud/modelarmor_v1/services/model_armor/transports/base.py +1 -1
  14. {google_cloud_modelarmor-0.2.0 → google_cloud_modelarmor-0.2.2}/google/cloud/modelarmor_v1/services/model_armor/transports/grpc.py +1 -1
  15. {google_cloud_modelarmor-0.2.0 → google_cloud_modelarmor-0.2.2}/google/cloud/modelarmor_v1/services/model_armor/transports/grpc_asyncio.py +1 -1
  16. {google_cloud_modelarmor-0.2.0 → google_cloud_modelarmor-0.2.2}/google/cloud/modelarmor_v1/services/model_armor/transports/rest.py +1 -1
  17. {google_cloud_modelarmor-0.2.0 → google_cloud_modelarmor-0.2.2}/google/cloud/modelarmor_v1/services/model_armor/transports/rest_base.py +1 -1
  18. {google_cloud_modelarmor-0.2.0 → google_cloud_modelarmor-0.2.2}/google/cloud/modelarmor_v1/types/__init__.py +1 -1
  19. {google_cloud_modelarmor-0.2.0 → google_cloud_modelarmor-0.2.2}/google/cloud/modelarmor_v1/types/service.py +3 -3
  20. {google_cloud_modelarmor-0.2.0 → google_cloud_modelarmor-0.2.2/google_cloud_modelarmor.egg-info}/PKG-INFO +91 -2
  21. {google_cloud_modelarmor-0.2.0 → google_cloud_modelarmor-0.2.2}/google_cloud_modelarmor.egg-info/requires.txt +1 -1
  22. {google_cloud_modelarmor-0.2.0 → google_cloud_modelarmor-0.2.2}/setup.py +2 -2
  23. {google_cloud_modelarmor-0.2.0 → google_cloud_modelarmor-0.2.2}/tests/__init__.py +1 -1
  24. {google_cloud_modelarmor-0.2.0/tests/unit/gapic → google_cloud_modelarmor-0.2.2/tests/unit}/__init__.py +1 -1
  25. {google_cloud_modelarmor-0.2.0/google/cloud/modelarmor_v1/services → google_cloud_modelarmor-0.2.2/tests/unit/gapic}/__init__.py +1 -1
  26. google_cloud_modelarmor-0.2.2/tests/unit/gapic/modelarmor_v1/__init__.py +15 -0
  27. {google_cloud_modelarmor-0.2.0 → google_cloud_modelarmor-0.2.2}/tests/unit/gapic/modelarmor_v1/test_model_armor.py +1 -1
  28. google_cloud_modelarmor-0.2.0/README.rst +0 -108
  29. google_cloud_modelarmor-0.2.0/tests/unit/gapic/modelarmor_v1/__init__.py +0 -15
  30. {google_cloud_modelarmor-0.2.0 → google_cloud_modelarmor-0.2.2}/LICENSE +0 -0
  31. {google_cloud_modelarmor-0.2.0 → google_cloud_modelarmor-0.2.2}/MANIFEST.in +0 -0
  32. {google_cloud_modelarmor-0.2.0 → google_cloud_modelarmor-0.2.2}/google/cloud/modelarmor/py.typed +0 -0
  33. {google_cloud_modelarmor-0.2.0 → google_cloud_modelarmor-0.2.2}/google/cloud/modelarmor_v1/gapic_metadata.json +0 -0
  34. {google_cloud_modelarmor-0.2.0 → google_cloud_modelarmor-0.2.2}/google/cloud/modelarmor_v1/py.typed +0 -0
  35. {google_cloud_modelarmor-0.2.0 → google_cloud_modelarmor-0.2.2}/google_cloud_modelarmor.egg-info/SOURCES.txt +0 -0
  36. {google_cloud_modelarmor-0.2.0 → google_cloud_modelarmor-0.2.2}/google_cloud_modelarmor.egg-info/dependency_links.txt +0 -0
  37. {google_cloud_modelarmor-0.2.0 → google_cloud_modelarmor-0.2.2}/google_cloud_modelarmor.egg-info/not-zip-safe +0 -0
  38. {google_cloud_modelarmor-0.2.0 → google_cloud_modelarmor-0.2.2}/google_cloud_modelarmor.egg-info/top_level.txt +0 -0
  39. {google_cloud_modelarmor-0.2.0 → google_cloud_modelarmor-0.2.2}/setup.cfg +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: google-cloud-modelarmor
3
- Version: 0.2.0
3
+ Version: 0.2.2
4
4
  Summary: Google Cloud Modelarmor API client library
5
5
  Home-page: https://github.com/googleapis/google-cloud-python/tree/main/packages/google-cloud-modelarmor
6
6
  Author: Google LLC
@@ -27,7 +27,7 @@ Requires-Dist: google-api-core[grpc]!=2.0.*,!=2.1.*,!=2.10.*,!=2.2.*,!=2.3.*,!=2
27
27
  Requires-Dist: google-auth!=2.24.0,!=2.25.0,<3.0.0,>=2.14.1
28
28
  Requires-Dist: proto-plus<2.0.0,>=1.22.3
29
29
  Requires-Dist: proto-plus<2.0.0,>=1.25.0; python_version >= "3.13"
30
- Requires-Dist: protobuf!=4.21.0,!=4.21.1,!=4.21.2,!=4.21.3,!=4.21.4,!=4.21.5,<6.0.0,>=3.20.2
30
+ Requires-Dist: protobuf!=4.21.0,!=4.21.1,!=4.21.2,!=4.21.3,!=4.21.4,!=4.21.5,<7.0.0,>=3.20.2
31
31
 
32
32
  Python Client for Model Armor API
33
33
  =================================
@@ -137,3 +137,92 @@ Next Steps
137
137
 
138
138
  .. _Model Armor API Product documentation: https://cloud.google.com/security-command-center/docs/model-armor-overview
139
139
  .. _README: https://github.com/googleapis/google-cloud-python/blob/main/README.rst
140
+
141
+ Logging
142
+ -------
143
+
144
+ This library uses the standard Python :code:`logging` functionality to log some RPC events that could be of interest for debugging and monitoring purposes.
145
+ Note the following:
146
+
147
+ #. Logs may contain sensitive information. Take care to **restrict access to the logs** if they are saved, whether it be on local storage or on Google Cloud Logging.
148
+ #. Google may refine the occurrence, level, and content of various log messages in this library without flagging such changes as breaking. **Do not depend on immutability of the logging events**.
149
+ #. By default, the logging events from this library are not handled. You must **explicitly configure log handling** using one of the mechanisms below.
150
+
151
+ Simple, environment-based configuration
152
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
153
+
154
+ To enable logging for this library without any changes in your code, set the :code:`GOOGLE_SDK_PYTHON_LOGGING_SCOPE` environment variable to a valid Google
155
+ logging scope. This configures handling of logging events (at level :code:`logging.DEBUG` or higher) from this library in a default manner, emitting the logged
156
+ messages in a structured format. It does not currently allow customizing the logging levels captured nor the handlers, formatters, etc. used for any logging
157
+ event.
158
+
159
+ A logging scope is a period-separated namespace that begins with :code:`google`, identifying the Python module or package to log.
160
+
161
+ - Valid logging scopes: :code:`google`, :code:`google.cloud.asset.v1`, :code:`google.api`, :code:`google.auth`, etc.
162
+ - Invalid logging scopes: :code:`foo`, :code:`123`, etc.
163
+
164
+ **NOTE**: If the logging scope is invalid, the library does not set up any logging handlers.
165
+
166
+ Environment-Based Examples
167
+ ^^^^^^^^^^^^^^^^^^^^^^^^^^
168
+
169
+ - Enabling the default handler for all Google-based loggers
170
+
171
+ .. code-block:: console
172
+
173
+ export GOOGLE_SDK_PYTHON_LOGGING_SCOPE=google
174
+
175
+ - Enabling the default handler for a specific Google module (for a client library called :code:`library_v1`):
176
+
177
+ .. code-block:: console
178
+
179
+ export GOOGLE_SDK_PYTHON_LOGGING_SCOPE=google.cloud.library_v1
180
+
181
+
182
+ Advanced, code-based configuration
183
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
184
+
185
+ You can also configure a valid logging scope using Python's standard `logging` mechanism.
186
+
187
+ Code-Based Examples
188
+ ^^^^^^^^^^^^^^^^^^^
189
+
190
+ - Configuring a handler for all Google-based loggers
191
+
192
+ .. code-block:: python
193
+
194
+ import logging
195
+
196
+ from google.cloud.translate_v3 import translate
197
+
198
+ base_logger = logging.getLogger("google")
199
+ base_logger.addHandler(logging.StreamHandler())
200
+ base_logger.setLevel(logging.DEBUG)
201
+
202
+ - Configuring a handler for a specific Google module (for a client library called :code:`library_v1`):
203
+
204
+ .. code-block:: python
205
+
206
+ import logging
207
+
208
+ from google.cloud.translate_v3 import translate
209
+
210
+ base_logger = logging.getLogger("google.cloud.library_v1")
211
+ base_logger.addHandler(logging.StreamHandler())
212
+ base_logger.setLevel(logging.DEBUG)
213
+
214
+ Logging details
215
+ ~~~~~~~~~~~~~~~
216
+
217
+ #. Regardless of which of the mechanisms above you use to configure logging for this library, by default logging events are not propagated up to the root
218
+ logger from the `google`-level logger. If you need the events to be propagated to the root logger, you must explicitly set
219
+ :code:`logging.getLogger("google").propagate = True` in your code.
220
+ #. You can mix the different logging configurations above for different Google modules. For example, you may want use a code-based logging configuration for
221
+ one library, but decide you need to also set up environment-based logging configuration for another library.
222
+
223
+ #. If you attempt to use both code-based and environment-based configuration for the same module, the environment-based configuration will be ineffectual
224
+ if the code -based configuration gets applied first.
225
+
226
+ #. The Google-specific logging configurations (default handlers for environment-based configuration; not propagating logging events to the root logger) get
227
+ executed the first time *any* client library is instantiated in your application, and only if the affected loggers have not been previously configured.
228
+ (This is the reason for 2.i. above.)
@@ -0,0 +1,197 @@
1
+ Python Client for Model Armor API
2
+ =================================
3
+
4
+ |preview| |pypi| |versions|
5
+
6
+ `Model Armor API`_: 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.
7
+
8
+ - `Client Library Documentation`_
9
+ - `Product Documentation`_
10
+
11
+ .. |preview| image:: https://img.shields.io/badge/support-preview-orange.svg
12
+ :target: https://github.com/googleapis/google-cloud-python/blob/main/README.rst#stability-levels
13
+ .. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-modelarmor.svg
14
+ :target: https://pypi.org/project/google-cloud-modelarmor/
15
+ .. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-modelarmor.svg
16
+ :target: https://pypi.org/project/google-cloud-modelarmor/
17
+ .. _Model Armor API: https://cloud.google.com/security-command-center/docs/model-armor-overview
18
+ .. _Client Library Documentation: https://cloud.google.com/python/docs/reference/google-cloud-modelarmor/latest/summary_overview
19
+ .. _Product Documentation: https://cloud.google.com/security-command-center/docs/model-armor-overview
20
+
21
+ Quick Start
22
+ -----------
23
+
24
+ In order to use this library, you first need to go through the following steps:
25
+
26
+ 1. `Select or create a Cloud Platform project.`_
27
+ 2. `Enable billing for your project.`_
28
+ 3. `Enable the Model Armor API.`_
29
+ 4. `Set up Authentication.`_
30
+
31
+ .. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project
32
+ .. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project
33
+ .. _Enable the Model Armor API.: https://cloud.google.com/security-command-center/docs/model-armor-overview
34
+ .. _Set up Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html
35
+
36
+ Installation
37
+ ~~~~~~~~~~~~
38
+
39
+ Install this library in a virtual environment using `venv`_. `venv`_ is a tool that
40
+ creates isolated Python environments. These isolated environments can have separate
41
+ versions of Python packages, which allows you to isolate one project's dependencies
42
+ from the dependencies of other projects.
43
+
44
+ With `venv`_, it's possible to install this library without needing system
45
+ install permissions, and without clashing with the installed system
46
+ dependencies.
47
+
48
+ .. _`venv`: https://docs.python.org/3/library/venv.html
49
+
50
+
51
+ Code samples and snippets
52
+ ~~~~~~~~~~~~~~~~~~~~~~~~~
53
+
54
+ Code samples and snippets live in the `samples/`_ folder.
55
+
56
+ .. _samples/: https://github.com/googleapis/google-cloud-python/tree/main/packages/google-cloud-modelarmor/samples
57
+
58
+
59
+ Supported Python Versions
60
+ ^^^^^^^^^^^^^^^^^^^^^^^^^
61
+ Our client libraries are compatible with all current `active`_ and `maintenance`_ versions of
62
+ Python.
63
+
64
+ Python >= 3.7
65
+
66
+ .. _active: https://devguide.python.org/devcycle/#in-development-main-branch
67
+ .. _maintenance: https://devguide.python.org/devcycle/#maintenance-branches
68
+
69
+ Unsupported Python Versions
70
+ ^^^^^^^^^^^^^^^^^^^^^^^^^^^
71
+ Python <= 3.6
72
+
73
+ If you are using an `end-of-life`_
74
+ version of Python, we recommend that you update as soon as possible to an actively supported version.
75
+
76
+ .. _end-of-life: https://devguide.python.org/devcycle/#end-of-life-branches
77
+
78
+ Mac/Linux
79
+ ^^^^^^^^^
80
+
81
+ .. code-block:: console
82
+
83
+ python3 -m venv <your-env>
84
+ source <your-env>/bin/activate
85
+ pip install google-cloud-modelarmor
86
+
87
+
88
+ Windows
89
+ ^^^^^^^
90
+
91
+ .. code-block:: console
92
+
93
+ py -m venv <your-env>
94
+ .\<your-env>\Scripts\activate
95
+ pip install google-cloud-modelarmor
96
+
97
+ Next Steps
98
+ ~~~~~~~~~~
99
+
100
+ - Read the `Client Library Documentation`_ for Model Armor API
101
+ to see other available methods on the client.
102
+ - Read the `Model Armor API Product documentation`_ to learn
103
+ more about the product and see How-to Guides.
104
+ - View this `README`_ to see the full list of Cloud
105
+ APIs that we cover.
106
+
107
+ .. _Model Armor API Product documentation: https://cloud.google.com/security-command-center/docs/model-armor-overview
108
+ .. _README: https://github.com/googleapis/google-cloud-python/blob/main/README.rst
109
+
110
+ Logging
111
+ -------
112
+
113
+ This library uses the standard Python :code:`logging` functionality to log some RPC events that could be of interest for debugging and monitoring purposes.
114
+ Note the following:
115
+
116
+ #. Logs may contain sensitive information. Take care to **restrict access to the logs** if they are saved, whether it be on local storage or on Google Cloud Logging.
117
+ #. Google may refine the occurrence, level, and content of various log messages in this library without flagging such changes as breaking. **Do not depend on immutability of the logging events**.
118
+ #. By default, the logging events from this library are not handled. You must **explicitly configure log handling** using one of the mechanisms below.
119
+
120
+ Simple, environment-based configuration
121
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
122
+
123
+ To enable logging for this library without any changes in your code, set the :code:`GOOGLE_SDK_PYTHON_LOGGING_SCOPE` environment variable to a valid Google
124
+ logging scope. This configures handling of logging events (at level :code:`logging.DEBUG` or higher) from this library in a default manner, emitting the logged
125
+ messages in a structured format. It does not currently allow customizing the logging levels captured nor the handlers, formatters, etc. used for any logging
126
+ event.
127
+
128
+ A logging scope is a period-separated namespace that begins with :code:`google`, identifying the Python module or package to log.
129
+
130
+ - Valid logging scopes: :code:`google`, :code:`google.cloud.asset.v1`, :code:`google.api`, :code:`google.auth`, etc.
131
+ - Invalid logging scopes: :code:`foo`, :code:`123`, etc.
132
+
133
+ **NOTE**: If the logging scope is invalid, the library does not set up any logging handlers.
134
+
135
+ Environment-Based Examples
136
+ ^^^^^^^^^^^^^^^^^^^^^^^^^^
137
+
138
+ - Enabling the default handler for all Google-based loggers
139
+
140
+ .. code-block:: console
141
+
142
+ export GOOGLE_SDK_PYTHON_LOGGING_SCOPE=google
143
+
144
+ - Enabling the default handler for a specific Google module (for a client library called :code:`library_v1`):
145
+
146
+ .. code-block:: console
147
+
148
+ export GOOGLE_SDK_PYTHON_LOGGING_SCOPE=google.cloud.library_v1
149
+
150
+
151
+ Advanced, code-based configuration
152
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
153
+
154
+ You can also configure a valid logging scope using Python's standard `logging` mechanism.
155
+
156
+ Code-Based Examples
157
+ ^^^^^^^^^^^^^^^^^^^
158
+
159
+ - Configuring a handler for all Google-based loggers
160
+
161
+ .. code-block:: python
162
+
163
+ import logging
164
+
165
+ from google.cloud.translate_v3 import translate
166
+
167
+ base_logger = logging.getLogger("google")
168
+ base_logger.addHandler(logging.StreamHandler())
169
+ base_logger.setLevel(logging.DEBUG)
170
+
171
+ - Configuring a handler for a specific Google module (for a client library called :code:`library_v1`):
172
+
173
+ .. code-block:: python
174
+
175
+ import logging
176
+
177
+ from google.cloud.translate_v3 import translate
178
+
179
+ base_logger = logging.getLogger("google.cloud.library_v1")
180
+ base_logger.addHandler(logging.StreamHandler())
181
+ base_logger.setLevel(logging.DEBUG)
182
+
183
+ Logging details
184
+ ~~~~~~~~~~~~~~~
185
+
186
+ #. Regardless of which of the mechanisms above you use to configure logging for this library, by default logging events are not propagated up to the root
187
+ logger from the `google`-level logger. If you need the events to be propagated to the root logger, you must explicitly set
188
+ :code:`logging.getLogger("google").propagate = True` in your code.
189
+ #. You can mix the different logging configurations above for different Google modules. For example, you may want use a code-based logging configuration for
190
+ one library, but decide you need to also set up environment-based logging configuration for another library.
191
+
192
+ #. If you attempt to use both code-based and environment-based configuration for the same module, the environment-based configuration will be ineffectual
193
+ if the code -based configuration gets applied first.
194
+
195
+ #. The Google-specific logging configurations (default handlers for environment-based configuration; not propagating logging events to the root logger) get
196
+ executed the first time *any* client library is instantiated in your application, and only if the affected loggers have not been previously configured.
197
+ (This is the reason for 2.i. above.)
@@ -1,5 +1,5 @@
1
1
  # -*- coding: utf-8 -*-
2
- # Copyright 2024 Google LLC
2
+ # Copyright 2025 Google LLC
3
3
  #
4
4
  # Licensed under the Apache License, Version 2.0 (the "License");
5
5
  # you may not use this file except in compliance with the License.
@@ -1,5 +1,5 @@
1
1
  # -*- coding: utf-8 -*-
2
- # Copyright 2024 Google LLC
2
+ # Copyright 2025 Google LLC
3
3
  #
4
4
  # Licensed under the Apache License, Version 2.0 (the "License");
5
5
  # you may not use this file except in compliance with the License.
@@ -13,4 +13,4 @@
13
13
  # See the License for the specific language governing permissions and
14
14
  # limitations under the License.
15
15
  #
16
- __version__ = "0.2.0" # {x-release-please-version}
16
+ __version__ = "0.2.2" # {x-release-please-version}
@@ -1,5 +1,5 @@
1
1
  # -*- coding: utf-8 -*-
2
- # Copyright 2024 Google LLC
2
+ # Copyright 2025 Google LLC
3
3
  #
4
4
  # Licensed under the Apache License, Version 2.0 (the "License");
5
5
  # you may not use this file except in compliance with the License.
@@ -1,5 +1,5 @@
1
1
  # -*- coding: utf-8 -*-
2
- # Copyright 2024 Google LLC
2
+ # Copyright 2025 Google LLC
3
3
  #
4
4
  # Licensed under the Apache License, Version 2.0 (the "License");
5
5
  # you may not use this file except in compliance with the License.
@@ -13,4 +13,4 @@
13
13
  # See the License for the specific language governing permissions and
14
14
  # limitations under the License.
15
15
  #
16
- __version__ = "0.2.0" # {x-release-please-version}
16
+ __version__ = "0.2.2" # {x-release-please-version}
@@ -1,5 +1,5 @@
1
1
  # -*- coding: utf-8 -*-
2
- # Copyright 2024 Google LLC
2
+ # Copyright 2025 Google LLC
3
3
  #
4
4
  # Licensed under the Apache License, Version 2.0 (the "License");
5
5
  # you may not use this file except in compliance with the License.
@@ -1,5 +1,5 @@
1
1
  # -*- coding: utf-8 -*-
2
- # Copyright 2024 Google LLC
2
+ # Copyright 2025 Google LLC
3
3
  #
4
4
  # Licensed under the Apache License, Version 2.0 (the "License");
5
5
  # you may not use this file except in compliance with the License.
@@ -1,5 +1,5 @@
1
1
  # -*- coding: utf-8 -*-
2
- # Copyright 2024 Google LLC
2
+ # Copyright 2025 Google LLC
3
3
  #
4
4
  # Licensed under the Apache License, Version 2.0 (the "License");
5
5
  # you may not use this file except in compliance with the License.
@@ -1,5 +1,5 @@
1
1
  # -*- coding: utf-8 -*-
2
- # Copyright 2024 Google LLC
2
+ # Copyright 2025 Google LLC
3
3
  #
4
4
  # Licensed under the Apache License, Version 2.0 (the "License");
5
5
  # you may not use this file except in compliance with the License.
@@ -1,5 +1,5 @@
1
1
  # -*- coding: utf-8 -*-
2
- # Copyright 2024 Google LLC
2
+ # Copyright 2025 Google LLC
3
3
  #
4
4
  # Licensed under the Apache License, Version 2.0 (the "License");
5
5
  # you may not use this file except in compliance with the License.
@@ -1,5 +1,5 @@
1
1
  # -*- coding: utf-8 -*-
2
- # Copyright 2024 Google LLC
2
+ # Copyright 2025 Google LLC
3
3
  #
4
4
  # Licensed under the Apache License, Version 2.0 (the "License");
5
5
  # you may not use this file except in compliance with the License.
@@ -1,5 +1,5 @@
1
1
  # -*- coding: utf-8 -*-
2
- # Copyright 2024 Google LLC
2
+ # Copyright 2025 Google LLC
3
3
  #
4
4
  # Licensed under the Apache License, Version 2.0 (the "License");
5
5
  # you may not use this file except in compliance with the License.
@@ -1,5 +1,5 @@
1
1
  # -*- coding: utf-8 -*-
2
- # Copyright 2024 Google LLC
2
+ # Copyright 2025 Google LLC
3
3
  #
4
4
  # Licensed under the Apache License, Version 2.0 (the "License");
5
5
  # you may not use this file except in compliance with the License.
@@ -1,5 +1,5 @@
1
1
  # -*- coding: utf-8 -*-
2
- # Copyright 2024 Google LLC
2
+ # Copyright 2025 Google LLC
3
3
  #
4
4
  # Licensed under the Apache License, Version 2.0 (the "License");
5
5
  # you may not use this file except in compliance with the License.
@@ -1,5 +1,5 @@
1
1
  # -*- coding: utf-8 -*-
2
- # Copyright 2024 Google LLC
2
+ # Copyright 2025 Google LLC
3
3
  #
4
4
  # Licensed under the Apache License, Version 2.0 (the "License");
5
5
  # you may not use this file except in compliance with the License.
@@ -1,5 +1,5 @@
1
1
  # -*- coding: utf-8 -*-
2
- # Copyright 2024 Google LLC
2
+ # Copyright 2025 Google LLC
3
3
  #
4
4
  # Licensed under the Apache License, Version 2.0 (the "License");
5
5
  # you may not use this file except in compliance with the License.
@@ -1,5 +1,5 @@
1
1
  # -*- coding: utf-8 -*-
2
- # Copyright 2024 Google LLC
2
+ # Copyright 2025 Google LLC
3
3
  #
4
4
  # Licensed under the Apache License, Version 2.0 (the "License");
5
5
  # you may not use this file except in compliance with the License.
@@ -1,5 +1,5 @@
1
1
  # -*- coding: utf-8 -*-
2
- # Copyright 2024 Google LLC
2
+ # Copyright 2025 Google LLC
3
3
  #
4
4
  # Licensed under the Apache License, Version 2.0 (the "License");
5
5
  # you may not use this file except in compliance with the License.
@@ -1085,7 +1085,7 @@ class FilterResult(proto.Message):
1085
1085
  Malicious URI filter results.
1086
1086
 
1087
1087
  This field is a member of `oneof`_ ``filter_result``.
1088
- csam_filter_result (google.cloud.modelarmor_v1.types.CsamFilterResult):
1088
+ csam_filter_filter_result (google.cloud.modelarmor_v1.types.CsamFilterResult):
1089
1089
  CSAM filter results.
1090
1090
 
1091
1091
  This field is a member of `oneof`_ ``filter_result``.
@@ -1119,7 +1119,7 @@ class FilterResult(proto.Message):
1119
1119
  oneof="filter_result",
1120
1120
  message="MaliciousUriFilterResult",
1121
1121
  )
1122
- csam_filter_result: "CsamFilterResult" = proto.Field(
1122
+ csam_filter_filter_result: "CsamFilterResult" = proto.Field(
1123
1123
  proto.MESSAGE,
1124
1124
  number=5,
1125
1125
  oneof="filter_result",
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: google-cloud-modelarmor
3
- Version: 0.2.0
3
+ Version: 0.2.2
4
4
  Summary: Google Cloud Modelarmor API client library
5
5
  Home-page: https://github.com/googleapis/google-cloud-python/tree/main/packages/google-cloud-modelarmor
6
6
  Author: Google LLC
@@ -27,7 +27,7 @@ Requires-Dist: google-api-core[grpc]!=2.0.*,!=2.1.*,!=2.10.*,!=2.2.*,!=2.3.*,!=2
27
27
  Requires-Dist: google-auth!=2.24.0,!=2.25.0,<3.0.0,>=2.14.1
28
28
  Requires-Dist: proto-plus<2.0.0,>=1.22.3
29
29
  Requires-Dist: proto-plus<2.0.0,>=1.25.0; python_version >= "3.13"
30
- Requires-Dist: protobuf!=4.21.0,!=4.21.1,!=4.21.2,!=4.21.3,!=4.21.4,!=4.21.5,<6.0.0,>=3.20.2
30
+ Requires-Dist: protobuf!=4.21.0,!=4.21.1,!=4.21.2,!=4.21.3,!=4.21.4,!=4.21.5,<7.0.0,>=3.20.2
31
31
 
32
32
  Python Client for Model Armor API
33
33
  =================================
@@ -137,3 +137,92 @@ Next Steps
137
137
 
138
138
  .. _Model Armor API Product documentation: https://cloud.google.com/security-command-center/docs/model-armor-overview
139
139
  .. _README: https://github.com/googleapis/google-cloud-python/blob/main/README.rst
140
+
141
+ Logging
142
+ -------
143
+
144
+ This library uses the standard Python :code:`logging` functionality to log some RPC events that could be of interest for debugging and monitoring purposes.
145
+ Note the following:
146
+
147
+ #. Logs may contain sensitive information. Take care to **restrict access to the logs** if they are saved, whether it be on local storage or on Google Cloud Logging.
148
+ #. Google may refine the occurrence, level, and content of various log messages in this library without flagging such changes as breaking. **Do not depend on immutability of the logging events**.
149
+ #. By default, the logging events from this library are not handled. You must **explicitly configure log handling** using one of the mechanisms below.
150
+
151
+ Simple, environment-based configuration
152
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
153
+
154
+ To enable logging for this library without any changes in your code, set the :code:`GOOGLE_SDK_PYTHON_LOGGING_SCOPE` environment variable to a valid Google
155
+ logging scope. This configures handling of logging events (at level :code:`logging.DEBUG` or higher) from this library in a default manner, emitting the logged
156
+ messages in a structured format. It does not currently allow customizing the logging levels captured nor the handlers, formatters, etc. used for any logging
157
+ event.
158
+
159
+ A logging scope is a period-separated namespace that begins with :code:`google`, identifying the Python module or package to log.
160
+
161
+ - Valid logging scopes: :code:`google`, :code:`google.cloud.asset.v1`, :code:`google.api`, :code:`google.auth`, etc.
162
+ - Invalid logging scopes: :code:`foo`, :code:`123`, etc.
163
+
164
+ **NOTE**: If the logging scope is invalid, the library does not set up any logging handlers.
165
+
166
+ Environment-Based Examples
167
+ ^^^^^^^^^^^^^^^^^^^^^^^^^^
168
+
169
+ - Enabling the default handler for all Google-based loggers
170
+
171
+ .. code-block:: console
172
+
173
+ export GOOGLE_SDK_PYTHON_LOGGING_SCOPE=google
174
+
175
+ - Enabling the default handler for a specific Google module (for a client library called :code:`library_v1`):
176
+
177
+ .. code-block:: console
178
+
179
+ export GOOGLE_SDK_PYTHON_LOGGING_SCOPE=google.cloud.library_v1
180
+
181
+
182
+ Advanced, code-based configuration
183
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
184
+
185
+ You can also configure a valid logging scope using Python's standard `logging` mechanism.
186
+
187
+ Code-Based Examples
188
+ ^^^^^^^^^^^^^^^^^^^
189
+
190
+ - Configuring a handler for all Google-based loggers
191
+
192
+ .. code-block:: python
193
+
194
+ import logging
195
+
196
+ from google.cloud.translate_v3 import translate
197
+
198
+ base_logger = logging.getLogger("google")
199
+ base_logger.addHandler(logging.StreamHandler())
200
+ base_logger.setLevel(logging.DEBUG)
201
+
202
+ - Configuring a handler for a specific Google module (for a client library called :code:`library_v1`):
203
+
204
+ .. code-block:: python
205
+
206
+ import logging
207
+
208
+ from google.cloud.translate_v3 import translate
209
+
210
+ base_logger = logging.getLogger("google.cloud.library_v1")
211
+ base_logger.addHandler(logging.StreamHandler())
212
+ base_logger.setLevel(logging.DEBUG)
213
+
214
+ Logging details
215
+ ~~~~~~~~~~~~~~~
216
+
217
+ #. Regardless of which of the mechanisms above you use to configure logging for this library, by default logging events are not propagated up to the root
218
+ logger from the `google`-level logger. If you need the events to be propagated to the root logger, you must explicitly set
219
+ :code:`logging.getLogger("google").propagate = True` in your code.
220
+ #. You can mix the different logging configurations above for different Google modules. For example, you may want use a code-based logging configuration for
221
+ one library, but decide you need to also set up environment-based logging configuration for another library.
222
+
223
+ #. If you attempt to use both code-based and environment-based configuration for the same module, the environment-based configuration will be ineffectual
224
+ if the code -based configuration gets applied first.
225
+
226
+ #. The Google-specific logging configurations (default handlers for environment-based configuration; not propagating logging events to the root logger) get
227
+ executed the first time *any* client library is instantiated in your application, and only if the affected loggers have not been previously configured.
228
+ (This is the reason for 2.i. above.)
@@ -1,7 +1,7 @@
1
1
  google-api-core[grpc]!=2.0.*,!=2.1.*,!=2.10.*,!=2.2.*,!=2.3.*,!=2.4.*,!=2.5.*,!=2.6.*,!=2.7.*,!=2.8.*,!=2.9.*,<3.0.0,>=1.34.1
2
2
  google-auth!=2.24.0,!=2.25.0,<3.0.0,>=2.14.1
3
3
  proto-plus<2.0.0,>=1.22.3
4
- protobuf!=4.21.0,!=4.21.1,!=4.21.2,!=4.21.3,!=4.21.4,!=4.21.5,<6.0.0,>=3.20.2
4
+ protobuf!=4.21.0,!=4.21.1,!=4.21.2,!=4.21.3,!=4.21.4,!=4.21.5,<7.0.0,>=3.20.2
5
5
 
6
6
  [:python_version >= "3.13"]
7
7
  proto-plus<2.0.0,>=1.25.0
@@ -1,5 +1,5 @@
1
1
  # -*- coding: utf-8 -*-
2
- # Copyright 2024 Google LLC
2
+ # Copyright 2025 Google LLC
3
3
  #
4
4
  # Licensed under the Apache License, Version 2.0 (the "License");
5
5
  # you may not use this file except in compliance with the License.
@@ -45,7 +45,7 @@ dependencies = [
45
45
  "google-auth >= 2.14.1, <3.0.0,!=2.24.0,!=2.25.0",
46
46
  "proto-plus >= 1.22.3, <2.0.0",
47
47
  "proto-plus >= 1.25.0, <2.0.0; python_version >= '3.13'",
48
- "protobuf>=3.20.2,<6.0.0,!=4.21.0,!=4.21.1,!=4.21.2,!=4.21.3,!=4.21.4,!=4.21.5",
48
+ "protobuf>=3.20.2,<7.0.0,!=4.21.0,!=4.21.1,!=4.21.2,!=4.21.3,!=4.21.4,!=4.21.5",
49
49
  ]
50
50
  extras = {}
51
51
  url = "https://github.com/googleapis/google-cloud-python/tree/main/packages/google-cloud-modelarmor"
@@ -1,5 +1,5 @@
1
1
  # -*- coding: utf-8 -*-
2
- # Copyright 2024 Google LLC
2
+ # Copyright 2025 Google LLC
3
3
  #
4
4
  # Licensed under the Apache License, Version 2.0 (the "License");
5
5
  # you may not use this file except in compliance with the License.
@@ -1,5 +1,5 @@
1
1
  # -*- coding: utf-8 -*-
2
- # Copyright 2024 Google LLC
2
+ # Copyright 2025 Google LLC
3
3
  #
4
4
  # Licensed under the Apache License, Version 2.0 (the "License");
5
5
  # you may not use this file except in compliance with the License.
@@ -1,5 +1,5 @@
1
1
  # -*- coding: utf-8 -*-
2
- # Copyright 2024 Google LLC
2
+ # Copyright 2025 Google LLC
3
3
  #
4
4
  # Licensed under the Apache License, Version 2.0 (the "License");
5
5
  # you may not use this file except in compliance with the License.
@@ -0,0 +1,15 @@
1
+ # -*- coding: utf-8 -*-
2
+ # Copyright 2025 Google LLC
3
+ #
4
+ # Licensed under the Apache License, Version 2.0 (the "License");
5
+ # you may not use this file except in compliance with the License.
6
+ # You may obtain a copy of the License at
7
+ #
8
+ # http://www.apache.org/licenses/LICENSE-2.0
9
+ #
10
+ # Unless required by applicable law or agreed to in writing, software
11
+ # distributed under the License is distributed on an "AS IS" BASIS,
12
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
+ # See the License for the specific language governing permissions and
14
+ # limitations under the License.
15
+ #
@@ -1,5 +1,5 @@
1
1
  # -*- coding: utf-8 -*-
2
- # Copyright 2024 Google LLC
2
+ # Copyright 2025 Google LLC
3
3
  #
4
4
  # Licensed under the Apache License, Version 2.0 (the "License");
5
5
  # you may not use this file except in compliance with the License.
@@ -1,108 +0,0 @@
1
- Python Client for Model Armor API
2
- =================================
3
-
4
- |preview| |pypi| |versions|
5
-
6
- `Model Armor API`_: 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.
7
-
8
- - `Client Library Documentation`_
9
- - `Product Documentation`_
10
-
11
- .. |preview| image:: https://img.shields.io/badge/support-preview-orange.svg
12
- :target: https://github.com/googleapis/google-cloud-python/blob/main/README.rst#stability-levels
13
- .. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-modelarmor.svg
14
- :target: https://pypi.org/project/google-cloud-modelarmor/
15
- .. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-modelarmor.svg
16
- :target: https://pypi.org/project/google-cloud-modelarmor/
17
- .. _Model Armor API: https://cloud.google.com/security-command-center/docs/model-armor-overview
18
- .. _Client Library Documentation: https://cloud.google.com/python/docs/reference/google-cloud-modelarmor/latest/summary_overview
19
- .. _Product Documentation: https://cloud.google.com/security-command-center/docs/model-armor-overview
20
-
21
- Quick Start
22
- -----------
23
-
24
- In order to use this library, you first need to go through the following steps:
25
-
26
- 1. `Select or create a Cloud Platform project.`_
27
- 2. `Enable billing for your project.`_
28
- 3. `Enable the Model Armor API.`_
29
- 4. `Set up Authentication.`_
30
-
31
- .. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project
32
- .. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project
33
- .. _Enable the Model Armor API.: https://cloud.google.com/security-command-center/docs/model-armor-overview
34
- .. _Set up Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html
35
-
36
- Installation
37
- ~~~~~~~~~~~~
38
-
39
- Install this library in a virtual environment using `venv`_. `venv`_ is a tool that
40
- creates isolated Python environments. These isolated environments can have separate
41
- versions of Python packages, which allows you to isolate one project's dependencies
42
- from the dependencies of other projects.
43
-
44
- With `venv`_, it's possible to install this library without needing system
45
- install permissions, and without clashing with the installed system
46
- dependencies.
47
-
48
- .. _`venv`: https://docs.python.org/3/library/venv.html
49
-
50
-
51
- Code samples and snippets
52
- ~~~~~~~~~~~~~~~~~~~~~~~~~
53
-
54
- Code samples and snippets live in the `samples/`_ folder.
55
-
56
- .. _samples/: https://github.com/googleapis/google-cloud-python/tree/main/packages/google-cloud-modelarmor/samples
57
-
58
-
59
- Supported Python Versions
60
- ^^^^^^^^^^^^^^^^^^^^^^^^^
61
- Our client libraries are compatible with all current `active`_ and `maintenance`_ versions of
62
- Python.
63
-
64
- Python >= 3.7
65
-
66
- .. _active: https://devguide.python.org/devcycle/#in-development-main-branch
67
- .. _maintenance: https://devguide.python.org/devcycle/#maintenance-branches
68
-
69
- Unsupported Python Versions
70
- ^^^^^^^^^^^^^^^^^^^^^^^^^^^
71
- Python <= 3.6
72
-
73
- If you are using an `end-of-life`_
74
- version of Python, we recommend that you update as soon as possible to an actively supported version.
75
-
76
- .. _end-of-life: https://devguide.python.org/devcycle/#end-of-life-branches
77
-
78
- Mac/Linux
79
- ^^^^^^^^^
80
-
81
- .. code-block:: console
82
-
83
- python3 -m venv <your-env>
84
- source <your-env>/bin/activate
85
- pip install google-cloud-modelarmor
86
-
87
-
88
- Windows
89
- ^^^^^^^
90
-
91
- .. code-block:: console
92
-
93
- py -m venv <your-env>
94
- .\<your-env>\Scripts\activate
95
- pip install google-cloud-modelarmor
96
-
97
- Next Steps
98
- ~~~~~~~~~~
99
-
100
- - Read the `Client Library Documentation`_ for Model Armor API
101
- to see other available methods on the client.
102
- - Read the `Model Armor API Product documentation`_ to learn
103
- more about the product and see How-to Guides.
104
- - View this `README`_ to see the full list of Cloud
105
- APIs that we cover.
106
-
107
- .. _Model Armor API Product documentation: https://cloud.google.com/security-command-center/docs/model-armor-overview
108
- .. _README: https://github.com/googleapis/google-cloud-python/blob/main/README.rst
@@ -1,15 +0,0 @@
1
- # -*- coding: utf-8 -*-
2
- # Copyright 2024 Google LLC
3
- #
4
- # Licensed under the Apache License, Version 2.0 (the "License");
5
- # you may not use this file except in compliance with the License.
6
- # You may obtain a copy of the License at
7
- #
8
- # http://www.apache.org/licenses/LICENSE-2.0
9
- #
10
- # Unless required by applicable law or agreed to in writing, software
11
- # distributed under the License is distributed on an "AS IS" BASIS,
12
- # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
- # See the License for the specific language governing permissions and
14
- # limitations under the License.
15
- #