Share via

3.1.1.1 Crawled Items and Properties

  • Article

The protocol server maintains a list of crawled items. The protocol server also associates a list of properties with each crawled item. In addition to that, the protocol server computes some property values at query time. This is typically done for properties for which the values depend on the search query, such as the Rank or HitHighlightedSummary properties.

Properties are uniquely identified by their names. A property name is a unique, case-insensitive string. Every property has an associated type that defines the possible values it can take. For a list of possible types, see section 3.1.4.4.4.1. Properties come in different varieties. They can be retrievable property, full-text searchable property, or both.

The following table contains a set of default properties that every crawled item has:

Name

Type of the property value

Variety of the property

Description

CollapsingStatus

Int64

Retrievable, computed at query time

1 if duplicate result removal was performed as part of the request to the protocol server, and this search result had duplicates that were removed; 0 otherwise.

Contents

String

Full-text searchable, stored with the item

Contents of the item.

HitHighlightedProperties

String

Retrievable, computed at query time

String in the form: <HHTitle>sample_title</HHTitle><HHUrl>sample_url</HHUrl>

sample_title is replaced by the actual title of the crawled item if title specified in the query request. sample_url is replaced by the actual URL of the crawled item.

If a token in the URL or title is also present in the query text, this token can be enclosed by <c0> and </c0>.<21>

HitHighlightedSummary

String

Retrievable, computed at query time

A set of excerpts from the crawled item that are relevant to the search query. These excerpts are meant to be shown to the user to help the user decide whether the item is relevant to the user's search query or not.

Excerpts are separated by a <ddd/> tag. The total length of all excerpts equates to a small paragraph of text. The exact length will vary depending on how the protocol client shows the hit highlighted summary in its user interface.

If a token in the URL or title is also present in the query text, this token can be enclosed by <c0> and </c0>.<22>

Path

String

Retrievable, Full-text searchable, stored with the item

URL of the crawled item.

Rank

Int64

Retrievable, computed at query time

A value from 0 to 100000000, representing the rank of the crawled item among all search results, where the higher value means the higher relevance.<23>

Scope

String

Neither, stored with the item

The search scope in which the item exists. This property doesn't exist if Query.ResultProvider is "FASTSearch".<24>

Size

Int64

Retrievable, Full-text searchable, stored with the item

The approximate size of the crawled item in bytes.

Title

String

Retrievable, Full-text searchable, stored with the item

The title for the crawled item.

WorkId

Int64

Retrievable, Full-text searchable, stored with the item

The unique identifier for the crawled item among all the crawled items that the protocol server knows about. If Query.ResultProvider is "FASTSearch", the property MUST be empty.

The protocol also defines a set of properties that some, but not all crawled items in the search results have:

Name

Type of the property value

Variety of the property

Description

Author

String

Retrievable, Full-text searchable, stored with the item

The name of the author of the crawled item.

ContentClass

String

Retrievable, stored with the item

This property is present only when the crawled item is a securable object. It is  one of the following strings:

  • "STS_Site"

  • "STS_Web"

  • "STS_List"

  • "STS_ListItem"

  • "STS_Document"

  • "STS_ListItem_DocumentLibrary"

  • "STS_List_PictureLibrary"

Respectively, they mean that the item is a site, a subsite, a list, a list item, an item stored in a site, a list item stored in a document library, and a list that stores pictures as its items.

Description

String

Retrievable, stored with the item

A short description of the crawled item.

IsDocument

Int64

Retrievable, stored with the item

If the crawled item is logically a container of another item, such as a folder, or if the crawled item is a list item, this property is 0. Otherwise, it is 1.

PictureThumbnailURL

String

Retrievable, stored with the item

URL of an image file that the protocol client can use to represent the item in a list of search results. The image file is a common image file type that popular web browsers can display, such as JPEG, GIF or PNG.

SiteName

String

Retrievable, stored with the item

URL of the site (2) that contains the crawled item. If the crawled item is not contained in a site, this property is absent.

Write

DateTime

Retrievable, stored with the item

Time and date that the crawled item was last changed.

Url

String

Retrievable, Full-text searchable, stored with the item

URL of the crawled item. This property doesn't exist if Query.ResultProvider is "SharepointSearch".

ServerRedirectedUrl

String

Retrievable, stored with the item

URL of preview of crawled item. This property doesn't exist if Query.ResultProvider is "SharepointSearch".

FileExtension

String

Retrievable, Full-text searchable, stored with the item

File extension of the crawled item. This property doesn't exist if Query.ResultProvider is "SharepointSearch".

SpSiteUrl

String

Retrievable, Full-text searchable, stored with the item

Root URL of the site. This property doesn't exist if Query.ResultProvider is "SharepointSearch".

docvector

String

Retrievable, stored with the item

Document vector of the crawled item. This property doesn't exist if Query.ResultProvider is "SharepointSearch".

fcocount

String

Retrievable, computed at query time

Number of duplicates for crawled item in the search results. This property doesn't exist Query.ResultProvider is "SharepointSearch".

fcoid

String

Retrievable, computed at query time

Value of field used for duplicate result removal. This property doesn't exist if Query.ResultProvider is "SharepointSearch".

PictureWidth

String

Retrievable, Full-text searchable, stored with the item

Width of an image file that the protocol client can use to represent the item in a list of search results. This property doesn't exist if Query.ResultProvider is "SharepointSearch".

PictureHeight

String

Retrievable, Full-text searchable, stored with the item

Height of an image file that the protocol client can use to represent the item in a list of search results. This property doesn't exist if Query.ResultProvider is "SharepointSearch".