diff --git a/docs/reference/graph/explore.asciidoc b/docs/reference/graph/explore.asciidoc index 8d3c244f99e..9635eb84173 100644 --- a/docs/reference/graph/explore.asciidoc +++ b/docs/reference/graph/explore.asciidoc @@ -32,6 +32,9 @@ vertices that have already been returned. [float] === Request Body +[role="child_attributes"] +==== + query:: A seed query that identifies the documents of interest. Can be any valid Elasticsearch query. For example: @@ -71,7 +74,10 @@ graph as vertices. For example: } ] -------------------------------------------------- - ++ +.Properties for `vertices` +[%collapsible%open] +====== field::: Identifies a field in the documents of interest. include::: Identifies the terms of interest that form the starting points from which you want to spider out. You do not have to specify a seed query @@ -93,6 +99,7 @@ shard_min_doc_count::: This advanced setting controls how many documents on a particular shard have to contain a pair of terms before the connection is returned for global consideration. Defaults to 2. +====== connections:: Specifies or more fields from which you want to extract terms that are @@ -113,7 +120,10 @@ NOTE: Connections can be nested inside the `connections` object to explore additional relationships in the data. Each level of nesting is considered a _hop_, and proximity within the graph is often described in terms of _hop depth_. - ++ +.Properties for `connections` +[%collapsible%open] +====== query::: An optional _guiding query_ that constrains the Graph API as it explores connected terms. For example, you might want to direct the Graph @@ -133,9 +143,13 @@ Contains the fields you are interested in. For example: } ] -------------------------------------------------- +====== controls:: Direct the Graph API how to build the graph. - ++ +.Properties for `controls` +[%collapsible%open] +====== use_significance::: The `use_significance` flag filters associated terms so only those that are significantly associated with your query are included. For information about @@ -168,6 +182,8 @@ a maximum number of documents per value for that field. For example: "max_docs_per_value": 500 } -------------------------------------------------- +====== +==== // [float] // === Authorization @@ -279,7 +295,7 @@ not a global count for all documents in the index). The default settings are configured to remove noisy data and get the "big picture" from your data. This example shows how to specify -additional parameters to influence how the graph is built. +additional parameters to influence how the graph is built. For tips on tuning the settings for more detailed forensic evaluation where every document could be of interest, see the @@ -401,4 +417,4 @@ POST clicklogs/_graph/explore <1> The vertices you want to start from are specified as an array of terms in an `include` clause. <2> The `exclude` clause prevents terms you already know about from being -included in the results. \ No newline at end of file +included in the results.