From 490d752bed3781a3556a9f23a615eff2946879b7 Mon Sep 17 00:00:00 2001 From: Abdon Pijpelink Date: Wed, 19 Jul 2023 13:11:04 +0200 Subject: [PATCH] [DOCS] Add descriptions for queries A-G --- output/schema/schema.json | 392 ++++++++++++------ specification/_doc_ids/table.csv | 16 +- specification/_types/Geo.ts | 13 + specification/_types/common.ts | 1 + .../_types/query_dsl/abstractions.ts | 99 ++++- specification/_types/query_dsl/compound.ts | 197 ++++++++- specification/_types/query_dsl/geo.ts | 46 +- specification/_types/query_dsl/specialized.ts | 16 + specification/_types/query_dsl/term.ts | 27 ++ 9 files changed, 682 insertions(+), 125 deletions(-) diff --git a/output/schema/schema.json b/output/schema/schema.json index 36a5e0dbc8..805266fce1 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -38980,7 +38980,7 @@ "name": "AggregateName", "namespace": "_types" }, - "specLocation": "_types/common.ts#L125-L129", + "specLocation": "_types/common.ts#L126-L130", "type": { "kind": "instance_of", "type": { @@ -39242,7 +39242,7 @@ "name": "Bytes", "namespace": "_types" }, - "specLocation": "_types/common.ts#L149-L167" + "specLocation": "_types/common.ts#L150-L168" }, { "kind": "type_alias", @@ -39282,7 +39282,7 @@ "name": "ClusterInfoTarget", "namespace": "_types" }, - "specLocation": "_types/common.ts#L343-L349" + "specLocation": "_types/common.ts#L344-L350" }, { "kind": "type_alias", @@ -39290,7 +39290,7 @@ "name": "ClusterInfoTargets", "namespace": "_types" }, - "specLocation": "_types/common.ts#L351-L351", + "specLocation": "_types/common.ts#L352-L352", "type": { "items": [ { @@ -39427,7 +39427,7 @@ "name": "Conflicts", "namespace": "_types" }, - "specLocation": "_types/common.ts#L169-L172" + "specLocation": "_types/common.ts#L170-L173" }, { "kind": "interface", @@ -39481,7 +39481,7 @@ } } ], - "specLocation": "_types/Geo.ts#L138-L143" + "specLocation": "_types/Geo.ts#L151-L156" }, { "kind": "enum", @@ -39948,7 +39948,7 @@ "namespace": "_types" }, "properties": [], - "specLocation": "_types/common.ts#L140-L141" + "specLocation": "_types/common.ts#L141-L142" }, { "generics": [ @@ -40141,7 +40141,7 @@ "name": "ExpandWildcard", "namespace": "_types" }, - "specLocation": "_types/common.ts#L181-L195" + "specLocation": "_types/common.ts#L182-L196" }, { "kind": "type_alias", @@ -40149,7 +40149,7 @@ "name": "ExpandWildcards", "namespace": "_types" }, - "specLocation": "_types/common.ts#L197-L197", + "specLocation": "_types/common.ts#L198-L198", "type": { "items": [ { @@ -40180,7 +40180,7 @@ "name": "Field", "namespace": "_types" }, - "specLocation": "_types/common.ts#L118-L119", + "specLocation": "_types/common.ts#L119-L120", "type": { "kind": "instance_of", "type": { @@ -40494,7 +40494,7 @@ "name": "Fields", "namespace": "_types" }, - "specLocation": "_types/common.ts#L120-L120", + "specLocation": "_types/common.ts#L121-L121", "type": { "items": [ { @@ -40582,12 +40582,14 @@ "specLocation": "_types/Stats.ts#L102-L107" }, { + "docId": "fuzziness", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/common-options.html#fuzziness", "kind": "type_alias", "name": { "name": "Fuzziness", "namespace": "_types" }, - "specLocation": "_types/common.ts#L114-L114", + "specLocation": "_types/common.ts#L114-L115", "type": { "items": [ { @@ -40621,7 +40623,7 @@ "name": "GeoBounds", "namespace": "_types" }, - "specLocation": "_types/Geo.ts#L119-L132", + "specLocation": "_types/Geo.ts#L132-L145", "type": { "items": [ { @@ -40785,7 +40787,7 @@ "name": "GeoHash", "namespace": "_types" }, - "specLocation": "_types/Geo.ts#L81-L81", + "specLocation": "_types/Geo.ts#L94-L94", "type": { "kind": "instance_of", "type": { @@ -40813,7 +40815,7 @@ } } ], - "specLocation": "_types/Geo.ts#L115-L117" + "specLocation": "_types/Geo.ts#L128-L130" }, { "codegenNames": [ @@ -40826,7 +40828,7 @@ "name": "GeoHashPrecision", "namespace": "_types" }, - "specLocation": "_types/Geo.ts#L76-L80", + "specLocation": "_types/Geo.ts#L89-L93", "type": { "items": [ { @@ -40854,7 +40856,7 @@ "name": "GeoHexCell", "namespace": "_types" }, - "specLocation": "_types/Geo.ts#L86-L87", + "specLocation": "_types/Geo.ts#L99-L100", "type": { "kind": "instance_of", "type": { @@ -40917,7 +40919,7 @@ "name": "GeoLocation", "namespace": "_types" }, - "specLocation": "_types/Geo.ts#L94-L108", + "specLocation": "_types/Geo.ts#L107-L121", "type": { "items": [ { @@ -40971,15 +40973,19 @@ "kind": "enum", "members": [ { + "description": "Return all documents whose `geo_shape` or `geo_point` field intersects the query geometry.", "name": "intersects" }, { + "description": "Return all documents whose `geo_shape` or `geo_point` field has nothing in common with the query geometry.", "name": "disjoint" }, { + "description": "Return all documents whose `geo_shape` or `geo_point` field is within the query geometry.\nLine geometries are not supported.", "name": "within" }, { + "description": "Return all documents whose `geo_shape` or `geo_point` field contains the query geometry.", "name": "contains" } ], @@ -40987,7 +40993,7 @@ "name": "GeoShapeRelation", "namespace": "_types" }, - "specLocation": "_types/Geo.ts#L67-L72" + "specLocation": "_types/Geo.ts#L67-L85" }, { "description": "A map tile reference, represented as `{zoom}/{x}/{y}`", @@ -40996,7 +41002,7 @@ "name": "GeoTile", "namespace": "_types" }, - "specLocation": "_types/Geo.ts#L83-L84", + "specLocation": "_types/Geo.ts#L96-L97", "type": { "kind": "instance_of", "type": { @@ -41011,7 +41017,7 @@ "name": "GeoTilePrecision", "namespace": "_types" }, - "specLocation": "_types/Geo.ts#L74-L74", + "specLocation": "_types/Geo.ts#L87-L87", "type": { "kind": "instance_of", "type": { @@ -41196,7 +41202,7 @@ "name": "HealthStatus", "namespace": "_types" }, - "specLocation": "_types/common.ts#L199-L219" + "specLocation": "_types/common.ts#L200-L220" }, { "kind": "type_alias", @@ -41219,7 +41225,7 @@ "name": "HttpHeaders", "namespace": "_types" }, - "specLocation": "_types/common.ts#L138-L138", + "specLocation": "_types/common.ts#L139-L139", "type": { "key": { "kind": "instance_of", @@ -41696,7 +41702,7 @@ } } ], - "specLocation": "_types/common.ts#L297-L324" + "specLocation": "_types/common.ts#L298-L325" }, { "inherits": { @@ -41835,7 +41841,7 @@ } } ], - "specLocation": "_types/common.ts#L286-L295" + "specLocation": "_types/common.ts#L287-L296" }, { "inherits": { @@ -42052,7 +42058,7 @@ } } ], - "specLocation": "_types/Geo.ts#L110-L113" + "specLocation": "_types/Geo.ts#L123-L126" }, { "kind": "enum", @@ -42071,7 +42077,7 @@ "name": "Level", "namespace": "_types" }, - "specLocation": "_types/common.ts#L229-L233" + "specLocation": "_types/common.ts#L230-L234" }, { "kind": "enum", @@ -42381,7 +42387,7 @@ "name": "MinimumShouldMatch", "namespace": "_types" }, - "specLocation": "_types/common.ts#L143-L147", + "specLocation": "_types/common.ts#L144-L148", "type": { "items": [ { @@ -42410,7 +42416,7 @@ "name": "MultiTermQueryRewrite", "namespace": "_types" }, - "specLocation": "_types/common.ts#L115-L116", + "specLocation": "_types/common.ts#L116-L117", "type": { "kind": "instance_of", "type": { @@ -43030,7 +43036,7 @@ "name": "OpType", "namespace": "_types" }, - "specLocation": "_types/common.ts#L235-L238" + "specLocation": "_types/common.ts#L236-L239" }, { "kind": "type_alias", @@ -43038,7 +43044,7 @@ "name": "Password", "namespace": "_types" }, - "specLocation": "_types/common.ts#L175-L175", + "specLocation": "_types/common.ts#L176-L176", "type": { "kind": "instance_of", "type": { @@ -43479,7 +43485,7 @@ "name": "Refresh", "namespace": "_types" }, - "specLocation": "_types/common.ts#L240-L247" + "specLocation": "_types/common.ts#L241-L248" }, { "kind": "interface", @@ -44438,7 +44444,7 @@ "name": "SearchType", "namespace": "_types" }, - "specLocation": "_types/common.ts#L249-L254" + "specLocation": "_types/common.ts#L250-L255" }, { "kind": "interface", @@ -44987,7 +44993,7 @@ "name": "Slices", "namespace": "_types" }, - "specLocation": "_types/common.ts#L326-L331", + "specLocation": "_types/common.ts#L327-L332", "type": { "items": [ { @@ -45020,7 +45026,7 @@ "name": "SlicesCalculation", "namespace": "_types" }, - "specLocation": "_types/common.ts#L333-L341" + "specLocation": "_types/common.ts#L334-L342" }, { "kind": "type_alias", @@ -45408,7 +45414,7 @@ "name": "SuggestMode", "namespace": "_types" }, - "specLocation": "_types/common.ts#L256-L260" + "specLocation": "_types/common.ts#L257-L261" }, { "description": "The suggestion name as returned from the server. Depending whether typed_keys is specified this could come back\nin the form of `name#type` instead of simply `name`", @@ -45417,7 +45423,7 @@ "name": "SuggestionName", "namespace": "_types" }, - "specLocation": "_types/common.ts#L131-L135", + "specLocation": "_types/common.ts#L132-L136", "type": { "kind": "instance_of", "type": { @@ -45562,7 +45568,7 @@ "name": "ThreadType", "namespace": "_types" }, - "specLocation": "_types/common.ts#L262-L268" + "specLocation": "_types/common.ts#L263-L269" }, { "description": "Time of day, expressed as HH:MM:SS", @@ -45663,7 +45669,7 @@ } } ], - "specLocation": "_types/Geo.ts#L145-L148" + "specLocation": "_types/Geo.ts#L158-L161" }, { "kind": "interface", @@ -45695,7 +45701,7 @@ } } ], - "specLocation": "_types/Geo.ts#L150-L153" + "specLocation": "_types/Geo.ts#L163-L166" }, { "kind": "interface", @@ -45918,7 +45924,7 @@ "name": "Username", "namespace": "_types" }, - "specLocation": "_types/common.ts#L174-L174", + "specLocation": "_types/common.ts#L175-L175", "type": { "kind": "instance_of", "type": { @@ -46008,7 +46014,7 @@ "name": "WaitForActiveShardOptions", "namespace": "_types" }, - "specLocation": "_types/common.ts#L270-L274" + "specLocation": "_types/common.ts#L271-L275" }, { "codegenNames": [ @@ -46020,7 +46026,7 @@ "name": "WaitForActiveShards", "namespace": "_types" }, - "specLocation": "_types/common.ts#L122-L123", + "specLocation": "_types/common.ts#L123-L124", "type": { "items": [ { @@ -46067,7 +46073,7 @@ "name": "WaitForEvents", "namespace": "_types" }, - "specLocation": "_types/common.ts#L276-L283" + "specLocation": "_types/common.ts#L277-L284" }, { "kind": "interface", @@ -46151,7 +46157,7 @@ } } ], - "specLocation": "_types/Geo.ts#L134-L136" + "specLocation": "_types/Geo.ts#L147-L149" }, { "kind": "interface", @@ -69432,6 +69438,7 @@ }, "properties": [ { + "description": "The clause (query) must appear in matching documents.\nHowever, unlike `must`, the score of the query will be ignored.", "name": "filter", "required": false, "type": { @@ -69458,6 +69465,9 @@ } }, { + "description": "Specifies the number or percentage of `should` clauses returned documents must match.", + "docId": "query-dsl-minimum-should-match", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-minimum-should-match.html", "name": "minimum_should_match", "required": false, "type": { @@ -69469,6 +69479,7 @@ } }, { + "description": "The clause (query) must appear in matching documents and will contribute to the score.", "name": "must", "required": false, "type": { @@ -69495,6 +69506,7 @@ } }, { + "description": "The clause (query) must not appear in the matching documents.\nBecause scoring is ignored, a score of `0` is returned for all documents.", "name": "must_not", "required": false, "type": { @@ -69521,6 +69533,7 @@ } }, { + "description": "The clause (query) should appear in the matching document.", "name": "should", "required": false, "type": { @@ -69547,7 +69560,7 @@ } } ], - "specLocation": "_types/query_dsl/compound.ts#L28-L34" + "specLocation": "_types/query_dsl/compound.ts#L28-L52" }, { "inherits": { @@ -69563,6 +69576,7 @@ }, "properties": [ { + "description": "Floating point number between 0 and 1.0 used to decrease the relevance scores of documents matching the `negative` query.", "name": "negative_boost", "required": true, "type": { @@ -69574,6 +69588,7 @@ } }, { + "description": "Query used to decrease the relevance score of matching documents.", "name": "negative", "required": true, "type": { @@ -69585,6 +69600,7 @@ } }, { + "description": "Any returned documents must match this query.", "name": "positive", "required": true, "type": { @@ -69596,7 +69612,7 @@ } } ], - "specLocation": "_types/query_dsl/compound.ts#L36-L40" + "specLocation": "_types/query_dsl/compound.ts#L54-L67" }, { "kind": "enum", @@ -69637,7 +69653,7 @@ "name": "CombinedFieldsOperator", "namespace": "_types.query_dsl" }, - "specLocation": "_types/query_dsl/abstractions.ts#L211-L214" + "specLocation": "_types/query_dsl/abstractions.ts#L298-L301" }, { "inherits": { @@ -69653,6 +69669,7 @@ }, "properties": [ { + "description": "List of fields to search. Field wildcard patterns are allowed. Only `text` fields are supported, and they must all have the same search `analyzer`.", "name": "fields", "required": true, "type": { @@ -69667,6 +69684,7 @@ } }, { + "description": "Text to search for in the provided `fields`.\nThe `combined_fields` query analyzes the provided text before performing a search.", "name": "query", "required": true, "type": { @@ -69678,6 +69696,7 @@ } }, { + "description": "If true, match phrase queries are automatically created for multi-term synonyms.", "name": "auto_generate_synonyms_phrase_query", "required": false, "serverDefault": true, @@ -69690,6 +69709,7 @@ } }, { + "description": "Boolean logic used to interpret text in the query value.", "name": "operator", "required": false, "serverDefault": "or", @@ -69702,6 +69722,9 @@ } }, { + "description": "Minimum number of clauses that must match for a document to be returned.", + "docId": "query-dsl-minimum-should-match", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-minimum-should-match.html", "name": "minimum_should_match", "required": false, "type": { @@ -69713,6 +69736,7 @@ } }, { + "description": "Indicates whether no documents are returned if the analyzer removes all tokens, such as when using a `stop` filter.", "name": "zero_terms_query", "required": false, "serverDefault": "none", @@ -69725,15 +69749,17 @@ } } ], - "specLocation": "_types/query_dsl/abstractions.ts#L190-L204" + "specLocation": "_types/query_dsl/abstractions.ts#L257-L291" }, { "kind": "enum", "members": [ { + "description": "No documents are returned if the analyzer removes all tokens.", "name": "none" }, { + "description": "Returns all documents, similar to a `match_all` query.", "name": "all" } ], @@ -69741,7 +69767,7 @@ "name": "CombinedFieldsZeroTerms", "namespace": "_types.query_dsl" }, - "specLocation": "_types/query_dsl/abstractions.ts#L216-L219" + "specLocation": "_types/query_dsl/abstractions.ts#L303-L312" }, { "inherits": { @@ -69840,6 +69866,7 @@ }, "properties": [ { + "description": "Filter query you wish to run. Any returned documents must match this query.\nFilter queries do not calculate relevance scores.\nTo speed up performance, Elasticsearch automatically caches frequently used filter queries.", "name": "filter", "required": true, "type": { @@ -69851,7 +69878,7 @@ } } ], - "specLocation": "_types/query_dsl/compound.ts#L42-L44" + "specLocation": "_types/query_dsl/compound.ts#L69-L76" }, { "attachedBehaviors": [ @@ -69909,7 +69936,7 @@ "namespace": "_types.query_dsl" }, "properties": [], - "specLocation": "_types/query_dsl/compound.ts#L92-L94" + "specLocation": "_types/query_dsl/compound.ts#L186-L188" }, { "inherits": { @@ -69940,7 +69967,7 @@ "namespace": "_types.query_dsl" }, "properties": [], - "specLocation": "_types/query_dsl/specialized.ts#L51-L54" + "specLocation": "_types/query_dsl/specialized.ts#L67-L70" }, { "inherits": { @@ -70068,7 +70095,7 @@ } } ], - "specLocation": "_types/query_dsl/term.ts#L73-L82" + "specLocation": "_types/query_dsl/term.ts#L100-L109" }, { "codegenNames": [ @@ -70081,7 +70108,7 @@ "name": "DecayFunction", "namespace": "_types.query_dsl" }, - "specLocation": "_types/query_dsl/compound.ts#L100-L105", + "specLocation": "_types/query_dsl/compound.ts#L194-L199", "type": { "items": [ { @@ -70117,8 +70144,10 @@ }, "properties": [ { + "description": "Determines how the distance is calculated when a field used for computing the decay contains multiple values.", "name": "multi_value_mode", "required": false, + "serverDefault": "min", "type": { "kind": "instance_of", "type": { @@ -70128,7 +70157,7 @@ } } ], - "specLocation": "_types/query_dsl/compound.ts#L84-L86" + "specLocation": "_types/query_dsl/compound.ts#L174-L180" }, { "generics": [ @@ -70148,8 +70177,10 @@ }, "properties": [ { + "description": "Defines how documents are scored at the distance given at scale.", "name": "decay", "required": false, + "serverDefault": 0.5, "type": { "kind": "instance_of", "type": { @@ -70159,8 +70190,10 @@ } }, { + "description": "If defined, the decay function will only compute the decay function for documents with a distance greater than the defined `offset`.", "name": "offset", "required": false, + "serverDefault": "0", "type": { "kind": "instance_of", "type": { @@ -70170,6 +70203,7 @@ } }, { + "description": "Defines the distance from origin + offset at which the computed score will equal `decay` parameter.", "name": "scale", "required": false, "type": { @@ -70181,6 +70215,7 @@ } }, { + "description": "The point of origin used for calculating distance. Must be given as a number for numeric field, date for date fields and geo point for geo fields.", "name": "origin", "required": false, "type": { @@ -70192,7 +70227,7 @@ } } ], - "specLocation": "_types/query_dsl/compound.ts#L77-L82" + "specLocation": "_types/query_dsl/compound.ts#L153-L172" }, { "inherits": { @@ -70208,6 +70243,7 @@ }, "properties": [ { + "description": "One or more query clauses.\nReturned documents must match one or more of these queries.\nIf a document matches multiple queries, Elasticsearch uses the highest relevance score.", "name": "queries", "required": true, "type": { @@ -70222,6 +70258,7 @@ } }, { + "description": "Floating point number between 0 and 1.0 used to increase the relevance scores of documents matching multiple query clauses.", "name": "tie_breaker", "required": false, "serverDefault": 0, @@ -70234,7 +70271,7 @@ } } ], - "specLocation": "_types/query_dsl/compound.ts#L46-L50" + "specLocation": "_types/query_dsl/compound.ts#L78-L90" }, { "codegenNames": [ @@ -70246,7 +70283,7 @@ "name": "DistanceFeatureQuery", "namespace": "_types.query_dsl" }, - "specLocation": "_types/query_dsl/specialized.ts#L56-L60", + "specLocation": "_types/query_dsl/specialized.ts#L72-L76", "type": { "items": [ { @@ -70291,6 +70328,7 @@ }, "properties": [ { + "description": "Date or point of origin used to calculate distances.\nIf the `field` value is a `date` or `date_nanos` field, the `origin` value must be a date.\nDate Math, such as `now-1h`, is supported.\nIf the field value is a `geo_point` field, the `origin` value must be a geopoint.", "name": "origin", "required": true, "type": { @@ -70302,6 +70340,7 @@ } }, { + "description": "Distance from the `origin` at which relevance scores receive half of the `boost` value.\nIf the `field` value is a `date` or `date_nanos` field, the `pivot` value must be a time unit, such as `1h` or `10d`. If the `field` value is a `geo_point` field, the `pivot` value must be a distance unit, such as `1km` or `12m`.", "name": "pivot", "required": true, "type": { @@ -70313,6 +70352,7 @@ } }, { + "description": "Name of the field used to calculate distances. This field must meet the following criteria:\nbe a `date`, `date_nanos` or `geo_point` field;\nhave an `index` mapping parameter value of `true`, which is the default;\nhave an `doc_values` mapping parameter value of `true`, which is the default.", "name": "field", "required": true, "type": { @@ -70324,7 +70364,7 @@ } } ], - "specLocation": "_types/query_dsl/specialized.ts#L40-L44" + "specLocation": "_types/query_dsl/specialized.ts#L40-L60" }, { "inherits": { @@ -70340,6 +70380,7 @@ }, "properties": [ { + "description": "Name of the field you wish to search.", "name": "field", "required": true, "type": { @@ -70351,7 +70392,7 @@ } } ], - "specLocation": "_types/query_dsl/term.ts#L36-L38" + "specLocation": "_types/query_dsl/term.ts#L36-L41" }, { "description": "A reference to a field with formatting instructions on how to return the value", @@ -70398,7 +70439,7 @@ } ], "shortcutProperty": "field", - "specLocation": "_types/query_dsl/abstractions.ts#L221-L235" + "specLocation": "_types/query_dsl/abstractions.ts#L314-L328" }, { "kind": "interface", @@ -70408,6 +70449,7 @@ }, "properties": [ { + "description": "`id` of the document.", "name": "id", "required": true, "type": { @@ -70419,6 +70461,7 @@ } }, { + "description": "Index from which to retrieve the document.", "name": "index", "required": false, "type": { @@ -70430,6 +70473,7 @@ } }, { + "description": "Name of the field.", "name": "path", "required": false, "type": { @@ -70441,6 +70485,7 @@ } }, { + "description": "Custom routing value.", "name": "routing", "required": false, "type": { @@ -70452,39 +70497,49 @@ } } ], - "specLocation": "_types/query_dsl/abstractions.ts#L173-L178" + "specLocation": "_types/query_dsl/abstractions.ts#L221-L238" }, { "kind": "enum", "members": [ { + "description": "Do not apply any multiplier to the field value.", "name": "none" }, { + "description": "Take the common logarithm of the field value.\nBecause this function will return a negative value and cause an error if used on values between 0 and 1, it is recommended to use `log1p` instead.", "name": "log" }, { + "description": "Add 1 to the field value and take the common logarithm.", "name": "log1p" }, { + "description": "Add 2 to the field value and take the common logarithm.", "name": "log2p" }, { + "description": "Take the natural logarithm of the field value.\nBecause this function will return a negative value and cause an error if used on values between 0 and 1, it is recommended to use `ln1p` instead.", "name": "ln" }, { + "description": "Add 1 to the field value and take the natural logarithm.", "name": "ln1p" }, { + "description": "Add 2 to the field value and take the natural logarithm.", "name": "ln2p" }, { + "description": "Square the field value (multiply it by itself).", "name": "square" }, { + "description": "Take the square root of the field value.", "name": "sqrt" }, { + "description": "Reciprocate the field value, same as `1/x` where `x` is the field’s value.", "name": "reciprocal" } ], @@ -70492,7 +70547,7 @@ "name": "FieldValueFactorModifier", "namespace": "_types.query_dsl" }, - "specLocation": "_types/query_dsl/compound.ts#L147-L158" + "specLocation": "_types/query_dsl/compound.ts#L298-L341" }, { "kind": "interface", @@ -70502,6 +70557,7 @@ }, "properties": [ { + "description": "Field to be extracted from the document.", "name": "field", "required": true, "type": { @@ -70513,8 +70569,10 @@ } }, { + "description": "Optional factor to multiply the field value with.", "name": "factor", "required": false, + "serverDefault": 1, "type": { "kind": "instance_of", "type": { @@ -70524,6 +70582,7 @@ } }, { + "description": "Value used if the document doesn’t have that field.\nThe modifier and factor are still applied to it as though it were read from the document.", "name": "missing", "required": false, "type": { @@ -70535,6 +70594,7 @@ } }, { + "description": "Modifier to apply to the field value.", "name": "modifier", "required": false, "type": { @@ -70546,27 +70606,33 @@ } } ], - "specLocation": "_types/query_dsl/compound.ts#L70-L75" + "specLocation": "_types/query_dsl/compound.ts#L132-L151" }, { "kind": "enum", "members": [ { + "description": "Query score and function score are multiplied", "name": "multiply" }, { + "description": "Only the function score is used.\nThe query score is ignored.", "name": "replace" }, { + "description": "Query score and function score are added", "name": "sum" }, { + "description": "Query score and function score are averaged", "name": "avg" }, { + "description": "Max of query score and function score", "name": "max" }, { + "description": "Min of query score and function score", "name": "min" } ], @@ -70574,7 +70640,7 @@ "name": "FunctionBoostMode", "namespace": "_types.query_dsl" }, - "specLocation": "_types/query_dsl/compound.ts#L138-L145" + "specLocation": "_types/query_dsl/compound.ts#L270-L296" }, { "esQuirk": "this container is valid without a variant. Despite being documented as a function, 'weight'\nis actually a container property that can be combined with a function. Comment in the ES code\n(SearchModule#registerScoreFunctions) says: Weight doesn't have its own parser, so every function\nsupports it out of the box. Can be a single function too when not associated to any other function,\nwhich is why it needs to be registered manually here.", @@ -70585,6 +70651,7 @@ }, "properties": [ { + "description": "Function that scores a document with a exponential decay, depending on the distance of a numeric field value of the document from an origin.", "name": "exp", "required": false, "type": { @@ -70596,6 +70663,7 @@ } }, { + "description": "Function that scores a document with a normal decay, depending on the distance of a numeric field value of the document from an origin.", "name": "gauss", "required": false, "type": { @@ -70607,6 +70675,7 @@ } }, { + "description": "Function that scores a document with a linear decay, depending on the distance of a numeric field value of the document from an origin.", "name": "linear", "required": false, "type": { @@ -70618,6 +70687,7 @@ } }, { + "description": "Function allows you to use a field from a document to influence the score.\nIt’s similar to using the script_score function, however, it avoids the overhead of scripting.", "name": "field_value_factor", "required": false, "type": { @@ -70629,6 +70699,7 @@ } }, { + "description": "Generates scores that are uniformly distributed from 0 up to but not including 1.\nIn case you want scores to be reproducible, it is possible to provide a `seed` and `field`.", "name": "random_score", "required": false, "type": { @@ -70640,6 +70711,7 @@ } }, { + "description": "Enables you to wrap another query and customize the scoring of it optionally with a computation derived from other numeric field values in the doc using a script expression.", "name": "script_score", "required": false, "type": { @@ -70675,7 +70747,7 @@ } } ], - "specLocation": "_types/query_dsl/compound.ts#L107-L127", + "specLocation": "_types/query_dsl/compound.ts#L201-L241", "variants": { "kind": "container" } @@ -70684,21 +70756,27 @@ "kind": "enum", "members": [ { + "description": "Scores are multiplied.", "name": "multiply" }, { + "description": "Scores are summed.", "name": "sum" }, { + "description": "Scores are averaged.", "name": "avg" }, { + "description": "The first function that has a matching filter is applied.", "name": "first" }, { + "description": "Maximum score is used.", "name": "max" }, { + "description": "Minimum score is used.", "name": "min" } ], @@ -70706,7 +70784,7 @@ "name": "FunctionScoreMode", "namespace": "_types.query_dsl" }, - "specLocation": "_types/query_dsl/compound.ts#L129-L136" + "specLocation": "_types/query_dsl/compound.ts#L243-L268" }, { "inherits": { @@ -70722,8 +70800,10 @@ }, "properties": [ { + "description": "Defines how he newly computed score is combined with the score of the query", "name": "boost_mode", "required": false, + "serverDefault": "multiply", "type": { "kind": "instance_of", "type": { @@ -70733,6 +70813,7 @@ } }, { + "description": "One or more functions that compute a new score for each document returned by the query.", "name": "functions", "required": false, "type": { @@ -70747,6 +70828,7 @@ } }, { + "description": "Restricts the new score to not exceed the provided limit.", "name": "max_boost", "required": false, "type": { @@ -70758,6 +70840,7 @@ } }, { + "description": "Excludes documents that do not meet the provided score threshold.", "name": "min_score", "required": false, "type": { @@ -70769,6 +70852,7 @@ } }, { + "description": "A query that determines the documents for which a new score is computed.", "name": "query", "required": false, "type": { @@ -70780,8 +70864,10 @@ } }, { + "description": "Specifies how the computed scores are combined", "name": "score_mode", "required": false, + "serverDefault": "multiply", "type": { "kind": "instance_of", "type": { @@ -70791,7 +70877,7 @@ } } ], - "specLocation": "_types/query_dsl/compound.ts#L52-L59" + "specLocation": "_types/query_dsl/compound.ts#L92-L118" }, { "inherits": { @@ -70807,8 +70893,10 @@ }, "properties": [ { + "description": "Maximum number of variations created.", "name": "max_expansions", "required": false, + "serverDefault": 50, "type": { "kind": "instance_of", "type": { @@ -70818,8 +70906,10 @@ } }, { + "description": "Number of beginning characters left unchanged when creating expansions.", "name": "prefix_length", "required": false, + "serverDefault": 0, "type": { "kind": "instance_of", "type": { @@ -70829,8 +70919,12 @@ } }, { + "description": "Number of beginning characters left unchanged when creating expansions.", + "docId": "query-dsl-multi-term-rewrite", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-multi-term-rewrite.html", "name": "rewrite", "required": false, + "serverDefault": "constant_score", "type": { "kind": "instance_of", "type": { @@ -70840,8 +70934,10 @@ } }, { + "description": "Indicates whether edits include transpositions of two adjacent characters (for example `ab` to `ba`).", "name": "transpositions", "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { @@ -70851,6 +70947,9 @@ } }, { + "description": "Maximum edit distance allowed for matching.", + "docId": "fuzziness", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/common-options.html#fuzziness", "name": "fuzziness", "required": false, "type": { @@ -70862,6 +70961,7 @@ } }, { + "description": "Term you wish to find in the provided field.", "name": "value", "required": true, "type": { @@ -70893,7 +70993,7 @@ } ], "shortcutProperty": "value", - "specLocation": "_types/query_dsl/term.ts#L40-L51" + "specLocation": "_types/query_dsl/term.ts#L43-L78" }, { "attachedBehaviors": [ @@ -70951,6 +71051,7 @@ } }, { + "description": "Set to `IGNORE_MALFORMED` to accept geo points with invalid latitude or longitude.\nSet to `COERCE` to also try to infer correct latitude or longitude.", "name": "validation_method", "required": false, "serverDefault": "'strict'", @@ -70963,8 +71064,10 @@ } }, { + "description": "Set to `true` to ignore an unmapped field and not match any documents for this query.\nSet to `false` to throw an exception if the field is not mapped.", "name": "ignore_unmapped", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -70974,7 +71077,7 @@ } } ], - "specLocation": "_types/query_dsl/geo.ts#L32-L41" + "specLocation": "_types/query_dsl/geo.ts#L32-L50" }, { "attachedBehaviors": [ @@ -71032,7 +71135,7 @@ "namespace": "_types.query_dsl" }, "properties": [], - "specLocation": "_types/query_dsl/compound.ts#L96-L98" + "specLocation": "_types/query_dsl/compound.ts#L190-L192" }, { "inherits": { @@ -71063,7 +71166,7 @@ "namespace": "_types.query_dsl" }, "properties": [], - "specLocation": "_types/query_dsl/specialized.ts#L46-L49" + "specLocation": "_types/query_dsl/specialized.ts#L62-L65" }, { "attachedBehaviors": [ @@ -71106,6 +71209,9 @@ }, "properties": [ { + "description": "The radius of the circle centred on the specified location.\nPoints which fall into this circle are considered to be matches.", + "docId": "distance-units", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/api-conventions.html#distance-units", "name": "distance", "required": true, "type": { @@ -71117,6 +71223,7 @@ } }, { + "description": "How to compute the distance.\nSet to `plane` for a faster calculation that's inaccurate on long distances and close to the poles.", "name": "distance_type", "required": false, "serverDefault": "'arc'", @@ -71129,6 +71236,7 @@ } }, { + "description": "Set to `IGNORE_MALFORMED` to accept geo points with invalid latitude or longitude.\nSet to `COERCE` to also try to infer correct latitude or longitude.", "name": "validation_method", "required": false, "serverDefault": "'strict'", @@ -71141,7 +71249,7 @@ } } ], - "specLocation": "_types/query_dsl/geo.ts#L48-L57" + "specLocation": "_types/query_dsl/geo.ts#L57-L79" }, { "kind": "enum", @@ -71157,7 +71265,7 @@ "name": "GeoExecution", "namespace": "_types.query_dsl" }, - "specLocation": "_types/query_dsl/geo.ts#L43-L46" + "specLocation": "_types/query_dsl/geo.ts#L52-L55" }, { "kind": "interface", @@ -71181,7 +71289,7 @@ } } ], - "specLocation": "_types/query_dsl/geo.ts#L59-L61" + "specLocation": "_types/query_dsl/geo.ts#L81-L83" }, { "attachedBehaviors": [ @@ -71251,7 +71359,7 @@ } } ], - "specLocation": "_types/query_dsl/geo.ts#L63-L71" + "specLocation": "_types/query_dsl/geo.ts#L85-L93" }, { "kind": "interface", @@ -71272,6 +71380,7 @@ } }, { + "description": "Query using an indexed shape retrieved from the the specified document and path.", "name": "indexed_shape", "required": false, "type": { @@ -71283,8 +71392,10 @@ } }, { + "description": "Spatial relation operator used to search a geo field.", "name": "relation", "required": false, + "serverDefault": "intersects", "type": { "kind": "instance_of", "type": { @@ -71294,7 +71405,7 @@ } } ], - "specLocation": "_types/query_dsl/geo.ts#L78-L82" + "specLocation": "_types/query_dsl/geo.ts#L100-L111" }, { "attachedBehaviors": [ @@ -71337,8 +71448,10 @@ }, "properties": [ { + "description": "Set to `true` to ignore an unmapped field and not match any documents for this query.\nSet to `false` to throw an exception if the field is not mapped.", "name": "ignore_unmapped", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -71348,15 +71461,17 @@ } } ], - "specLocation": "_types/query_dsl/geo.ts#L86-L91" + "specLocation": "_types/query_dsl/geo.ts#L115-L125" }, { "kind": "enum", "members": [ { + "description": "Accept geo points with invalid latitude or longitude and additionally try and infer correct coordinates.", "name": "coerce" }, { + "description": "Accept geo points with invalid latitude or longitude.", "name": "ignore_malformed" }, { @@ -71367,7 +71482,7 @@ "name": "GeoValidationMethod", "namespace": "_types.query_dsl" }, - "specLocation": "_types/query_dsl/geo.ts#L107-L111" + "specLocation": "_types/query_dsl/geo.ts#L141-L151" }, { "inherits": { @@ -71562,7 +71677,7 @@ } } ], - "specLocation": "_types/query_dsl/term.ts#L53-L55" + "specLocation": "_types/query_dsl/term.ts#L80-L82" }, { "kind": "interface", @@ -72189,7 +72304,7 @@ "name": "Like", "namespace": "_types.query_dsl" }, - "specLocation": "_types/query_dsl/specialized.ts#L103-L108", + "specLocation": "_types/query_dsl/specialized.ts#L119-L124", "type": { "items": [ { @@ -72317,7 +72432,7 @@ } } ], - "specLocation": "_types/query_dsl/specialized.ts#L91-L101" + "specLocation": "_types/query_dsl/specialized.ts#L107-L117" }, { "inherits": { @@ -73063,7 +73178,7 @@ } } ], - "specLocation": "_types/query_dsl/specialized.ts#L62-L89" + "specLocation": "_types/query_dsl/specialized.ts#L78-L105" }, { "inherits": { @@ -73283,15 +73398,19 @@ "kind": "enum", "members": [ { + "description": "Distance is the minimum distance.", "name": "min" }, { + "description": "Distance is the maximum distance.", "name": "max" }, { + "description": "Distance is the average distance.", "name": "avg" }, { + "description": "Distance is the sum of all distances.", "name": "sum" } ], @@ -73299,7 +73418,7 @@ "name": "MultiValueMode", "namespace": "_types.query_dsl" }, - "specLocation": "_types/query_dsl/compound.ts#L160-L165" + "specLocation": "_types/query_dsl/compound.ts#L343-L360" }, { "inherits": { @@ -73478,7 +73597,7 @@ } } ], - "specLocation": "_types/query_dsl/term.ts#L84-L91" + "specLocation": "_types/query_dsl/term.ts#L111-L118" }, { "attachedBehaviors": [ @@ -73536,7 +73655,7 @@ "namespace": "_types.query_dsl" }, "properties": [], - "specLocation": "_types/query_dsl/compound.ts#L88-L90" + "specLocation": "_types/query_dsl/compound.ts#L182-L184" }, { "kind": "enum", @@ -73718,7 +73837,7 @@ } } ], - "specLocation": "_types/query_dsl/specialized.ts#L110-L120" + "specLocation": "_types/query_dsl/specialized.ts#L126-L136" }, { "kind": "interface", @@ -73750,7 +73869,7 @@ } } ], - "specLocation": "_types/query_dsl/specialized.ts#L132-L135" + "specLocation": "_types/query_dsl/specialized.ts#L148-L151" }, { "inherits": { @@ -73806,7 +73925,7 @@ } } ], - "specLocation": "_types/query_dsl/specialized.ts#L122-L130", + "specLocation": "_types/query_dsl/specialized.ts#L138-L146", "variants": { "kind": "container" } @@ -73867,7 +73986,7 @@ } ], "shortcutProperty": "value", - "specLocation": "_types/query_dsl/term.ts#L57-L67" + "specLocation": "_types/query_dsl/term.ts#L84-L94" }, { "kind": "interface", @@ -73877,8 +73996,10 @@ }, "properties": [ { + "description": "Floating point number used to decrease or increase the relevance scores of the query.\nBoost values are relative to the default value of 1.0.\nA boost value between 0 and 1.0 decreases the relevance score.\nA value greater than 1.0 increases the relevance score.", "name": "boost", "required": false, + "serverDefault": 1, "type": { "kind": "instance_of", "type": { @@ -73900,7 +74021,7 @@ } } ], - "specLocation": "_types/query_dsl/abstractions.ts#L184-L188" + "specLocation": "_types/query_dsl/abstractions.ts#L244-L255" }, { "docId": "query-dsl", @@ -73912,6 +74033,9 @@ }, "properties": [ { + "description": "matches documents matching boolean combinations of other queries.", + "docId": "query-dsl-bool-query", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-bool-query.html", "name": "bool", "required": false, "type": { @@ -73923,6 +74047,9 @@ } }, { + "description": "Returns documents matching a `positive` query while reducing the relevance score of documents that also match a `negative` query.", + "docId": "query-dsl-boosting-query", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-boosting-query.html", "name": "boosting", "required": false, "type": { @@ -73966,6 +74093,9 @@ "since": "7.13.0" } }, + "description": "The `combined_fields` query supports searching multiple text fields as if their contents had been indexed into one combined field.", + "docId": "query-dsl-combined-fields-query", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-combined-fields-query.html", "name": "combined_fields", "required": false, "since": "7.13.0", @@ -73978,6 +74108,9 @@ } }, { + "description": "Wraps a filter query and returns every matching document with a relevance score equal to the `boost` parameter value.", + "docId": "query-dsl-constant-score-query", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-constant-score-query.html", "name": "constant_score", "required": false, "type": { @@ -73989,6 +74122,9 @@ } }, { + "description": "Returns documents matching one or more wrapped queries, called query clauses or clauses.\nIf a returned document matches multiple query clauses, the `dis_max` query assigns the document the highest relevance score from any matching clause, plus a tie breaking increment for any additional matching subqueries.", + "docId": "query-dsl-dis-max-query", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-dis-max-query.html", "name": "dis_max", "required": false, "type": { @@ -74000,6 +74136,9 @@ } }, { + "description": "Boosts the relevance score of documents closer to a provided origin date or point.\nFor example, you can use this query to give more weight to documents closer to a certain date or location.", + "docId": "query-dsl-distance-feature-query", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-distance-feature-query.html", "name": "distance_feature", "required": false, "type": { @@ -74011,6 +74150,9 @@ } }, { + "description": "Returns documents that contain an indexed value for a field.", + "docId": "query-dsl-exists-query", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-exists-query.html", "name": "exists", "required": false, "type": { @@ -74022,6 +74164,9 @@ } }, { + "description": "The `function_score` enables you to modify the score of documents that are retrieved by a query.", + "docId": "query-dsl-function-score-query", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-function-score-query.html", "name": "function_score", "required": false, "type": { @@ -74033,6 +74178,9 @@ } }, { + "description": "Returns documents that contain terms similar to the search term, as measured by a Levenshtein edit distance.", + "docId": "query-dsl-fuzzy-query", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-fuzzy-query.html", "name": "fuzzy", "required": false, "type": { @@ -74055,6 +74203,9 @@ } }, { + "description": "Matches geo_point and geo_shape values that intersect a bounding box.", + "docId": "query-dsl-geo-bounding-box-query", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-geo-bounding-box-query.html", "name": "geo_bounding_box", "required": false, "type": { @@ -74066,6 +74217,9 @@ } }, { + "description": "Matches `geo_point` and `geo_shape` values within a given distance of a geopoint.", + "docId": "query-dsl-geo-distance-query", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-geo-distance-query.html", "name": "geo_distance", "required": false, "type": { @@ -74088,6 +74242,9 @@ } }, { + "description": "Filter documents indexed using either the `geo_shape` or the `geo_point` type.", + "docId": "query-dsl-geo-shape-query", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-geo-shape-query.html", "name": "geo_shape", "required": false, "type": { @@ -74693,7 +74850,7 @@ } } ], - "specLocation": "_types/query_dsl/abstractions.ts#L97-L171", + "specLocation": "_types/query_dsl/abstractions.ts#L97-L219", "variants": { "kind": "container", "nonExhaustive": true @@ -75045,7 +75202,7 @@ } } ], - "specLocation": "_types/query_dsl/compound.ts#L65-L68" + "specLocation": "_types/query_dsl/compound.ts#L127-L130" }, { "codegenNames": [ @@ -75057,7 +75214,7 @@ "name": "RangeQuery", "namespace": "_types.query_dsl" }, - "specLocation": "_types/query_dsl/term.ts#L93-L95", + "specLocation": "_types/query_dsl/term.ts#L120-L122", "type": { "items": [ { @@ -75103,7 +75260,7 @@ } } ], - "specLocation": "_types/query_dsl/term.ts#L69-L71" + "specLocation": "_types/query_dsl/term.ts#L96-L98" }, { "kind": "enum", @@ -75122,7 +75279,7 @@ "name": "RangeRelation", "namespace": "_types.query_dsl" }, - "specLocation": "_types/query_dsl/term.ts#L97-L101" + "specLocation": "_types/query_dsl/term.ts#L124-L128" }, { "kind": "interface", @@ -75131,7 +75288,7 @@ "namespace": "_types.query_dsl" }, "properties": [], - "specLocation": "_types/query_dsl/specialized.ts#L137-L137" + "specLocation": "_types/query_dsl/specialized.ts#L153-L153" }, { "inherits": { @@ -75146,7 +75303,7 @@ "namespace": "_types.query_dsl" }, "properties": [], - "specLocation": "_types/query_dsl/specialized.ts#L139-L139" + "specLocation": "_types/query_dsl/specialized.ts#L155-L155" }, { "inherits": { @@ -75173,7 +75330,7 @@ } } ], - "specLocation": "_types/query_dsl/specialized.ts#L141-L143" + "specLocation": "_types/query_dsl/specialized.ts#L157-L159" }, { "inherits": { @@ -75200,7 +75357,7 @@ } } ], - "specLocation": "_types/query_dsl/specialized.ts#L145-L147" + "specLocation": "_types/query_dsl/specialized.ts#L161-L163" }, { "inherits": { @@ -75238,7 +75395,7 @@ } } ], - "specLocation": "_types/query_dsl/specialized.ts#L149-L152" + "specLocation": "_types/query_dsl/specialized.ts#L165-L168" }, { "inherits": { @@ -75309,7 +75466,7 @@ } } ], - "specLocation": "_types/query_dsl/specialized.ts#L154-L162" + "specLocation": "_types/query_dsl/specialized.ts#L170-L178" }, { "inherits": { @@ -75390,7 +75547,7 @@ } ], "shortcutProperty": "value", - "specLocation": "_types/query_dsl/term.ts#L103-L116" + "specLocation": "_types/query_dsl/term.ts#L130-L143" }, { "inherits": { @@ -75417,7 +75574,7 @@ } } ], - "specLocation": "_types/query_dsl/specialized.ts#L164-L166" + "specLocation": "_types/query_dsl/specialized.ts#L180-L182" }, { "kind": "interface", @@ -75427,6 +75584,7 @@ }, "properties": [ { + "description": "A script that computes a score.", "name": "script", "required": true, "type": { @@ -75438,7 +75596,7 @@ } } ], - "specLocation": "_types/query_dsl/compound.ts#L61-L63" + "specLocation": "_types/query_dsl/compound.ts#L120-L125" }, { "inherits": { @@ -75487,7 +75645,7 @@ } } ], - "specLocation": "_types/query_dsl/specialized.ts#L168-L172" + "specLocation": "_types/query_dsl/specialized.ts#L184-L188" }, { "kind": "interface", @@ -75530,7 +75688,7 @@ } } ], - "specLocation": "_types/query_dsl/specialized.ts#L183-L187" + "specLocation": "_types/query_dsl/specialized.ts#L199-L203" }, { "attachedBehaviors": [ @@ -75584,7 +75742,7 @@ } } ], - "specLocation": "_types/query_dsl/specialized.ts#L176-L181" + "specLocation": "_types/query_dsl/specialized.ts#L192-L197" }, { "kind": "enum", @@ -76403,7 +76561,7 @@ } ], "shortcutProperty": "value", - "specLocation": "_types/query_dsl/term.ts#L118-L126" + "specLocation": "_types/query_dsl/term.ts#L145-L153" }, { "kind": "interface", @@ -76457,7 +76615,7 @@ } } ], - "specLocation": "_types/query_dsl/term.ts#L137-L142" + "specLocation": "_types/query_dsl/term.ts#L164-L169" }, { "attachedBehaviors": [ @@ -76499,7 +76657,7 @@ "namespace": "_types.query_dsl" }, "properties": [], - "specLocation": "_types/query_dsl/term.ts#L128-L130" + "specLocation": "_types/query_dsl/term.ts#L155-L157" }, { "codegenNames": [ @@ -76511,7 +76669,7 @@ "name": "TermsQueryField", "namespace": "_types.query_dsl" }, - "specLocation": "_types/query_dsl/term.ts#L132-L135", + "specLocation": "_types/query_dsl/term.ts#L159-L162", "type": { "items": [ { @@ -76585,7 +76743,7 @@ } } ], - "specLocation": "_types/query_dsl/term.ts#L144-L148" + "specLocation": "_types/query_dsl/term.ts#L171-L175" }, { "inherits": { @@ -76693,7 +76851,7 @@ } } ], - "specLocation": "_types/query_dsl/term.ts#L150-L152" + "specLocation": "_types/query_dsl/term.ts#L177-L179" }, { "inherits": { @@ -76765,7 +76923,7 @@ } ], "shortcutProperty": "value", - "specLocation": "_types/query_dsl/term.ts#L154-L168" + "specLocation": "_types/query_dsl/term.ts#L181-L195" }, { "inherits": { @@ -76793,7 +76951,7 @@ } } ], - "specLocation": "_types/query_dsl/abstractions.ts#L206-L209" + "specLocation": "_types/query_dsl/abstractions.ts#L293-L296" }, { "kind": "enum", diff --git a/specification/_doc_ids/table.csv b/specification/_doc_ids/table.csv index 9394acc435..cafde04f44 100644 --- a/specification/_doc_ids/table.csv +++ b/specification/_doc_ids/table.csv @@ -402,4 +402,18 @@ index-modules-settings,https://www.elastic.co/guide/en/elasticsearch/reference/{ templating-role-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/field-and-document-access-control.html#templating-role-query mapping-settings-limit,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping-settings-limit.html index-modules-slowlog-slowlog,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/index-modules-slowlog.html#index-slow-log -multi-fields,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/multi-fields.html \ No newline at end of file +multi-fields,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/multi-fields.html +query-dsl-bool-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-bool-query.html +query-dsl-boosting-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-boosting-query.html +query-dsl-combined-fields-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-combined-fields-query.html +query-dsl-constant-score-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-constant-score-query.html +query-dsl-dis-max-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-dis-max-query.html +query-dsl-distance-feature-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-distance-feature-query.html +query-dsl-exists-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-exists-query.html +query-dsl-function-score-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-function-score-query.html +fuzziness,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/common-options.html#fuzziness +query-dsl-fuzzy-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-fuzzy-query.html +query-dsl-geo-bounding-box-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-geo-bounding-box-query.html +query-dsl-geo-distance-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-geo-distance-query.html +distance-units,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/api-conventions.html#distance-units +query-dsl-geo-shape-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-geo-shape-query.html \ No newline at end of file diff --git a/specification/_types/Geo.ts b/specification/_types/Geo.ts index 6bf523ef51..7bf7ba15fe 100644 --- a/specification/_types/Geo.ts +++ b/specification/_types/Geo.ts @@ -65,9 +65,22 @@ export class GeoLine { } export enum GeoShapeRelation { + /** + * Return all documents whose `geo_shape` or `geo_point` field intersects the query geometry. + */ intersects = 0, + /** + * Return all documents whose `geo_shape` or `geo_point` field has nothing in common with the query geometry. + */ disjoint = 1, + /** + * Return all documents whose `geo_shape` or `geo_point` field is within the query geometry. + * Line geometries are not supported. + */ within = 2, + /** + * Return all documents whose `geo_shape` or `geo_point` field contains the query geometry. + */ contains = 3 } diff --git a/specification/_types/common.ts b/specification/_types/common.ts index 2d9591b74d..3bccb37f4e 100644 --- a/specification/_types/common.ts +++ b/specification/_types/common.ts @@ -111,6 +111,7 @@ export type SequenceNumber = long export type PropertyName = string export type RelationName = string export type TaskId = string | integer +/** @doc_id fuzziness */ export type Fuzziness = string | integer /** @doc_id query-dsl-multi-term-rewrite */ export type MultiTermQueryRewrite = string diff --git a/specification/_types/query_dsl/abstractions.ts b/specification/_types/query_dsl/abstractions.ts index f6898a81ec..9d77fe6d25 100644 --- a/specification/_types/query_dsl/abstractions.ts +++ b/specification/_types/query_dsl/abstractions.ts @@ -100,24 +100,72 @@ import { TextExpansionQuery } from './TextExpansionQuery' * @doc_id query-dsl */ export class QueryContainer { + /** + * matches documents matching boolean combinations of other queries. + * @doc_id query-dsl-bool-query + */ bool?: BoolQuery + /** + * Returns documents matching a `positive` query while reducing the relevance score of documents that also match a `negative` query. + * @doc_id query-dsl-boosting-query + */ boosting?: BoostingQuery /** @deprecated 7.3.0 */ common?: SingleKeyDictionary /** + * The `combined_fields` query supports searching multiple text fields as if their contents had been indexed into one combined field. + * @doc_id query-dsl-combined-fields-query * @availability stack since=7.13.0 * @availability serverless */ combined_fields?: CombinedFieldsQuery + /** + * Wraps a filter query and returns every matching document with a relevance score equal to the `boost` parameter value. + * @doc_id query-dsl-constant-score-query + */ constant_score?: ConstantScoreQuery + /** + * Returns documents matching one or more wrapped queries, called query clauses or clauses. + * If a returned document matches multiple query clauses, the `dis_max` query assigns the document the highest relevance score from any matching clause, plus a tie breaking increment for any additional matching subqueries. + * @doc_id query-dsl-dis-max-query + */ dis_max?: DisMaxQuery + /** + * Boosts the relevance score of documents closer to a provided origin date or point. + * For example, you can use this query to give more weight to documents closer to a certain date or location. + * @doc_id query-dsl-distance-feature-query + */ distance_feature?: DistanceFeatureQuery + /** + * Returns documents that contain an indexed value for a field. + * @doc_id query-dsl-exists-query + */ exists?: ExistsQuery + /** + * The `function_score` enables you to modify the score of documents that are retrieved by a query. + * @doc_id query-dsl-function-score-query + */ function_score?: FunctionScoreQuery + /** + * Returns documents that contain terms similar to the search term, as measured by a Levenshtein edit distance. + * @doc_id query-dsl-fuzzy-query + */ fuzzy?: SingleKeyDictionary + /** + * Matches geo_point and geo_shape values that intersect a bounding box. + * @doc_id query-dsl-geo-bounding-box-query + */ geo_bounding_box?: GeoBoundingBoxQuery + /** + * Matches `geo_point` and `geo_shape` values within a given distance of a geopoint. + * @doc_id query-dsl-geo-distance-query + */ geo_distance?: GeoDistanceQuery geo_polygon?: GeoPolygonQuery + /** + * Filter documents indexed using either the `geo_shape` or the `geo_point` type. + * @doc_id query-dsl-geo-shape-query + */ geo_shape?: GeoShapeQuery has_child?: HasChildQuery has_parent?: HasParentQuery @@ -171,9 +219,21 @@ export class QueryContainer { } export class FieldLookup { + /** + * `id` of the document. + */ id: Id + /** + * Index from which to retrieve the document. + */ index?: IndexName + /** + * Name of the field. + */ path?: Field + /** + * Custom routing value. + */ routing?: Routing } @@ -182,24 +242,51 @@ export class FieldNameQuery { } export class QueryBase { + /** + * Floating point number used to decrease or increase the relevance scores of the query. + * Boost values are relative to the default value of 1.0. + * A boost value between 0 and 1.0 decreases the relevance score. + * A value greater than 1.0 increases the relevance score. + * @server_default 1.0 + */ boost?: float /** @codegen_name query_name */ _name?: string } export class CombinedFieldsQuery extends QueryBase { + /** + * List of fields to search. Field wildcard patterns are allowed. Only `text` fields are supported, and they must all have the same search `analyzer`. + */ fields: Field[] + /** + * Text to search for in the provided `fields`. + * The `combined_fields` query analyzes the provided text before performing a search. + */ query: string - /** @server_default true */ + /** + * If true, match phrase queries are automatically created for multi-term synonyms. + * @server_default true + */ auto_generate_synonyms_phrase_query?: boolean - /** @server_default or */ + /** + * Boolean logic used to interpret text in the query value. + * @server_default or + */ operator?: CombinedFieldsOperator + /** + * Minimum number of clauses that must match for a document to be returned. + * @doc_id query-dsl-minimum-should-match + */ minimum_should_match?: MinimumShouldMatch - /** @server_default none */ + /** + * Indicates whether no documents are returned if the analyzer removes all tokens, such as when using a `stop` filter. + * @server_default none + */ zero_terms_query?: CombinedFieldsZeroTerms } @@ -214,7 +301,13 @@ export enum CombinedFieldsOperator { } export enum CombinedFieldsZeroTerms { + /** + * No documents are returned if the analyzer removes all tokens. + */ none, + /** + * Returns all documents, similar to a `match_all` query. + */ all } diff --git a/specification/_types/query_dsl/compound.ts b/specification/_types/query_dsl/compound.ts index 7d0ed78c28..b3a7d20175 100644 --- a/specification/_types/query_dsl/compound.ts +++ b/specification/_types/query_dsl/compound.ts @@ -26,39 +26,101 @@ import { DateMath, Duration } from '@_types/Time' import { QueryBase, QueryContainer } from './abstractions' export class BoolQuery extends QueryBase { + /** + * The clause (query) must appear in matching documents. + * However, unlike `must`, the score of the query will be ignored. + */ filter?: QueryContainer | QueryContainer[] + /** + * Specifies the number or percentage of `should` clauses returned documents must match. + * @doc_id query-dsl-minimum-should-match + */ minimum_should_match?: MinimumShouldMatch + /** + * The clause (query) must appear in matching documents and will contribute to the score. + */ must?: QueryContainer | QueryContainer[] + /** + * The clause (query) must not appear in the matching documents. + * Because scoring is ignored, a score of `0` is returned for all documents. + */ must_not?: QueryContainer | QueryContainer[] + /** + * The clause (query) should appear in the matching document. + */ should?: QueryContainer | QueryContainer[] } export class BoostingQuery extends QueryBase { + /** + * Floating point number between 0 and 1.0 used to decrease the relevance scores of documents matching the `negative` query. + */ negative_boost: double + /** + * Query used to decrease the relevance score of matching documents. + */ negative: QueryContainer + /** + * Any returned documents must match this query. + */ positive: QueryContainer } export class ConstantScoreQuery extends QueryBase { + /** + * Filter query you wish to run. Any returned documents must match this query. + * Filter queries do not calculate relevance scores. + * To speed up performance, Elasticsearch automatically caches frequently used filter queries. + */ filter: QueryContainer } export class DisMaxQuery extends QueryBase { + /** + * One or more query clauses. + * Returned documents must match one or more of these queries. + * If a document matches multiple queries, Elasticsearch uses the highest relevance score. + */ queries: QueryContainer[] - /** @server_default 0.0 */ + /** + * Floating point number between 0 and 1.0 used to increase the relevance scores of documents matching multiple query clauses. + * @server_default 0.0 + */ tie_breaker?: double } export class FunctionScoreQuery extends QueryBase { + /** + * Defines how he newly computed score is combined with the score of the query + * @server_default multiply + */ boost_mode?: FunctionBoostMode + /** + * One or more functions that compute a new score for each document returned by the query. + */ functions?: FunctionScoreContainer[] + /** + * Restricts the new score to not exceed the provided limit. + */ max_boost?: double + /** + * Excludes documents that do not meet the provided score threshold. + */ min_score?: double + /** + * A query that determines the documents for which a new score is computed. + */ query?: QueryContainer + /** Specifies how the computed scores are combined + * @server_default multiply + */ score_mode?: FunctionScoreMode } export class ScriptScoreFunction { + /** + * A script that computes a score. + */ script: Script } @@ -68,20 +130,52 @@ export class RandomScoreFunction { } export class FieldValueFactorScoreFunction { + /** + * Field to be extracted from the document. + */ field: Field + /** + * Optional factor to multiply the field value with. + * @server_default 1 + */ factor?: double + /** + * Value used if the document doesn’t have that field. + * The modifier and factor are still applied to it as though it were read from the document. + */ missing?: double + /** + * Modifier to apply to the field value. + */ modifier?: FieldValueFactorModifier } export class DecayPlacement { + /** + * Defines how documents are scored at the distance given at scale. + * @server_default 0.5 + */ decay?: double + /** + * If defined, the decay function will only compute the decay function for documents with a distance greater than the defined `offset`. + * @server_default 0 + */ offset?: TScale + /** + * Defines the distance from origin + offset at which the computed score will equal `decay` parameter. + */ scale?: TScale + /** + * The point of origin used for calculating distance. Must be given as a number for numeric field, date for date fields and geo point for geo fields. + */ origin?: TOrigin } export class DecayFunctionBase { + /** + * Determines how the distance is calculated when a field used for computing the decay contains multiple values. + * @server_default min + */ multi_value_mode?: MultiValueMode } @@ -113,11 +207,31 @@ export type DecayFunction = * which is why it needs to be registered manually here. */ export class FunctionScoreContainer { + /** + * Function that scores a document with a exponential decay, depending on the distance of a numeric field value of the document from an origin. + */ exp?: DecayFunction + /** + * Function that scores a document with a normal decay, depending on the distance of a numeric field value of the document from an origin. + */ gauss?: DecayFunction + /** + * Function that scores a document with a linear decay, depending on the distance of a numeric field value of the document from an origin. + */ linear?: DecayFunction + /** + * Function allows you to use a field from a document to influence the score. + * It’s similar to using the script_score function, however, it avoids the overhead of scripting. + */ field_value_factor?: FieldValueFactorScoreFunction + /** + * Generates scores that are uniformly distributed from 0 up to but not including 1. + * In case you want scores to be reproducible, it is possible to provide a `seed` and `field`. + */ random_score?: RandomScoreFunction + /** + * Enables you to wrap another query and customize the scoring of it optionally with a computation derived from other numeric field values in the doc using a script expression. + */ script_score?: ScriptScoreFunction /** @variant container_property */ @@ -127,39 +241,120 @@ export class FunctionScoreContainer { } export enum FunctionScoreMode { + /** + * Scores are multiplied. + */ multiply = 0, + /** + * Scores are summed. + */ sum = 1, + /** + * Scores are averaged. + */ avg = 2, + /** + * The first function that has a matching filter is applied. + */ first = 3, + /** + * Maximum score is used. + */ max = 4, + /** + * Minimum score is used. + */ min = 5 } export enum FunctionBoostMode { + /** + * Query score and function score are multiplied + */ multiply = 0, + /** + * Only the function score is used. + * The query score is ignored. + */ replace = 1, + /** + * Query score and function score are added + */ sum = 2, + /** + * Query score and function score are averaged + */ avg = 3, + /** + * Max of query score and function score + */ max = 4, + /** + * Min of query score and function score + */ min = 5 } export enum FieldValueFactorModifier { + /** + * Do not apply any multiplier to the field value. + */ none = 0, + /** + * Take the common logarithm of the field value. + * Because this function will return a negative value and cause an error if used on values between 0 and 1, it is recommended to use `log1p` instead. + */ log = 1, + /** + * Add 1 to the field value and take the common logarithm. + */ log1p = 2, + /** + * Add 2 to the field value and take the common logarithm. + */ log2p = 3, + /** + * Take the natural logarithm of the field value. + * Because this function will return a negative value and cause an error if used on values between 0 and 1, it is recommended to use `ln1p` instead. + */ ln = 4, + /** + * Add 1 to the field value and take the natural logarithm. + */ ln1p = 5, + /** + * Add 2 to the field value and take the natural logarithm. + */ ln2p = 6, + /** + * Square the field value (multiply it by itself). + */ square = 7, + /** + * Take the square root of the field value. + */ sqrt = 8, + /** + * Reciprocate the field value, same as `1/x` where `x` is the field’s value. + */ reciprocal = 9 } export enum MultiValueMode { + /** + * Distance is the minimum distance. + */ min = 0, + /** + * Distance is the maximum distance. + */ max = 1, + /** + * Distance is the average distance. + */ avg = 2, + /** + * Distance is the sum of all distances. + */ sum = 3 } diff --git a/specification/_types/query_dsl/geo.ts b/specification/_types/query_dsl/geo.ts index fb46879329..32539f18d3 100644 --- a/specification/_types/query_dsl/geo.ts +++ b/specification/_types/query_dsl/geo.ts @@ -35,8 +35,17 @@ export class GeoBoundingBoxQuery { /** @deprecated 7.14.0 */ type?: GeoExecution - /** @server_default 'strict' */ + /** + * Set to `IGNORE_MALFORMED` to accept geo points with invalid latitude or longitude. + * Set to `COERCE` to also try to infer correct latitude or longitude. + * @server_default 'strict' + */ validation_method?: GeoValidationMethod + /** + * Set to `true` to ignore an unmapped field and not match any documents for this query. + * Set to `false` to throw an exception if the field is not mapped. + * @server_default false + */ ignore_unmapped?: boolean } @@ -49,10 +58,23 @@ export class GeoDistanceQuery extends QueryBase implements AdditionalProperty { + /** + * The radius of the circle centred on the specified location. + * Points which fall into this circle are considered to be matches. + * @doc_id distance-units + */ distance: Distance - /** @server_default 'arc' */ + /** + * How to compute the distance. + * Set to `plane` for a faster calculation that's inaccurate on long distances and close to the poles. + * @server_default 'arc' + */ distance_type?: GeoDistanceType - /** @server_default 'strict' */ + /** + * Set to `IGNORE_MALFORMED` to accept geo points with invalid latitude or longitude. + * Set to `COERCE` to also try to infer correct latitude or longitude. + * @server_default 'strict' + */ validation_method?: GeoValidationMethod } @@ -77,7 +99,14 @@ export enum GeoFormat { export class GeoShapeFieldQuery { shape?: GeoShape + /** + * Query using an indexed shape retrieved from the the specified document and path. + */ indexed_shape?: FieldLookup + /** + * Spatial relation operator used to search a geo field. + * @server_default intersects + */ relation?: GeoShapeRelation } @@ -87,6 +116,11 @@ export class GeoShapeQuery extends QueryBase implements AdditionalProperty { + /** + * Set to `true` to ignore an unmapped field and not match any documents for this query. + * Set to `false` to throw an exception if the field is not mapped. + * @server_default false + */ ignore_unmapped?: boolean } @@ -105,7 +139,13 @@ export enum TokenType { } export enum GeoValidationMethod { + /** + * Accept geo points with invalid latitude or longitude and additionally try and infer correct coordinates. + */ coerce = 0, + /** + * Accept geo points with invalid latitude or longitude. + */ ignore_malformed = 1, strict = 2 } diff --git a/specification/_types/query_dsl/specialized.ts b/specification/_types/query_dsl/specialized.ts index 63d2118b98..60dc0665ee 100644 --- a/specification/_types/query_dsl/specialized.ts +++ b/specification/_types/query_dsl/specialized.ts @@ -38,8 +38,24 @@ import { FieldLookup, QueryBase, QueryContainer } from './abstractions' import { AdditionalProperty } from '@spec_utils/behaviors' export class DistanceFeatureQueryBase extends QueryBase { + /** + * Date or point of origin used to calculate distances. + * If the `field` value is a `date` or `date_nanos` field, the `origin` value must be a date. + * Date Math, such as `now-1h`, is supported. + * If the field value is a `geo_point` field, the `origin` value must be a geopoint. + */ origin: TOrigin + /** + * Distance from the `origin` at which relevance scores receive half of the `boost` value. + * If the `field` value is a `date` or `date_nanos` field, the `pivot` value must be a time unit, such as `1h` or `10d`. If the `field` value is a `geo_point` field, the `pivot` value must be a distance unit, such as `1km` or `12m`. + */ pivot: TDistance + /** + * Name of the field used to calculate distances. This field must meet the following criteria: + * be a `date`, `date_nanos` or `geo_point` field; + * have an `index` mapping parameter value of `true`, which is the default; + * have an `doc_values` mapping parameter value of `true`, which is the default. + */ field: Field } diff --git a/specification/_types/query_dsl/term.ts b/specification/_types/query_dsl/term.ts index 7b4b890e83..c6ad9949bb 100644 --- a/specification/_types/query_dsl/term.ts +++ b/specification/_types/query_dsl/term.ts @@ -34,16 +34,43 @@ import { QueryBase } from './abstractions' import { AdditionalProperty } from '@spec_utils/behaviors' export class ExistsQuery extends QueryBase { + /** + * Name of the field you wish to search. + */ field: Field } /** @shortcut_property value */ export class FuzzyQuery extends QueryBase { + /** + * Maximum number of variations created. + * @server_default 50 + */ max_expansions?: integer + /** + * Number of beginning characters left unchanged when creating expansions. + * @server_default 0 + */ prefix_length?: integer + /** + * Number of beginning characters left unchanged when creating expansions. + * @doc_id query-dsl-multi-term-rewrite + * @server_default constant_score + */ rewrite?: MultiTermQueryRewrite + /** + * Indicates whether edits include transpositions of two adjacent characters (for example `ab` to `ba`). + * @server_default true + */ transpositions?: boolean + /** + * Maximum edit distance allowed for matching. + * @doc_id fuzziness + */ fuzziness?: Fuzziness + /** + * Term you wish to find in the provided field. + */ // ES is lenient and accepts any primitive type, but ultimately converts it to a string. // Changing this field definition from UserDefinedValue to string breaks a recording produced from Nest tests, // but Nest is probably also overly flexible here and exposes an option that should not exist.