Class GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey
Specifies how a facet is computed.
Implements
Inherited Members
Namespace: Google.Apis.DiscoveryEngine.v1.Data
Assembly: Google.Apis.DiscoveryEngine.v1.dll
Syntax
public class GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey : IDirectResponseSchema
Properties
CaseInsensitive
True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.
Declaration
[JsonProperty("caseInsensitive")]
public virtual bool? CaseInsensitive { get; set; }
Property Value
Type | Description |
---|---|
bool? |
Contains
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.
Declaration
[JsonProperty("contains")]
public virtual IList<string> Contains { get; set; }
Property Value
Type | Description |
---|---|
IList<string> |
ETag
The ETag of the item.
Declaration
public virtual string ETag { get; set; }
Property Value
Type | Description |
---|---|
string |
Intervals
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.
Declaration
[JsonProperty("intervals")]
public virtual IList<GoogleCloudDiscoveryengineV1betaInterval> Intervals { get; set; }
Property Value
Type | Description |
---|---|
IList<GoogleCloudDiscoveryengineV1betaInterval> |
Key
Required. Supported textual and numerical facet keys in Document object, over which the facet values are computed. Facet key is case-sensitive.
Declaration
[JsonProperty("key")]
public virtual string Key { get; set; }
Property Value
Type | Description |
---|---|
string |
OrderBy
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.
Declaration
[JsonProperty("orderBy")]
public virtual string OrderBy { get; set; }
Property Value
Type | Description |
---|---|
string |
Prefixes
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.
Declaration
[JsonProperty("prefixes")]
public virtual IList<string> Prefixes { get; set; }
Property Value
Type | Description |
---|---|
IList<string> |
RestrictedValues
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.
Declaration
[JsonProperty("restrictedValues")]
public virtual IList<string> RestrictedValues { get; set; }
Property Value
Type | Description |
---|---|
IList<string> |