Struct ConditionBoostSpec 

#[non_exhaustive]
pub struct ConditionBoostSpec {
    pub condition: String,
    pub boost: f32,
    pub boost_control_spec: Option<BoostControlSpec>,
    /* private fields */
}

Available on crate features assistant-service or conversational-search-service or search-service or serving-config-service only.

Boost applies to documents which match a condition.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

condition: String

An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations.

Examples:

• To boost documents with document ID “doc_1” or “doc_2”, and color “Red” or “Blue”: (document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))

boost: f32

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. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied.

boost_control_spec: Option<BoostControlSpec>

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

Implementations

impl ConditionBoostSpec

pub fn new() -> Self

pub fn set_condition<T: Into<String>>(self, v: T) -> Self

Sets the value of condition.

Example

let x = ConditionBoostSpec::new().set_condition("example");

pub fn set_boost<T: Into<f32>>(self, v: T) -> Self

Sets the value of boost.

Example

let x = ConditionBoostSpec::new().set_boost(42.0);

pub fn set_boost_control_spec<T>(self, v: T) -> Self

where T: Into<BoostControlSpec>,

Sets the value of boost_control_spec.

Example

use google_cloud_discoveryengine_v1::model::search_request::boost_spec::condition_boost_spec::BoostControlSpec;
let x = ConditionBoostSpec::new().set_boost_control_spec(BoostControlSpec::default()/* use setters */);

pub fn set_or_clear_boost_control_spec<T>(self, v: Option<T>) -> Self

where T: Into<BoostControlSpec>,

Sets or clears the value of boost_control_spec.

Example

use google_cloud_discoveryengine_v1::model::search_request::boost_spec::condition_boost_spec::BoostControlSpec;
let x = ConditionBoostSpec::new().set_or_clear_boost_control_spec(Some(BoostControlSpec::default()/* use setters */));
let x = ConditionBoostSpec::new().set_or_clear_boost_control_spec(None::<BoostControlSpec>);

Trait Implementations

impl Clone for ConditionBoostSpec

fn clone(&self) -> ConditionBoostSpec

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ConditionBoostSpec

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ConditionBoostSpec

fn default() -> ConditionBoostSpec

Returns the “default value” for a type.

impl Message for ConditionBoostSpec

fn typename() -> &'static str

The typename of this message.

impl PartialEq for ConditionBoostSpec

fn eq(&self, other: &ConditionBoostSpec) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ConditionBoostSpec