@coveo/headless
    Preparing search index...

    Module Insight

    The Coveo Headless Insight sub-package exposes exposes the engine, controllers, actions, and utility functions to build an insight experience.

    import { buildSearchBox, buildInsightEngine, getSampleInsightEngineConfiguration } from '@coveo/headless/insight';

    const engine = buildInsightEngine({
    configuration: getSampleInsightEngineConfiguration()
    });

    const searchBox = buildSearchBox(engine);
    InsightAnalyticsActionCreators
    loadInsightAnalyticsActions
    AttachedResultsActionCreators
    AttachedResultsAnalyticsActionCreators
    loadAttachedResultsActions
    loadAttachedResultsAnalyticsActions
    CaseContextActionCreators
    loadCaseContextActions
    ContextActionCreators
    loadContextActions
    DateFacetSetActionCreators
    loadDateFacetSetActions
    FieldActionCreators
    loadFieldActions
    GeneratedAnswerActionCreators
    loadGeneratedAnswerActions
    GenericAnalyticsActionCreators
    loadGenericAnalyticsActions
    InsightInterfaceActionCreators
    loadInsightInterfaceActions
    InsightSearchAnalyticsActionCreators
    loadInsightSearchAnalyticsActions
    InsightUserActionsActionCreators
    loadInsightUserActionsActions
    NumericFacetSetActionCreators
    loadNumericFacetSetActions
    QuerySetActionCreators
    loadQuerySetActions
    QuerySuggestActionCreators
    loadQuerySuggestActions
    QuestionAnsweringActionCreators
    loadQuestionAnsweringActions
    RecentResultsActionCreators
    loadRecentResultsActions
    AttachedResults
    buildAttachedResults
    AttachToCase
    buildAttachToCase
    buildBreadcrumbManager
    CategoryFacet
    CategoryFacetState
    CoreCategoryFacet
    CoreCategoryFacetState
    buildCategoryFacet
    DateFacet
    DateFacetState
    buildDateFacet
    DateFilter
    DateFilterState
    buildDateFilter
    DidYouMean
    DidYouMeanState
    buildDidYouMean
    CoreFacet
    CoreFacetState
    Facet
    FacetState
    buildFacet
    buildFacetConditionsManager
    FacetManager
    FacetManagerState
    buildFacetManager
    FoldedResultList
    FoldedResultListState
    buildFoldedResultList
    GeneratedAnswer
    GeneratedAnswerState
    buildGeneratedAnswer
    InsightInterface
    buildInsightInterface
    InteractiveCitation
    buildInteractiveCitation
    InteractiveResult
    buildInteractiveResult
    NotifyTrigger
    NotifyTriggerState
    buildNotifyTrigger
    NumericFacet
    NumericFacetState
    buildNumericFacet
    NumericFilter
    NumericFilterState
    buildNumericFilter
    Pager
    PagerState
    buildPager
    QueryError
    QueryErrorState
    buildQueryError
    QuerySummary
    QuerySummaryState
    buildQuerySummary
    Quickview
    QuickviewState
    buildQuickview
    RecentQueriesList
    RecentQueriesState
    buildRecentQueriesList
    ResultList
    ResultListState
    buildResultList
    ResultsPerPage
    ResultsPerPageState
    buildResultsPerPage
    SearchBoxState
    buildSearchBox
    SearchParameterManager
    SearchParameterManagerState
    buildSearchParameterManager
    SearchStatus
    SearchStatusState
    buildSearchStatus
    SmartSnippet
    SmartSnippetState
    buildSmartSnippet
    SmartSnippetQuestionsList
    SmartSnippetQuestionsListState
    buildSmartSnippetQuestionsList
    Sort
    SortState
    buildSort
    Tab
    TabState
    buildTab
    UserActions
    buildUserActions
    InsightEngine
    InsightEngineOptions
    buildInsightEngine
    SortOrder
    buildController
    buildCriterionExpression
    buildDateRange
    buildDateSortCriterion
    buildNumericRange
    buildRelevanceSortCriterion
    buildResultTemplatesManager
    deserializeRelativeDate
    getAnalyticsNextApiBaseUrl
    getOrganizationEndpoint
    getSampleInsightEngineConfiguration
    loadFoldingActions
    loadInsightSearchActions
    AddContextActionCreatorPayload
    AnalyticsConfiguration
    AnyFacetValuesCondition
    AttachedResultsOptions
    AttachedResultsProps
    AttachedResultsState
    AttachToCaseOptions
    AttachToCaseProps
    CategoryFacetBreadcrumb
    CategoryFacetOptions
    CategoryFacetProps
    CategoryFacetSearch
    CategoryFacetSearchOptions
    CategoryFacetSearchResult
    CategoryFacetSearchState
    CategoryFacetValue
    CategoryFacetValueCommon
    CategoryFacetValueRequest
    ClearQuerySuggestActionCreatorPayload
    Controller
    CoreEngine
    CoreFacetOptions
    CoreSmartSnippetQuestionsList
    CoreSmartSnippetQuestionsListState
    CreateArticleMetadata
    DateFacetOptions
    DateFacetProps
    DateFacetValue
    DateFilterInitialState
    DateFilterOptions
    DateFilterProps
    DateFilterRange
    DateRangeOptions
    DateRangeRequest
    Delimiters
    DeselectableValue
    DidYouMeanOptions
    DidYouMeanProps
    EngineConfiguration
    ExternalEngineOptions
    FacetConditionsManager
    FacetConditionsManagerProps
    FacetManagerPayload
    FacetOptions
    FacetProps
    FacetSearch
    FacetSearchOptions
    FacetSearchState
    FacetValue
    FacetValueRequest
    FetchQuerySuggestionsActionCreatorPayload
    FoldedCollection
    FoldedResult
    FoldedResultListOptions
    FoldingOptions
    GeneratedAnswerProps
    HighlightKeyword
    InsightAPIErrorStatusResponse
    InsightEngineConfiguration
    InsightEngineSearchConfigurationOptions
    InsightFoldedResultListProps
    InsightFoldingActionCreators
    InsightInteractiveResultOptions
    InsightInteractiveResultProps
    InsightInterfaceState
    InsightSearchActionCreators
    InteractiveCitationOptions
    InteractiveCitationProps
    InteractiveResultCore
    InteractiveResultCoreOptions
    InteractiveResultCoreProps
    LogCategoryFacetBreadcrumbActionCreatorPayload
    LogClickEventActionCreatorPayload
    LogCustomEventActionCreatorPayload
    LogDateFacetBreadcrumbActionCreatorPayload
    LogFacetBreadcrumbActionCreatorPayload
    LogFacetDeselectActionCreatorPayload
    LogFacetExcludeActionCreatorPayload
    LogFacetSelectActionCreatorPayload
    LogFacetUnexcludeActionCreatorPayload
    LogFacetUpdateSortActionCreatorPayload
    LoggerOptions
    LogNumericFacetBreadcrumbActionCreatorPayload
    LogSearchEventActionCreatorPayload
    LogStaticFilterToggleValueActionCreatorPayload
    Middleware
    NumericFacetOptions
    NumericFacetProps
    NumericFacetValue
    NumericFilterInitialState
    NumericFilterOptions
    NumericFilterProps
    NumericFilterRange
    NumericRangeOptions
    NumericRangeRequest
    PagerInitialState
    PagerOptions
    PagerProps
    QueryCorrection
    QuestionAnswerDocumentIdentifier
    QuickviewOptions
    QuickviewProps
    Raw
    RecentQueriesListInitialState
    RecentQueriesListOptions
    RecentQueriesListProps
    RegisterDateFacetActionCreatorPayload
    RegisterFoldingActionCreatorPayload
    RegisterNumericFacetActionCreatorPayload
    RegisterQuerySetQueryActionCreatorPayload
    RegisterQuerySuggestActionCreatorPayload
    RegisterRecentResultsCreatorPayload
    RegisterUserActionsPayload
    RelativeDate
    Relay
    Result
    ResultListOptions
    ResultListProps
    ResultsPerPageInitialState
    ResultsPerPageProps
    ResultTemplatesManager
    SearchBoxOptions
    SearchBoxProps
    SearchParameterManagerInitialState
    SearchParameterManagerProps
    SearchParameters
    SelectQuerySuggestionActionCreatorPayload
    SmartSnippetCore
    SmartSnippetOptions
    SmartSnippetProps
    SmartSnippetQuestionsListOptions
    SmartSnippetQuestionsListProps
    SmartSnippetRelatedQuestion
    SortInitialState
    SortProps
    SpecificFacetSearchResult
    StaticFilterBreadcrumb
    StaticFilterValueMetadata
    Subscribable
    Suggestion
    SuggestionHighlightingOptions
    TabInitialState
    TabOptions
    TabProps
    ToggleSelectDateFacetValueActionCreatorPayload
    ToggleSelectNumericFacetValueActionCreatorPayload
    Unsubscribe
    UpdateDateFacetSortCriterionActionCreatorPayload
    UpdateDateFacetValuesActionCreatorPayload
    UpdateNumericFacetSortCriterionActionCreatorPayload
    UpdateNumericFacetValuesActionCreatorPayload
    UpdateQuerySetQueryActionCreatorPayload
    UserAction
    UserActionsOptions
    UserActionsProps
    UserActionsState
    UserSession
    WordCorrection
    HighlightUtils
    AnalyticsRuntimeEnvironment
    CategoryFacetSortCriterion
    DateFacetBreadcrumb
    DateRangeInput
    FacetBreadcrumb
    FacetSortCriterion
    FacetValueState
    LogLevel
    NumericFacetBreadcrumb
    PlatformEnvironment
    RangeFacetRangeAlgorithm
    RangeFacetSortCriterion
    RelativeDatePeriod
    RelativeDateUnit
    ResultTemplate
    ResultTemplateCondition
    SmartSnippetFeedback
    ResultTemplatesHelpers
    VERSION