More
Product news
Community
Support
Settings
Cookie preferences

AI agent context: a documentation index for this site is available at /llms.txt. A markdown version of this page is also available by appending .md to this page URL.

Home
Coveo Platform

Implementation guide
Index content
Build a search UI
Tune relevance
Monitor and measure your data
Leverage AI and ML
Manage an organization
Manage customer service solutions
Knowledge Hub
Coveo CLI
Coveo REST APIs
Searching with Coveo

Solutions and integrations

Coveo for Adobe
Coveo for Agentforce
Coveo for Commerce
Coveo for Contentful
Coveo for Optimizely
Coveo In-Product Experience (IPX)
Coveo for Salesforce

New features

Features of 2024
Features of 2023
Features of 2022
Features of 2021
Features of 2020

Basics

What's new in v6?
What's new in v5?
What's new in v4?
Architecture
Main features
Supported browsers
Product lifecycle
Grant login access to your Salesforce account

Get started

Install the application
Configure the application
Add a Salesforce source

Index Chatter feeds
Index Knowledge
JSON modification

Go to production

Grant users access to your Coveo Lightning components
Grant users access to your Coveo Classic components (Deprecated)
Get started for end users

Get started with Coveo for Einstein Bots

Integrate Coveo components

Choose the right Insight Panel component
Hosted components

Integrate a Coveo Hosted Insight Panel

Generate a custom platform token
Add custom context to the Hosted Insight Panel

Integrate a Coveo hosted search page in a Lightning Console app

Generate a custom search token
Add custom context

Integrate a Coveo hosted search page in an Experience Cloud site

Generate a custom search token
Add custom context

Lightning Console app components

Integrate a Coveo Full Search page
Integrate a Coveo Insight Panel Lightning Component

Configure a Coveo Insight Panel Lightning Component for Chat (Live Agent)
Use the result actions
Add the Create Article button
Add the UserActions component
Customize the Full Search button options
Add the Attached Results component
Add the Insight Query Summary component

Integrate a Coveo Insight Attached Results component

Experience Cloud site components

Integrate a Coveo Community Search component
Integrate a Coveo Page View Tracker component
Integrate a Coveo Recommendation component
Integrate a Coveo Case Deflection component

Analytics tracking components

Coveo ClientIdAccessor Lightning component
Coveo VisitorIdAccessor Lightning component (Deprecated)

Classic components (Deprecated)

Integrate a Coveo Insight Panel Classic Component (Deprecated)

Add a Create Article button to the Coveo Insight Panel Classic Component (Deprecated)
Add a contextual query to the Coveo Insight Panel Classic Component (Deprecated)
Add a UserActions component (Deprecated)

Integrate a Coveo Full Search page (Deprecated)

Access the Interface Editor

Manage the application

Configure Coveo for Salesforce

Reset your Coveo for Salesforce configuration
Access to the Coveo for Salesforce configuration pages
Uninstall Coveo for Salesforce

Refresh Coveo for Salesforce in a sandbox
Identify your Coveo for Salesforce version
Use SSO with Coveo for Salesforce
Synchronize your configuration
Lightning Web Components (LWC) support
Upgrade

Upgrade the Coveo for Salesforce application
Upgrade to the new Coveo Insight Panel Lightning Component experience
Upgrade from v5 to v6
Upgrade from v4 to v5
Upgrade from v3 to v4

Migrate components from Salesforce API 39 to API 40+

Develop and customize

Basic setup before you can start to develop
Quantic library

Usage

Use a standalone search box
Use the Result Template component
Implement folding
Use generative answering
Content recommendations
Create a Case Assist interface
Create a custom caption provider component for facets
Usage Analytics

Log view events with Coveo UA

Display a facet based on the selection of another facet
Create custom result actions
Access Headless through Quantic
Create a custom Insight Panel

Create result templates
Create custom result actions
Leverage case context
Integrate useful Coveo for Salesforce features

Safely set the search hub value

Upgrade
Reference

Search components

AriaLive
BreadcrumbManager
CategoryFacet
CategoryFacetValue
DateFacet
DidYouMean
Facet
FacetCaption
FacetManager
FacetValue
Feedback
FeedbackModal
FeedbackModalQna
FoldedResultList
GeneratedAnswer
Modal
ModalA11yHandler
NoResults
Notifications
NumericFacet
Pager
QueryError
RecentQueriesList
RecentResultLink
RecentResultsList
RefineModalContent
RefineToggle
Result
ResultAction
ResultActionBar
ResultList
ResultsPerPage
SearchBox
SearchBoxSuggestionsList
SearchInterface
SmartSnippet
SmartSnippetAnswer
SmartSnippetSource
SmartSnippetSuggestions
Sort
SortOption
StandaloneSearchBox
Summary
Tab
TabBar
Timeframe
TimeframeFacet

Result Template components

ColoredResultBadge
ResultChildren
ResultDate
ResultField
ResultHighlightedTextField
ResultLabel
ResultLink
ResultMultiValueText
ResultNumber
ResultPrintableUri
ResultQuickview
ResultTag
ResultTemplate
ResultText
ViewedByCustomerBadge

Case Assist components

CaseAssistInterface
CaseClassification
DocumentSuggestion

Utility components

CardContainer
Carousel
Heading
NumberButton
Pill
Placeholder
Svg

Insight Panel components

AriaLive
BreadcrumbManager
CategoryFacet
CategoryFacetValue
DidYouMean
Facet
FacetCaption
FacetManager
FacetValue
Feedback
FeedbackModal
FeedbackModalQna
InsightInterface
InsightPanelSummary
Modal
ModalA11yHandler
NoResults
Notifications
NumericFacet
Pager
QueryError
RefineModalContent
RefineToggle
Result
ResultAction
ResultActionBar
ResultCopyToClipboard
ResultList
ResultsPerPage
SearchBox
SearchBoxSuggestionsList
Sort
SortOption
Summary
Tab
TabBar
Timeframe
TimeframeFacet
UserActionsToggle

Recommendation components

RecommendationInterface
RecommendationList

Product lifecycle
Change log
Versioned documentation

Quantic library

Usage

Use a standalone search box
Use the Result Template component
Implement folding
Use generative answering
Content recommendations
Create a custom caption provider component for facets
Display a facet based on the selection of another facet
Create custom result actions
Access Headless through Quantic
Safely set the search hub value

Reference

Search components

AriaLive
BreadcrumbManager
CategoryFacet
CategoryFacetValue
DateFacet
DidYouMean
Facet
FacetCaption
FacetManager
FacetValue
Feedback
FeedbackModal
FeedbackModalQna
FoldedResultList
GeneratedAnswer
Modal
ModalA11yHandler
NoResults
Notifications
NumericFacet
Pager
QueryError
RecentQueriesList
RecentResultLink
RecentResultsList
RefineModalContent
RefineToggle
Result
ResultAction
ResultActionBar
ResultList
ResultsPerPage
SearchBox
SearchBoxSuggestionsList
SearchInterface
SmartSnippet
SmartSnippetAnswer
SmartSnippetSource
SmartSnippetSuggestions
Sort
SortOption
StandaloneSearchBox
Summary
Tab
TabBar
Timeframe
TimeframeFacet

Result Template components

ColoredResultBadge
ResultBadge
ResultChildren
ResultDate
ResultField
ResultHighlightedTextField
ResultLabel
ResultLink
ResultMultiValueText
ResultNumber
ResultPrintableUri
ResultQuickview
ResultTemplate
ResultText
ViewedByCustomerBadge

Case Assist components

CaseAssistInterface
CaseClassification
DocumentSuggestion

Utility components

CardContainer
Carousel
Heading
NumberButton
Pill
Placeholder
Svg

Insight Panel components

AriaLive
BreadcrumbManager
CategoryFacet
CategoryFacetValue
DidYouMean
Facet
FacetCaption
FacetManager
FacetValue
Feedback
FeedbackModal
FeedbackModalQna
InsightInterface
Modal
ModalA11yHandler
NoResults
NumericFacet
Pager
QueryError
RefineModalContent
RefineToggle
Result
ResultAction
ResultActionBar
ResultCopyToClipboard
ResultList
ResultsPerPage
SearchBox
SearchBoxSuggestionsList
Sort
SortOption
Summary
Tab
TabBar
Timeframe
TimeframeFacet

Recommendation components

RecommendationInterface
RecommendationList

Change log
Versioned documentation

Quantic library

Usage

Use a standalone search box
Use the Result Template component
Access Headless through Quantic
Safely set the search hub value

Reference

Search components

AriaLive
BreadcrumbManager
CategoryFacet
CategoryFacetValue
DateFacet
DidYouMean
Facet
FacetManager
FacetValue
Modal
ModalA11yHandler
NoResults
NumericFacet
Pager
QueryError
RecentQueriesList
RecentResultLink
RecentResultsList
RefineModalContent
RefineToggle
Result
ResultAction
ResultActionBar
ResultList
ResultsPerPage
SearchBox
SearchBoxSuggestionsList
SearchInterface
Sort
StandaloneSearchBox
Summary
Tab
TabBar
Timeframe
TimeframeFacet

Result template components

ColoredResultBadge
ResultBadge
ResultLabel
ResultLink
ResultPrintableUri
ResultQuickview
ResultTemplate

Case Assist components

CaseAssistInterface
CaseClassification
DocumentSuggestion

Utility components

CardContainer
NumberButton
Pill
Placeholder
Svg

Insight Panel components

AriaLive
BreadcrumbManager
CategoryFacet
CategoryFacetValue
DidYouMean
Facet
FacetManager
FacetValue
InsightInterface
Modal
ModalA11yHandler
NoResults
NumericFacet
Pager
QueryError
RefineModalContent
RefineToggle
Result
ResultAction
ResultActionBar
ResultCopyToClipboard
ResultList
ResultsPerPage
SearchBox
SearchBoxSuggestionsList
Sort
Summary
Tab
TabBar
Timeframe
TimeframeFacet

Versioned documentation

About search and relevance

About search interfaces

About the default Coveo for Salesforce Full Search page

Expression basics

Ranking basics
Query extensions

Query extension example for a Related People tab
Query extension examples related to accounts
Query extension examples related to cases

Query expansions

About queries

Coveo query syntax examples
Thesaurus rule syntax with numeric and boolean parameters

About usage analytics
Customize Coveo Lightning Aura components

Common customizations
Integrate Coveo Lightning Aura components

Add JavaScript to the Coveo Lightning Aura components with custom code
Integrate Coveo Lightning Aura components in a custom Lightning app
Customize the standalone search box
Change the result icons in a Coveo Lightning Aura component
Change the language of your search interface in Lightning Aura
Make the Coveo Lightning Aura components Lightning-Locker compliant
Send custom context information in a custom page view tracker
Change the default Quick view in Coveo for Salesforce
Change the search result links for Salesforce items
Send custom context information in Salesforce Lightning
Send Apex context to a JavaScript Search interface (Deprecated)
Generate a custom search token for Coveo Lightning Aura components using Lightning Locker

Add a server-side Coveo Lightning Aura component configuration

Customize the Coveo Lightning Aura components used in your Experience Cloud site

Integrate Coveo Lightning Aura components in a custom Lightning component for your Experience Cloud site
Create a search driven page in a Salesforce community
Create a custom standalone search box for your Experience Cloud site
Use Salesforce page variations
Add hidden fields in a Case Deflection component

Integrate Coveo Classic components (Deprecated)

Create a custom Visualforce search page (Deprecated)

Search page architecture (Deprecated)
Change the default Coveo-powered search page (Deprecated)

Create a custom Coveo Insight Panel Classic Component (Deprecated)

Create a custom Coveo box inside the Salesforce console (Deprecated)
Create custom actions for a Coveo Insight Panel Classic Component or a custom box (Deprecated)
Customize the AttachToCase (Deprecated)

Index Lightning flows
Consume the Case Assist API using Apex

Retrieve Case Classifications using Apex
Retrieve Document Suggestions using Apex

Safely apply content filtering
Reference

JavaScript components

AugmentedResultList component
BoxAttachToCase component (Deprecated)
BoxBody component (Deprecated)
Box component (Deprecated)
BoxCreateArticle component (Deprecated)
BoxCurrentSort component (Deprecated)
BoxCurrentTab component (Deprecated)
BoxEditLink component (Deprecated)
BoxExpandLink component (Deprecated)
BoxFieldTable component (Deprecated)
BoxHeader component (Deprecated)
BoxPipelineContext component (Deprecated)
BoxPopup component (Deprecated)
BoxQuerySome component (Deprecated)
BoxQuerySummary component (Deprecated)
BoxQuickview component (Deprecated)
BoxResultAction component (Deprecated)
CaseCreation component (Deprecated)

Cancel component (Deprecated)
Field component (Deprecated)
Picklist component (Deprecated)
Submit component (Deprecated)

CaseDeflection component
ChatterThumbnail component
CommunityStateManager component
ConsoleResultLink component
Copy to clipboard component
CreateArticle component
FullSearch component
InsightQuerySummary component
PipelineContext component
SalesforceAdaptiveResultLink component
SalesforceResultLink component
SalesforceThumbnail component
StandaloneSearchbox component
UserActions component for Visualforce components (Deprecated)
UserActions component for Lightning components
ResultActionsSendEmail component
ResultActionsPostToFeed component
ResultActionsSendLiveAgent component
ResultQuickAction component
ViewedByCustomer component

Visualforce components (Deprecated)

Box Visualforce component (Deprecated)
CaseCreation Visualforce component (Deprecated)
JsSearch Visualforce component (Deprecated)
SearchInterface Visualforce component (Deprecated)
UserActions Visualforce component (Deprecated)

Coveo Lightning Aura components

AgentPanel Lightning component
Base Lightning component (Obsolete)
CaseCreation Lightning component (Obsolete)
CaseDeflection Lightning component
ClickedDocumentList Lightning component
CommunitySearch Lightning component
CommunitySearchBox Lightning component
FullSearch Lightning component
PageViewTracker Lightning component
QueryList Lightning component
Searchbox Lightning component (Obsolete)
Search Lightning component (Obsolete)
SearchUI Lightning component
UserActivity Lightning component
ClientIdAccessor Lightning component
VisitorIdAccessor Lightning component (Deprecated)

Lightning Web components

Recommendation Lightning Web component

Apex classes

UsageAnalytics Apex class
AnalyticsApiClient Apex class
SearchAPIClient Apex class
SearchApiResponse Apex class
SearchApiResult Apex class
AttachToCaseController Apex class
Globals Class

Troubleshooting

Impacts of endpoint deprecation
Lightning component no longer loads after updating the page configuration on the server side
Search interface does not return the expected results
Cannot see values when using an existing field in a facet
Unknown page for the current site configuration error with Coveo Lightning components
Coveo object unavailable in Lightning component
The feature is not activated for your organization
Access token update required