Package com.google.cloud.dialogflow.v2

Interface SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpecOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec, SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.Builder
Enclosing class:
SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec
public static interface SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpecOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getCondition

      String getCondition()
       Optional. An expression which specifies a boost condition. The
 syntax and supported fields are the same as a filter expression.
 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 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The condition.

    • getConditionBytes

      com.google.protobuf.ByteString getConditionBytes()
       Optional. An expression which specifies a boost condition. The
 syntax and supported fields are the same as a filter expression.
 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 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for condition.

    • getBoost

      float getBoost()
       Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The boost.

    • hasBoostControlSpec

      boolean hasBoostControlSpec()
       Optional. Complex specification for custom ranking based on
 customer defined attribute value.
      .google.cloud.dialogflow.v2.SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.BoostControlSpec boost_control_spec = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the boostControlSpec field is set.

    • getBoostControlSpec

      SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.BoostControlSpec getBoostControlSpec()
       Optional. Complex specification for custom ranking based on
 customer defined attribute value.
      .google.cloud.dialogflow.v2.SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.BoostControlSpec boost_control_spec = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The boostControlSpec.

    • getBoostControlSpecOrBuilder

      SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.BoostControlSpecOrBuilder getBoostControlSpecOrBuilder()
       Optional. Complex specification for custom ranking based on
 customer defined attribute value.
      .google.cloud.dialogflow.v2.SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.BoostControlSpec boost_control_spec = 4 [(.google.api.field_behavior) = OPTIONAL];