Class SearchRequest.RelevanceScoreSpec.Builder (0.79.0)

public static final class SearchRequest.RelevanceScoreSpec.Builder extends GeneratedMessage.Builder<SearchRequest.RelevanceScoreSpec.Builder> implements SearchRequest.RelevanceScoreSpecOrBuilder

The specification for returning the document relevance score.

Protobuf type google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

build()

public SearchRequest.RelevanceScoreSpec build()
Returns
Type Description
SearchRequest.RelevanceScoreSpec

buildPartial()

public SearchRequest.RelevanceScoreSpec buildPartial()
Returns
Type Description
SearchRequest.RelevanceScoreSpec

clear()

public SearchRequest.RelevanceScoreSpec.Builder clear()
Returns
Type Description
SearchRequest.RelevanceScoreSpec.Builder
Overrides

clearReturnRelevanceScore()

public SearchRequest.RelevanceScoreSpec.Builder clearReturnRelevanceScore()

Optional. Whether to return the relevance score for search results. The higher the score, the more relevant the document is to the query.

bool return_relevance_score = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SearchRequest.RelevanceScoreSpec.Builder

This builder for chaining.

getDefaultInstanceForType()

public SearchRequest.RelevanceScoreSpec getDefaultInstanceForType()
Returns
Type Description
SearchRequest.RelevanceScoreSpec

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getReturnRelevanceScore()

public boolean getReturnRelevanceScore()

Optional. Whether to return the relevance score for search results. The higher the score, the more relevant the document is to the query.

bool return_relevance_score = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The returnRelevanceScore.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(SearchRequest.RelevanceScoreSpec other)

public SearchRequest.RelevanceScoreSpec.Builder mergeFrom(SearchRequest.RelevanceScoreSpec other)
Parameter
Name Description
other SearchRequest.RelevanceScoreSpec
Returns
Type Description
SearchRequest.RelevanceScoreSpec.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SearchRequest.RelevanceScoreSpec.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchRequest.RelevanceScoreSpec.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public SearchRequest.RelevanceScoreSpec.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
SearchRequest.RelevanceScoreSpec.Builder
Overrides

setReturnRelevanceScore(boolean value)

public SearchRequest.RelevanceScoreSpec.Builder setReturnRelevanceScore(boolean value)

Optional. Whether to return the relevance score for search results. The higher the score, the more relevant the document is to the query.

bool return_relevance_score = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value boolean

The returnRelevanceScore to set.

Returns
Type Description
SearchRequest.RelevanceScoreSpec.Builder

This builder for chaining.