@coveo/headless
    Preparing search index...

    Module Search

    The Coveo Headless Search sub-package exposes exposes the engine, controllers, actions, and utility functions to build a search experience.

    import { buildSearchBox, buildSearchEngine, getSampleSearchEngineConfiguration } from '@coveo/headless';

    const engine = buildSearchEngine({
    configuration: getSampleSearchEngineConfiguration()
    });

    const searchBox = buildSearchBox(engine);

    Engine

    SearchEngine
    SearchEngineOptions
    buildSearchEngine

    Controllers - AutomaticFacetGenerator

    AutomaticFacet
    AutomaticFacetGenerator
    AutomaticFacetGeneratorState
    AutomaticFacetState
    buildAutomaticFacetGenerator

    Controllers - BreadcrumbManager

    buildBreadcrumbManager

    Controllers - CategoryFacet

    CategoryFacet
    CategoryFacetState
    CoreCategoryFacet
    CoreCategoryFacetState
    buildCategoryFacet

    Controllers - CategoryFieldSuggestions

    CategoryFieldSuggestions
    CategoryFieldSuggestionsState
    buildCategoryFieldSuggestions

    Controllers - Context

    Context
    ContextState

    Controllers - DateFacet

    DateFacet
    DateFacetState
    buildDateFacet

    Controllers - DateFilter

    DateFilter
    DateFilterState
    buildDateFilter

    Controllers - DictionaryFieldContext

    DictionaryFieldContext
    DictionaryFieldContextState
    buildDictionaryFieldContext

    Controllers - DidYouMean

    DidYouMean
    DidYouMeanState
    buildDidYouMean

    Controllers - ExecuteTrigger

    ExecuteTrigger
    ExecuteTriggerState
    buildExecuteTrigger

    Controllers - Facet

    CoreFacet
    CoreFacetState
    Facet
    FacetState
    buildFacet

    Controllers - FacetManager

    FacetManager
    FacetManagerState
    buildFacetManager

    Controllers - FieldSuggestions

    FieldSuggestions
    FieldSuggestionsState
    buildFieldSuggestions

    Controllers - FoldedResultList

    FoldedResultList
    FoldedResultListState
    buildFoldedResultList

    Controllers - GeneratedAnswer

    GeneratedAnswer
    GeneratedAnswerState
    buildGeneratedAnswer

    Controllers - HistoryManager

    HistoryManager
    HistoryManagerState
    buildHistoryManager

    Controllers - InstantResults

    InstantResults
    InstantResultsState
    buildInstantResults

    Controllers - InteractiveCitation

    InteractiveCitation
    buildInteractiveCitation

    Controllers - InteractiveInstantResult

    InteractiveInstantResult
    buildInteractiveInstantResult

    Controllers - InteractiveRecentResult

    InteractiveRecentResult
    buildInteractiveRecentResult

    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 - QueryTrigger

    QueryTrigger
    QueryTriggerState
    buildQueryTrigger

    Controllers - Quickview

    Quickview
    QuickviewState
    buildQuickview

    Controllers - RecentQueriesList

    RecentQueriesList
    RecentQueriesState
    buildRecentQueriesList

    Controllers - RecentResultsList

    RecentResultsList
    RecentResultsState
    buildRecentResultsList

    Controllers - RedirectionTrigger

    RedirectionTrigger
    RedirectionTriggerState
    buildRedirectionTrigger

    Controllers - RelevanceInspector

    RelevanceInspector
    RelevanceInspectorState
    buildRelevanceInspector

    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 - StandaloneSearchBox

    StandaloneSearchBox
    StandaloneSearchBoxState
    buildStandaloneSearchBox

    Controllers - StaticFilter

    StaticFilter
    StaticFilterState
    buildStaticFilter

    Controllers - Tab

    Tab
    TabState
    buildTab

    Controllers - TabManager

    TabManager
    TabManagerState
    buildTabManager

    Controllers - UrlManager

    UrlManager
    UrlManagerState
    buildUrlManager

    Actions - AdvancedSearchQueries

    AdvancedSearchQueryActionCreators
    loadAdvancedSearchQueryActions

    Actions - Analytics

    ClickAnalyticsActionCreators
    SearchAnalyticsActionCreators
    loadClickAnalyticsActions
    loadSearchAnalyticsActions

    Actions - Breadcrumb

    loadBreadcrumbActions

    Actions - CategoryFacetSet

    CategoryFacetSetActionCreators
    loadCategoryFacetSetActions

    Actions - Configuration

    ConfigurationActionCreators
    loadConfigurationActions

    Actions - Context

    ContextActionCreators
    loadContextActions

    Actions - DateFacetSet

    DateFacetSetActionCreators
    loadDateFacetSetActions

    Actions - Debug

    DebugActionCreators
    loadDebugActions

    Actions - DictionaryFieldContext

    DictionaryFieldContextActionCreators
    loadDictionaryFieldContextActions

    Actions - DidYouMean

    DidYouMeanActionCreators
    loadDidYouMeanActions

    Actions - ExcerptLength

    ExcerptLengthActionCreators
    loadExcerptLengthActions

    Actions - FacetOptions

    FacetOptionsActionCreators
    loadFacetOptionsActions

    Actions - FacetSet

    FacetSetActionCreators
    loadFacetSetActions

    Actions - Field

    FieldActionCreators
    loadFieldActions

    Actions - Folding

    FoldingActionCreators
    loadFoldingActions

    Actions - GeneratedAnswer

    GeneratedAnswerActionCreators
    loadGeneratedAnswerActions

    Actions - GenericAnalytics

    GenericAnalyticsActionCreators
    loadGenericAnalyticsActions

    Actions - History

    HistoryActionCreators
    loadHistoryActions

    Actions - InsightResults

    InstantResultsActionCreators
    loadInstantResultsActions

    Actions - NumericFacetSet

    NumericFacetSetActionCreators
    loadNumericFacetSetActions

    Actions - Pagination

    PaginationActionCreators
    loadPaginationActions

    Actions - Pipeline

    PipelineActionCreators
    loadPipelineActions

    Actions - Query

    QueryActionCreators
    loadQueryActions

    Actions - QuerySet

    QuerySetActionCreators
    loadQuerySetActions

    Actions - QuerySuggest

    QuerySuggestActionCreators
    loadQuerySuggestActions

    Actions - QuestionAnswering

    QuestionAnsweringActionCreators
    loadQuestionAnsweringActions

    Actions - RecentQueries

    RecentQueriesActionCreators
    loadRecentQueriesActions

    Actions - RecentResults

    RecentResultsActionCreators
    loadRecentResultsActions

    Actions - ResultPreview

    ResultPreviewActionCreators
    loadResultPreviewActions

    Actions - Search

    SearchActionCreators
    loadSearchActions

    Actions - SearchConfiguration

    SearchConfigurationActionCreators
    loadSearchConfigurationActions

    Actions - SearchHub

    SearchHubActionCreators
    loadSearchHubActions

    Actions - SortCriteria

    SortCriteriaActionCreators
    loadSortCriteriaActions

    Actions - StandaloneSearchBoxSet

    StandaloneSearchBoxSetActionCreators
    loadStandaloneSearchBoxSetActions

    Actions - StaticFilterSet

    StaticFilterSetActionCreators
    loadStaticFilterSetActions

    Actions - TabSet

    TabSetActionCreators
    loadTabSetActions

    Enumerations

    SortBy
    SortOrder

    Functions - Context

    buildContext

    Functions - Other

    baseFacetResponseSelector
    buildController
    buildCriterionExpression
    buildDateRange
    buildDateSortCriterion
    buildFacetConditionsManager
    buildFieldSortCriterion
    buildNoSortCriterion
    buildNumericRange
    buildQueryExpression
    buildQueryRankingExpressionSortCriterion
    buildRelevanceSortCriterion
    buildResultTemplatesManager
    buildSearchParameterSerializer
    buildStaticFilterValue
    currentPageSelector
    currentPagesSelector
    deserializeRelativeDate
    facetRequestSelector
    facetResponseSelectedValuesSelector
    facetResponseSelector
    getAnalyticsNextApiBaseUrl
    getOrganizationEndpoint
    getSampleSearchEngineConfiguration
    getSearchApiBaseUrl
    loadIPXActionsHistoryActions
    maxPageSelector
    parseCriterionExpression
    validateRelativeDate

    Interfaces

    AddContextActionCreatorPayload
    AddDictionaryFieldContextActionCreatorPayload
    AdvancedSearchQueryActionCreatorPayload
    AnalyticsConfiguration
    AnyFacetValuesCondition
    AutomaticFacetBreadcrumb
    AutomaticFacetGeneratorOptions
    AutomaticFacetGeneratorProps
    CategoryFacetBreadcrumb
    CategoryFacetOptions
    CategoryFacetProps
    CategoryFacetSearch
    CategoryFacetSearchOptions
    CategoryFacetSearchResult
    CategoryFacetSearchState
    CategoryFacetValue
    CategoryFacetValueCommon
    CategoryFacetValueRequest
    CategoryFieldSuggestionsOptions
    CategoryFieldSuggestionsProps
    CategoryFieldSuggestionsValue
    ClearExpiredInstantResultsActionCreatorPayload
    ClearQuerySuggestActionCreatorPayload
    ContextInitialState
    ContextProps
    Controller
    CoreBreadcrumbManager
    CoreBreadcrumbManagerState
    CoreEngine
    CoreQuickview
    CoreQuickviewState
    CoreSmartSnippetQuestionsList
    CoreSmartSnippetQuestionsListState
    DateFacetOptions
    DateFacetProps
    DateFacetValue
    DateFieldExpression
    DateFilterInitialState
    DateFilterOptions
    DateFilterProps
    DateFilterRange
    DateRangeFieldExpression
    DateRangeOptions
    DateRangeRequest
    Delimiters
    DeselectableValue
    DidYouMeanOptions
    DidYouMeanProps
    DocumentWeights
    EngineConfiguration
    ErrorPayload
    ExactMatchExpression
    ExecutionReport
    ExecutionStep
    ExternalEngineOptions
    FacetConditionsManager
    FacetManagerPayload
    FacetOptions
    FacetProps
    FacetSearch
    FacetSearchOptions
    FacetSearchState
    FacetValue
    FacetValueRequest
    FetchInstantResultsActionCreatorPayload
    FetchQuerySuggestionsActionCreatorPayload
    FetchRedirectUrlActionCreatorPayload
    FieldDescription
    FieldExistsExpression
    FieldSuggestionsOptions
    FieldSuggestionsProps
    FieldSuggestionsValue
    FoldedCollection
    FoldedResult
    FoldedResultListOptions
    FoldedResultListProps
    FoldingOptions
    FunctionExecutionTrigger
    GeneratedAnswerCitation
    GeneratedAnswerProps
    GeneratedAnswerPropsInitialState
    GeneratedResponseFormat
    InstantResultOptions
    InstantResultProps
    InteractiveCitationOptions
    InteractiveCitationProps
    InteractiveInstantResultOptions
    InteractiveInstantResultProps
    InteractiveRecentResultOptions
    InteractiveRecentResultProps
    InteractiveResultCore
    InteractiveResultCoreOptions
    InteractiveResultCoreProps
    InteractiveResultOptions
    InteractiveResultProps
    IPXActionsHistoryActionCreators
    KeywordExpression
    LogCategoryFacetBreadcrumbActionCreatorPayload
    LogClickEventActionCreatorPayload
    LogCustomEventActionCreatorPayload
    LogDateFacetBreadcrumbActionCreatorPayload
    LogFacetBreadcrumbActionCreatorPayload
    LogFacetDeselectActionCreatorPayload
    LogFacetExcludeActionCreatorPayload
    LogFacetSelectActionCreatorPayload
    LogFacetUnexcludeActionCreatorPayload
    LogFacetUpdateSortActionCreatorPayload
    LoggerOptions
    LogNumericFacetBreadcrumbActionCreatorPayload
    LogQuerySuggestionClickActionCreatorPayload
    LogSearchEventActionCreatorPayload
    LogStaticFilterClearAllActionCreatorPayload
    LogStaticFilterToggleValueActionCreatorPayload
    LogUndoTriggerQueryActionCreatorPayload
    Middleware
    NearExpression
    Negatable
    NumericFacetOptions
    NumericFacetProps
    NumericFacetValue
    NumericFieldExpression
    NumericFilterInitialState
    NumericFilterOptions
    NumericFilterProps
    NumericFilterRange
    NumericRangeFieldExpression
    NumericRangeOptions
    NumericRangeRequest
    OtherTerm
    PagerInitialState
    PagerOptions
    PagerProps
    QueryCorrection
    QueryExpression
    QueryExpressions
    QueryExtensionExpression
    QueryRankingExpression
    QueryRankingExpressionWeights
    QuestionAnswerDocumentIdentifier
    QuestionAnsweringInlineLinkActionCreatorPayload
    QuestionAnsweringUniqueIdentifierActionCreatorPayload
    QuickviewOptions
    QuickviewProps
    RankingInformation
    Raw
    RecentQueriesListInitialState
    RecentQueriesListOptions
    RecentQueriesListProps
    RecentResultsListInitialState
    RecentResultsListOptions
    RecentResultsListProps
    RegisterCategoryFacetActionCreatorPayload
    RegisterDateFacetActionCreatorPayload
    RegisterFacetActionCreatorPayload
    RegisterFoldingActionCreatorPayload
    RegisterInstantResultActionCreatorPayload
    RegisterNumericFacetActionCreatorPayload
    RegisterQuerySetQueryActionCreatorPayload
    RegisterQuerySuggestActionCreatorPayload
    RegisterRecentResultsCreatorPayload
    RegisterStandaloneSearchBoxActionCreatorPayload
    RegisterStaticFilterActionCreatorPayload
    RegisterTabActionCreatorPayload
    RelativeDate
    Relay
    RelevanceInspectorInitialState
    RelevanceInspectorProps
    ResetStandaloneSearchBoxActionCreatorPayload
    Result
    ResultListOptions
    ResultListProps
    ResultRankingInformation
    ResultsPerPageInitialState
    ResultsPerPageProps
    ResultTemplatesManager
    SearchBoxOptions
    SearchBoxProps
    SearchConfigurationOptions
    SearchEngineConfiguration
    SearchParameterManagerInitialState
    SearchParameterManagerProps
    SearchParameters
    SecurityIdentity
    SelectQuerySuggestionActionCreatorPayload
    SetOriginLevel2ActionCreatorPayload
    SetOriginLevel3ActionCreatorPayload
    SmartSnippetCore
    SmartSnippetOptions
    SmartSnippetProps
    SmartSnippetQuestionsListOptions
    SmartSnippetQuestionsListProps
    SmartSnippetRelatedQuestion
    SortInitialState
    SortProps
    SpecificFacetSearchResult
    StandaloneSearchBoxOptions
    StandaloneSearchBoxProps
    StaticFilterBreadcrumb
    StaticFilterOptions
    StaticFilterProps
    StaticFilterValue
    StaticFilterValueMetadata
    StaticFilterValueOptions
    StringFacetFieldExpression
    StringFieldExpression
    Subscribable
    Suggestion
    SuggestionHighlightingOptions
    TabInitialState
    TabOptions
    TabProps
    Template
    TemplatesManager
    ToggleSelectCategoryFacetValueActionCreatorPayload
    ToggleSelectDateFacetValueActionCreatorPayload
    ToggleSelectFacetValueActionCreatorPayload
    ToggleSelectNumericFacetValueActionCreatorPayload
    ToggleSelectStaticFilterValueActionCreatorPayload
    Unsubscribe
    UpdateAnalyticsConfigurationActionCreatorPayload
    UpdateAnalyticsToOmniboxFromLinkActionCreatorPayload
    UpdateAnalyticsToSearchFromLinkActionCreatorPayload
    UpdateBasicConfigurationActionCreatorPayload
    UpdateCategoryFacetBasePathActionCreatorPayload
    UpdateCategoryFacetNumberOfValuesActionCreatorPayload
    UpdateCategoryFacetSortCriterionActionCreatorPayload
    UpdateDateFacetSortCriterionActionCreatorPayload
    UpdateDateFacetValuesActionCreatorPayload
    UpdateFacetAutoSelectionActionCreatorPayload
    UpdateFacetIsFieldExpandedActionCreatorPayload
    UpdateFacetNumberOfValuesActionCreatorPayload
    UpdateFacetOptionsActionCreatorPayload
    UpdateFacetSortCriterionActionCreatorPayload
    UpdateFreezeCurrentValuesActionCreatorPayload
    UpdateInstantResultQueryActionCreatorPayload
    UpdateNumericFacetSortCriterionActionCreatorPayload
    UpdateNumericFacetValuesActionCreatorPayload
    UpdateQueryActionCreatorPayload
    UpdateQuerySetQueryActionCreatorPayload
    UpdateSearchConfigurationActionCreatorPayload
    UrlManagerInitialState
    UrlManagerProps
    WordCorrection

    Namespaces

    HighlightUtils

    References

    HighlightKeyword → HighlightUtils.HighlightKeyword

    Type Aliases

    AnalyticsClientSendEventHook
    AnalyticsRuntimeEnvironment
    AnyFacetValueRequest
    CategoryFacetSortCriterion
    ContextPayload
    ContextValue
    DateFacetBreadcrumb
    DateRangeInput
    DictionaryFieldContextPayload
    DisableFacetActionCreatorPayload
    EnableFacetActionCreatorPayload
    ExecuteTriggerParams
    FacetBreadcrumb
    FacetResultsMustMatch
    FacetSortCriterion
    FacetValueState
    GeneratedAnswerFeedback
    GeneratedAnswerFeedbackOption
    GeneratedContentFormat
    LogLevel
    NumericFacetBreadcrumb
    PhrasesToHighlight
    PlatformEnvironment
    RangeFacetRangeAlgorithm
    RangeFacetSortCriterion
    RelativeDatePeriod
    RelativeDateUnit
    ResultTemplate
    ResultTemplateCondition
    SearchAppState
    SearchParametersState
    SmartSnippetFeedback
    SortByDate
    SortByField
    SortByNoSort
    SortByQRE
    SortByRelevancy
    SortCriterion
    StandaloneSearchBoxAnalytics
    StaticFilterValueState
    TermsToHighlight
    TermWeightReport

    Variables

    API_DATE_FORMAT
    DefaultFieldsToInclude
    EcommerceDefaultFieldsToInclude
    MinimumFieldsToInclude
    ResultTemplatesHelpers
    VERSION