Package com.google.cloud.discoveryengine.v1

Class SearchRequest.BoostSpec.ConditionBoostSpec

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • 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

      • 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.

      • 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.

      • isInitialized

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

      • 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.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

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

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

      • parseFrom

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

      • parseFrom

        public static SearchRequest.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 SearchRequest.BoostSpec.ConditionBoostSpec parseFrom​(byte[] data)
                                                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • newBuilderForType

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

      • getParserForType

        public com.google.protobuf.Parser<SearchRequest.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.GeneratedMessageV3

      • getDefaultInstanceForType

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