Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

An activity is an event related to a specific Coveo Cloud V2 platform resource such as a source, a field, an indexing pipeline extension, etc. (see Activity - Panel).

Anchor
AdministrationConsole
AdministrationConsole
administration console

See Coveo Cloud V2 administration console

Anchor
AdvancedQueryExpression
AdvancedQueryExpression
advanced query expression

The advanced query expression is a part of the larger query expression (the aq value) that is typically hidden to the end-user and  generated by code based on various rules such as facet selections. 

Anchor
Alias
Alias
alias

An alias is a security identity relationship indicating that two distinct security identities correspond to the same security identity in different enterprise systems. Most of the time, aliases are user security identities.

Anchor
AQ
AQ
aq

See advanced query expression.

Anchor
BasicQueryExpression
BasicQueryExpression
basic query expression

The basic query expression is the part of the larger query expression (the q value) that typically comes from end user input, such as when a user is typing keywords in a search box.

...

The constant query expression is a part of the larger query expression (the cq value) similar to the advanced query expression, but that must hold expressions such as a search scope that are constant for all users of a specific search interface or search tab.  The results of evaluating those expressions are kept in a special index cache to avoid re-evaluating them on each query. 

Anchor
CoveoCloudQueryPipeline
CoveoCloudQueryPipeline
Coveo Cloud query Cloud query pipeline

Coveo Cloud query pipeline is a conditionally applied Search API set of query pipeline features that can be defined to modify a query (see What Is a Query Pipeline?).

Note
iconfalse
titleImportant:

Do not confuse Coveo Cloud query pipelines with the Coveo Cloud V2 indexing pipeline.


Anchor
CoveoCloudQuerySyntax
CoveoCloudQuerySyntax
Coveo Cloud query syntax

The Coveo Cloud query syntax is a set of semantic rules that can be used to compose advanced queries to send to the Search API (see Coveo Cloud Query Syntax Reference).

...

The usage analytics data also feeds Coveo Machine Learning models that are learning user behavior to suggest more relevant content. 

...

The Coveo Cloud V2 administration console is a web application that allows an administrator to manage a Coveo Cloud V2 organization from a graphical user interface (see Coveo Cloud V2 Administration Console ).

The administration console relies on all of the REST API services exposed by the Coveo Cloud V2 platform

Anchor
CoveoCloudV2IndexingPipeline
CoveoCloudV2IndexingPipeline
Coveo Cloud V2 indexing pipeline

The Coveo Cloud V2 Indexing Pipeline is the process through which each source item goes when it is indexed in a Coveo Cloud V2 organization (see Coveo Cloud V2 Indexing Pipeline). 

Note
iconfalse
titleImportant:

Do not confuse the Coveo Cloud V2 indexing pipeline with Coveo Cloud query pipelines.

Anchor
CoveoCloudV2Organization
CoveoCloudV2Organization
Coveo Cloud V2 organization

Coveo Cloud V2 organization is a single tenant instance hosting data and Coveo Cloud V2 platform service configurations allowing a company/corporation/organization to make multiple public and private enterprise content securely searchable with optimized relevance powered by Coveo Cloud usage analytics and Coveo Machine Learning (see  Organization - Section)

...

The Coveo Cloud V2 platform is an enterprise-class native cloud SaaS/PaaS solution that provides a unified and secure way to search for contextually relevant content across multiple enterprise systems (see  Coveo Cloud V2). The platform relies on Coveo Cloud usage analytics data to yield machine learning powered recommendations. The platform embraces the concepts of micro-services and scalability, allowing users to expand their search solution as their business grows.

...

The Coveo JavaScript Search Framework is an open-source set of components (such as a search box, facets, a search result list, sort options) that you can assemble to easily build a feature-rich HTML search page getting results from a Coveo index (see JavaScript Search Framework Home). 

The Coveo JavaScript search page sends search requests to the Search API to get query results, and sends events to the Usage Analytics Write API to log Coveo Cloud usage analytics data. 

Anchor
CoveoMachineLearning
CoveoMachineLearning
Coveo Machine Learning

Coveo Machine Learning is an artificial intelligence (AI) based cloud service hosting machine learning models used to provide more relevant content (see Coveo Machine Learning).

The models learn from Coveo Cloud usage analytics data and validate with the Coveo Cloud index that the querying user has the permission to view each recommended item.

Anchor
CQ
CQ
cq

See constant query expression.

Anchor
DisjunctiveQueryExpression
DisjunctiveQueryExpression
disjunctive query disjunctive query expression

The disjunctive query expression is the part of the larger query expression (the dq value) that is merged with the other expression parts using an OR boolean operator. 

...

The document processing manager is the part of the Coveo Cloud V2 indexing pipeline that applies indexing pipeline extensions and mappings, and processes each incoming item before forwarding it to the index.

Anchor
DPM
DPM
DPM

See document processing manager.

Anchor
DQ
DQ
dq

See disjunctive query expression.

Anchor
EffectivePermissions
EffectivePermissions
effective permissions

The effective permissions of an itemindicate which users can or cannot this item in query results. The index uses the permission model of an item to evaluate its effective permissions when a security identity update is performed.

Anchor
Entity
Entity
entity

See security identity.

Anchor
Expansion
Expansion
expansion

See security identity update.

Anchor
Extension
Extension
extension

See indexing pipeline extension.

Anchor
Facet
Facet
facet

A facet is a Coveo JavaScript Search Framework component that displays a list of values occurring for a certain field in a query result set. Those values are retrieved using a Group By operation, and can be ordered by a configurable criteria (e.g., number of occurrences). End users can interact with facet components to automatically perform advanced query expressions that filter out unwanted query results.

Anchor
Feature
Feature
feature

See query pipeline feature.

Anchor
Field
Field
field

A field is an index-wide data container that holds specific information about each individual item whose corresponding source mappings include rules to populate this field (see Fields - Page).

...

A granted identity is a type of security identity that is automatically given to certain authenticated users by a security identity provider.

A single security identity can have several granted identities, and a given granted identity can be associated with multiple security identities. A granted identity is conceptually similar to a group, except that most of the time, it is not possible for an external secured enterprise system to retrieve the complete list of users who would receive a certain granted identity.

...

Anchor
Group
Group
group

A group is a type of security identity that can contain other security identities (individual users and/or other groups/virtual groups), which are referred to as members. A group has a parent-child security identity relationship with its members.

Anchor
GroupBy
GroupBy
Group By

A Group By operation can be performed at query time by the Search AP to retrieve the different available values for a certain field in the query result set, along with the number of occurrences of each of those values.

The Coveo JavaScript Search Framework performs Group By operations to generate facets.

Anchor
Index
Index
index

An index is a data struture allowing to quickly return items matching a specific query

Anchor
IndexingPipeline
IndexingPipeline
Indexing Pipeline

See Coveo Cloud V2 indexing pipeline.

Anchor
IndexingPipelineExtension
IndexingPipelineExtension
indexing pipeline extension

An indexing pipeline extension is a script defined in a Coveo Cloud V2 organization that can be applied to one or more sources to modify how items are indexed (see Coveo Cloud V2 Indexing Pipeline Extensions).  

An administrator can manage indexing pipeline extensions from the Coveo Cloud V2 administration console (see Extensions - Page).

Anchor
IPE
IPE
IPE

See indexing pipeline extension.

Anchor
Item
Item
item

An item is a source element, such as a document or an object, that can be returned as a single query result. Items in a secured source have a permission model, whereas items in a shared or private source do not.

Anchor
JavaScriptSearch
JavaScriptSearch
JavaScript Search

See Coveo JavaScript Search Framework

Anchor
JsSearch
JsSearch
JsSearch

See Coveo JavaScript Search Framework

Anchor
JS UI
JS UI
JS UI

See Coveo JavaScript Search Framework.

Anchor
Mapping
Mapping
mapping

A mapping is a source-specific set of rules that defines which metadata should be used to populate a certain field when an item passes through the Coveo Cloud V2 indexing pipeline.

See:

...

A metadata is a key-value pair that provides specific information about an item. Metadata is typically leveraged by mappings to populate fields.

Anchor
NestedQuery
NestedQuery
nested query

nested query is a recursive Coveo Cloud query syntax expression used to perform a query on a subset of results obtained from another (possibly nested) query (see Nested Queries).

Anchor
Notification
Notification
notification

A notification is an activity report which can be sent as an email or as the body of an HTTP POST request, depending on its originating subscription configuration.

Anchor
Organization
Organization
organization

See Coveo Cloud V2 organization

Anchor
Permission
Permission
permission

A permission is a single rule that can apply to an individual item to indicate that a certain security identity is either allowed or denied access to that item.

Note
iconfalse
titleImportant:

Do not confuse permissions with privileges.

Anchor
PermissionLevel
PermissionLevel
permission level

A permission level contains one or several combined permission sets that can apply to an individual item.

Anchor
PermissionModel
PermissionModel
permission model

A permission model contains all permissions that apply to an individual item. It can contain allowed and denied permissions, as well as multiple permission sets and permission levels in order to faithfully replicate a complex secured enterprise system.

...

A permission set contains a list of allowed permissions, and a list of denied permission that can apply to an individual item. A permission set can also allow anonymous (i.e., unauthenticated) users to access the item it applies to.

Anchor
Pipeline
Pipeline
pipeline

See Coveo Cloud V2 indexing pipeline.

See Coveo Cloud query pipeline.

Anchor
Privilege
Privilege
privilege

A privilege is granted to a Coveo Cloud V2 platform access token to allow its owner (or owners) to perform certain operations in a Coveo Cloud V2 organization.

Example
exampleheaderExamples

 In a specific Coveo Cloud V2 organization, all members of a certain group could be granted the privilege to view sources, a certain API key could be granted the privilege to edit fields, etc.

Note
iconfalse
titleImportant:

Do not confuse privileges with permissions.

Anchor
Q
Q
q

See basic query expression.

Anchor
QPL
QPL
QPL

See Query Pipeline Language.

Anchor
Query
Query
query

query is a set of one or more expressions sent to a service such as an index to return matching relevant items

Anchor
QueryFunction
QueryFunction
query function

A query function is a mathematical expression evaluated against each item returned by a query, and whose output is stored in a dynamic, temporary field generated at query time (see Query Function).

Anchor
QueryPipeline
QueryPipeline
query pipeline

See Coveo Cloud query pipeline.

Anchor
QueryPipelineFeature
QueryPipelineFeature
query pipeline feature

A query pipeline feature is a query pipeline statement expressing a meaningful action in the Coveo Cloud query pipeline, such as a Coveo Machine Learning model, a thesaurus rule, a featured result rule, a ranking weights rule, etc.

...

The query pipeline language, also known as QPL (pronounced qupel) is a simple language to express the various query pipeline features supported by the Coveo Cloud query pipeline (see Query Pipeline Language (QPL)).

...

A query pipeline statement is an expression constructed using query pipeline language building blocks such as primitive types, lists, conditions, objects, etc.

...

A ranking function is a mathematical expression evaluated against each item returned by a query, and whose output is added to the ranking score of the current item (see Ranking Function). 

...

Anchor
SearchUI
SearchUI
Search UI

The name of the Coveo JavaScript Search Framework GitHub repository (see search-ui).

Anchor
SecurityCache
SecurityCache
security cache

See security identity cache.

Anchor
SecurityIdentity
SecurityIdentity
security identity

A security identity is an entity (i.e., a user, group, virtual group, or granted identity) that can be used to define a permission on a secured item, so that only authenticated users who are allowed to access this item can see it in query results. A security identity is defined in a security identity provider.

Anchor
SecurityIdentityCache
SecurityIdentityCache
security identity cache

The security identity cache is a Coveo Cloud V2 organization module that stores security identities, their properties (such as their state and last update timestamp), and their security identity relationships. The security identity cache greatly speeds up the query processing time when evaluating the effective permissions of secured items.

Anchor
SecurityIdentityProvider
SecurityIdentityProvider
security identity provider

A security identity provider is a Coveo Cloud V2 organization module whose purpose is to extract security identity relationships from a specific secured enterprise system.

...

A security identity relationship is a link (i.e., child, parent, or alias) between two security identities. Security identity relationships are essential when evaluating effective permissions, as they allow the index to resolve granted identitiesgroups, virtual groups, and aliases to individual user entities.

Anchor
SecurityIdentityUpdate
SecurityIdentityUpdate
security identity update

A security identity update is a process during which a security identity provider extracts security identity relationships and stores them in the security identity cache. Once this process is over, the index can re-evaluate the effective permissions of each secured item.

Anchor
SecurityProvider
SecurityProvider
security provider

See security identity provider.

Anchor
Source
Source
source

A source is a Coveo Cloud V2 index container holding all items related to a specific enterprise system such as Google Drive, Web, or SharePoint. A source can be either private, secured, or shared (see Sources - Page).

Anchor
Statement
Statement
statement

See query pipeline statement.

Anchor
Subscription
Subscription
subscription

A subscription can be created by a Coveo Cloud V2 organization user or administrator to allow this person to receive notifications when certain activities occur in this organization.

Anchor
UsageAnalytics
UsageAnalytics
usage analytics

See Coveo Cloud usage analytics

Show If
actionedit

UsageAnalyticsWriteAPIUsage Analytics Write API


Anchor
User
User
user

A user is a type of security identity that usually corresponds to a single authenticated person who can log in a search interface to perform queries. A user can be a member of groups, and can also have aliases and granted identities.

Anchor
UserMapping
UserMapping
user mapping

See alias.

Anchor
VirtualGroup
VirtualGroup
virtual group

A virtual group is a group that exclusively exists within the confines of a security identity provider to ease the permission model management of a given indexed enterprise system. The only difference between a group and a virtual group is that the former typically exists as an entity in the original enterprise system, whereas the latter does not.

Anchor
WellknownGroup
WellknownGroup
well-known group

See granted identity.