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

Class BoostSpec.ConditionBoostSpec

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.dialogflow.cx.v3beta1.BoostSpec.ConditionBoostSpec
All Implemented Interfaces:
BoostSpec.ConditionBoostSpecOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
Enclosing class:
BoostSpec
public static final class BoostSpec.ConditionBoostSpec extends com.google.protobuf.GeneratedMessage implements BoostSpec.ConditionBoostSpecOrBuilder
 Boost applies to documents which match a condition.
Protobuf type google.cloud.dialogflow.cx.v3beta1.BoostSpec.ConditionBoostSpec
See Also:

  • Field Details

    • CONDITION_FIELD_NUMBER

      public static final int CONDITION_FIELD_NUMBER
      See Also:

    • BOOST_FIELD_NUMBER

      public static final int BOOST_FIELD_NUMBER
      See Also:

    • BOOST_CONTROL_SPEC_FIELD_NUMBER

      public static final int BOOST_CONTROL_SPEC_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

    • getCondition

      public String getCondition()
       Optional. An expression which specifies a boost condition. The syntax and
 supported fields are the same as a filter expression.
 Examples:

 * To boost documents with document ID "doc_1" or "doc_2", and
 color
 "Red" or "Blue":
 * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue"))
      string condition = 1 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCondition in interface BoostSpec.ConditionBoostSpecOrBuilder
      Returns:
      The condition.

    • getConditionBytes

      public com.google.protobuf.ByteString getConditionBytes()
       Optional. An expression which specifies a boost condition. The syntax and
 supported fields are the same as a filter expression.
 Examples:

 * To boost documents with document ID "doc_1" or "doc_2", and
 color
 "Red" or "Blue":
 * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue"))
      string condition = 1 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getConditionBytes in interface BoostSpec.ConditionBoostSpecOrBuilder
      Returns:
      The bytes for condition.

    • getBoost

      public float getBoost()
       Optional. Strength of the condition boost, which should be in [-1, 1].
 Negative boost means demotion. Default is 0.0.

 Setting to 1.0 gives the document a big promotion. However, it does not
 necessarily mean that the boosted document will be the top result at
 all times, nor that other documents will be excluded. Results could
 still be shown even when none of them matches the condition. And
 results that are significantly more relevant to the search query can
 still trump your heavily favored but irrelevant documents.

 Setting to -1.0 gives the document a big demotion. However, results
 that are deeply relevant might still be shown. The document will have
 an upstream battle to get a fairly high ranking, but it is not blocked
 out completely.

 Setting to 0.0 means no boost applied. The boosting condition is
 ignored.
      float boost = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getBoost in interface BoostSpec.ConditionBoostSpecOrBuilder
      Returns:
      The boost.

    • hasBoostControlSpec

      public boolean hasBoostControlSpec()
       Optional. Complex specification for custom ranking based on customer
 defined attribute value.
      .google.cloud.dialogflow.cx.v3beta1.BoostSpec.ConditionBoostSpec.BoostControlSpec boost_control_spec = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasBoostControlSpec in interface BoostSpec.ConditionBoostSpecOrBuilder
      Returns:
      Whether the boostControlSpec field is set.

    • getBoostControlSpec

      public BoostSpec.ConditionBoostSpec.BoostControlSpec getBoostControlSpec()
       Optional. Complex specification for custom ranking based on customer
 defined attribute value.
      .google.cloud.dialogflow.cx.v3beta1.BoostSpec.ConditionBoostSpec.BoostControlSpec boost_control_spec = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getBoostControlSpec in interface BoostSpec.ConditionBoostSpecOrBuilder
      Returns:
      The boostControlSpec.

    • getBoostControlSpecOrBuilder

      public BoostSpec.ConditionBoostSpec.BoostControlSpecOrBuilder getBoostControlSpecOrBuilder()
       Optional. Complex specification for custom ranking based on customer
 defined attribute value.
      .google.cloud.dialogflow.cx.v3beta1.BoostSpec.ConditionBoostSpec.BoostControlSpec boost_control_spec = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getBoostControlSpecOrBuilder in interface BoostSpec.ConditionBoostSpecOrBuilder

    • 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 BoostSpec.ConditionBoostSpec parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static BoostSpec.ConditionBoostSpec parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static BoostSpec.ConditionBoostSpec parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static BoostSpec.ConditionBoostSpec.Builder newBuilder()

    • newBuilder

      public static BoostSpec.ConditionBoostSpec.Builder newBuilder(BoostSpec.ConditionBoostSpec prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static BoostSpec.ConditionBoostSpec getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<BoostSpec.ConditionBoostSpec> 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 BoostSpec.ConditionBoostSpec getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder