IMPORTANT: elasticsearch.js has been replaced by the new Elasticsearch JavaScript client. We strongly advise you to migrate to the new client. To learn more, see the migration guide.

« searchTemplate termvectors »

› ›

suggest

edit

IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

`suggest`

edit

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

The suggest feature suggests similar looking terms based on a provided text by using a specific suggester.

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

Return query terms suggestions (“auto-correction”).

const response = await client.suggest({
  index: 'myindex',
  body: {
    mysuggester: {
      text: 'tset',
      term: {
        field: 'title'
      }
    }
  }
});

// response will be formatted like so:
//
// {
//   ...
//   mysuggester: [
//     {
//       text: "tset",
//       ...
//       options: [
//         {
//           text: "test",
//           score: 0.75,
//           freq: 5
//         }
//       ]
//     }
//   ]
// }

Params

`ignoreUnavailable`	`Boolean` — Whether specified concrete indices should be ignored when unavailable (missing or closed)
`allowNoIndices`	`Boolean` — Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
`[expandWildcards=open]`	`String` — Whether to expand wildcard expression to concrete indices that are open, closed or both. Options `"open"` `"closed"` `"none"` `"all"`
`preference`	`String` — Specify the node or shard the operation should be performed on (default: random)
`routing`	`String` — Specific routing value
`index`	`String`, `String[]`, `Boolean` — A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices
`body`	`Object`, `JSON` — The request body, as either JSON or a JSON serializable object. See the elasticsearch docs for details about what can be specified here.

« searchTemplate termvectors »