This preview documentation is deprecated as of October 27, 2023. For GA documentation, go to the Vertex AI Search documentation.

Changes in GA:

Name: Discovery for Media is renamed to Vertex AI Search for media. Vertex AI Search includes media recommendations and media search.
Google Cloud Console page: Use the Agent Builder page in the console. The Discovery Engine console page is deprecated.
API reference: Continue to use the discoveryengine.googleapis.com service. The API remains the same but the documentation has moved. Go to the up-to-date, GA version of the Discovery Engine API reference in the Vertex AI Search documentation.
All changes: To see what else changed between preview and GA, see Switch from Discovery for Media to media recommendations in the Vertex AI Search documentation.

FacetSpec

JSON representation
FacetKey
- JSON representation

A facet specification to perform faceted search.

JSON representation
{ "facetKey": { object (`FacetKey`) }, "limit": integer, "excludedFilterKeys": [ string ], "enableDynamicPosition": boolean }

Fields
`facetKey`	`object (FacetKey)` Required. The facet key specification.
`limit`	`integer` 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 are coerced to 300. If this field is negative, an `INVALID_ARGUMENT` is returned.
`excludedFilterKeys[]`	`string` 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.
`enableDynamicPosition`	`boolean` 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 enableDynamicPosition 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", enableDynamicPosition = true "price", enableDynamicPosition = false "brands", enableDynamicPosition = 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 enableDynamicPosition is false.

FacetKey

Specifies how a facet is computed.

JSON representation
{ "key": string, "intervals": [ { object (`Interval`) } ], "restrictedValues": [ string ], "prefixes": [ string ], "contains": [ string ], "caseInsensitive": boolean, "orderBy": string }

Fields
`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[]`	`object (Interval)` 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.
`restrictedValues[]`	`string` 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 "restrictedValues" to "Action > 2022", the "category" facet only contains "Action > 2022". Only supported on textual fields. Maximum is 10.
`prefixes[]`	`string` 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.
`contains[]`	`string` 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.
`caseInsensitive`	`boolean` True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.
`orderBy`	`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`.