Module Case Assist

The Coveo Headless Case Assist sub-package exposes exposes the engine, controllers, actions, and utility functions to build a case assist experience.

import { buildCaseInput, buildCaseAssistEngine } from '@coveo/headless/case-assist';

const engine = buildCaseAssistEngine({
configuration: ...
});

const caseInput = buildCaseInput(engine);

Engine

CaseAssistEngine
CaseAssistEngineOptions
buildCaseAssistEngine

Controllers - CaseAssistInteractiveResult

CaseAssistInteractiveResult
buildInteractiveResult

Controllers - CaseAssistQuickview

CaseAssistQuickview
CaseAssistQuickviewState
buildQuickview

Controllers - CaseField

CaseField
CaseFieldState
buildCaseField

Controllers - CaseInput

CaseInput
CaseInputState
buildCaseInput

Controllers - DocumentSuggestionList

DocumentSuggestionList
DocumentSuggestionListState
buildDocumentSuggestionList

Actions - Analytics

CaseAssistAnalyticsActionCreators
loadCaseAssistAnalyticsActions

Actions - CaseField

CaseFieldActionCreators
loadCaseFieldActions

Actions - CaseInput

CaseInputActionCreators
loadCaseInputActions

Actions - DocumentSuggestion

DocumentSuggestionActionCreators
loadDocumentSuggestionActions

Actions - GenericAnalytics

GenericAnalyticsActionCreators
loadGenericAnalyticsActions

Functions

buildController
getAnalyticsNextApiBaseUrl
getOrganizationEndpoint

Interfaces

AnalyticsConfiguration
CaseAssistEngineConfiguration
CaseAssistInteractiveResultOptions
CaseAssistInteractiveResultProps
CaseAssistQuickviewOptions
CaseAssistQuickviewProps
CaseFieldOptions
CaseFieldProps
CaseFieldSuggestion
CaseInputOptions
CaseInputProps
Controller
CoreEngine
DocumentSuggestionResponse
EngineConfiguration
ExternalEngineOptions
HighlightKeyword
InteractiveResultCore
InteractiveResultCoreOptions
InteractiveResultCoreProps
LogClickEventActionCreatorPayload
LogCustomEventActionCreatorPayload
LoggerOptions
LogSearchEventActionCreatorPayload
Middleware
NavigatorContext
NextStageOptions
Quickview
QuickviewOptions
QuickviewProps
QuickviewState
Raw
Relay
Result
SetCaseFieldActionCreatorPayload
SetCaseInputActionCreatorPayload
Subscribable
Unsubscribe
UpdateCaseFieldFetchOptions
UpdateFetchOptions

References

buildDocumentSuggestion → buildDocumentSuggestionList

Type Aliases

AnalyticsRuntimeEnvironment
LogLevel

Variables

ResultTemplatesHelpers