Class SafetySettings (0.92.0)

Version latest

• 0.92.0 (latest)
• 0.91.0
• 0.89.0
• 0.87.0
• 0.86.0
• 0.85.0
• 0.84.0
• 0.83.0
• 0.81.0
• 0.79.0
• 0.78.0
• 0.75.0
• 0.74.0
• 0.73.0
• 0.71.0
• 0.70.0
• 0.69.0
• 0.68.0
• 0.67.0
• 0.66.0
• 0.65.0
• 0.64.0
• 0.63.0
• 0.62.0
• 0.60.0
• 0.59.0
• 0.58.0
• 0.57.0
• 0.56.0
• 0.55.0
• 0.54.0
• 0.53.0
• 0.52.0
• 0.51.0
• 0.50.0
• 0.48.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.7
• 0.13.1
• 0.12.1
• 0.11.5

public final class SafetySettings extends GeneratedMessageV3 implements SafetySettingsOrBuilder

Settings for Generative Safety.

Protobuf type google.cloud.dialogflow.cx.v3beta1.SafetySettings

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > SafetySettings

Implements

SafetySettingsOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

BANNED_PHRASES_FIELD_NUMBER

public static final int BANNED_PHRASES_FIELD_NUMBER

Field Value
Type	Description
int

DEFAULT_BANNED_PHRASE_MATCH_STRATEGY_FIELD_NUMBER

public static final int DEFAULT_BANNED_PHRASE_MATCH_STRATEGY_FIELD_NUMBER

Field Value
Type	Description
int

DEFAULT_RAI_SETTINGS_FIELD_NUMBER

public static final int DEFAULT_RAI_SETTINGS_FIELD_NUMBER

Field Value
Type	Description
int

PROMPT_SECURITY_SETTINGS_FIELD_NUMBER

public static final int PROMPT_SECURITY_SETTINGS_FIELD_NUMBER

Field Value
Type	Description
int

RAI_SETTINGS_FIELD_NUMBER

public static final int RAI_SETTINGS_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static SafetySettings getDefaultInstance()

Returns
Type	Description
SafetySettings

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static SafetySettings.Builder newBuilder()

Returns
Type	Description
SafetySettings.Builder

newBuilder(SafetySettings prototype)

public static SafetySettings.Builder newBuilder(SafetySettings prototype)

Parameter
Name	Description
prototype	SafetySettings

Returns
Type	Description
SafetySettings.Builder

parseDelimitedFrom(InputStream input)

public static SafetySettings parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
SafetySettings

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SafetySettings parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SafetySettings

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static SafetySettings parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
SafetySettings

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SafetySettings parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SafetySettings

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SafetySettings parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
SafetySettings

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SafetySettings parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SafetySettings

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SafetySettings parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
SafetySettings

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SafetySettings parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SafetySettings

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static SafetySettings parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
SafetySettings

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SafetySettings parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SafetySettings

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static SafetySettings parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
SafetySettings

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SafetySettings parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SafetySettings

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<SafetySettings> parser()

Returns
Type	Description
Parser<SafetySettings>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getBannedPhrases(int index)

public SafetySettings.Phrase getBannedPhrases(int index)

Banned phrases for generated text.

repeated .google.cloud.dialogflow.cx.v3beta1.SafetySettings.Phrase banned_phrases = 1;

Parameter
Name	Description
index	int

Returns
Type	Description
SafetySettings.Phrase

getBannedPhrasesCount()

public int getBannedPhrasesCount()

Banned phrases for generated text.

repeated .google.cloud.dialogflow.cx.v3beta1.SafetySettings.Phrase banned_phrases = 1;

Returns
Type	Description
int

getBannedPhrasesList()

public List<SafetySettings.Phrase> getBannedPhrasesList()

Banned phrases for generated text.

repeated .google.cloud.dialogflow.cx.v3beta1.SafetySettings.Phrase banned_phrases = 1;

Returns
Type	Description
List<Phrase>

getBannedPhrasesOrBuilder(int index)

public SafetySettings.PhraseOrBuilder getBannedPhrasesOrBuilder(int index)

Banned phrases for generated text.

repeated .google.cloud.dialogflow.cx.v3beta1.SafetySettings.Phrase banned_phrases = 1;

Parameter
Name	Description
index	int

Returns
Type	Description
SafetySettings.PhraseOrBuilder

getBannedPhrasesOrBuilderList()

public List<? extends SafetySettings.PhraseOrBuilder> getBannedPhrasesOrBuilderList()

Banned phrases for generated text.

repeated .google.cloud.dialogflow.cx.v3beta1.SafetySettings.Phrase banned_phrases = 1;

Returns
Type	Description
List<? extends com.google.cloud.dialogflow.cx.v3beta1.SafetySettings.PhraseOrBuilder>

getDefaultBannedPhraseMatchStrategy()

public SafetySettings.PhraseMatchStrategy getDefaultBannedPhraseMatchStrategy()

Optional. Default phrase match strategy for banned phrases.

.google.cloud.dialogflow.cx.v3beta1.SafetySettings.PhraseMatchStrategy default_banned_phrase_match_strategy = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
SafetySettings.PhraseMatchStrategy	The defaultBannedPhraseMatchStrategy.

getDefaultBannedPhraseMatchStrategyValue()

public int getDefaultBannedPhraseMatchStrategyValue()

Optional. Default phrase match strategy for banned phrases.

.google.cloud.dialogflow.cx.v3beta1.SafetySettings.PhraseMatchStrategy default_banned_phrase_match_strategy = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The enum numeric value on the wire for defaultBannedPhraseMatchStrategy.

getDefaultInstanceForType()

public SafetySettings getDefaultInstanceForType()

Returns
Type	Description
SafetySettings

getDefaultRaiSettings()

public SafetySettings.RaiSettings getDefaultRaiSettings()

Optional. Immutable. Default RAI settings to be annotated on the agent, so that users will be able to restore their RAI configurations to the default settings. Read-only field for the API proto only.

.google.cloud.dialogflow.cx.v3beta1.SafetySettings.RaiSettings default_rai_settings = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
SafetySettings.RaiSettings	The defaultRaiSettings.

getDefaultRaiSettingsOrBuilder()

public SafetySettings.RaiSettingsOrBuilder getDefaultRaiSettingsOrBuilder()

Optional. Immutable. Default RAI settings to be annotated on the agent, so that users will be able to restore their RAI configurations to the default settings. Read-only field for the API proto only.

.google.cloud.dialogflow.cx.v3beta1.SafetySettings.RaiSettings default_rai_settings = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
SafetySettings.RaiSettingsOrBuilder

getParserForType()

public Parser<SafetySettings> getParserForType()

Returns
Type	Description
Parser<SafetySettings>

Overrides

GeneratedMessageV3.getParserForType()

getPromptSecuritySettings()

public SafetySettings.PromptSecuritySettings getPromptSecuritySettings()

Optional. Settings for prompt security checks.

.google.cloud.dialogflow.cx.v3beta1.SafetySettings.PromptSecuritySettings prompt_security_settings = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
SafetySettings.PromptSecuritySettings	The promptSecuritySettings.

getPromptSecuritySettingsOrBuilder()

public SafetySettings.PromptSecuritySettingsOrBuilder getPromptSecuritySettingsOrBuilder()

Optional. Settings for prompt security checks.

.google.cloud.dialogflow.cx.v3beta1.SafetySettings.PromptSecuritySettings prompt_security_settings = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
SafetySettings.PromptSecuritySettingsOrBuilder

getRaiSettings()

public SafetySettings.RaiSettings getRaiSettings()

Optional. Settings for Responsible AI checks.

.google.cloud.dialogflow.cx.v3beta1.SafetySettings.RaiSettings rai_settings = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
SafetySettings.RaiSettings	The raiSettings.

getRaiSettingsOrBuilder()

public SafetySettings.RaiSettingsOrBuilder getRaiSettingsOrBuilder()

Optional. Settings for Responsible AI checks.

.google.cloud.dialogflow.cx.v3beta1.SafetySettings.RaiSettings rai_settings = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
SafetySettings.RaiSettingsOrBuilder

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

hasDefaultRaiSettings()

public boolean hasDefaultRaiSettings()

Optional. Immutable. Default RAI settings to be annotated on the agent, so that users will be able to restore their RAI configurations to the default settings. Read-only field for the API proto only.

.google.cloud.dialogflow.cx.v3beta1.SafetySettings.RaiSettings default_rai_settings = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
boolean	Whether the defaultRaiSettings field is set.

hasPromptSecuritySettings()

public boolean hasPromptSecuritySettings()

Optional. Settings for prompt security checks.

.google.cloud.dialogflow.cx.v3beta1.SafetySettings.PromptSecuritySettings prompt_security_settings = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the promptSecuritySettings field is set.

hasRaiSettings()

public boolean hasRaiSettings()

Optional. Settings for Responsible AI checks.

.google.cloud.dialogflow.cx.v3beta1.SafetySettings.RaiSettings rai_settings = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the raiSettings field is set.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public SafetySettings.Builder newBuilderForType()

Returns
Type	Description
SafetySettings.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SafetySettings.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
SafetySettings.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public SafetySettings.Builder toBuilder()

Returns
Type	Description
SafetySettings.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException