[[reference-graph-explore]]

////////
===========================================================================================================================
||                                                                                                                       ||
||                                                                                                                       ||
||                                                                                                                       ||
||        ██████╗ ███████╗ █████╗ ██████╗ ███╗   ███╗███████╗                                                            ||
||        ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝                                                            ||
||        ██████╔╝█████╗  ███████║██║  ██║██╔████╔██║█████╗                                                              ||
||        ██╔══██╗██╔══╝  ██╔══██║██║  ██║██║╚██╔╝██║██╔══╝                                                              ||
||        ██║  ██║███████╗██║  ██║██████╔╝██║ ╚═╝ ██║███████╗                                                            ||
||        ╚═╝  ╚═╝╚══════╝╚═╝  ╚═╝╚═════╝ ╚═╝     ╚═╝╚══════╝                                                            ||
||                                                                                                                       ||
||                                                                                                                       ||
||    This file is autogenerated, DO NOT send pull requests that changes this file directly.                             ||
||    You should update the script that does the generation, which can be found in:                                      ||
||    https://github.com/elastic/elastic-client-generator-js                                                             ||
||                                                                                                                       ||
||    You can run the script with the following command:                                                                 ||
||       npm run elasticsearch -- --version <version>                                                                    ||
||                                                                                                                       ||
||                                                                                                                       ||
||                                                                                                                       ||
===========================================================================================================================
////////

[discrete]
=== client.graph.explore

Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index.

{ref}/graph-explore-api.html[{es} documentation]

[discrete]
==== Function signature

[source,ts]
----
(GraphExploreRequest, options?): Promise<GraphExploreResponse>
----

[discrete]
===== `GraphExploreRequest`

[source,ts]
----
interface GraphExploreRequest extends <<shared-type-request-base, RequestBase>> {
  index: <<shared-type-indices, Indices>>
  routing?: <<shared-type-routing, Routing>>
  timeout?: <<shared-type-duration, Duration>>
  connections?: GraphHop
  controls?: GraphExploreControls
  query?: QueryDslQueryContainer
  vertices?: GraphVertexDefinition[]
}
----

[discrete]
===== `GraphExploreResponse`

[source,ts]
----
interface GraphExploreResponse {
  connections: GraphConnection[]
  failures: <<shared-type-shard-failure, ShardFailure>>[]
  timed_out: boolean
  took: <<shared-type-long, long>>
  vertices: GraphVertex[]
}
----

