@coveo/headless
    Preparing search index...

    Module Recommendation

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

    import { buildRecommendationList, buildRecommendationEngine, getSampleRecommendationEngineConfiguration } from '@coveo/headless/recommendation';

    const engine = buildRecommendationEngine({
    configuration: getSampleRecommendationEngineConfiguration()
    });

    const recommendationList = buildRecommendationList(engine);

    Engine

    RecommendationEngine
    RecommendationEngineOptions
    buildRecommendationEngine

    Controllers - Context

    Context
    ContextState

    Controllers - DictionaryFieldContext

    DictionaryFieldContext
    DictionaryFieldContextState
    buildDictionaryFieldContext

    Controllers - InteractiveResult

    InteractiveResult
    buildInteractiveResult

    Controllers - RecommendationList

    RecommendationList
    buildRecommendationList

    Actions - AdvancedSearchQueries

    AdvancedSearchQueryActionCreators
    loadAdvancedSearchQueryActions

    Actions - Configuration

    ConfigurationActionCreators
    loadConfigurationActions

    Actions - Context

    ContextActionCreators
    loadContextActions

    Actions - Debug

    DebugActionCreators
    loadDebugActions

    Actions - DictionaryFieldContext

    DictionaryFieldContextActionCreators
    loadDictionaryFieldContextActions

    Actions - Field

    FieldActionCreators
    loadFieldActions

    Actions - Pagination

    PaginationActionCreators
    loadPaginationActions

    Actions - Pipeline

    PipelineActionCreators
    loadPipelineActions

    Actions - Recommendation

    RecommendationActionCreators
    loadRecommendationActions

    Actions - SearchConfiguration

    SearchConfigurationActionCreators
    loadSearchConfigurationActions

    Actions - SearchHub

    SearchHubActionCreators
    loadSearchHubActions

    Functions - Context

    buildContext

    Functions - Other

    buildController
    buildResultTemplatesManager
    getAnalyticsNextApiBaseUrl
    getOrganizationEndpoint
    getSampleRecommendationEngineConfiguration
    loadClickAnalyticsActions

    Interfaces

    AddContextActionCreatorPayload
    AddDictionaryFieldContextActionCreatorPayload
    AdvancedSearchQueryActionCreatorPayload
    AnalyticsConfiguration
    ClickAnalyticsActionCreators
    ContextInitialState
    ContextProps
    Controller
    CoreEngine
    EngineConfiguration
    ExternalEngineOptions
    InteractiveResultCore
    InteractiveResultCoreOptions
    InteractiveResultCoreProps
    LoggerOptions
    Middleware
    Raw
    RecommendationEngineConfiguration
    RecommendationInteractiveResultOptions
    RecommendationInteractiveResultProps
    RecommendationListOptions
    RecommendationListProps
    RecommendationListState
    Relay
    Result
    ResultTemplatesManager
    SetOriginLevel2ActionCreatorPayload
    SetOriginLevel3ActionCreatorPayload
    SetRecommendationIdActionCreatorPayload
    Subscribable
    Unsubscribe
    UpdateAnalyticsConfigurationActionCreatorPayload
    UpdateBasicConfigurationActionCreatorPayload
    UpdateSearchConfigurationActionCreatorPayload

    Namespaces

    HighlightUtils

    References

    HighlightKeyword → HighlightUtils.HighlightKeyword

    Type Aliases

    AnalyticsRuntimeEnvironment
    ContextPayload
    ContextValue
    DictionaryFieldContextPayload
    LogLevel
    PlatformEnvironment
    ResultTemplate
    ResultTemplateCondition

    Variables

    DefaultFieldsToInclude
    EcommerceDefaultFieldsToInclude
    MinimumFieldsToInclude
    ResultTemplatesHelpers