termvectorsedit

client.termvectors([params, [callback]])

Check the API Conventions and the elasticsearch docs for more information pertaining to this method.

Params

termStatistics

Boolean — Specifies if total term frequency and document frequency should be returned.

[fieldStatistics=true]

Boolean — Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned.

fields

String, String[], Boolean — A comma-separated list of fields to return.

[offsets=true]

Boolean — Specifies if term offsets should be returned.

[positions=true]

Boolean — Specifies if term positions should be returned.

[payloads=true]

Boolean — Specifies if term payloads should be returned.

preference

String — Specify the node or shard the operation should be performed on (default: random).

routing

String — Specific routing value.

realtime

Boolean — Specifies if request is real-time as opposed to near-real-time (default: true).

version

Number — Explicit version number for concurrency control

versionType

String — Specific version type

Options
  • "internal"
  • "external"
  • "external_gte"
  • "force"

index

String — The index in which the document resides.

type

String — The type of the document.

id

String — The id of the document, when not specified a doc param should be supplied.

body

Object, JSON — An optional request body, as either JSON or a JSON serializable object. See the elasticsearch docs for details about what can be specified here.

back to top