Package com.google.cloud.discoveryengine.v1

Class SearchRequest.BoostSpec.ConditionBoostSpec.Builder

    • Method Detail

      • getDescriptor

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

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.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.GeneratedMessageV3.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

      • isInitialized

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

      • 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.v1.SearchRequest.filter]
 for detail syntax and limitations.

 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;
        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.v1.SearchRequest.filter]
 for detail syntax and limitations.

 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;
        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.v1.SearchRequest.filter]
 for detail syntax and limitations.

 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;
        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.v1.SearchRequest.filter]
 for detail syntax and limitations.

 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;
        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.v1.SearchRequest.filter]
 for detail syntax and limitations.

 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;
        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.
        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.
        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.
        float boost = 2;
        Returns:
        This builder for chaining.