- 0.74.0 (latest)
 - 0.72.0
 - 0.71.0
 - 0.70.0
 - 0.69.0
 - 0.68.0
 - 0.66.0
 - 0.64.0
 - 0.63.0
 - 0.60.0
 - 0.59.0
 - 0.58.0
 - 0.56.0
 - 0.55.0
 - 0.54.0
 - 0.53.0
 - 0.52.0
 - 0.51.0
 - 0.50.0
 - 0.49.0
 - 0.48.0
 - 0.47.0
 - 0.45.0
 - 0.44.0
 - 0.43.0
 - 0.42.0
 - 0.41.0
 - 0.40.0
 - 0.39.0
 - 0.38.0
 - 0.37.0
 - 0.36.0
 - 0.35.0
 - 0.33.0
 - 0.32.0
 - 0.31.0
 - 0.30.0
 - 0.29.0
 - 0.28.0
 - 0.27.0
 - 0.26.0
 - 0.25.0
 - 0.24.0
 - 0.23.0
 - 0.20.0
 - 0.19.0
 - 0.18.0
 - 0.17.0
 - 0.16.0
 - 0.15.0
 - 0.14.0
 - 0.13.0
 - 0.12.0
 - 0.11.0
 - 0.10.0
 - 0.9.0
 - 0.8.0
 - 0.7.0
 - 0.5.0
 - 0.4.0
 - 0.3.0
 - 0.2.0
 - 0.1.0
 
public static final class SearchResponse.SearchResult.RankSignals.Builder extends GeneratedMessageV3.Builder<SearchResponse.SearchResult.RankSignals.Builder> implements SearchResponse.SearchResult.RankSignalsOrBuilderA set of ranking signals.
 Protobuf type 
 google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RankSignals
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > SearchResponse.SearchResult.RankSignals.BuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description | 
Descriptor | 
        |
Methods
addAllCustomSignals(Iterable<? extends SearchResponse.SearchResult.RankSignals.CustomSignal> values)
public SearchResponse.SearchResult.RankSignals.Builder addAllCustomSignals(Iterable<? extends SearchResponse.SearchResult.RankSignals.CustomSignal> values)A list of custom clearbox signals.
 
 repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RankSignals.CustomSignal custom_signals = 33 [(.google.api.field_behavior) = OPTIONAL];
 
| Parameter | |
|---|---|
| Name | Description | 
values | 
        Iterable<? extends com.google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RankSignals.CustomSignal> | 
      
| Returns | |
|---|---|
| Type | Description | 
SearchResponse.SearchResult.RankSignals.Builder | 
        |
addCustomSignals(SearchResponse.SearchResult.RankSignals.CustomSignal value)
public SearchResponse.SearchResult.RankSignals.Builder addCustomSignals(SearchResponse.SearchResult.RankSignals.CustomSignal value)A list of custom clearbox signals.
 
 repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RankSignals.CustomSignal custom_signals = 33 [(.google.api.field_behavior) = OPTIONAL];
 
| Parameter | |
|---|---|
| Name | Description | 
value | 
        SearchResponse.SearchResult.RankSignals.CustomSignal | 
      
| Returns | |
|---|---|
| Type | Description | 
SearchResponse.SearchResult.RankSignals.Builder | 
        |
addCustomSignals(SearchResponse.SearchResult.RankSignals.CustomSignal.Builder builderForValue)
public SearchResponse.SearchResult.RankSignals.Builder addCustomSignals(SearchResponse.SearchResult.RankSignals.CustomSignal.Builder builderForValue)A list of custom clearbox signals.
 
 repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RankSignals.CustomSignal custom_signals = 33 [(.google.api.field_behavior) = OPTIONAL];
 
| Parameter | |
|---|---|
| Name | Description | 
builderForValue | 
        SearchResponse.SearchResult.RankSignals.CustomSignal.Builder | 
      
| Returns | |
|---|---|
| Type | Description | 
SearchResponse.SearchResult.RankSignals.Builder | 
        |
addCustomSignals(int index, SearchResponse.SearchResult.RankSignals.CustomSignal value)
public SearchResponse.SearchResult.RankSignals.Builder addCustomSignals(int index, SearchResponse.SearchResult.RankSignals.CustomSignal value)A list of custom clearbox signals.
 
 repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RankSignals.CustomSignal custom_signals = 33 [(.google.api.field_behavior) = OPTIONAL];
 
| Parameters | |
|---|---|
| Name | Description | 
index | 
        int | 
      
value | 
        SearchResponse.SearchResult.RankSignals.CustomSignal | 
      
| Returns | |
|---|---|
| Type | Description | 
SearchResponse.SearchResult.RankSignals.Builder | 
        |
addCustomSignals(int index, SearchResponse.SearchResult.RankSignals.CustomSignal.Builder builderForValue)
public SearchResponse.SearchResult.RankSignals.Builder addCustomSignals(int index, SearchResponse.SearchResult.RankSignals.CustomSignal.Builder builderForValue)A list of custom clearbox signals.
 
 repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RankSignals.CustomSignal custom_signals = 33 [(.google.api.field_behavior) = OPTIONAL];
 
| Parameters | |
|---|---|
| Name | Description | 
index | 
        int | 
      
builderForValue | 
        SearchResponse.SearchResult.RankSignals.CustomSignal.Builder | 
      
| Returns | |
|---|---|
| Type | Description | 
SearchResponse.SearchResult.RankSignals.Builder | 
        |
addCustomSignalsBuilder()
public SearchResponse.SearchResult.RankSignals.CustomSignal.Builder addCustomSignalsBuilder()A list of custom clearbox signals.
 
 repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RankSignals.CustomSignal custom_signals = 33 [(.google.api.field_behavior) = OPTIONAL];
 
| Returns | |
|---|---|
| Type | Description | 
SearchResponse.SearchResult.RankSignals.CustomSignal.Builder | 
        |
addCustomSignalsBuilder(int index)
public SearchResponse.SearchResult.RankSignals.CustomSignal.Builder addCustomSignalsBuilder(int index)A list of custom clearbox signals.
 
 repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RankSignals.CustomSignal custom_signals = 33 [(.google.api.field_behavior) = OPTIONAL];
 
| Parameter | |
|---|---|
| Name | Description | 
index | 
        int | 
      
| Returns | |
|---|---|
| Type | Description | 
SearchResponse.SearchResult.RankSignals.CustomSignal.Builder | 
        |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public SearchResponse.SearchResult.RankSignals.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description | 
field | 
        FieldDescriptor | 
      
value | 
        Object | 
      
| Returns | |
|---|---|
| Type | Description | 
SearchResponse.SearchResult.RankSignals.Builder | 
        |
build()
public SearchResponse.SearchResult.RankSignals build()| Returns | |
|---|---|
| Type | Description | 
SearchResponse.SearchResult.RankSignals | 
        |
buildPartial()
public SearchResponse.SearchResult.RankSignals buildPartial()| Returns | |
|---|---|
| Type | Description | 
SearchResponse.SearchResult.RankSignals | 
        |
clear()
public SearchResponse.SearchResult.RankSignals.Builder clear()| Returns | |
|---|---|
| Type | Description | 
SearchResponse.SearchResult.RankSignals.Builder | 
        |
clearBoostingFactor()
public SearchResponse.SearchResult.RankSignals.Builder clearBoostingFactor()Combined custom boosts for a doc.
 optional float boosting_factor = 8 [(.google.api.field_behavior) = OPTIONAL];
 
| Returns | |
|---|---|
| Type | Description | 
SearchResponse.SearchResult.RankSignals.Builder | 
        This builder for chaining.  | 
      
clearCustomSignals()
public SearchResponse.SearchResult.RankSignals.Builder clearCustomSignals()A list of custom clearbox signals.
 
 repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RankSignals.CustomSignal custom_signals = 33 [(.google.api.field_behavior) = OPTIONAL];
 
| Returns | |
|---|---|
| Type | Description | 
SearchResponse.SearchResult.RankSignals.Builder | 
        |
clearDefaultRank()
public SearchResponse.SearchResult.RankSignals.Builder clearDefaultRank()The default rank of the result.
 float default_rank = 32 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description | 
SearchResponse.SearchResult.RankSignals.Builder | 
        This builder for chaining.  | 
      
clearDocumentAge()
public SearchResponse.SearchResult.RankSignals.Builder clearDocumentAge()Age of the document in hours.
 optional float document_age = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description | 
SearchResponse.SearchResult.RankSignals.Builder | 
        This builder for chaining.  | 
      
clearField(Descriptors.FieldDescriptor field)
public SearchResponse.SearchResult.RankSignals.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description | 
field | 
        FieldDescriptor | 
      
| Returns | |
|---|---|
| Type | Description | 
SearchResponse.SearchResult.RankSignals.Builder | 
        |
clearKeywordSimilarityScore()
public SearchResponse.SearchResult.RankSignals.Builder clearKeywordSimilarityScore()Keyword matching adjustment.
 
 optional float keyword_similarity_score = 1 [(.google.api.field_behavior) = OPTIONAL];
 
| Returns | |
|---|---|
| Type | Description | 
SearchResponse.SearchResult.RankSignals.Builder | 
        This builder for chaining.  | 
      
clearOneof(Descriptors.OneofDescriptor oneof)
public SearchResponse.SearchResult.RankSignals.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description | 
oneof | 
        OneofDescriptor | 
      
| Returns | |
|---|---|
| Type | Description | 
SearchResponse.SearchResult.RankSignals.Builder | 
        |
clearPctrRank()
public SearchResponse.SearchResult.RankSignals.Builder clearPctrRank()Predicted conversion rate adjustment as a rank.
 optional float pctr_rank = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description | 
SearchResponse.SearchResult.RankSignals.Builder | 
        This builder for chaining.  | 
      
clearRelevanceScore()
public SearchResponse.SearchResult.RankSignals.Builder clearRelevanceScore()Semantic relevance adjustment.
 optional float relevance_score = 2 [(.google.api.field_behavior) = OPTIONAL];
 
| Returns | |
|---|---|
| Type | Description | 
SearchResponse.SearchResult.RankSignals.Builder | 
        This builder for chaining.  | 
      
clearSemanticSimilarityScore()
public SearchResponse.SearchResult.RankSignals.Builder clearSemanticSimilarityScore()Semantic similarity adjustment.
 
 optional float semantic_similarity_score = 3 [(.google.api.field_behavior) = OPTIONAL];
 
| Returns | |
|---|---|
| Type | Description | 
SearchResponse.SearchResult.RankSignals.Builder | 
        This builder for chaining.  | 
      
clearTopicalityRank()
public SearchResponse.SearchResult.RankSignals.Builder clearTopicalityRank()Topicality adjustment as a rank.
 optional float topicality_rank = 6 [(.google.api.field_behavior) = OPTIONAL];
 
| Returns | |
|---|---|
| Type | Description | 
SearchResponse.SearchResult.RankSignals.Builder | 
        This builder for chaining.  | 
      
clone()
public SearchResponse.SearchResult.RankSignals.Builder clone()| Returns | |
|---|---|
| Type | Description | 
SearchResponse.SearchResult.RankSignals.Builder | 
        |
getBoostingFactor()
public float getBoostingFactor()Combined custom boosts for a doc.
 optional float boosting_factor = 8 [(.google.api.field_behavior) = OPTIONAL];
 
| Returns | |
|---|---|
| Type | Description | 
float | 
        The boostingFactor.  | 
      
getCustomSignals(int index)
public SearchResponse.SearchResult.RankSignals.CustomSignal getCustomSignals(int index)A list of custom clearbox signals.
 
 repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RankSignals.CustomSignal custom_signals = 33 [(.google.api.field_behavior) = OPTIONAL];
 
| Parameter | |
|---|---|
| Name | Description | 
index | 
        int | 
      
| Returns | |
|---|---|
| Type | Description | 
SearchResponse.SearchResult.RankSignals.CustomSignal | 
        |
getCustomSignalsBuilder(int index)
public SearchResponse.SearchResult.RankSignals.CustomSignal.Builder getCustomSignalsBuilder(int index)A list of custom clearbox signals.
 
 repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RankSignals.CustomSignal custom_signals = 33 [(.google.api.field_behavior) = OPTIONAL];
 
| Parameter | |
|---|---|
| Name | Description | 
index | 
        int | 
      
| Returns | |
|---|---|
| Type | Description | 
SearchResponse.SearchResult.RankSignals.CustomSignal.Builder | 
        |
getCustomSignalsBuilderList()
public List<SearchResponse.SearchResult.RankSignals.CustomSignal.Builder> getCustomSignalsBuilderList()A list of custom clearbox signals.
 
 repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RankSignals.CustomSignal custom_signals = 33 [(.google.api.field_behavior) = OPTIONAL];
 
| Returns | |
|---|---|
| Type | Description | 
List<Builder> | 
        |
getCustomSignalsCount()
public int getCustomSignalsCount()A list of custom clearbox signals.
 
 repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RankSignals.CustomSignal custom_signals = 33 [(.google.api.field_behavior) = OPTIONAL];
 
| Returns | |
|---|---|
| Type | Description | 
int | 
        |
getCustomSignalsList()
public List<SearchResponse.SearchResult.RankSignals.CustomSignal> getCustomSignalsList()A list of custom clearbox signals.
 
 repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RankSignals.CustomSignal custom_signals = 33 [(.google.api.field_behavior) = OPTIONAL];
 
| Returns | |
|---|---|
| Type | Description | 
List<CustomSignal> | 
        |
getCustomSignalsOrBuilder(int index)
public SearchResponse.SearchResult.RankSignals.CustomSignalOrBuilder getCustomSignalsOrBuilder(int index)A list of custom clearbox signals.
 
 repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RankSignals.CustomSignal custom_signals = 33 [(.google.api.field_behavior) = OPTIONAL];
 
| Parameter | |
|---|---|
| Name | Description | 
index | 
        int | 
      
| Returns | |
|---|---|
| Type | Description | 
SearchResponse.SearchResult.RankSignals.CustomSignalOrBuilder | 
        |
getCustomSignalsOrBuilderList()
public List<? extends SearchResponse.SearchResult.RankSignals.CustomSignalOrBuilder> getCustomSignalsOrBuilderList()A list of custom clearbox signals.
 
 repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RankSignals.CustomSignal custom_signals = 33 [(.google.api.field_behavior) = OPTIONAL];
 
| Returns | |
|---|---|
| Type | Description | 
List<? extends com.google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RankSignals.CustomSignalOrBuilder> | 
        |
getDefaultInstanceForType()
public SearchResponse.SearchResult.RankSignals getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description | 
SearchResponse.SearchResult.RankSignals | 
        |
getDefaultRank()
public float getDefaultRank()The default rank of the result.
 float default_rank = 32 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description | 
float | 
        The defaultRank.  | 
      
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description | 
Descriptor | 
        |
getDocumentAge()
public float getDocumentAge()Age of the document in hours.
 optional float document_age = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description | 
float | 
        The documentAge.  | 
      
getKeywordSimilarityScore()
public float getKeywordSimilarityScore()Keyword matching adjustment.
 
 optional float keyword_similarity_score = 1 [(.google.api.field_behavior) = OPTIONAL];
 
| Returns | |
|---|---|
| Type | Description | 
float | 
        The keywordSimilarityScore.  | 
      
getPctrRank()
public float getPctrRank()Predicted conversion rate adjustment as a rank.
 optional float pctr_rank = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description | 
float | 
        The pctrRank.  | 
      
getRelevanceScore()
public float getRelevanceScore()Semantic relevance adjustment.
 optional float relevance_score = 2 [(.google.api.field_behavior) = OPTIONAL];
 
| Returns | |
|---|---|
| Type | Description | 
float | 
        The relevanceScore.  | 
      
getSemanticSimilarityScore()
public float getSemanticSimilarityScore()Semantic similarity adjustment.
 
 optional float semantic_similarity_score = 3 [(.google.api.field_behavior) = OPTIONAL];
 
| Returns | |
|---|---|
| Type | Description | 
float | 
        The semanticSimilarityScore.  | 
      
getTopicalityRank()
public float getTopicalityRank()Topicality adjustment as a rank.
 optional float topicality_rank = 6 [(.google.api.field_behavior) = OPTIONAL];
 
| Returns | |
|---|---|
| Type | Description | 
float | 
        The topicalityRank.  | 
      
hasBoostingFactor()
public boolean hasBoostingFactor()Combined custom boosts for a doc.
 optional float boosting_factor = 8 [(.google.api.field_behavior) = OPTIONAL];
 
| Returns | |
|---|---|
| Type | Description | 
boolean | 
        Whether the boostingFactor field is set.  | 
      
hasDocumentAge()
public boolean hasDocumentAge()Age of the document in hours.
 optional float document_age = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description | 
boolean | 
        Whether the documentAge field is set.  | 
      
hasKeywordSimilarityScore()
public boolean hasKeywordSimilarityScore()Keyword matching adjustment.
 
 optional float keyword_similarity_score = 1 [(.google.api.field_behavior) = OPTIONAL];
 
| Returns | |
|---|---|
| Type | Description | 
boolean | 
        Whether the keywordSimilarityScore field is set.  | 
      
hasPctrRank()
public boolean hasPctrRank()Predicted conversion rate adjustment as a rank.
 optional float pctr_rank = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description | 
boolean | 
        Whether the pctrRank field is set.  | 
      
hasRelevanceScore()
public boolean hasRelevanceScore()Semantic relevance adjustment.
 optional float relevance_score = 2 [(.google.api.field_behavior) = OPTIONAL];
 
| Returns | |
|---|---|
| Type | Description | 
boolean | 
        Whether the relevanceScore field is set.  | 
      
hasSemanticSimilarityScore()
public boolean hasSemanticSimilarityScore()Semantic similarity adjustment.
 
 optional float semantic_similarity_score = 3 [(.google.api.field_behavior) = OPTIONAL];
 
| Returns | |
|---|---|
| Type | Description | 
boolean | 
        Whether the semanticSimilarityScore field is set.  | 
      
hasTopicalityRank()
public boolean hasTopicalityRank()Topicality adjustment as a rank.
 optional float topicality_rank = 6 [(.google.api.field_behavior) = OPTIONAL];
 
| Returns | |
|---|---|
| Type | Description | 
boolean | 
        Whether the topicalityRank field is set.  | 
      
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description | 
FieldAccessorTable | 
        |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description | 
boolean | 
        |
mergeFrom(SearchResponse.SearchResult.RankSignals other)
public SearchResponse.SearchResult.RankSignals.Builder mergeFrom(SearchResponse.SearchResult.RankSignals other)| Parameter | |
|---|---|
| Name | Description | 
other | 
        SearchResponse.SearchResult.RankSignals | 
      
| Returns | |
|---|---|
| Type | Description | 
SearchResponse.SearchResult.RankSignals.Builder | 
        |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public SearchResponse.SearchResult.RankSignals.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description | 
input | 
        CodedInputStream | 
      
extensionRegistry | 
        ExtensionRegistryLite | 
      
| Returns | |
|---|---|
| Type | Description | 
SearchResponse.SearchResult.RankSignals.Builder | 
        |
| Exceptions | |
|---|---|
| Type | Description | 
IOException | 
        |
mergeFrom(Message other)
public SearchResponse.SearchResult.RankSignals.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description | 
other | 
        Message | 
      
| Returns | |
|---|---|
| Type | Description | 
SearchResponse.SearchResult.RankSignals.Builder | 
        |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final SearchResponse.SearchResult.RankSignals.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description | 
unknownFields | 
        UnknownFieldSet | 
      
| Returns | |
|---|---|
| Type | Description | 
SearchResponse.SearchResult.RankSignals.Builder | 
        |
removeCustomSignals(int index)
public SearchResponse.SearchResult.RankSignals.Builder removeCustomSignals(int index)A list of custom clearbox signals.
 
 repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RankSignals.CustomSignal custom_signals = 33 [(.google.api.field_behavior) = OPTIONAL];
 
| Parameter | |
|---|---|
| Name | Description | 
index | 
        int | 
      
| Returns | |
|---|---|
| Type | Description | 
SearchResponse.SearchResult.RankSignals.Builder | 
        |
setBoostingFactor(float value)
public SearchResponse.SearchResult.RankSignals.Builder setBoostingFactor(float value)Combined custom boosts for a doc.
 optional float boosting_factor = 8 [(.google.api.field_behavior) = OPTIONAL];
 
| Parameter | |
|---|---|
| Name | Description | 
value | 
        floatThe boostingFactor to set.  | 
      
| Returns | |
|---|---|
| Type | Description | 
SearchResponse.SearchResult.RankSignals.Builder | 
        This builder for chaining.  | 
      
setCustomSignals(int index, SearchResponse.SearchResult.RankSignals.CustomSignal value)
public SearchResponse.SearchResult.RankSignals.Builder setCustomSignals(int index, SearchResponse.SearchResult.RankSignals.CustomSignal value)A list of custom clearbox signals.
 
 repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RankSignals.CustomSignal custom_signals = 33 [(.google.api.field_behavior) = OPTIONAL];
 
| Parameters | |
|---|---|
| Name | Description | 
index | 
        int | 
      
value | 
        SearchResponse.SearchResult.RankSignals.CustomSignal | 
      
| Returns | |
|---|---|
| Type | Description | 
SearchResponse.SearchResult.RankSignals.Builder | 
        |
setCustomSignals(int index, SearchResponse.SearchResult.RankSignals.CustomSignal.Builder builderForValue)
public SearchResponse.SearchResult.RankSignals.Builder setCustomSignals(int index, SearchResponse.SearchResult.RankSignals.CustomSignal.Builder builderForValue)A list of custom clearbox signals.
 
 repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RankSignals.CustomSignal custom_signals = 33 [(.google.api.field_behavior) = OPTIONAL];
 
| Parameters | |
|---|---|
| Name | Description | 
index | 
        int | 
      
builderForValue | 
        SearchResponse.SearchResult.RankSignals.CustomSignal.Builder | 
      
| Returns | |
|---|---|
| Type | Description | 
SearchResponse.SearchResult.RankSignals.Builder | 
        |
setDefaultRank(float value)
public SearchResponse.SearchResult.RankSignals.Builder setDefaultRank(float value)The default rank of the result.
 float default_rank = 32 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description | 
value | 
        floatThe defaultRank to set.  | 
      
| Returns | |
|---|---|
| Type | Description | 
SearchResponse.SearchResult.RankSignals.Builder | 
        This builder for chaining.  | 
      
setDocumentAge(float value)
public SearchResponse.SearchResult.RankSignals.Builder setDocumentAge(float value)Age of the document in hours.
 optional float document_age = 7 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description | 
value | 
        floatThe documentAge to set.  | 
      
| Returns | |
|---|---|
| Type | Description | 
SearchResponse.SearchResult.RankSignals.Builder | 
        This builder for chaining.  | 
      
setField(Descriptors.FieldDescriptor field, Object value)
public SearchResponse.SearchResult.RankSignals.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description | 
field | 
        FieldDescriptor | 
      
value | 
        Object | 
      
| Returns | |
|---|---|
| Type | Description | 
SearchResponse.SearchResult.RankSignals.Builder | 
        |
setKeywordSimilarityScore(float value)
public SearchResponse.SearchResult.RankSignals.Builder setKeywordSimilarityScore(float value)Keyword matching adjustment.
 
 optional float keyword_similarity_score = 1 [(.google.api.field_behavior) = OPTIONAL];
 
| Parameter | |
|---|---|
| Name | Description | 
value | 
        floatThe keywordSimilarityScore to set.  | 
      
| Returns | |
|---|---|
| Type | Description | 
SearchResponse.SearchResult.RankSignals.Builder | 
        This builder for chaining.  | 
      
setPctrRank(float value)
public SearchResponse.SearchResult.RankSignals.Builder setPctrRank(float value)Predicted conversion rate adjustment as a rank.
 optional float pctr_rank = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description | 
value | 
        floatThe pctrRank to set.  | 
      
| Returns | |
|---|---|
| Type | Description | 
SearchResponse.SearchResult.RankSignals.Builder | 
        This builder for chaining.  | 
      
setRelevanceScore(float value)
public SearchResponse.SearchResult.RankSignals.Builder setRelevanceScore(float value)Semantic relevance adjustment.
 optional float relevance_score = 2 [(.google.api.field_behavior) = OPTIONAL];
 
| Parameter | |
|---|---|
| Name | Description | 
value | 
        floatThe relevanceScore to set.  | 
      
| Returns | |
|---|---|
| Type | Description | 
SearchResponse.SearchResult.RankSignals.Builder | 
        This builder for chaining.  | 
      
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public SearchResponse.SearchResult.RankSignals.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description | 
field | 
        FieldDescriptor | 
      
index | 
        int | 
      
value | 
        Object | 
      
| Returns | |
|---|---|
| Type | Description | 
SearchResponse.SearchResult.RankSignals.Builder | 
        |
setSemanticSimilarityScore(float value)
public SearchResponse.SearchResult.RankSignals.Builder setSemanticSimilarityScore(float value)Semantic similarity adjustment.
 
 optional float semantic_similarity_score = 3 [(.google.api.field_behavior) = OPTIONAL];
 
| Parameter | |
|---|---|
| Name | Description | 
value | 
        floatThe semanticSimilarityScore to set.  | 
      
| Returns | |
|---|---|
| Type | Description | 
SearchResponse.SearchResult.RankSignals.Builder | 
        This builder for chaining.  | 
      
setTopicalityRank(float value)
public SearchResponse.SearchResult.RankSignals.Builder setTopicalityRank(float value)Topicality adjustment as a rank.
 optional float topicality_rank = 6 [(.google.api.field_behavior) = OPTIONAL];
 
| Parameter | |
|---|---|
| Name | Description | 
value | 
        floatThe topicalityRank to set.  | 
      
| Returns | |
|---|---|
| Type | Description | 
SearchResponse.SearchResult.RankSignals.Builder | 
        This builder for chaining.  | 
      
setUnknownFields(UnknownFieldSet unknownFields)
public final SearchResponse.SearchResult.RankSignals.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description | 
unknownFields | 
        UnknownFieldSet | 
      
| Returns | |
|---|---|
| Type | Description | 
SearchResponse.SearchResult.RankSignals.Builder | 
        |