Google Cloud Discovery Engine V1beta Client - Class FacetKey (0.5.0)

Reference documentation and code samples for the Google Cloud Discovery Engine V1beta Client class FacetKey.

Specifies how a facet is computed.

Generated from protobuf message google.cloud.discoveryengine.v1beta.SearchRequest.FacetSpec.FacetKey

Namespace

Google \ Cloud \ DiscoveryEngine \ V1beta \ SearchRequest \ FacetSpec

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ 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 array<Google\Cloud\DiscoveryEngine\V1beta\Interval>

Set only if values should be bucketized 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 array

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 will only contain "Action > 2022". Only supported on textual fields. Maximum is 10.

↳ prefixes array

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 will only contain "Action > 2022" and "Action > 2021". Only supported on textual fields. Maximum is 10.

↳ contains array

Only get facet values that contains 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 will only contain "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.

getKey

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

Returns
TypeDescription
string

setKey

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getIntervals

Set only if values should be bucketized 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.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setIntervals

Set only if values should be bucketized 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.

Parameter
NameDescription
var array<Google\Cloud\DiscoveryEngine\V1beta\Interval>
Returns
TypeDescription
$this

getRestrictedValues

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 will only contain "Action > 2022". Only supported on textual fields. Maximum is 10.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setRestrictedValues

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 will only contain "Action > 2022". Only supported on textual fields. Maximum is 10.

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this

getPrefixes

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 will only contain "Action > 2022" and "Action > 2021".

Only supported on textual fields. Maximum is 10.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setPrefixes

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 will only contain "Action > 2022" and "Action > 2021".

Only supported on textual fields. Maximum is 10.

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this

getContains

Only get facet values that contains 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 will only contain "Action > 2022" and "Sci-Fi > 2022".

Only supported on textual fields. Maximum is 10.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setContains

Only get facet values that contains 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 will only contain "Action > 2022" and "Sci-Fi > 2022".

Only supported on textual fields. Maximum is 10.

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this

getCaseInsensitive

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

Returns
TypeDescription
bool

setCaseInsensitive

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

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getOrderBy

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.
Returns
TypeDescription
string

setOrderBy

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.
Parameter
NameDescription
var string
Returns
TypeDescription
$this