Package com.google.cloud.discoveryengine.v1beta

Class SearchRequest.BoostSpec.ConditionBoostSpec.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<SearchRequest.BoostSpec.ConditionBoostSpec.Builder>
com.google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec.ConditionBoostSpec.Builder
All Implemented Interfaces:
SearchRequest.BoostSpec.ConditionBoostSpecOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
SearchRequest.BoostSpec.ConditionBoostSpec
public static final class SearchRequest.BoostSpec.ConditionBoostSpec.Builder extends com.google.protobuf.GeneratedMessage.Builder<SearchRequest.BoostSpec.ConditionBoostSpec.Builder> implements SearchRequest.BoostSpec.ConditionBoostSpecOrBuilder
 Boost applies to documents which match a condition.
Protobuf type google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec.ConditionBoostSpec

  • 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.Builder<SearchRequest.BoostSpec.ConditionBoostSpec.Builder>

    • clear

      public SearchRequest.BoostSpec.ConditionBoostSpec.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<SearchRequest.BoostSpec.ConditionBoostSpec.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<SearchRequest.BoostSpec.ConditionBoostSpec.Builder>

    • getDefaultInstanceForType

      public SearchRequest.BoostSpec.ConditionBoostSpec getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

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

    • buildPartial

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

    • mergeFrom

      public SearchRequest.BoostSpec.ConditionBoostSpec.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SearchRequest.BoostSpec.ConditionBoostSpec.Builder>

    • mergeFrom

      public SearchRequest.BoostSpec.ConditionBoostSpec.Builder mergeFrom(SearchRequest.BoostSpec.ConditionBoostSpec other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<SearchRequest.BoostSpec.ConditionBoostSpec.Builder>

    • mergeFrom

      public SearchRequest.BoostSpec.ConditionBoostSpec.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SearchRequest.BoostSpec.ConditionBoostSpec.Builder>
      Throws:
      IOException

    • getCondition

      public String getCondition()
       An expression which specifies a boost condition. The syntax and
 supported fields are the same as a filter expression. See
 [SearchRequest.filter][google.cloud.discoveryengine.v1beta.SearchRequest.filter]
 for detail syntax and limitations.

 Examples:

 * To boost documents with document ID "doc_1" or "doc_2", and
 color "Red" or "Blue":
 `(document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))`
      string condition = 1;
      Specified by:
      getCondition in interface SearchRequest.BoostSpec.ConditionBoostSpecOrBuilder
      Returns:
      The condition.

    • getConditionBytes

      public com.google.protobuf.ByteString getConditionBytes()
       An expression which specifies a boost condition. The syntax and
 supported fields are the same as a filter expression. See
 [SearchRequest.filter][google.cloud.discoveryengine.v1beta.SearchRequest.filter]
 for detail syntax and limitations.

 Examples:

 * To boost documents with document ID "doc_1" or "doc_2", and
 color "Red" or "Blue":
 `(document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))`
      string condition = 1;
      Specified by:
      getConditionBytes in interface SearchRequest.BoostSpec.ConditionBoostSpecOrBuilder
      Returns:
      The bytes for condition.

    • setCondition

      public SearchRequest.BoostSpec.ConditionBoostSpec.Builder setCondition(String value)
       An expression which specifies a boost condition. The syntax and
 supported fields are the same as a filter expression. See
 [SearchRequest.filter][google.cloud.discoveryengine.v1beta.SearchRequest.filter]
 for detail syntax and limitations.

 Examples:

 * To boost documents with document ID "doc_1" or "doc_2", and
 color "Red" or "Blue":
 `(document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))`
      string condition = 1;
      Parameters:
      value - The condition to set.
      Returns:
      This builder for chaining.

    • clearCondition

      public SearchRequest.BoostSpec.ConditionBoostSpec.Builder clearCondition()
       An expression which specifies a boost condition. The syntax and
 supported fields are the same as a filter expression. See
 [SearchRequest.filter][google.cloud.discoveryengine.v1beta.SearchRequest.filter]
 for detail syntax and limitations.

 Examples:

 * To boost documents with document ID "doc_1" or "doc_2", and
 color "Red" or "Blue":
 `(document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))`
      string condition = 1;
      Returns:
      This builder for chaining.

    • setConditionBytes

      public SearchRequest.BoostSpec.ConditionBoostSpec.Builder setConditionBytes(com.google.protobuf.ByteString value)
       An expression which specifies a boost condition. The syntax and
 supported fields are the same as a filter expression. See
 [SearchRequest.filter][google.cloud.discoveryengine.v1beta.SearchRequest.filter]
 for detail syntax and limitations.

 Examples:

 * To boost documents with document ID "doc_1" or "doc_2", and
 color "Red" or "Blue":
 `(document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))`
      string condition = 1;
      Parameters:
      value - The bytes for condition to set.
      Returns:
      This builder for chaining.

    • getBoost

      public float getBoost()
       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. Only one of the (condition, boost) combination or the
 boost_control_spec below are set. If both are set then the global boost
 is ignored and the more fine-grained boost_control_spec is applied.
      float boost = 2;
      Specified by:
      getBoost in interface SearchRequest.BoostSpec.ConditionBoostSpecOrBuilder
      Returns:
      The boost.

    • setBoost

      public SearchRequest.BoostSpec.ConditionBoostSpec.Builder setBoost(float value)
       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. Only one of the (condition, boost) combination or the
 boost_control_spec below are set. If both are set then the global boost
 is ignored and the more fine-grained boost_control_spec is applied.
      float boost = 2;
      Parameters:
      value - The boost to set.
      Returns:
      This builder for chaining.

    • clearBoost

      public SearchRequest.BoostSpec.ConditionBoostSpec.Builder clearBoost()
       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. Only one of the (condition, boost) combination or the
 boost_control_spec below are set. If both are set then the global boost
 is ignored and the more fine-grained boost_control_spec is applied.
      float boost = 2;
      Returns:
      This builder for chaining.

    • hasBoostControlSpec

      public boolean hasBoostControlSpec()
       Complex specification for custom ranking based on customer defined
 attribute value.
      .google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec boost_control_spec = 3;
      Specified by:
      hasBoostControlSpec in interface SearchRequest.BoostSpec.ConditionBoostSpecOrBuilder
      Returns:
      Whether the boostControlSpec field is set.

    • getBoostControlSpec

      public SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec getBoostControlSpec()
       Complex specification for custom ranking based on customer defined
 attribute value.
      .google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec boost_control_spec = 3;
      Specified by:
      getBoostControlSpec in interface SearchRequest.BoostSpec.ConditionBoostSpecOrBuilder
      Returns:
      The boostControlSpec.

    • setBoostControlSpec

      public SearchRequest.BoostSpec.ConditionBoostSpec.Builder setBoostControlSpec(SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec value)
       Complex specification for custom ranking based on customer defined
 attribute value.
      .google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec boost_control_spec = 3;

    • setBoostControlSpec

      public SearchRequest.BoostSpec.ConditionBoostSpec.Builder setBoostControlSpec(SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.Builder builderForValue)
       Complex specification for custom ranking based on customer defined
 attribute value.
      .google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec boost_control_spec = 3;

    • mergeBoostControlSpec

      public SearchRequest.BoostSpec.ConditionBoostSpec.Builder mergeBoostControlSpec(SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec value)
       Complex specification for custom ranking based on customer defined
 attribute value.
      .google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec boost_control_spec = 3;

    • clearBoostControlSpec

      public SearchRequest.BoostSpec.ConditionBoostSpec.Builder clearBoostControlSpec()
       Complex specification for custom ranking based on customer defined
 attribute value.
      .google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec boost_control_spec = 3;

    • getBoostControlSpecBuilder

      public SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.Builder getBoostControlSpecBuilder()
       Complex specification for custom ranking based on customer defined
 attribute value.
      .google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec boost_control_spec = 3;

    • getBoostControlSpecOrBuilder

      public SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpecOrBuilder getBoostControlSpecOrBuilder()
       Complex specification for custom ranking based on customer defined
 attribute value.
      .google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec boost_control_spec = 3;
      Specified by:
      getBoostControlSpecOrBuilder in interface SearchRequest.BoostSpec.ConditionBoostSpecOrBuilder