Class SafetyRating (3.48.0)

public final class SafetyRating extends GeneratedMessageV3 implements SafetyRatingOrBuilder

Safety rating corresponding to the generated content.

Protobuf type google.cloud.aiplatform.v1beta1.SafetyRating

Static Fields

BLOCKED_FIELD_NUMBER

public static final int BLOCKED_FIELD_NUMBER
Field Value
Type Description
int

CATEGORY_FIELD_NUMBER

public static final int CATEGORY_FIELD_NUMBER
Field Value
Type Description
int

PROBABILITY_FIELD_NUMBER

public static final int PROBABILITY_FIELD_NUMBER
Field Value
Type Description
int

PROBABILITY_SCORE_FIELD_NUMBER

public static final int PROBABILITY_SCORE_FIELD_NUMBER
Field Value
Type Description
int

SEVERITY_FIELD_NUMBER

public static final int SEVERITY_FIELD_NUMBER
Field Value
Type Description
int

SEVERITY_SCORE_FIELD_NUMBER

public static final int SEVERITY_SCORE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SafetyRating getDefaultInstance()
Returns
Type Description
SafetyRating

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static SafetyRating.Builder newBuilder()
Returns
Type Description
SafetyRating.Builder

newBuilder(SafetyRating prototype)

public static SafetyRating.Builder newBuilder(SafetyRating prototype)
Parameter
Name Description
prototype SafetyRating
Returns
Type Description
SafetyRating.Builder

parseDelimitedFrom(InputStream input)

public static SafetyRating parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SafetyRating
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SafetyRating parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SafetyRating
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static SafetyRating parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
SafetyRating
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SafetyRating parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SafetyRating
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SafetyRating parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SafetyRating
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SafetyRating parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SafetyRating
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SafetyRating parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SafetyRating
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SafetyRating parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SafetyRating
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static SafetyRating parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SafetyRating
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SafetyRating parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SafetyRating
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static SafetyRating parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SafetyRating
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SafetyRating parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SafetyRating
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<SafetyRating> parser()
Returns
Type Description
Parser<SafetyRating>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getBlocked()

public boolean getBlocked()

Output only. Indicates whether the content was filtered out because of this rating.

bool blocked = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The blocked.

getCategory()

public HarmCategory getCategory()

Output only. Harm category.

.google.cloud.aiplatform.v1beta1.HarmCategory category = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
HarmCategory

The category.

getCategoryValue()

public int getCategoryValue()

Output only. Harm category.

.google.cloud.aiplatform.v1beta1.HarmCategory category = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for category.

getDefaultInstanceForType()

public SafetyRating getDefaultInstanceForType()
Returns
Type Description
SafetyRating

getParserForType()

public Parser<SafetyRating> getParserForType()
Returns
Type Description
Parser<SafetyRating>
Overrides

getProbability()

public SafetyRating.HarmProbability getProbability()

Output only. Harm probability levels in the content.

.google.cloud.aiplatform.v1beta1.SafetyRating.HarmProbability probability = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
SafetyRating.HarmProbability

The probability.

getProbabilityScore()

public float getProbabilityScore()

Output only. Harm probability score.

float probability_score = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
float

The probabilityScore.

getProbabilityValue()

public int getProbabilityValue()

Output only. Harm probability levels in the content.

.google.cloud.aiplatform.v1beta1.SafetyRating.HarmProbability probability = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for probability.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSeverity()

public SafetyRating.HarmSeverity getSeverity()

Output only. Harm severity levels in the content.

.google.cloud.aiplatform.v1beta1.SafetyRating.HarmSeverity severity = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
SafetyRating.HarmSeverity

The severity.

getSeverityScore()

public float getSeverityScore()

Output only. Harm severity score.

float severity_score = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
float

The severityScore.

getSeverityValue()

public int getSeverityValue()

Output only. Harm severity levels in the content.

.google.cloud.aiplatform.v1beta1.SafetyRating.HarmSeverity severity = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for severity.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public SafetyRating.Builder newBuilderForType()
Returns
Type Description
SafetyRating.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SafetyRating.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SafetyRating.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public SafetyRating.Builder toBuilder()
Returns
Type Description
SafetyRating.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException