Package Classes (0.7.4)

Service describing handlers for resources

Service describing handlers for resources

A pager for iterating through list_templates requests.

This class thinly wraps an initial ListTemplatesResponse object, and provides an __aiter__ method to iterate through its templates field.

If there are more pages, the __aiter__ method will make additional ListTemplates requests and continue to iterate through the templates field on the corresponding responses.

All the usual ListTemplatesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_templates requests.

This class thinly wraps an initial ListTemplatesResponse object, and provides an __iter__ method to iterate through its templates field.

If there are more pages, the __iter__ method will make additional ListTemplates requests and continue to iterate through the templates field on the corresponding responses.

All the usual ListTemplatesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

message describing AiPlatformFloorSetting

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

Represents Byte Data item.

Option to specify the type of byte data.

Message for creating a Template

CSAM (Child Safety Abuse Material) Filter Result

Represents Data item

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

Message for deleting a Template

Confidence levels for detectors. Higher value maps to a greater confidence level. To enforce stricter level a lower value should be used.

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

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

Filters configuration.

Enum which reports whether a specific filter executed successfully or not.

Option to specify filter match state.

Filter Result obtained after Sanitization operations.

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

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

A set of rules that modifies the behavior of specific filters based on the rules defined within the set.

Settings for customizing filter rules.

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.

Message describing a Filter Version Configuration.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

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

Message describing FloorSetting resource

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

message describing FloorSetting Metadata

Metadata to enable multi language detection via floor setting.

Integrated service for which the floor setting is applicable.

Message for getting a Floor Setting

Message for getting a Template

A field indicating the outcome of the invocation, irrespective of match status.

Message for requesting list of Templates

Message for response to listing Templates

Malicious URI Filter Result.

Information regarding malicious URI and its location within the input content.

Malicious URI filter settings.

Option to specify the state of Malicious URI filter (ENABLED/DISABLED).

Defines the scope of the match for a rule.

Additional values may be added to this enum in the future.

    - 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

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

Message item to report information, warning or error messages.

Option to specify the type of message.

This enum is used in the TemplateMetadata and FloorSettingMetadata messages to indicate the modality supported for sanitize API calls.

Message for Enabling Multi Language Detection.

Prompt injection and Jailbreak Filter Result.

Prompt injection and Jailbreak Filter settings.

Option to specify the state of Prompt Injection and Jailbreak filter (ENABLED/DISABLED).

Responsible AI Result.

Detailed Filter result for each of the responsible AI Filter Types.

The abstract base class for a message.

Responsible AI Filter settings.

Responsible AI filter.

Options for responsible AI Filter Types.

Half-open range interval [start, end)

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Message defining a custom regular expression.

Model Armor Filter types supported for rules.

Sanitization result after applying all the filters on input content.

The abstract base class for a message.

Message describing Sanitization metadata.

Sanitize Model Response request.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Sanitized Model Response Response.

Sanitize User Prompt request.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Sanitized User Prompt Response.

Sensitive Data Protection Advanced configuration.

Sensitive Data Protection basic configuration.

Option to specify the state of Sensitive Data Protection basic config (ENABLED/DISABLED).

Precise location of the finding within a document, record, image, or metadata container.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Sensitive Data Protection Deidentification Result.

Sensitive Data Protection filter result.

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

Sensitive Data Protection settings.

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

Finding corresponding to Sensitive Data Protection filter.

Location of this Sensitive Data Protection Finding within input content.

For more information about each Sensitive Data Protection likelihood level, see https://cloud.google.com/sensitive-data-protection/docs/likelihood.

Location of the finding within an image.

Bounding box encompassing a finding within an image.

Sensitive Data Protection Inspection Result.

Sensitive Data Protection Redaction Result.

Streaming Mode for Sanitize* API.

Message describing Template resource

The abstract base class for a message.

Message describing TemplateMetadata

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Enforcement type for Model Armor filters.

Metadata to enable multi language detection via template.

Message for Updating a Floor Setting

Message for updating a Template

Details of an identified virus

Defines all the threat types of a virus

Virus scan results.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Type of content scanned.

Message defining a list of words or phrases.

Service describing handlers for resources

Service describing handlers for resources

A pager for iterating through list_templates requests.

This class thinly wraps an initial ListTemplatesResponse object, and provides an __aiter__ method to iterate through its templates field.

If there are more pages, the __aiter__ method will make additional ListTemplates requests and continue to iterate through the templates field on the corresponding responses.

All the usual ListTemplatesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_templates requests.

This class thinly wraps an initial ListTemplatesResponse object, and provides an __iter__ method to iterate through its templates field.

If there are more pages, the __iter__ method will make additional ListTemplates requests and continue to iterate through the templates field on the corresponding responses.

All the usual ListTemplatesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

message describing AiPlatformFloorSetting

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

Represents Byte Data item.

Option to specify the type of byte data.

Message for creating a Template

CSAM (Child Safety Abuse Material) Filter Result

Represents Data item

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

Message for deleting a Template

Confidence levels for detectors. Higher value maps to a greater confidence level. To enforce stricter level a lower value should be used.

Filters configuration.

Enum which reports whether a specific filter executed successfully or not.

Option to specify filter match state.

Filter Result obtained after Sanitization operations.

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

Message describing FloorSetting resource

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

message describing FloorSetting Metadata

Metadata to enable multi language detection via floor setting.

Integrated service for which the floor setting is applicable.

Message for getting a Floor Setting

Message for getting a Template

A field indicating the outcome of the invocation, irrespective of match status.

Message for requesting list of Templates

Message for response to listing Templates

Malicious URI Filter Result.

Information regarding malicious URI and its location within the input content.

Malicious URI filter settings.

Option to specify the state of Malicious URI filter (ENABLED/DISABLED).

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

Message item to report information, warning or error messages.

Option to specify the type of message.

Message for Enabling Multi Language Detection.

Prompt injection and Jailbreak Filter Result.

Prompt injection and Jailbreak Filter settings.

Option to specify the state of Prompt Injection and Jailbreak filter (ENABLED/DISABLED).

Responsible AI Result.

Detailed Filter result for each of the responsible AI Filter Types.

The abstract base class for a message.

Responsible AI Filter settings.

Responsible AI filter.

Options for responsible AI Filter Types.

Half-open range interval [start, end)

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Sanitization result after applying all the filters on input content.

The abstract base class for a message.

Message describing Sanitization metadata.

Sanitize Model Response request.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Sanitized Model Response Response.

Sanitize User Prompt request.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Sanitized User Prompt Response.

Sensitive Data Protection Advanced configuration.

Sensitive Data Protection basic configuration.

Option to specify the state of Sensitive Data Protection basic config (ENABLED/DISABLED).

Sensitive Data Protection Deidentification Result.

Sensitive Data Protection filter result.

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

Sensitive Data Protection settings.

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

Finding corresponding to Sensitive Data Protection filter.

Location of this Sensitive Data Protection Finding within input content.

For more information about each Sensitive Data Protection likelihood level, see https://cloud.google.com/sensitive-data-protection/docs/likelihood.

Sensitive Data Protection Inspection Result.

Streaming Mode for Sanitize* API.

Message describing Template resource

The abstract base class for a message.

Message describing TemplateMetadata

Enforcement type for Model Armor filters.

Metadata to enable multi language detection via template.

Message for Updating a Floor Setting

Message for updating a Template

Details of an identified virus

Defines all the threat types of a virus

Virus scan results.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Type of content scanned.

API documentation for modelarmor_v1.services.model_armor.pagers module.

API documentation for modelarmor_v1beta.services.model_armor.pagers module.