Content entity attributes

The default entity for Sitecore Search is the content entity. The attributes in the content entity represent metadata that is relevant for a wide variety of types of content such as blog posts, articles, videos, news items, and so on.

Note

Currently, the content entity is the only entity available in Sitecore Search.

You can edit the default content entity attributes. However, we strongly recommend that you do not alter any attribute that starts with the prefix rfk_ because they are important internal attributes. An exception to this is rfk_stats, which has inner statistical attributes that you might want to enable for use as a sorting option.

The following table lists all of the attributes that are included in the content entity by default:

Note

If an attribute is marked as Required, it means that a value for that attribute must be included in all of your content items and you must specify how to extract it. If Search is unable to extract a value for the attribute from a content item, it is not indexed.

Display name

Attribute name

Data type

Default features

Description

Breadcrumbs

breadcrumbs

Array of strings

API response

Array of navigational breadcrumbs for the content item.

Content type

type

String

API response, facets, filter

Required.

Category of content the content item represents.

Examples: Article, Blog, Events.

Description

description

String

API response, textual relevance

Description of the content item.

Id

id

String

API response, filter

Required.

ID associated with the content item. Generated for each index document by Search.

Image url

image_url

String

API response

URL for image to use in search results.

Name/Title

name

String

API response, sorting options, textual relevance

Name or title of the content item.

Questions and Answering

rfk_questions

Array of composites

N/A

Question and answer pairs that match queries sent by visitors. Generated by Search using machine learning.

Review rating

review_rating

Float

API response, filter, search ranking

Average value of reviews on the content item.

Source

rfk_source

Composite

N/A

Data associated with a content item that is generated by Sitecore Search and used internally.

Stats

rfk_stats

Composite

N/A

Statistical data generated by Sitecore Search and used internally. Inner attributes represent information such as the number of clicks, views, or conversions generated by a content item.

Tags

tags

Array of strings

API response, facets, filter, textual relevance

Tags associated with the content item.

Url

url

String

API response

URL of the content item.

Tip

In most cases, you do not need to add a value for Id to your index documents. However, if your domain supports multiple locales, we recommend that you override the Sitecore-generated ID and specify how to extract IDs when setting up your source.

Do you have some feedback for us?

If you have suggestions for improving this article,