/

documentContent

The document​Content stage retrieves the fields of documents you provide, optionally highlighting occurrences of a list of search queries.

This document contains API reference only, please refer to document content retrieval chapter for examples and strategies of formatting document fields.

document​Content

Returns the fields of documents provided by the documents reference. 

{
  "type": "documentContent",
  "documents": {
    "type": "documents:reference",
    "auto": true
  },
  "fields": {
    "type": "contentFields:reference",
    "auto": true
  },
  "limit": "unlimited",
  "queries": {},
  "start": 0
}

documents

Type
documents
Default
{
  "type": "documents:reference",
  "auto": true
}
Required
no

A mandatory reference to any documents:* component or stage, providing documents for which fields should be retrieved.

fields

Type
contentFields
Default
{
  "type": "contentFields:reference",
  "auto": true
}
Required
no

This property controls which fields are returned for each document and how they are formatted.

The value of this property should contain or reference one of the content​Fields:​* components.

limit

Type
limit
Default
unlimited
Required
no

An optional document limit (can be used to implement paging through large document sets).

The value must be an integer >= 0 or the string unlimited.

queries

Type
object of query
Default
{}
Required
no

An optional map of named query:​* components, each of which should be highlighted in the returned document fields.

See the query highlighting section in the content retrieval tutorial for more information.

start

Type
integer
Default
0
Constraints
value >= 0
Required
no

An optional starting offset of the first document in documents (can be used to implement paging through large document sets).