Files
elasticsearch-js/docs/reference/api/GraphExploreRequest.md
2025-05-28 10:02:30 -05:00

1.5 KiB

GraphExploreRequest [interface-GraphExploreRequest]

Name Type Description
body string ({ [key: string]: any; } & { index?: never; routing?: never; timeout?: never; connections?: never; controls?: never; query?: never; vertices?: never; })
connections GraphHop Specifies or more fields from which you want to extract terms that are associated with the specified vertices.
controls GraphExploreControls Direct the Graph API how to build the graph.
index Indices Name of the index.
query QueryDslQueryContainer A seed query that identifies the documents of interest. Can be any valid Elasticsearch query.
querystring { [key: string]: any; } & { index?: never; routing?: never; timeout?: never; connections?: never; controls?: never; query?: never; vertices?: never; } All values in querystring will be added to the request querystring.
routing Routing Custom value used to route operations to a specific shard.
timeout Duration 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 GraphVertexDefinition[] Specifies one or more fields that contain the terms you want to include in the graph as vertices.