TermAggUI
Property | Description | Default | Type | Required |
---|---|---|---|---|
max_display | Maximum number of terms to display in the UI | 5 | Union[int, None] | No |
mime_icon | Whether to use MIME icons in the UI | False | bool | No |
enable_negative | Whether to enable negative terms in the UI | True | bool | No |
TermAgg
Property | Description | Default | Type | Required |
---|---|---|---|---|
type | Type of aggregation | DynamicAggType.TERM | DynamicAggType | Yes |
max_values | Maximum number of term values to retrieve | None | Union[int, None] | No |
min_doc_count | Minimum document count threshold for terms to be included | 0 | int | Yes (>=0) |
operation | Boolean operation for combining terms (OR or AND) | OR | BoolOperation | No |
order | Custom order for the aggregation results | None | Union[OrderEntry, None] | No |
exclude_terms | List of terms to be excluded from aggregation | None | List[str] | No |
include_terms | List of terms to be explicitly included in the aggregation | None | List[str] | No |
ui_only | Section dedicated to UI transformation options only. Not required for regular aggregation process | None | Union[TermAggUI, None] | No |