1.0.0-beta25 (latest) 1.0.0-beta24

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

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

A facet specification to perform faceted search.

## Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) \> SearchRequest.Types.FacetSpec

## Implements

[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[SearchRequest](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequest)[Types](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequest.Types)[FacetSpec](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequest.Types.FacetSpec), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[SearchRequest](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequest)[Types](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequest.Types)[FacetSpec](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequest.Types.FacetSpec), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[SearchRequest](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequest)[Types](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequest.Types)[FacetSpec](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequest.Types.FacetSpec), [IBufferMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IBufferMessage.html), [IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage.html)

## Inherited Members

[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode) [object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype) [object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)

## Namespace

[Google.Cloud.DiscoveryEngine.V1Beta](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta)

## Assembly

Google.Cloud.DiscoveryEngine.V1Beta.dll

## Constructors

### FacetSpec()

    public FacetSpec()

### FacetSpec(FacetSpec)

    public FacetSpec(SearchRequest.Types.FacetSpec other)

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `other` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequesthttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequest.Typeshttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequest.Types.FacetSpec` |

## Properties

### EnableDynamicPosition

    public bool EnableDynamicPosition { get; set; }

Enables dynamic position for this facet. If set to true, the position of
this facet among all facets in the response is determined automatically.
If dynamic facets are enabled, it is ordered together.
If set to false, the position of this facet in the
response is the same as in the request, and it is ranked before
the facets with dynamic position enable and all dynamic facets.

For example, you may always want to have rating facet returned in
the response, but it's not necessarily to always display the rating facet
at the top. In that case, you can set enable_dynamic_position to true so
that the position of rating facet in response is determined
automatically.

Another example, assuming you have the following facets in the request:

- "rating", enable_dynamic_position = true

- "price", enable_dynamic_position = false

- "brands", enable_dynamic_position = false

And also you have a dynamic facets enabled, which generates a facet
`gender`. Then the final order of the facets in the response can be
("price", "brands", "rating", "gender") or ("price", "brands", "gender",
"rating") depends on how API orders "gender" and "rating" facets.
However, notice that "price" and "brands" are always
ranked at first and second position because their enable_dynamic_position
is false.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.boolean` |   |

### ExcludedFilterKeys

    public RepeatedField<string> ExcludedFilterKeys { get; }

List of keys to exclude when faceting.

By default,
\[FacetKey.key\]\[google.cloud.discoveryengine.v1beta.SearchRequest.FacetSpec.FacetKey.key\]
is not excluded from the filter unless it is listed in this field.

Listing a facet key in this field allows its values to appear as facet
results, even when they are filtered out of search results. Using this
field does not affect what search results are returned.

For example, suppose there are 100 documents with the color facet "Red"
and 200 documents with the color facet "Blue". A query containing the
filter "color:ANY("Red")" and having "color" as
\[FacetKey.key\]\[google.cloud.discoveryengine.v1beta.SearchRequest.FacetSpec.FacetKey.key\]
would by default return only "Red" documents in the search results, and
also return "Red" with count 100 as the only color facet. Although there
are also blue documents available, "Blue" would not be shown as an
available facet value.

If "color" is listed in "excludedFilterKeys", then the query returns the
facet values "Red" with count 100 and "Blue" with count 200, because the
"color" key is now excluded from the filter. Because this field doesn't
affect search results, the search results are still correctly filtered to
return only "Red" documents.

A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT`
error is returned.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.Collections.RepeatedField-1.htmlhttps://learn.microsoft.com/dotnet/api/system.string` |   |

### FacetKey

    public SearchRequest.Types.FacetSpec.Types.FacetKey FacetKey { get; set; }

Required. The facet key specification.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequesthttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequest.Typeshttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequest.Types.FacetSpechttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequest.Types.FacetSpec.Typeshttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequest.Types.FacetSpec.Types.FacetKey` |   |

### Limit

    public int Limit { get; set; }

Maximum facet values that are returned for this facet. If
unspecified, defaults to 20. The maximum allowed value is 300. Values
above 300 are coerced to 300.
For aggregation in healthcare search, when the \[FacetKey.key\] is
"healthcare_aggregation_key", the limit will be overridden to
10,000 internally, regardless of the value set here.

If this field is negative, an `INVALID_ARGUMENT` is returned.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.int32` |   |