public interface RaiFilterResultOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
containsRaiFilterTypeResults(String key)
public abstract boolean containsRaiFilterTypeResults(String key)The map of RAI filter results where key is RAI filter type - either of "sexually_explicit", "hate_speech", "harassment", "dangerous".
map<string, .google.cloud.modelarmor.v1.RaiFilterResult.RaiFilterTypeResult> rai_filter_type_results = 4;
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getExecutionState()
public abstract FilterExecutionState getExecutionState()Output only. Reports whether the RAI filter was successfully executed or not.
.google.cloud.modelarmor.v1.FilterExecutionState execution_state = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
FilterExecutionState |
The executionState. |
getExecutionStateValue()
public abstract int getExecutionStateValue()Output only. Reports whether the RAI filter was successfully executed or not.
.google.cloud.modelarmor.v1.FilterExecutionState execution_state = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for executionState. |
getMatchState()
public abstract FilterMatchState 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.
.google.cloud.modelarmor.v1.FilterMatchState match_state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
FilterMatchState |
The matchState. |
getMatchStateValue()
public abstract int getMatchStateValue()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.
.google.cloud.modelarmor.v1.FilterMatchState match_state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for matchState. |
getMessageItems(int index)
public abstract MessageItem getMessageItems(int index)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.
repeated .google.cloud.modelarmor.v1.MessageItem message_items = 2;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
MessageItem |
|
getMessageItemsCount()
public abstract int getMessageItemsCount()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.
repeated .google.cloud.modelarmor.v1.MessageItem message_items = 2;
| Returns | |
|---|---|
| Type | Description |
int |
|
getMessageItemsList()
public abstract List<MessageItem> getMessageItemsList()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.
repeated .google.cloud.modelarmor.v1.MessageItem message_items = 2;
| Returns | |
|---|---|
| Type | Description |
List<MessageItem> |
|
getMessageItemsOrBuilder(int index)
public abstract MessageItemOrBuilder getMessageItemsOrBuilder(int index)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.
repeated .google.cloud.modelarmor.v1.MessageItem message_items = 2;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
MessageItemOrBuilder |
|
getMessageItemsOrBuilderList()
public abstract List<? extends MessageItemOrBuilder> getMessageItemsOrBuilderList()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.
repeated .google.cloud.modelarmor.v1.MessageItem message_items = 2;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.modelarmor.v1.MessageItemOrBuilder> |
|
getRaiFilterTypeResults() (deprecated)
public abstract Map<String,RaiFilterResult.RaiFilterTypeResult> getRaiFilterTypeResults()Use #getRaiFilterTypeResultsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,RaiFilterTypeResult> |
|
getRaiFilterTypeResultsCount()
public abstract int getRaiFilterTypeResultsCount()The map of RAI filter results where key is RAI filter type - either of "sexually_explicit", "hate_speech", "harassment", "dangerous".
map<string, .google.cloud.modelarmor.v1.RaiFilterResult.RaiFilterTypeResult> rai_filter_type_results = 4;
| Returns | |
|---|---|
| Type | Description |
int |
|
getRaiFilterTypeResultsMap()
public abstract Map<String,RaiFilterResult.RaiFilterTypeResult> getRaiFilterTypeResultsMap()The map of RAI filter results where key is RAI filter type - either of "sexually_explicit", "hate_speech", "harassment", "dangerous".
map<string, .google.cloud.modelarmor.v1.RaiFilterResult.RaiFilterTypeResult> rai_filter_type_results = 4;
| Returns | |
|---|---|
| Type | Description |
Map<String,RaiFilterTypeResult> |
|
getRaiFilterTypeResultsOrDefault(String key, RaiFilterResult.RaiFilterTypeResult defaultValue)
public abstract RaiFilterResult.RaiFilterTypeResult getRaiFilterTypeResultsOrDefault(String key, RaiFilterResult.RaiFilterTypeResult defaultValue)The map of RAI filter results where key is RAI filter type - either of "sexually_explicit", "hate_speech", "harassment", "dangerous".
map<string, .google.cloud.modelarmor.v1.RaiFilterResult.RaiFilterTypeResult> rai_filter_type_results = 4;
| Parameters | |
|---|---|
| Name | Description |
key |
String |
defaultValue |
RaiFilterResult.RaiFilterTypeResult |
| Returns | |
|---|---|
| Type | Description |
RaiFilterResult.RaiFilterTypeResult |
|
getRaiFilterTypeResultsOrThrow(String key)
public abstract RaiFilterResult.RaiFilterTypeResult getRaiFilterTypeResultsOrThrow(String key)The map of RAI filter results where key is RAI filter type - either of "sexually_explicit", "hate_speech", "harassment", "dangerous".
map<string, .google.cloud.modelarmor.v1.RaiFilterResult.RaiFilterTypeResult> rai_filter_type_results = 4;
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
RaiFilterResult.RaiFilterTypeResult |
|