Class SearchResponse.SearchResult.RankSignals (0.70.0) 

public static final class SearchResponse.SearchResult.RankSignals extends GeneratedMessageV3 implements SearchResponse.SearchResult.RankSignalsOrBuilder

A set of ranking signals.

Protobuf type google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult.RankSignals

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > SearchResponse.SearchResult.RankSignals

Static Fields

BOOSTING_FACTOR_FIELD_NUMBER

public static final int BOOSTING_FACTOR_FIELD_NUMBER
Field Value
Type Description
int

CUSTOM_SIGNALS_FIELD_NUMBER

public static final int CUSTOM_SIGNALS_FIELD_NUMBER
Field Value
Type Description
int

DEFAULT_RANK_FIELD_NUMBER

public static final int DEFAULT_RANK_FIELD_NUMBER
Field Value
Type Description
int

DOCUMENT_AGE_FIELD_NUMBER

public static final int DOCUMENT_AGE_FIELD_NUMBER
Field Value
Type Description
int

KEYWORD_SIMILARITY_SCORE_FIELD_NUMBER

public static final int KEYWORD_SIMILARITY_SCORE_FIELD_NUMBER
Field Value
Type Description
int

PCTR_RANK_FIELD_NUMBER

public static final int PCTR_RANK_FIELD_NUMBER
Field Value
Type Description
int

RELEVANCE_SCORE_FIELD_NUMBER

public static final int RELEVANCE_SCORE_FIELD_NUMBER
Field Value
Type Description
int

SEMANTIC_SIMILARITY_SCORE_FIELD_NUMBER

public static final int SEMANTIC_SIMILARITY_SCORE_FIELD_NUMBER
Field Value
Type Description
int

TOPICALITY_RANK_FIELD_NUMBER

public static final int TOPICALITY_RANK_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SearchResponse.SearchResult.RankSignals getDefaultInstance()
Returns
Type Description
SearchResponse.SearchResult.RankSignals

getDescriptor()

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

newBuilder()

public static SearchResponse.SearchResult.RankSignals.Builder newBuilder()
Returns
Type Description
SearchResponse.SearchResult.RankSignals.Builder

newBuilder(SearchResponse.SearchResult.RankSignals prototype)

public static SearchResponse.SearchResult.RankSignals.Builder newBuilder(SearchResponse.SearchResult.RankSignals prototype)
Parameter
Name Description
prototype SearchResponse.SearchResult.RankSignals
Returns
Type Description
SearchResponse.SearchResult.RankSignals.Builder

parseDelimitedFrom(InputStream input)

public static SearchResponse.SearchResult.RankSignals parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SearchResponse.SearchResult.RankSignals
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchResponse.SearchResult.RankSignals parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchResponse.SearchResult.RankSignals
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static SearchResponse.SearchResult.RankSignals parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
SearchResponse.SearchResult.RankSignals
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SearchResponse.SearchResult.RankSignals parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchResponse.SearchResult.RankSignals
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SearchResponse.SearchResult.RankSignals parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SearchResponse.SearchResult.RankSignals
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SearchResponse.SearchResult.RankSignals parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchResponse.SearchResult.RankSignals
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SearchResponse.SearchResult.RankSignals parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SearchResponse.SearchResult.RankSignals
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchResponse.SearchResult.RankSignals parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchResponse.SearchResult.RankSignals
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static SearchResponse.SearchResult.RankSignals parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SearchResponse.SearchResult.RankSignals
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchResponse.SearchResult.RankSignals parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchResponse.SearchResult.RankSignals
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static SearchResponse.SearchResult.RankSignals parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SearchResponse.SearchResult.RankSignals
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SearchResponse.SearchResult.RankSignals parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchResponse.SearchResult.RankSignals
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<SearchResponse.SearchResult.RankSignals> parser()
Returns
Type Description
Parser<RankSignals>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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.v1beta.SearchResponse.SearchResult.RankSignals.CustomSignal custom_signals = 33 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
SearchResponse.SearchResult.RankSignals.CustomSignal

getCustomSignalsCount()

public int getCustomSignalsCount()

A list of custom clearbox signals.

repeated .google.cloud.discoveryengine.v1beta.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.v1beta.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.v1beta.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.v1beta.SearchResponse.SearchResult.RankSignals.CustomSignal custom_signals = 33 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.discoveryengine.v1beta.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.

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.

getParserForType()

public Parser<SearchResponse.SearchResult.RankSignals> getParserForType()
Returns
Type Description
Parser<RankSignals>
Overrides

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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public SearchResponse.SearchResult.RankSignals.Builder newBuilderForType()
Returns
Type Description
SearchResponse.SearchResult.RankSignals.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SearchResponse.SearchResult.RankSignals.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SearchResponse.SearchResult.RankSignals.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public SearchResponse.SearchResult.RankSignals.Builder toBuilder()
Returns
Type Description
SearchResponse.SearchResult.RankSignals.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException