public final class RaiFilterResult extends GeneratedMessageV3 implements RaiFilterResultOrBuilder
Responsible AI Result.
Protobuf type google.cloud.modelarmor.v1.RaiFilterResult
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
EXECUTION_STATE_FIELD_NUMBER
public static final int EXECUTION_STATE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
MATCH_STATE_FIELD_NUMBER
public static final int MATCH_STATE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
MESSAGE_ITEMS_FIELD_NUMBER
public static final int MESSAGE_ITEMS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
RAI_FILTER_TYPE_RESULTS_FIELD_NUMBER
public static final int RAI_FILTER_TYPE_RESULTS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static RaiFilterResult getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static RaiFilterResult.Builder newBuilder()
newBuilder(RaiFilterResult prototype)
public static RaiFilterResult.Builder newBuilder(RaiFilterResult prototype)
public static RaiFilterResult parseDelimitedFrom(InputStream input)
public static RaiFilterResult parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static RaiFilterResult parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static RaiFilterResult parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static RaiFilterResult parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static RaiFilterResult parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static RaiFilterResult parseFrom(CodedInputStream input)
public static RaiFilterResult parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static RaiFilterResult parseFrom(InputStream input)
public static RaiFilterResult parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static RaiFilterResult parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static RaiFilterResult parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<RaiFilterResult> parser()
Methods
containsRaiFilterTypeResults(String key)
public 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
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public RaiFilterResult getDefaultInstanceForType()
getExecutionState()
public 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];
getExecutionStateValue()
public 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 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];
getMatchStateValue()
public 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 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
|
getMessageItemsCount()
public 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 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;
getMessageItemsOrBuilder(int index)
public 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
|
getMessageItemsOrBuilderList()
public 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> |
|
getParserForType()
public Parser<RaiFilterResult> getParserForType()
Overrides
getRaiFilterTypeResults() (deprecated)
public Map<String,RaiFilterResult.RaiFilterTypeResult> getRaiFilterTypeResults()
getRaiFilterTypeResultsCount()
public 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 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;
getRaiFilterTypeResultsOrDefault(String key, RaiFilterResult.RaiFilterTypeResult defaultValue)
public 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;
getRaiFilterTypeResultsOrThrow(String key)
public 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
|
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
| Parameter |
| Name |
Description |
number |
int
|
| Returns |
| Type |
Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public RaiFilterResult.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected RaiFilterResult.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public RaiFilterResult.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
