Struct FacetKey 

#[non_exhaustive]
pub struct FacetKey {
    pub key: String,
    pub intervals: Vec<Interval>,
    pub restricted_values: Vec<String>,
    pub prefixes: Vec<String>,
    pub contains: Vec<String>,
    pub case_insensitive: bool,
    pub order_by: String,
    /* private fields */
}

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

Specifies how a facet is computed.

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.

key: String

Required. Supported textual and numerical facet keys in Document object, over which the facet values are computed. Facet key is case-sensitive.

intervals: Vec<Interval>

Set only if values should be bucketed into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30.

restricted_values: Vec<String>

Only get facet for the given restricted values. Only supported on textual fields. For example, suppose “category” has three values “Action > 2022”, “Action > 2021” and “Sci-Fi > 2022”. If set “restricted_values” to “Action > 2022”, the “category” facet only contains “Action > 2022”. Only supported on textual fields. Maximum is 10.

prefixes: Vec<String>

Only get facet values that start with the given string prefix. For example, suppose “category” has three values “Action > 2022”, “Action > 2021” and “Sci-Fi > 2022”. If set “prefixes” to “Action”, the “category” facet only contains “Action > 2022” and “Action > 2021”. Only supported on textual fields. Maximum is 10.

contains: Vec<String>

Only get facet values that contain the given strings. For example, suppose “category” has three values “Action > 2022”, “Action > 2021” and “Sci-Fi > 2022”. If set “contains” to “2022”, the “category” facet only contains “Action > 2022” and “Sci-Fi > 2022”. Only supported on textual fields. Maximum is 10.

case_insensitive: bool

True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.

order_by: String

The order in which documents are returned.

Allowed values are:

• “count desc”, which means order by SearchResponse.Facet.values.count descending.

• “value desc”, which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets.

If not set, textual values are sorted in natural order; numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals.

Implementations

impl FacetKey

pub fn new() -> Self

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

Sets the value of key.

Example

let x = FacetKey::new().set_key("example");

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

where T: IntoIterator<Item = V>, V: Into<Interval>,

Sets the value of intervals.

Example

use google_cloud_discoveryengine_v1::model::Interval;
let x = FacetKey::new()
    .set_intervals([
        Interval::default()/* use setters */,
        Interval::default()/* use (different) setters */,
    ]);

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

where T: IntoIterator<Item = V>, V: Into<String>,

Sets the value of restricted_values.

Example

let x = FacetKey::new().set_restricted_values(["a", "b", "c"]);

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

where T: IntoIterator<Item = V>, V: Into<String>,

Sets the value of prefixes.

Example

let x = FacetKey::new().set_prefixes(["a", "b", "c"]);

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

where T: IntoIterator<Item = V>, V: Into<String>,

Sets the value of contains.

Example

let x = FacetKey::new().set_contains(["a", "b", "c"]);

pub fn set_case_insensitive<T: Into<bool>>(self, v: T) -> Self

Sets the value of case_insensitive.

Example

let x = FacetKey::new().set_case_insensitive(true);

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

Sets the value of order_by.

Example

let x = FacetKey::new().set_order_by("example");

Trait Implementations

impl Clone for FacetKey

fn clone(&self) -> FacetKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FacetKey

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

Formats the value using the given formatter.

impl Default for FacetKey

fn default() -> FacetKey

Returns the “default value” for a type.

impl Message for FacetKey

fn typename() -> &'static str

The typename of this message.

impl PartialEq for FacetKey

fn eq(&self, other: &FacetKey) -> 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 FacetKey