@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);

    Engine

    InsightEngine
    InsightEngineOptions
    buildInsightEngine

    Controllers - AttachToCase

    AttachToCase
    buildAttachToCase

    Controllers - BreadcrumbManager

    buildBreadcrumbManager

    Controllers - CategoryFacet

    CategoryFacet
    CategoryFacetState
    CoreCategoryFacet
    CoreCategoryFacetState
    buildCategoryFacet

    Controllers - DateFacet

    DateFacet
    DateFacetState
    buildDateFacet

    Controllers - DateFilter

    DateFilter
    DateFilterState
    buildDateFilter

    Controllers - DidYouMean

    DidYouMean
    DidYouMeanState
    buildDidYouMean

    Controllers - Facet

    CoreFacet
    CoreFacetState
    Facet
    FacetState
    buildFacet

    Controllers - FacetConditionsManager

    buildFacetConditionsManager

    Controllers - FacetManager

    FacetManager
    FacetManagerState
    buildFacetManager

    Controllers - FoldedResultList

    FoldedResultList
    FoldedResultListState

    Controllers - FolderResultList

    buildFoldedResultList

    Controllers - GeneratedAnswer

    GeneratedAnswer
    GeneratedAnswerState
    buildGeneratedAnswer

    Controllers - InsightInterface

    InsightInterface
    buildInsightInterface

    Controllers - InteractiveCitation

    InteractiveCitation
    buildInteractiveCitation

    Controllers - InteractiveResult

    InteractiveResult
    buildInteractiveResult

    Controllers - NotifyTrigger

    NotifyTrigger
    NotifyTriggerState
    buildNotifyTrigger

    Controllers - NumericFacet

    NumericFacet
    NumericFacetState
    buildNumericFacet

    Controllers - NumericFilter

    NumericFilter
    NumericFilterState
    buildNumericFilter

    Controllers - Pager

    Pager
    PagerState
    buildPager

    Controllers - QueryError

    QueryError
    QueryErrorState
    buildQueryError

    Controllers - QuerySummary

    QuerySummary
    QuerySummaryState
    buildQuerySummary

    Controllers - Quickview

    Quickview
    QuickviewState
    buildQuickview

    Controllers - ResultList

    ResultList
    ResultListState
    buildResultList

    Controllers - ResultsPerPage

    ResultsPerPage
    ResultsPerPageState
    buildResultsPerPage

    Controllers - SearchBox

    SearchBoxState
    buildSearchBox

    Controllers - SearchParameterManager

    SearchParameterManager
    SearchParameterManagerState
    buildSearchParameterManager

    Controllers - SearchStatus

    SearchStatus
    SearchStatusState
    buildSearchStatus

    Controllers - SmartSnippet

    SmartSnippet
    SmartSnippetState
    buildSmartSnippet

    Controllers - SmartSnippetQuestionsList

    SmartSnippetQuestionsList
    SmartSnippetQuestionsListState
    buildSmartSnippetQuestionsList

    Controllers - Sort

    Sort
    SortState
    buildSort

    Controllers - Tab

    Tab
    TabState
    buildTab

    Controllers - UserActions

    UserActions
    buildUserActions

    Actions - Analytics

    InsightAnalyticsActionCreators
    loadInsightAnalyticsActions

    Actions - AttachedResults

    AttachedResultsActionCreators
    loadAttachedResultsActions

    Actions - CaseContext

    CaseContextActionCreators
    loadCaseContextActions

    Actions - Context

    ContextActionCreators
    loadContextActions

    Actions - DateFacetSet

    DateFacetSetActionCreators
    loadDateFacetSetActions

    Actions - Field

    FieldActionCreators
    loadFieldActions

    Actions - Folding

    FoldingActionCreators
    loadFoldingActions

    Actions - GenericAnalytics

    GenericAnalyticsActionCreators
    loadGenericAnalyticsActions

    Actions - InsightInterface

    InsightInterfaceActionCreators
    loadInsightInterfaceActions

    Actions - InsightSearchAnalytics

    InsightSearchAnalyticsActionCreators
    loadInsightSearchAnalyticsActions

    Actions - InsightUserActions

    InsightUserActionsActionCreators
    loadInsightUserActionsActions

    Actions - NumericFacetSet

    NumericFacetSetActionCreators
    loadNumericFacetSetActions

    Actions - QuerySet

    QuerySetActionCreators
    loadQuerySetActions

    Actions - QuerySuggest

    QuerySuggestActionCreators
    loadQuerySuggestActions

    Actions - QuestionAnswering

    QuestionAnsweringActionCreators
    loadQuestionAnsweringActions

    Actions - RecentResults

    RecentResultsActionCreators
    loadRecentResultsActions

    Enumerations

    SortOrder

    Functions

    buildController
    buildCriterionExpression
    buildDateRange
    buildDateSortCriterion
    buildNumericRange
    buildRelevanceSortCriterion
    buildResultTemplatesManager
    deserializeRelativeDate
    getAnalyticsNextApiBaseUrl
    getOrganizationEndpoint
    getSampleInsightEngineConfiguration
    loadInsightSearchActions

    Interfaces

    AddContextActionCreatorPayload
    AnalyticsConfiguration
    AnyFacetValuesCondition
    AttachedResult
    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
    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
    RegisterDateFacetActionCreatorPayload
    RegisterFoldingActionCreatorPayload
    RegisterNumericFacetActionCreatorPayload
    RegisterQuerySetQueryActionCreatorPayload
    RegisterQuerySuggestActionCreatorPayload
    RegisterRecentResultsCreatorPayload
    RegisterUserActionsPayload
    RelativeDate
    Relay
    Result
    ResultListOptions
    ResultListProps
    ResultsPerPageInitialState
    ResultsPerPageProps
    ResultTemplatesManager
    SearchBoxOptions
    SearchBoxProps
    SearchParameterManagerInitialState
    SearchParameterManagerProps
    SearchParameters
    SelectQuerySuggestionActionCreatorPayload
    SetAttachedResultsActionCreatorPayload
    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

    Namespaces

    HighlightUtils

    Type Aliases

    AnalyticsRuntimeEnvironment
    CategoryFacetSortCriterion
    DateFacetBreadcrumb
    DateRangeInput
    FacetBreadcrumb
    FacetSortCriterion
    FacetValueState
    LogLevel
    NumericFacetBreadcrumb
    PlatformEnvironment
    RangeFacetRangeAlgorithm
    RangeFacetSortCriterion
    RelativeDatePeriod
    RelativeDateUnit
    ResultTemplate
    ResultTemplateCondition
    SmartSnippetFeedback

    Variables

    ResultTemplatesHelpers