Google Cloud Dialogflow v2 API - Class SearchKnowledgeRequest.Types.SearchConfig.Types.BoostSpecs.Types.BoostSpec.Types.ConditionBoostSpec (4.24.0)

public sealed class SearchKnowledgeRequest.Types.SearchConfig.Types.BoostSpecs.Types.BoostSpec.Types.ConditionBoostSpec : IMessage<SearchKnowledgeRequest.Types.SearchConfig.Types.BoostSpecs.Types.BoostSpec.Types.ConditionBoostSpec>, IEquatable<SearchKnowledgeRequest.Types.SearchConfig.Types.BoostSpecs.Types.BoostSpec.Types.ConditionBoostSpec>, IDeepCloneable<SearchKnowledgeRequest.Types.SearchConfig.Types.BoostSpecs.Types.BoostSpec.Types.ConditionBoostSpec>, IBufferMessage, IMessage

Reference documentation and code samples for the Google Cloud Dialogflow v2 API class SearchKnowledgeRequest.Types.SearchConfig.Types.BoostSpecs.Types.BoostSpec.Types.ConditionBoostSpec.

Boost applies to documents which match a condition.

Inheritance

object > SearchKnowledgeRequest.Types.SearchConfig.Types.BoostSpecs.Types.BoostSpec.Types.ConditionBoostSpec

Implements

IMessage SearchKnowledgeRequest Types SearchConfig Types BoostSpecs Types BoostSpec Types ConditionBoostSpec, IEquatable SearchKnowledgeRequest Types SearchConfig Types BoostSpecs Types BoostSpec Types ConditionBoostSpec, IDeepCloneable SearchKnowledgeRequest Types SearchConfig Types BoostSpecs Types BoostSpec Types ConditionBoostSpec, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Dialogflow.V2

Assembly

Google.Cloud.Dialogflow.V2.dll

Constructors

ConditionBoostSpec()

public ConditionBoostSpec()

ConditionBoostSpec(ConditionBoostSpec)

public ConditionBoostSpec(SearchKnowledgeRequest.Types.SearchConfig.Types.BoostSpecs.Types.BoostSpec.Types.ConditionBoostSpec other)

Parameter
Name	Description
`other`	`SearchKnowledgeRequestTypesSearchConfigTypesBoostSpecsTypesBoostSpecTypesConditionBoostSpec`

Properties

Boost

public float Boost { get; set; }

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.

Property Value
Type	Description
`float`

BoostControlSpec

public SearchKnowledgeRequest.Types.SearchConfig.Types.BoostSpecs.Types.BoostSpec.Types.ConditionBoostSpec.Types.BoostControlSpec BoostControlSpec { get; set; }

Optional. Complex specification for custom ranking based on customer defined attribute value.

Property Value
Type	Description
`SearchKnowledgeRequestTypesSearchConfigTypesBoostSpecsTypesBoostSpecTypesConditionBoostSpecTypesBoostControlSpec`

Condition

public string Condition { get; set; }

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"))

Property Value
Type	Description
`string`