Method: Elasticsearch::API::Synonyms::Actions#get_synonyms_sets

Defined in:
lib/elasticsearch/api/actions/synonyms/get_synonyms_sets.rb

#get_synonyms_sets(arguments = {}) ⇒ Object

Get all synonym sets. Get a summary of all defined synonym sets.

Parameters:

  • arguments (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (arguments):

  • :from (Integer) —

    The starting offset for synonyms sets to retrieve. Server default: 0.

  • :size (Integer) —

    The maximum number of synonyms sets to retrieve. Server default: 10.

  • :error_trace (Boolean) —

    When set to ‘true` Elasticsearch will include the full stack trace of errors when they occur.

  • :filter_path (String, Array<String>) —

    Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.

  • :human (Boolean) —

    When set to ‘true` will return statistics in a format suitable for humans. For example `“exists_time”: “1h”` for humans and `“exists_time_in_millis”: 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines.

  • :pretty (Boolean) —

    If set to ‘true` the returned JSON will be “pretty-formatted”. Only use this option for debugging only.

  • :headers (Hash) —

    Custom HTTP headers

See Also:



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/elasticsearch/api/actions/synonyms/get_synonyms_sets.rb', line 45

def get_synonyms_sets(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'synonyms.get_synonyms_sets' }

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = nil

  method = Elasticsearch::API::HTTP_GET
  path   = '_synonyms'
  params = Utils.process_params(arguments)

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
end