Tools.Reader()

new Reader()

The Reader tool provides a way of reading documents in the corpus, text is fetched as needed.

Tutorials:
Example
let config = {
    "limit": null,
    "query": null,
    "skipTodocId": null,
    "start": null
  };

  loadCorpus("austen").tool("Reader", config);

Members

limit

Properties:
Name Type Default Description
limit Number 1000

The number of items to limit the result to.

query

Properties:
Name Type Description
query String | Array.<String>

A query or array of queries (queries can be separated by a comma). For query syntax, see the search documentation.

skipToDocId

Properties:
Name Type Description
skipToDocId String

The document ID to start reading from, defaults to the first document in the corpus.

start

Properties:
Name Type Default Description
start Number 0

The index of the item to start the results at.