Skip to main content
Version: 11.13.0

Types Table

Type NameDescription
AggregationDescribes the results of an aggregation, base for list and tree aggregations
AggregationItemDescribes an aggregation item, base for list and tree aggregation nodes
AggregationOptionsOptions for pagination of aggregation values
ListAggregationFields specific to a list aggregation
TreeAggregationFields specific to a tree aggregation
TreeAggregationNodeNode in a tree aggregation, extends AggregationItem
API_ENDPOINTSAPI endpoint string type with autocomplete
CredentialsUsername and password credentials
AuditEventDescribes a single audit event
AuditEventsComposite type for a set of audit events
AuditEventTypeEnum of standard audit event types
AuditRecordContains an array of audit events and ML audit event records
TextChunkText chunk with offset, length, and HTML-highlighted text
TextLocationLocation and length in a document
CCConfigFields available in all configuration objects
CCAppApplication configuration object
CCAppPreLoginPre-login application configuration
CCAppRefreshObject returned by AppWebService.refresh
CCAutocompleteAutocomplete web service configuration
CCColumnColumn configuration in an index
CCColumnInfoConfiguration parameters for a column
CCIndexIndex configuration object
CCLabelsLabels web service configuration
CCListList configuration object
CCListItemList item configuration object
CCQueryQuery configuration object
CCRFMRFM configuration object
CCRFMActionRFM action configuration object
CCScopeScope configuration object for query filtering
CCSortingChoiceSorting choice for queries
CCTabTab configuration object
CCTabSearchTab search configuration in a query
CCWebServiceWeb service configuration object
QueryPrecisionPrecision operators for text search
QueryStrategyStrategies for query search parameters
SpellingCorrectionModeModes for spelling correction in search
BetweenFilterFilter for between operator
ExprFilterFilter for expression operators (and/or/not)
FilterGeneric filter object
FilterExprOperatorExpression filter operators (and/or/not)
FilterOperatorAll filter operators
FilterRangeOperatorRange filter operators (in/between)
FilterScalarOperatorScalar filter operators (eq, neq, gt, etc.)
InFilterFilter for 'in' operator
NotNullFilterFilter for 'notnull' operator
NullFilterFilter for 'null' operator
SimpleFilterFilter for scalar operators
LegacyFilterLegacy filter object
QueryQuery object for QueryWebService
OpenObject to request children of a tree node in aggregation
SelectObject to filter a query by facet selection
LinkResultSingle sponsored link result
LinksResultsSet of sponsored links
ExportOutputFormatOutput format for export (Csv, Xlsx, etc.)
ExportSourceTypeSource type for export (Result, Selection, etc.)
ExportQueryModelData model for export dialog
ExportDialogModelDeprecated export dialog model
LabelsRightsRights for managing/editing labels
CategoryHighlightDataHighlight data for a category
CustomHighlightsCustom highlight data for a category
HighlightDataPerCategoryHighlight data for a set of categories
HighlightDataPerLocationHighlight data for a set of locations
HighlightValueSingle highlight value
PreviewDataData returned by PreviewWebService.get
LocationSingle highlight location
ResultResults of a query web service call
RelevantExtractRelevant extract for a query
QueryIntentSingle query intent item
QueryIntentActionQuery intent action
QueryIntentEntityQuery intent entity
QueryIntentWordQuery intent word
QueryIntentDatasetsSet of query intent datasets
QueryIntentMatchQuery intent match
QueryIntentResponseQuery intent response
TopPassageTop passage in a result
TabResults for a particular tab
TermPresenceTerm presence for a search term
RFMDisplayEnum for RFM display kinds
RFMDataRFM data returned with results
RFMActionDisplayFields of an RFM action
SuggestionSuggestion from suggest web services
UserSettingsMinimal built-in user settings, extensible
StringWithAutocompleteString type with autocomplete support
UserSettingsKeysKeys of user settings