Package com.google.cloud.discoveryengine.v1beta

Interface SearchResponse.SearchResult.RankSignalsOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
SearchResponse.SearchResult.RankSignals, SearchResponse.SearchResult.RankSignals.Builder
Enclosing class:
SearchResponse.SearchResult
public static interface SearchResponse.SearchResult.RankSignalsOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • hasKeywordSimilarityScore

      boolean hasKeywordSimilarityScore()
       Keyword matching adjustment.
      optional float keyword_similarity_score = 1 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the keywordSimilarityScore field is set.

    • getKeywordSimilarityScore

      float getKeywordSimilarityScore()
       Keyword matching adjustment.
      optional float keyword_similarity_score = 1 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The keywordSimilarityScore.

    • hasRelevanceScore

      boolean hasRelevanceScore()
       Semantic relevance adjustment.
      optional float relevance_score = 2 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the relevanceScore field is set.

    • getRelevanceScore

      float getRelevanceScore()
       Semantic relevance adjustment.
      optional float relevance_score = 2 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The relevanceScore.

    • hasSemanticSimilarityScore

      boolean hasSemanticSimilarityScore()
       Semantic similarity adjustment.
      optional float semantic_similarity_score = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the semanticSimilarityScore field is set.

    • getSemanticSimilarityScore

      float getSemanticSimilarityScore()
       Semantic similarity adjustment.
      optional float semantic_similarity_score = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The semanticSimilarityScore.

    • hasPctrRank

      boolean hasPctrRank()
       Predicted conversion rate adjustment as a rank.
      optional float pctr_rank = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the pctrRank field is set.

    • getPctrRank

      float getPctrRank()
       Predicted conversion rate adjustment as a rank.
      optional float pctr_rank = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The pctrRank.

    • hasTopicalityRank

      boolean hasTopicalityRank()
       Topicality adjustment as a rank.
      optional float topicality_rank = 6 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the topicalityRank field is set.

    • getTopicalityRank

      float getTopicalityRank()
       Topicality adjustment as a rank.
      optional float topicality_rank = 6 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The topicalityRank.

    • hasDocumentAge

      boolean hasDocumentAge()
       Age of the document in hours.
      optional float document_age = 7 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the documentAge field is set.

    • getDocumentAge

      float getDocumentAge()
       Age of the document in hours.
      optional float document_age = 7 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The documentAge.

    • hasBoostingFactor

      boolean hasBoostingFactor()
       Combined custom boosts for a doc.
      optional float boosting_factor = 8 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the boostingFactor field is set.

    • getBoostingFactor

      float getBoostingFactor()
       Combined custom boosts for a doc.
      optional float boosting_factor = 8 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The boostingFactor.

    • getDefaultRank

      float getDefaultRank()
       The default rank of the result.
      float default_rank = 32 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The defaultRank.

    • getCustomSignalsList

      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];

    • getCustomSignals

      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];

    • getCustomSignalsCount

      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];

    • getCustomSignalsOrBuilderList

      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];

    • getCustomSignalsOrBuilder

      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];