mtermvectorsedit

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

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

Params

ids

String, String[], Boolean — A comma-separated list of documents ids. You must define ids as parameter or set "ids" or "docs" in the request body

termStatistics

Boolean — Specifies if total term frequency and document frequency should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs".

[fieldStatistics=true]

Boolean — Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs".

fields

String, String[], Boolean — A comma-separated list of fields to return. Applies to all returned documents unless otherwise specified in body "params" or "docs".

[offsets=true]

Boolean — Specifies if term offsets should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs".

[positions=true]

Boolean — Specifies if term positions should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs".

[payloads=true]

Boolean — Specifies if term payloads should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs".

preference

String — Specify the node or shard the operation should be performed on (default: random) .Applies to all returned documents unless otherwise specified in body "params" or "docs".

routing

String — Specific routing value. Applies to all returned documents unless otherwise specified in body "params" or "docs".

parent

String — Parent id of documents. Applies to all returned documents unless otherwise specified in body "params" or "docs".

realtime

Boolean — Specifies if requests are 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.

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