From 4275b93246d4dbc2f6da88fe6f431813c77fc933 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Istv=C3=A1n=20Zolt=C3=A1n=20Szab=C3=B3?= Date: Thu, 3 Aug 2023 15:03:30 +0200 Subject: [PATCH] [DOCS] Fixes issues. --- output/schema/schema.json | 29 +++++++++++++++---- specification/_doc_ids/table.csv | 2 ++ specification/graph/_types/ExploreControls.ts | 13 ++++----- specification/graph/_types/Hop.ts | 6 ++-- specification/graph/_types/Vertex.ts | 2 +- 5 files changed, 36 insertions(+), 16 deletions(-) diff --git a/output/schema/schema.json b/output/schema/schema.json index 6642876d12..c30a8bb233 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -105979,6 +105979,7 @@ }, "properties": [ { + "description": "To avoid the top-matching documents sample being dominated by a single source of results, it is sometimes necessary to request diversity in the sample.\nYou can do this by selecting a single-value field and setting a maximum number of documents per value for that field.", "name": "sample_diversity", "required": false, "type": { @@ -105990,8 +105991,10 @@ } }, { + "description": "Each hop considers a sample of the best-matching documents on each shard.\nUsing samples improves the speed of execution and keeps exploration focused on meaningfully-connected terms.\nVery small values (less than 50) might not provide sufficient weight-of-evidence to identify significant connections between terms.\nVery large sample sizes can dilute the quality of the results and increase execution times.", "name": "sample_size", "required": false, + "serverDefault": 100, "type": { "kind": "instance_of", "type": { @@ -106001,6 +106004,7 @@ } }, { + "description": "The length of time in milliseconds after which exploration will be halted and the results gathered so far are returned.\nThis timeout is honored on a best-effort basis.\nExecution might overrun this timeout if, for example, a long pause is encountered while FieldData is loaded for a field.", "name": "timeout", "required": false, "type": { @@ -106012,6 +106016,9 @@ } }, { + "description": "Filters associated terms so only those that are significantly associated with your query are included.", + "docId": "search-aggregations-bucket-significantterms-aggregation", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-significantterms-aggregation.html", "name": "use_significance", "required": true, "type": { @@ -106023,7 +106030,7 @@ } } ], - "specLocation": "graph/_types/ExploreControls.ts#L24-L29" + "specLocation": "graph/_types/ExploreControls.ts#L24-L49" }, { "kind": "interface", @@ -106033,6 +106040,7 @@ }, "properties": [ { + "description": "Specifies one or more fields from which you want to extract terms that are associated with the specified vertices.", "name": "connections", "required": false, "type": { @@ -106044,6 +106052,7 @@ } }, { + "description": "An optional guiding query that constrains the Graph API as it explores connected terms.", "name": "query", "required": true, "type": { @@ -106055,6 +106064,7 @@ } }, { + "description": "Contains the fields you are interested in.", "name": "vertices", "required": true, "type": { @@ -106069,7 +106079,7 @@ } } ], - "specLocation": "graph/_types/Hop.ts#L23-L27" + "specLocation": "graph/_types/Hop.ts#L23-L36" }, { "kind": "interface", @@ -106101,7 +106111,7 @@ } } ], - "specLocation": "graph/_types/ExploreControls.ts#L31-L34" + "specLocation": "graph/_types/ExploreControls.ts#L51-L54" }, { "kind": "interface", @@ -106165,6 +106175,7 @@ }, "properties": [ { + "description": "Prevents the specified terms from being included in the results.", "name": "exclude", "required": false, "type": { @@ -106179,6 +106190,7 @@ } }, { + "description": "Identifies a field in the documents of interest.", "name": "field", "required": true, "type": { @@ -106190,6 +106202,7 @@ } }, { + "description": "Identifies the terms of interest that form the starting points from which you want to spider out.", "name": "include", "required": false, "type": { @@ -106204,8 +106217,10 @@ } }, { + "description": "Specifies how many documents must contain a pair of terms before it is considered to be a useful connection.\nThis setting acts as a certainty threshold.", "name": "min_doc_count", "required": false, + "serverDefault": 3, "type": { "kind": "instance_of", "type": { @@ -106215,8 +106230,10 @@ } }, { + "description": "Controls how many documents on a particular shard have to contain a pair of terms before the connection is returned for global consideration.", "name": "shard_min_doc_count", "required": false, + "serverDefault": 2, "type": { "kind": "instance_of", "type": { @@ -106226,8 +106243,10 @@ } }, { + "description": "Specifies the maximum number of vertex terms returned for each field.", "name": "size", "required": false, + "serverDefault": 5, "type": { "kind": "instance_of", "type": { @@ -106237,7 +106256,7 @@ } } ], - "specLocation": "graph/_types/Vertex.ts#L30-L37" + "specLocation": "graph/_types/Vertex.ts#L30-L59" }, { "kind": "interface", @@ -106269,7 +106288,7 @@ } } ], - "specLocation": "graph/_types/Vertex.ts#L39-L42" + "specLocation": "graph/_types/Vertex.ts#L61-L64" }, { "attachedBehaviors": [ diff --git a/specification/_doc_ids/table.csv b/specification/_doc_ids/table.csv index 06264f69fb..6824cff422 100644 --- a/specification/_doc_ids/table.csv +++ b/specification/_doc_ids/table.csv @@ -134,6 +134,7 @@ get-pipeline-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch grok-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/grok-processor.html put-pipeline-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/put-pipeline-api.html simulate-pipeline-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/simulate-pipeline-api.html + search-search,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-search.html delete-license,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-license.html get-license,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-license.html @@ -349,6 +350,7 @@ modules-node,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mo search-aggregations-bucket-count-ks-test-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-count-ks-test-aggregation.html search-aggregations-bucket-correlation-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-correlation-aggregation.html search-aggregations-bucket-categorize-text-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-categorize-text-aggregation.html +search-aggregations-bucket-significantterms-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-significantterms-aggregation.html search-aggregations-pipeline-bucket-path,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline.html#buckets-path-syntax ml-feature-importance,https://www.elastic.co/guide/en/machine-learning/{branch}/ml-feature-importance.html analysis-normalizers,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/analysis-normalizers.html diff --git a/specification/graph/_types/ExploreControls.ts b/specification/graph/_types/ExploreControls.ts index 8f1c6fee99..36c17777fd 100644 --- a/specification/graph/_types/ExploreControls.ts +++ b/specification/graph/_types/ExploreControls.ts @@ -23,27 +23,26 @@ import { Duration } from '@_types/Time' export class ExploreControls { /** - * To avoid the top-matching documents sample being dominated by a single source of results, it is sometimes necessary to request diversity in the sample. + * To avoid the top-matching documents sample being dominated by a single source of results, it is sometimes necessary to request diversity in the sample. * You can do this by selecting a single-value field and setting a maximum number of documents per value for that field. */ sample_diversity?: SampleDiversity /** - * Each hop considers a sample of the best-matching documents on each shard. - * Using samples improves the speed of execution and keeps exploration focused on meaningfully-connected terms. - * Very small values (less than 50) might not provide sufficient weight-of-evidence to identify significant connections between terms. + * Each hop considers a sample of the best-matching documents on each shard. + * Using samples improves the speed of execution and keeps exploration focused on meaningfully-connected terms. + * Very small values (less than 50) might not provide sufficient weight-of-evidence to identify significant connections between terms. * Very large sample sizes can dilute the quality of the results and increase execution times. * @server_default 100 */ sample_size?: integer /** - * The length of time in milliseconds after which exploration will be halted and the results gathered so far are returned. - * This timeout is honored on a best-effort basis. + * The length of time in milliseconds after which exploration will be halted and the results gathered so far are returned. + * This timeout is honored on a best-effort basis. * Execution might overrun this timeout if, for example, a long pause is encountered while FieldData is loaded for a field. */ timeout?: Duration /** * Filters associated terms so only those that are significantly associated with your query are included. - * @server_default True * @doc_id search-aggregations-bucket-significantterms-aggregation */ use_significance: boolean diff --git a/specification/graph/_types/Hop.ts b/specification/graph/_types/Hop.ts index e15ddf537a..c1a0f6071f 100644 --- a/specification/graph/_types/Hop.ts +++ b/specification/graph/_types/Hop.ts @@ -22,15 +22,15 @@ import { VertexDefinition } from './Vertex' export class Hop { /** - * Specifies or more fields from which you want to extract terms that are associated with the specified vertices. + * Specifies one or more fields from which you want to extract terms that are associated with the specified vertices. */ connections?: Hop /** - * A seed query that identifies the documents of interest. Can be any valid Elasticsearch query. + * An optional guiding query that constrains the Graph API as it explores connected terms. */ query: QueryContainer /** - * Specifies one or more fields that contain the terms you want to include in the graph as vertices. + * Contains the fields you are interested in. */ vertices: VertexDefinition[] } diff --git a/specification/graph/_types/Vertex.ts b/specification/graph/_types/Vertex.ts index ab15091653..05c925aa45 100644 --- a/specification/graph/_types/Vertex.ts +++ b/specification/graph/_types/Vertex.ts @@ -41,7 +41,7 @@ export class VertexDefinition { */ include?: VertexInclude[] /** - * Specifies how many documents must contain a pair of terms before it is considered to be a useful connection. + * Specifies how many documents must contain a pair of terms before it is considered to be a useful connection. * This setting acts as a certainty threshold. * @server_default 3 */