Reference documentation and code samples for the Google Cloud Model Armor V1beta Client class RaiFilterResult.
Responsible AI Result.
Generated from protobuf message google.cloud.modelarmor.v1beta.RaiFilterResult
Namespace
Google \ Cloud \ ModelArmor \ V1betaMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ execution_state |
int
Output only. Reports whether the RAI filter was successfully executed or not. |
↳ message_items |
array<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 |
int
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 |
array|Google\Protobuf\Internal\MapField
The map of RAI filter results where key is RAI filter type - either of "sexually_explicit", "hate_speech", "harassment", "dangerous". |
getExecutionState
Output only. Reports whether the RAI filter was successfully executed or not.
| Returns | |
|---|---|
| Type | Description |
int |
|
setExecutionState
Output only. Reports whether the RAI filter was successfully executed or not.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMessageItems
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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setMessageItems
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.
| Parameter | |
|---|---|
| Name | Description |
var |
array<MessageItem>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMatchState
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.
| Returns | |
|---|---|
| Type | Description |
int |
|
setMatchState
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.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRaiFilterTypeResults
The map of RAI filter results where key is RAI filter type - either of "sexually_explicit", "hate_speech", "harassment", "dangerous".
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField |
|
setRaiFilterTypeResults
The map of RAI filter results where key is RAI filter type - either of "sexually_explicit", "hate_speech", "harassment", "dangerous".
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this |
|