Reference documentation and code samples for the Google Cloud Discovery Engine V1beta Client class FacetSpec.
A facet specification to perform faceted search.
Generated from protobuf message google.cloud.discoveryengine.v1beta.SearchRequest.FacetSpec
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ facet_key |
Google\Cloud\DiscoveryEngine\V1beta\SearchRequest\FacetSpec\FacetKey
Required. The facet key specification. |
↳ limit |
int
Maximum of facet values that should be returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 will be coerced to 300. If this field is negative, an |
↳ excluded_filter_keys |
array
List of keys to exclude when faceting. By default, 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 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 |
↳ enable_dynamic_position |
bool
Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. It will be ordered together with dynamic facets if dynamic facets is enabled. If set to false, the position of this facet in the response will be the same as in the request, and it will be 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 will be 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 enable, which will generate 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" will always be ranked at 1st and 2nd position since their enable_dynamic_position are false. |
getFacetKey
Required. The facet key specification.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\DiscoveryEngine\V1beta\SearchRequest\FacetSpec\FacetKey|null | |
hasFacetKey
clearFacetKey
setFacetKey
Required. The facet key specification.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\DiscoveryEngine\V1beta\SearchRequest\FacetSpec\FacetKey
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getLimit
Maximum of facet values that should be returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 will be coerced to 300.
If this field is negative, an INVALID_ARGUMENT is returned.
| Returns | |
|---|---|
| Type | Description |
int | |
setLimit
Maximum of facet values that should be returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 will be coerced to 300.
If this field is negative, an INVALID_ARGUMENT is returned.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getExcludedFilterKeys
List of keys to exclude when faceting.
By default,
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
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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setExcludedFilterKeys
List of keys to exclude when faceting.
By default,
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
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEnableDynamicPosition
Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically.
It will be ordered together with dynamic facets if dynamic facets is enabled. If set to false, the position of this facet in the response will be the same as in the request, and it will be 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 will be 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 enable, which will generate 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" will always be ranked at 1st and 2nd position since their enable_dynamic_position are false.
| Returns | |
|---|---|
| Type | Description |
bool | |
setEnableDynamicPosition
Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically.
It will be ordered together with dynamic facets if dynamic facets is enabled. If set to false, the position of this facet in the response will be the same as in the request, and it will be 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 will be 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 enable, which will generate 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" will always be ranked at 1st and 2nd position since their enable_dynamic_position are false.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |