Class RaiFilterResult (0.3.0)

RaiFilterResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Responsible AI Result.

Attributes

Name Description
execution_state google.cloud.modelarmor_v1.types.FilterExecutionState
Output only. Reports whether the RAI filter was successfully executed or not.
message_items MutableSequence[google.cloud.modelarmor_v1.types.MessageItem]
Optional messages corresponding to the result. A message can provide warnings or error details. For example, if execution state is skipped then this field provides related reason/explanation.
match_state google.cloud.modelarmor_v1.types.FilterMatchState
Output only. Overall filter match state for RAI. Value is MATCH_FOUND if at least one RAI filter confidence level is equal to or higher than the confidence level defined in configuration.
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".

Classes

RaiFilterTypeResult

RaiFilterTypeResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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

RaiFilterTypeResultsEntry

RaiFilterTypeResultsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name Description
kwargs dict

Keys and values corresponding to the fields of the message.

mapping Union[dict, .Message]

A dictionary or message to be used to determine the values for this message.

ignore_unknown_fields Optional(bool)

If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.