Discovery Engine v1 API - Class SearchRequest.Types.FacetSpec.Types.FacetKey (1.0.0-beta04)

public sealed class SearchRequest.Types.FacetSpec.Types.FacetKey : IMessage<SearchRequest.Types.FacetSpec.Types.FacetKey>, IEquatable<SearchRequest.Types.FacetSpec.Types.FacetKey>, IDeepCloneable<SearchRequest.Types.FacetSpec.Types.FacetKey>, IBufferMessage, IMessage

Reference documentation and code samples for the Discovery Engine v1 API class SearchRequest.Types.FacetSpec.Types.FacetKey.

Specifies how a facet is computed.

Inheritance

object > SearchRequest.Types.FacetSpec.Types.FacetKey

Implements

IMessage SearchRequest Types FacetSpec Types FacetKey, IEquatable SearchRequest Types FacetSpec Types FacetKey, IDeepCloneable SearchRequest Types FacetSpec Types FacetKey, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Constructors

FacetKey()

public FacetKey()

FacetKey(FacetKey)

public FacetKey(SearchRequest.Types.FacetSpec.Types.FacetKey other)

Parameter
Name	Description
`other`	`SearchRequestTypesFacetSpecTypesFacetKey`

Properties

CaseInsensitive

public bool CaseInsensitive { get; set; }

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

Property Value
Type	Description
`bool`

Contains

public RepeatedField<string> Contains { get; }

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 only contains "Action > 2022" and "Sci-Fi > 2022". Only supported on textual fields. Maximum is 10.

Property Value
Type	Description
`RepeatedFieldstring`

Intervals

public RepeatedField<Interval> Intervals { get; }

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.

Property Value
Type	Description
`RepeatedFieldInterval`

Key

public string Key { get; set; }

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

Property Value
Type	Description
`string`

OrderBy

public string OrderBy { get; set; }

The order in which documents are returned.

Allowed values are:

"count desc", which means order by [SearchResponse.Facet.values.count][google.cloud.discoveryengine.v1.SearchResponse.Facet.FacetValue.count] descending.
"value desc", which means order by [SearchResponse.Facet.values.value][google.cloud.discoveryengine.v1.SearchResponse.Facet.FacetValue.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][google.cloud.discoveryengine.v1.SearchRequest.FacetSpec.FacetKey.intervals].

Property Value
Type	Description
`string`

Prefixes

public RepeatedField<string> Prefixes { get; }

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.

Property Value
Type	Description
`RepeatedFieldstring`

RestrictedValues

public RepeatedField<string> RestrictedValues { get; }

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.

Property Value
Type	Description
`RepeatedFieldstring`