Module: Elasticsearch::API::Graph::Actions

Included in:
GraphClient
Defined in:
lib/elasticsearch/api/namespace/graph.rb,
lib/elasticsearch/api/actions/graph/explore.rb

Instance Method Summary collapse

Instance Method Details

#explore(arguments = {}) ⇒ Object

Explore extracted and summarized information about the documents and terms in an index.

Parameters:

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

    a customizable set of options

Options Hash (arguments):

  • :index (List) —

    A comma-separated list of index names to search; use ‘_all` or empty string to perform the operation on all indices

  • :routing (String) —

    Specific routing value

  • :timeout (Time) —

    Explicit operation timeout

  • :headers (Hash) —

    Custom HTTP headers

  • :body (Hash) —

    Graph Query DSL

Raises:

  • (ArgumentError)

See Also:



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/elasticsearch/api/actions/graph/explore.rb', line 35

def explore(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'graph.explore' }

  defined_params = [:index].each_with_object({}) do |variable, set_variables|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
  end
  request_opts[:defined_params] = defined_params unless defined_params.empty?

  raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]

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

  body = arguments.delete(:body)

  _index = arguments.delete(:index)

  method = if body
             Elasticsearch::API::HTTP_POST
           else
             Elasticsearch::API::HTTP_GET
           end

  path = "#{Utils.__listify(_index)}/_graph/explore"
  params = Utils.process_params(arguments)

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