module Elasticsearch::API::Graph::Actions
Public Instance Methods
Source
# File lib/elasticsearch/api/actions/graph/explore.rb, line 42 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
Explore graph analytics. Extract and summarize information about the documents and terms in an Elasticsearch
data stream or index. The easiest way to understand the behavior of this API
is to use the Graph
UI to explore connections. An initial request to the _explore
API
contains a seed query that identifies the documents of interest and specifies the fields that define the vertices and connections you want to include in the graph. Subsequent requests enable you to spider out from one more vertices of interest. You can exclude vertices that have already been returned.
@option arguments [String, Array] :index Name of the index. (Required) @option arguments [String] :routing Custom value used to route operations to a specific shard. @option arguments [Time] :timeout Specifies the period of time to wait for a response from each shard.
If no response is received before the timeout expires, the request fails and returns an error. Defaults to no timeout.
@option arguments [Hash] :headers Custom HTTP headers @option arguments [Hash] :body request body
@see www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-graph