WARNING: Version 5.x has passed its EOL date.

This documentation is no longer being maintained and may be removed. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.

« tasks.list update »

› ›

termvectors

edit

termvectors

edit

client.termvectors({
  index: string,
  type: string,
  id: string,
  term_statistics: boolean,
  field_statistics: boolean,
  fields: string | string[],
  offsets: boolean,
  positions: boolean,
  payloads: boolean,
  preference: string,
  routing: string,
  parent: string,
  realtime: boolean,
  version: number,
  version_type: 'internal' | 'external' | 'external_gte' | 'force',
  body: object
})

Reference

`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.
`term_statistics` or `termStatistics`	`boolean` - Specifies if total term frequency and document frequency should be returned.
`field_statistics` or `fieldStatistics`	`boolean` - Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned. Default: `true`
`fields`	`string \| string[]` - A comma-separated list of fields to return.
`offsets`	`boolean` - Specifies if term offsets should be returned. Default: `true`
`positions`	`boolean` - Specifies if term positions should be returned. Default: `true`
`payloads`	`boolean` - Specifies if term payloads should be returned. Default: `true`
`preference`	`string` - Specify the node or shard the operation should be performed on (default: random).
`routing`	`string` - Specific routing value.
`parent`	`string` - Parent id of documents.
`realtime`	`boolean` - Specifies if request is real-time as opposed to near-real-time (default: true).
`version`	`number` - Explicit version number for concurrency control
`version_type` or `versionType`	`'internal' \| 'external' \| 'external_gte' \| 'force'` - Specific version type
`body`	`object` - Define parameters and or supply a document to get termvectors for. See documentation.

« tasks.list update »