Skip to main content
Legacy Docs: This page describes our legacy API. It will be deprecated in a future version. Please use the v2 API where possible.

Basic Usage

The record option specifies how much information is recorded with an indexed field. By default, all fields use position.
Records only the document IDs.
Records the document IDs as well as term frequency. This is useful for BM25 scoring.
Records the document ID, term frequency and positions of occurrences. Required to run a phrase query.