Graph Explore

class elasticsearch.client.GraphClient(client)
Parameters:

client (BaseClient)

explore(*, index, connections=None, controls=None, error_trace=None, filter_path=None, human=None, pretty=None, query=None, routing=None, timeout=None, vertices=None, body=None)

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

https://www.elastic.co/guide/en/elasticsearch/reference/8.16/graph-explore-api.html

Parameters:

  • index (str | Sequence[str]) – Name of the index.

  • connections (Mapping[str, Any] | None) – Specifies or more fields from which you want to extract terms that are associated with the specified vertices.

  • controls (Mapping[str, Any] | None) – Direct the Graph API how to build the graph.

  • query (Mapping[str, Any] | None) – A seed query that identifies the documents of interest. Can be any valid Elasticsearch query.

  • routing (str | None) – Custom value used to route operations to a specific shard.

  • timeout (str | Literal[-1] | ~typing.Literal[0] | None) – 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.

  • vertices (Sequence[Mapping[str, Any]] | None) – Specifies one or more fields that contain the terms you want to include in the graph as vertices.

  • error_trace (bool | None)

  • filter_path (str | Sequence[str] | None)

  • human (bool | None)

  • pretty (bool | None)

  • body (Dict[str, Any] | None)

Return type:

ObjectApiResponse[Any]