Package com.google.cloud.dialogflow.cx.v3beta1

Class SafetySettings

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.dialogflow.cx.v3beta1.SafetySettings
All Implemented Interfaces:
SafetySettingsOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class SafetySettings extends com.google.protobuf.GeneratedMessage implements SafetySettingsOrBuilder
 Settings for Generative Safety.
Protobuf type google.cloud.dialogflow.cx.v3beta1.SafetySettings
See Also:

  • Field Details

    • DEFAULT_BANNED_PHRASE_MATCH_STRATEGY_FIELD_NUMBER

      public static final int DEFAULT_BANNED_PHRASE_MATCH_STRATEGY_FIELD_NUMBER
      See Also:

    • BANNED_PHRASES_FIELD_NUMBER

      public static final int BANNED_PHRASES_FIELD_NUMBER
      See Also:

    • RAI_SETTINGS_FIELD_NUMBER

      public static final int RAI_SETTINGS_FIELD_NUMBER
      See Also:

    • DEFAULT_RAI_SETTINGS_FIELD_NUMBER

      public static final int DEFAULT_RAI_SETTINGS_FIELD_NUMBER
      See Also:

    • PROMPT_SECURITY_SETTINGS_FIELD_NUMBER

      public static final int PROMPT_SECURITY_SETTINGS_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • 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];
      Specified by:
      getDefaultBannedPhraseMatchStrategyValue in interface SafetySettingsOrBuilder
      Returns:
      The enum numeric value on the wire for defaultBannedPhraseMatchStrategy.

    • 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];
      Specified by:
      getDefaultBannedPhraseMatchStrategy in interface SafetySettingsOrBuilder
      Returns:
      The defaultBannedPhraseMatchStrategy.

    • getBannedPhrasesList

      public List<SafetySettings.Phrase> getBannedPhrasesList()
       Banned phrases for generated text.
      repeated .google.cloud.dialogflow.cx.v3beta1.SafetySettings.Phrase banned_phrases = 1;
      Specified by:
      getBannedPhrasesList in interface SafetySettingsOrBuilder

    • getBannedPhrasesOrBuilderList

      public List<? extends SafetySettings.PhraseOrBuilder> getBannedPhrasesOrBuilderList()
       Banned phrases for generated text.
      repeated .google.cloud.dialogflow.cx.v3beta1.SafetySettings.Phrase banned_phrases = 1;
      Specified by:
      getBannedPhrasesOrBuilderList in interface SafetySettingsOrBuilder

    • getBannedPhrasesCount

      public int getBannedPhrasesCount()
       Banned phrases for generated text.
      repeated .google.cloud.dialogflow.cx.v3beta1.SafetySettings.Phrase banned_phrases = 1;
      Specified by:
      getBannedPhrasesCount in interface SafetySettingsOrBuilder

    • getBannedPhrases

      public SafetySettings.Phrase getBannedPhrases(int index)
       Banned phrases for generated text.
      repeated .google.cloud.dialogflow.cx.v3beta1.SafetySettings.Phrase banned_phrases = 1;
      Specified by:
      getBannedPhrases in interface SafetySettingsOrBuilder

    • getBannedPhrasesOrBuilder

      public SafetySettings.PhraseOrBuilder getBannedPhrasesOrBuilder(int index)
       Banned phrases for generated text.
      repeated .google.cloud.dialogflow.cx.v3beta1.SafetySettings.Phrase banned_phrases = 1;
      Specified by:
      getBannedPhrasesOrBuilder in interface SafetySettingsOrBuilder

    • 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];
      Specified by:
      hasRaiSettings in interface SafetySettingsOrBuilder
      Returns:
      Whether the raiSettings field is set.

    • 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];
      Specified by:
      getRaiSettings in interface SafetySettingsOrBuilder
      Returns:
      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];
      Specified by:
      getRaiSettingsOrBuilder in interface SafetySettingsOrBuilder

    • 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];
      Specified by:
      hasDefaultRaiSettings in interface SafetySettingsOrBuilder
      Returns:
      Whether the defaultRaiSettings field is set.

    • 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];
      Specified by:
      getDefaultRaiSettings in interface SafetySettingsOrBuilder
      Returns:
      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];
      Specified by:
      getDefaultRaiSettingsOrBuilder in interface SafetySettingsOrBuilder

    • 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];
      Specified by:
      hasPromptSecuritySettings in interface SafetySettingsOrBuilder
      Returns:
      Whether the promptSecuritySettings field is set.

    • 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];
      Specified by:
      getPromptSecuritySettings in interface SafetySettingsOrBuilder
      Returns:
      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];
      Specified by:
      getPromptSecuritySettingsOrBuilder in interface SafetySettingsOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static SafetySettings parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SafetySettings parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SafetySettings parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SafetySettings parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SafetySettings parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SafetySettings parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SafetySettings parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SafetySettings parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static SafetySettings parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static SafetySettings parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SafetySettings parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SafetySettings parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public SafetySettings.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static SafetySettings.Builder newBuilder()

    • newBuilder

      public static SafetySettings.Builder newBuilder(SafetySettings prototype)

    • toBuilder

      public SafetySettings.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected SafetySettings.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static SafetySettings getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<SafetySettings> parser()

    • getParserForType

      public com.google.protobuf.Parser<SafetySettings> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public SafetySettings getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder