Options for processing facet reults of a query.
Inherits From: expected_type
View aliases
Main aliases
`google.appengine.api.search.search.FacetOptions`
google.appengine.api.search.FacetOptions(
discovery_limit=10, discovery_value_limit=None, depth=None
)
Args | |
---|---|
discovery_limit
|
Number of facets to discover if facet discovery is turned on. If None, discover facets will be disabled. |
discovery_value_limit
|
Number of values to be discovered for each of the top discovered facets. |
depth
|
Number of documents in query results to evaluate to gather facet information. |
Raises | |
---|---|
TypeError
|
If an unknown attribute is passed. |
ValueError
|
If any of the parameters have invalid values (e.g., a negative depth). |
Attributes | |
---|---|
depth
|
Returns the number of documents to analyze for facet discovery. |
discovery_limit
|
Returns the number of facets to discover. |
discovery_value_limit
|
Returns the number of values to discover for each facet. |