From 096ecd310816b23432e4acea832393fc4a39a8ba Mon Sep 17 00:00:00 2001 From: Jan Kuipers <148754765+jan-elastic@users.noreply.github.com> Date: Thu, 25 Jan 2024 09:22:58 +0100 Subject: [PATCH] Specification of test_grok_pattern endpoint (#2394) * Specs for test_grok_pattern endpoint * Copy REST API spec from Elasticsearch * Autogenerate files * Fix API spec * Lint fixes * Add ecs_compatibility * Always return array * Add ecs_compatibility to requests * experimental -> stable --- output/schema/schema.json | 237 ++- output/schema/schema/schema.json | 1641 ++++++++++++----- output/schema/schema/validation-errors.json | 60 +- output/schema/validation-errors.json | 6 - output/typescript/types.ts | 24 + .../text_structure.test_grok_pattern.json | 32 + .../find_structure/FindStructureRequest.ts | 2 + .../TestGrokPatternRequest.ts | 43 + .../TestGrokPatternResponse.ts | 26 + .../text_structure/test_grok_pattern/types.ts | 32 + 10 files changed, 1655 insertions(+), 448 deletions(-) create mode 100644 specification/_json_spec/text_structure.test_grok_pattern.json create mode 100644 specification/text_structure/test_grok_pattern/TestGrokPatternRequest.ts create mode 100644 specification/text_structure/test_grok_pattern/TestGrokPatternResponse.ts create mode 100644 specification/text_structure/test_grok_pattern/types.ts diff --git a/output/schema/schema.json b/output/schema/schema.json index 7a4da04ca2..48725ba9da 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -18307,6 +18307,48 @@ ], "visibility": "public" }, + { + "availability": { + "serverless": { + "stability": "stable", + "visibility": "private" + }, + "stack": { + "since": "8.13.0", + "stability": "stable" + } + }, + "description": "Tests a Grok pattern on some text.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/test-grok-pattern-api.html", + "name": "text_structure.test_grok_pattern", + "request": { + "name": "Request", + "namespace": "text_structure.test_grok_pattern" + }, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], + "response": { + "name": "Response", + "namespace": "text_structure.test_grok_pattern" + }, + "responseMediaType": [ + "application/json" + ], + "since": "8.13.0", + "stability": "stable", + "urls": [ + { + "methods": [ + "GET", + "POST" + ], + "path": "/_text_structure/test_grok_pattern" + } + ], + "visibility": "public" + }, { "availability": { "serverless": { @@ -187134,6 +187176,18 @@ } } }, + { + "description": "The mode of compatibility with ECS compliant Grok patterns (disabled or v1, default: disabled).", + "name": "ecs_compatibility", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, { "description": "If this parameter is set to true, the response includes a field named explanation, which is an array of strings that indicate how the structure finder produced its result.", "name": "explain", @@ -187271,7 +187325,7 @@ } } ], - "specLocation": "text_structure/find_structure/FindStructureRequest.ts#L24-L73" + "specLocation": "text_structure/find_structure/FindStructureRequest.ts#L24-L75" }, { "body": { @@ -187579,6 +187633,187 @@ ], "specLocation": "text_structure/find_structure/types.ts#L35-L38" }, + { + "kind": "interface", + "name": { + "name": "MatchedField", + "namespace": "text_structure.test_grok_pattern" + }, + "properties": [ + { + "name": "match", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "offset", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "length", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + } + ], + "specLocation": "text_structure/test_grok_pattern/types.ts#L23-L27" + }, + { + "kind": "interface", + "name": { + "name": "MatchedText", + "namespace": "text_structure.test_grok_pattern" + }, + "properties": [ + { + "name": "matched", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "fields", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "MatchedField", + "namespace": "text_structure.test_grok_pattern" + } + } + } + } + } + ], + "specLocation": "text_structure/test_grok_pattern/types.ts#L29-L32" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "description": "Grok pattern to run on the text.", + "name": "grok_pattern", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "Lines of text to run the Grok pattern on.", + "name": "text", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + } + ] + }, + "description": "Tests a Grok pattern on some text.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "text_structure.test_grok_pattern" + }, + "path": [], + "query": [ + { + "description": "The mode of compatibility with ECS compliant Grok patterns (disabled or v1, default: disabled).", + "name": "ecs_compatibility", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "text_structure/test_grok_pattern/TestGrokPatternRequest.ts#L22-L43" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "matches", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "MatchedText", + "namespace": "text_structure.test_grok_pattern" + } + } + } + } + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "text_structure.test_grok_pattern" + }, + "specLocation": "text_structure/test_grok_pattern/TestGrokPatternResponse.ts#L22-L26" + }, { "kind": "interface", "name": { diff --git a/output/schema/schema/schema.json b/output/schema/schema/schema.json index a9b6117aff..0e8ec1412f 100644 --- a/output/schema/schema/schema.json +++ b/output/schema/schema/schema.json @@ -3673,7 +3673,7 @@ }, "description": "Returns async results from previously executed Event Query Language (EQL) search", "docId": "eql-async-search-api", - "docUrl": " https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-async-eql-search-api.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-async-eql-search-api.html", "name": "eql.get", "request": { "name": "Request", @@ -3712,7 +3712,7 @@ }, "description": "Returns the status of a previously submitted async or stored Event Query Language (EQL) search", "docId": "eql-async-search-status-api", - "docUrl": " https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-async-eql-status-api.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-async-eql-status-api.html", "name": "eql.get_status", "request": { "name": "Request", @@ -3780,6 +3780,44 @@ ], "visibility": "public" }, + { + "availability": { + "stack": { + "since": "8.11.0", + "stability": "experimental" + } + }, + "description": "Executes an ESQL request", + "docId": "esql-query", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/esql-rest.html", + "name": "esql.query", + "request": { + "name": "Request", + "namespace": "esql.query" + }, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], + "response": { + "name": "Response", + "namespace": "esql.query" + }, + "responseMediaType": [ + "application/json" + ], + "since": "8.11.0", + "stability": "experimental", + "urls": [ + { + "methods": [ + "POST" + ], + "path": "/_query" + } + ], + "visibility": "public" + }, { "availability": { "serverless": { @@ -4026,6 +4064,60 @@ ], "visibility": "public" }, + { + "availability": { + "stack": { + "stability": "experimental", + "visibility": "private" + } + }, + "description": "Deletes a secret stored by Fleet.", + "docUrl": null, + "name": "fleet.delete_secret", + "request": null, + "requestBodyRequired": false, + "response": null, + "responseMediaType": [ + "application/json" + ], + "stability": "experimental", + "urls": [ + { + "methods": [ + "DELETE" + ], + "path": "/_fleet/secret/{id}" + } + ], + "visibility": "private" + }, + { + "availability": { + "stack": { + "stability": "experimental", + "visibility": "private" + } + }, + "description": "Retrieves a secret stored by Fleet.", + "docUrl": null, + "name": "fleet.get_secret", + "request": null, + "requestBodyRequired": false, + "response": null, + "responseMediaType": [ + "application/json" + ], + "stability": "experimental", + "urls": [ + { + "methods": [ + "GET" + ], + "path": "/_fleet/secret/{id}" + } + ], + "visibility": "private" + }, { "availability": { "serverless": { @@ -4121,6 +4213,33 @@ ], "visibility": "public" }, + { + "availability": { + "stack": { + "stability": "experimental", + "visibility": "private" + } + }, + "description": "Creates a secret stored by Fleet.", + "docUrl": null, + "name": "fleet.post_secret", + "request": null, + "requestBodyRequired": true, + "response": null, + "responseMediaType": [ + "application/json" + ], + "stability": "experimental", + "urls": [ + { + "methods": [ + "POST" + ], + "path": "/_fleet/secret" + } + ], + "visibility": "private" + }, { "availability": { "serverless": { @@ -5423,7 +5542,7 @@ } }, "description": "Deletes an index template.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-delete-template.html", "name": "indices.delete_index_template", "privileges": { "cluster": [ @@ -5463,7 +5582,7 @@ } }, "description": "Deletes an index template.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-delete-template-v1.html", "name": "indices.delete_template", "privileges": { "cluster": [ @@ -5670,7 +5789,7 @@ } }, "description": "Returns information about whether a particular index template exists.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/index-templates.html", "name": "indices.exists_index_template", "request": { "name": "Request", @@ -5704,7 +5823,7 @@ } }, "description": "Returns information about whether a particular index template exists.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-template-exists-v1.html", "name": "indices.exists_template", "request": { "name": "Request", @@ -6141,7 +6260,7 @@ } }, "description": "Returns an index template.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-template.html", "name": "indices.get_index_template", "privileges": { "cluster": [ @@ -6294,7 +6413,7 @@ } }, "description": "Returns an index template.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-template-v1.html", "name": "indices.get_template", "request": { "name": "Request", @@ -6581,7 +6700,7 @@ } }, "description": "Creates or updates an index template.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-put-template.html", "name": "indices.put_index_template", "request": { "name": "Request", @@ -6717,7 +6836,7 @@ } }, "description": "Creates or updates an index template.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates-v1.html", "name": "indices.put_template", "request": { "name": "Request", @@ -7093,7 +7212,7 @@ } }, "description": "Simulate matching the given index name against the index templates in the system", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-simulate-index.html", "name": "indices.simulate_index_template", "request": { "name": "Request", @@ -7134,7 +7253,7 @@ } }, "description": "Simulate resolving the given template name or body", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-simulate-template.html", "name": "indices.simulate_template", "privileges": { "cluster": [ @@ -13380,7 +13499,7 @@ } }, "description": "Deletes a search application.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-search-application.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-search-application.html", "name": "search_application.delete", "request": { "name": "Request", @@ -13676,7 +13795,7 @@ { "availability": { "stack": { - "stability": "beta", + "stability": "experimental", "visibility": "public" } }, @@ -13692,7 +13811,7 @@ "responseMediaType": [ "application/json" ], - "stability": "beta", + "stability": "experimental", "urls": [ { "methods": [ @@ -14439,13 +14558,12 @@ { "availability": { "stack": { - "stability": "experimental", - "visibility": "feature_flag" + "stability": "beta", + "visibility": "public" } }, "description": "Creates a cross-cluster API key for API key based remote cluster access.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-cross-cluster-api-key.html", - "featureFlag": "es.untrusted_remote_cluster_feature_flag_registered", "name": "security.create_cross_cluster_api_key", "request": null, "requestBodyRequired": true, @@ -14456,7 +14574,7 @@ "responseMediaType": [ "application/json" ], - "stability": "experimental", + "stability": "beta", "urls": [ { "methods": [ @@ -14465,7 +14583,7 @@ "path": "/_security/cross_cluster/api_key" } ], - "visibility": "feature_flag" + "visibility": "public" }, { "availability": { @@ -15258,6 +15376,36 @@ ], "visibility": "public" }, + { + "availability": { + "stack": { + "stability": "stable", + "visibility": "public" + } + }, + "description": "Retrieve settings for the security system indices", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-settings.html", + "name": "security.get_settings", + "request": null, + "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], + "response": null, + "responseMediaType": [ + "application/json" + ], + "stability": "stable", + "urls": [ + { + "methods": [ + "GET" + ], + "path": "/_security/settings" + } + ], + "visibility": "public" + }, { "availability": { "serverless": { @@ -16294,13 +16442,12 @@ { "availability": { "stack": { - "stability": "experimental", - "visibility": "feature_flag" + "stability": "beta", + "visibility": "public" } }, "description": "Updates attributes of an existing cross-cluster API key.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-update-cross-cluster-api-key.html", - "featureFlag": "es.untrusted_remote_cluster_feature_flag_registered", "name": "security.update_cross_cluster_api_key", "request": null, "requestBodyRequired": true, @@ -16311,7 +16458,7 @@ "responseMediaType": [ "application/json" ], - "stability": "experimental", + "stability": "beta", "urls": [ { "methods": [ @@ -16320,7 +16467,37 @@ "path": "/_security/cross_cluster/api_key/{id}" } ], - "visibility": "feature_flag" + "visibility": "public" + }, + { + "availability": { + "stack": { + "stability": "stable", + "visibility": "public" + } + }, + "description": "Update settings for the security system index", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-update-settings.html", + "name": "security.update_settings", + "request": null, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], + "response": null, + "responseMediaType": [ + "application/json" + ], + "stability": "stable", + "urls": [ + { + "methods": [ + "PUT" + ], + "path": "/_security/settings" + } + ], + "visibility": "public" }, { "availability": { @@ -17594,12 +17771,12 @@ { "availability": { "serverless": { - "stability": "experimental", + "stability": "stable", "visibility": "public" }, "stack": { "since": "8.10.0", - "stability": "experimental" + "stability": "stable" } }, "description": "Deletes a synonym set", @@ -17618,7 +17795,7 @@ "application/json" ], "since": "8.10.0", - "stability": "experimental", + "stability": "stable", "urls": [ { "methods": [ @@ -17632,12 +17809,12 @@ { "availability": { "serverless": { - "stability": "experimental", + "stability": "stable", "visibility": "public" }, "stack": { "since": "8.10.0", - "stability": "experimental" + "stability": "stable" } }, "description": "Deletes a synonym rule in a synonym set", @@ -17659,7 +17836,7 @@ "application/json" ], "since": "8.10.0", - "stability": "experimental", + "stability": "stable", "urls": [ { "methods": [ @@ -17673,12 +17850,12 @@ { "availability": { "serverless": { - "stability": "experimental", + "stability": "stable", "visibility": "public" }, "stack": { "since": "8.10.0", - "stability": "experimental" + "stability": "stable" } }, "description": "Retrieves a synonym set", @@ -17697,7 +17874,7 @@ "application/json" ], "since": "8.10.0", - "stability": "experimental", + "stability": "stable", "urls": [ { "methods": [ @@ -17711,12 +17888,12 @@ { "availability": { "serverless": { - "stability": "experimental", + "stability": "stable", "visibility": "public" }, "stack": { "since": "8.10.0", - "stability": "experimental" + "stability": "stable" } }, "description": "Retrieves a synonym rule from a synonym set", @@ -17738,7 +17915,7 @@ "application/json" ], "since": "8.10.0", - "stability": "experimental", + "stability": "stable", "urls": [ { "methods": [ @@ -17752,12 +17929,12 @@ { "availability": { "serverless": { - "stability": "experimental", + "stability": "stable", "visibility": "public" }, "stack": { "since": "8.10.0", - "stability": "experimental" + "stability": "stable" } }, "description": "Retrieves a summary of all defined synonym sets", @@ -17776,7 +17953,7 @@ "application/json" ], "since": "8.10.0", - "stability": "experimental", + "stability": "stable", "urls": [ { "methods": [ @@ -17790,12 +17967,12 @@ { "availability": { "serverless": { - "stability": "experimental", + "stability": "stable", "visibility": "public" }, "stack": { "since": "8.10.0", - "stability": "experimental" + "stability": "stable" } }, "description": "Creates or updates a synonyms set", @@ -17817,7 +17994,7 @@ "application/json" ], "since": "8.10.0", - "stability": "experimental", + "stability": "stable", "urls": [ { "methods": [ @@ -17831,12 +18008,12 @@ { "availability": { "serverless": { - "stability": "experimental", + "stability": "stable", "visibility": "public" }, "stack": { "since": "8.10.0", - "stability": "experimental" + "stability": "stable" } }, "description": "Creates or updates a synonym rule in a synonym set", @@ -17858,7 +18035,7 @@ "application/json" ], "since": "8.10.0", - "stability": "experimental", + "stability": "stable", "urls": [ { "methods": [ @@ -40116,7 +40293,7 @@ "name": "AggregateName", "namespace": "_types" }, - "specLocation": "_types/common.ts#L144-L148", + "specLocation": "_types/common.ts#L145-L149", "type": { "kind": "instance_of", "type": { @@ -40325,7 +40502,7 @@ "name": "ByteSize", "namespace": "_types" }, - "specLocation": "_types/common.ts#L95-L96", + "specLocation": "_types/common.ts#L96-L97", "type": { "items": [ { @@ -40378,7 +40555,7 @@ "name": "Bytes", "namespace": "_types" }, - "specLocation": "_types/common.ts#L168-L186" + "specLocation": "_types/common.ts#L169-L181" }, { "kind": "type_alias", @@ -40386,7 +40563,7 @@ "name": "CategoryId", "namespace": "_types" }, - "specLocation": "_types/common.ts#L52-L52", + "specLocation": "_types/common.ts#L58-L58", "type": { "kind": "instance_of", "type": { @@ -40401,7 +40578,7 @@ "name": "ClusterAlias", "namespace": "_types" }, - "specLocation": "_types/common.ts#L72-L72", + "specLocation": "_types/common.ts#L78-L78", "type": { "kind": "instance_of", "type": { @@ -40521,7 +40698,7 @@ "name": "ClusterInfoTarget", "namespace": "_types" }, - "specLocation": "_types/common.ts#L383-L389" + "specLocation": "_types/common.ts#L378-L384" }, { "kind": "type_alias", @@ -40529,7 +40706,7 @@ "name": "ClusterInfoTargets", "namespace": "_types" }, - "specLocation": "_types/common.ts#L391-L391", + "specLocation": "_types/common.ts#L386-L386", "type": { "items": [ { @@ -40748,7 +40925,7 @@ "name": "Conflicts", "namespace": "_types" }, - "specLocation": "_types/common.ts#L188-L197" + "specLocation": "_types/common.ts#L183-L192" }, { "kind": "interface", @@ -40802,7 +40979,7 @@ } } ], - "specLocation": "_types/Geo.ts#L163-L168" + "specLocation": "_types/Geo.ts#L154-L159" }, { "kind": "enum", @@ -40881,7 +41058,7 @@ "name": "DataStreamName", "namespace": "_types" }, - "specLocation": "_types/common.ts#L90-L91", + "specLocation": "_types/common.ts#L91-L92", "type": { "kind": "instance_of", "type": { @@ -40896,7 +41073,7 @@ "name": "DataStreamNames", "namespace": "_types" }, - "specLocation": "_types/common.ts#L93-L93", + "specLocation": "_types/common.ts#L94-L94", "type": { "items": [ { @@ -41048,7 +41225,7 @@ "name": "DistanceUnit", "namespace": "_types" }, - "specLocation": "_types/Geo.ts#L30-L49" + "specLocation": "_types/Geo.ts#L30-L40" }, { "kind": "interface", @@ -41269,7 +41446,7 @@ "namespace": "_types" }, "properties": [], - "specLocation": "_types/common.ts#L159-L160" + "specLocation": "_types/common.ts#L160-L161" }, { "generics": [ @@ -41434,6 +41611,21 @@ ], "specLocation": "_types/Base.ts#L66-L75" }, + { + "kind": "type_alias", + "name": { + "name": "EsqlColumns", + "namespace": "_types" + }, + "specLocation": "_types/Binary.ts#L24-L24", + "type": { + "kind": "instance_of", + "type": { + "name": "binary", + "namespace": "_builtins" + } + } + }, { "kind": "enum", "members": [ @@ -41462,7 +41654,7 @@ "name": "ExpandWildcard", "namespace": "_types" }, - "specLocation": "_types/common.ts#L206-L220" + "specLocation": "_types/common.ts#L201-L215" }, { "kind": "type_alias", @@ -41470,7 +41662,7 @@ "name": "ExpandWildcards", "namespace": "_types" }, - "specLocation": "_types/common.ts#L222-L222", + "specLocation": "_types/common.ts#L217-L217", "type": { "items": [ { @@ -41501,7 +41693,7 @@ "name": "Field", "namespace": "_types" }, - "specLocation": "_types/common.ts#L137-L138", + "specLocation": "_types/common.ts#L138-L139", "type": { "kind": "instance_of", "type": { @@ -41815,7 +42007,7 @@ "name": "Fields", "namespace": "_types" }, - "specLocation": "_types/common.ts#L139-L139", + "specLocation": "_types/common.ts#L140-L140", "type": { "items": [ { @@ -41910,7 +42102,7 @@ "name": "Fuzziness", "namespace": "_types" }, - "specLocation": "_types/common.ts#L132-L133", + "specLocation": "_types/common.ts#L133-L134", "type": { "items": [ { @@ -41944,7 +42136,7 @@ "name": "GeoBounds", "namespace": "_types" }, - "specLocation": "_types/Geo.ts#L144-L157", + "specLocation": "_types/Geo.ts#L135-L148", "type": { "items": [ { @@ -42102,7 +42294,7 @@ "name": "GeoDistanceType", "namespace": "_types" }, - "specLocation": "_types/Geo.ts#L51-L60" + "specLocation": "_types/Geo.ts#L42-L51" }, { "kind": "type_alias", @@ -42110,7 +42302,7 @@ "name": "GeoHash", "namespace": "_types" }, - "specLocation": "_types/Geo.ts#L100-L100", + "specLocation": "_types/Geo.ts#L91-L91", "type": { "kind": "instance_of", "type": { @@ -42138,7 +42330,7 @@ } } ], - "specLocation": "_types/Geo.ts#L140-L142" + "specLocation": "_types/Geo.ts#L131-L133" }, { "codegenNames": [ @@ -42151,7 +42343,7 @@ "name": "GeoHashPrecision", "namespace": "_types" }, - "specLocation": "_types/Geo.ts#L95-L99", + "specLocation": "_types/Geo.ts#L86-L90", "type": { "items": [ { @@ -42179,7 +42371,7 @@ "name": "GeoHexCell", "namespace": "_types" }, - "specLocation": "_types/Geo.ts#L105-L106", + "specLocation": "_types/Geo.ts#L96-L97", "type": { "kind": "instance_of", "type": { @@ -42227,7 +42419,7 @@ } } ], - "specLocation": "_types/Geo.ts#L65-L71" + "specLocation": "_types/Geo.ts#L56-L62" }, { "codegenNames": [ @@ -42242,7 +42434,7 @@ "name": "GeoLocation", "namespace": "_types" }, - "specLocation": "_types/Geo.ts#L113-L127", + "specLocation": "_types/Geo.ts#L104-L118", "type": { "items": [ { @@ -42287,7 +42479,7 @@ "name": "GeoShape", "namespace": "_types" }, - "specLocation": "_types/Geo.ts#L62-L63", + "specLocation": "_types/Geo.ts#L53-L54", "type": { "kind": "user_defined_value" } @@ -42316,7 +42508,7 @@ "name": "GeoShapeRelation", "namespace": "_types" }, - "specLocation": "_types/Geo.ts#L73-L91" + "specLocation": "_types/Geo.ts#L64-L82" }, { "description": "A map tile reference, represented as `{zoom}/{x}/{y}`", @@ -42325,7 +42517,7 @@ "name": "GeoTile", "namespace": "_types" }, - "specLocation": "_types/Geo.ts#L102-L103", + "specLocation": "_types/Geo.ts#L93-L94", "type": { "kind": "instance_of", "type": { @@ -42340,7 +42532,7 @@ "name": "GeoTilePrecision", "namespace": "_types" }, - "specLocation": "_types/Geo.ts#L93-L93", + "specLocation": "_types/Geo.ts#L84-L84", "type": { "kind": "instance_of", "type": { @@ -42525,7 +42717,7 @@ "name": "HealthStatus", "namespace": "_types" }, - "specLocation": "_types/common.ts#L224-L244" + "specLocation": "_types/common.ts#L219-L239" }, { "kind": "type_alias", @@ -42548,7 +42740,7 @@ "name": "HttpHeaders", "namespace": "_types" }, - "specLocation": "_types/common.ts#L157-L157", + "specLocation": "_types/common.ts#L158-L158", "type": { "key": { "kind": "instance_of", @@ -42621,7 +42813,7 @@ "name": "Id", "namespace": "_types" }, - "specLocation": "_types/common.ts#L55-L55", + "specLocation": "_types/common.ts#L61-L61", "type": { "kind": "instance_of", "type": { @@ -42636,7 +42828,7 @@ "name": "Ids", "namespace": "_types" }, - "specLocation": "_types/common.ts#L56-L56", + "specLocation": "_types/common.ts#L62-L62", "type": { "items": [ { @@ -42666,7 +42858,7 @@ "name": "IndexAlias", "namespace": "_types" }, - "specLocation": "_types/common.ts#L62-L62", + "specLocation": "_types/common.ts#L68-L68", "type": { "kind": "instance_of", "type": { @@ -42681,7 +42873,7 @@ "name": "IndexName", "namespace": "_types" }, - "specLocation": "_types/common.ts#L60-L60", + "specLocation": "_types/common.ts#L66-L66", "type": { "kind": "instance_of", "type": { @@ -42696,7 +42888,7 @@ "name": "IndexPattern", "namespace": "_types" }, - "specLocation": "_types/common.ts#L63-L63", + "specLocation": "_types/common.ts#L69-L69", "type": { "kind": "instance_of", "type": { @@ -42711,7 +42903,7 @@ "name": "IndexPatterns", "namespace": "_types" }, - "specLocation": "_types/common.ts#L64-L64", + "specLocation": "_types/common.ts#L70-L70", "type": { "kind": "array_of", "value": { @@ -42942,7 +43134,7 @@ "name": "Indices", "namespace": "_types" }, - "specLocation": "_types/common.ts#L61-L61", + "specLocation": "_types/common.ts#L67-L67", "type": { "items": [ { @@ -43025,7 +43217,7 @@ } } ], - "specLocation": "_types/common.ts#L337-L364" + "specLocation": "_types/common.ts#L332-L359" }, { "inherits": { @@ -43164,7 +43356,7 @@ } } ], - "specLocation": "_types/common.ts#L326-L335" + "specLocation": "_types/common.ts#L321-L330" }, { "inherits": { @@ -43398,7 +43590,7 @@ } } ], - "specLocation": "_types/Geo.ts#L129-L138" + "specLocation": "_types/Geo.ts#L120-L129" }, { "kind": "enum", @@ -43417,7 +43609,7 @@ "name": "Level", "namespace": "_types" }, - "specLocation": "_types/common.ts#L254-L258" + "specLocation": "_types/common.ts#L249-L253" }, { "kind": "enum", @@ -43438,31 +43630,6 @@ }, "specLocation": "_types/Lifecycle.ts#L20-L24" }, - { - "kind": "type_alias", - "name": { - "name": "ManagedBy", - "namespace": "_types" - }, - "specLocation": "_types/common.ts#L74-L77", - "type": { - "items": [ - { - "kind": "literal_value", - "value": "Index Lifecycle Management" - }, - { - "kind": "literal_value", - "value": "Data stream lifecycle" - }, - { - "kind": "literal_value", - "value": "Unmanaged" - } - ], - "kind": "union_of" - } - }, { "kind": "type_alias", "name": { @@ -43697,7 +43864,7 @@ "name": "Metadata", "namespace": "_types" }, - "specLocation": "_types/common.ts#L98-L98", + "specLocation": "_types/common.ts#L99-L99", "type": { "key": { "kind": "instance_of", @@ -43719,7 +43886,7 @@ "name": "Metrics", "namespace": "_types" }, - "specLocation": "_types/common.ts#L70-L70", + "specLocation": "_types/common.ts#L76-L76", "type": { "items": [ { @@ -43752,7 +43919,7 @@ "name": "MinimumShouldMatch", "namespace": "_types" }, - "specLocation": "_types/common.ts#L162-L166", + "specLocation": "_types/common.ts#L163-L167", "type": { "items": [ { @@ -43781,7 +43948,7 @@ "name": "MultiTermQueryRewrite", "namespace": "_types" }, - "specLocation": "_types/common.ts#L134-L135", + "specLocation": "_types/common.ts#L135-L136", "type": { "kind": "instance_of", "type": { @@ -43796,7 +43963,7 @@ "name": "Name", "namespace": "_types" }, - "specLocation": "_types/common.ts#L79-L79", + "specLocation": "_types/common.ts#L80-L80", "type": { "kind": "instance_of", "type": { @@ -43811,7 +43978,7 @@ "name": "Names", "namespace": "_types" }, - "specLocation": "_types/common.ts#L80-L80", + "specLocation": "_types/common.ts#L81-L81", "type": { "items": [ { @@ -43841,7 +44008,7 @@ "name": "Namespace", "namespace": "_types" }, - "specLocation": "_types/common.ts#L82-L82", + "specLocation": "_types/common.ts#L83-L83", "type": { "kind": "instance_of", "type": { @@ -44020,7 +44187,7 @@ "name": "NodeId", "namespace": "_types" }, - "specLocation": "_types/common.ts#L57-L57", + "specLocation": "_types/common.ts#L63-L63", "type": { "kind": "instance_of", "type": { @@ -44035,7 +44202,7 @@ "name": "NodeIds", "namespace": "_types" }, - "specLocation": "_types/common.ts#L58-L58", + "specLocation": "_types/common.ts#L64-L64", "type": { "items": [ { @@ -44067,7 +44234,7 @@ "name": "NodeName", "namespace": "_types" }, - "specLocation": "_types/common.ts#L87-L88", + "specLocation": "_types/common.ts#L88-L89", "type": { "kind": "instance_of", "type": { @@ -44403,7 +44570,7 @@ "name": "OpType", "namespace": "_types" }, - "specLocation": "_types/common.ts#L260-L269" + "specLocation": "_types/common.ts#L255-L264" }, { "kind": "type_alias", @@ -44411,7 +44578,7 @@ "name": "Password", "namespace": "_types" }, - "specLocation": "_types/common.ts#L200-L200", + "specLocation": "_types/common.ts#L195-L195", "type": { "kind": "instance_of", "type": { @@ -44453,7 +44620,7 @@ "name": "PipelineName", "namespace": "_types" }, - "specLocation": "_types/common.ts#L85-L85", + "specLocation": "_types/common.ts#L86-L86", "type": { "kind": "instance_of", "type": { @@ -44580,7 +44747,7 @@ "name": "PropertyName", "namespace": "_types" }, - "specLocation": "_types/common.ts#L129-L129", + "specLocation": "_types/common.ts#L130-L130", "type": { "kind": "instance_of", "type": { @@ -44852,7 +45019,7 @@ "name": "Refresh", "namespace": "_types" }, - "specLocation": "_types/common.ts#L271-L278" + "specLocation": "_types/common.ts#L266-L273" }, { "kind": "interface", @@ -44954,7 +45121,7 @@ "name": "RelationName", "namespace": "_types" }, - "specLocation": "_types/common.ts#L130-L130", + "specLocation": "_types/common.ts#L131-L131", "type": { "kind": "instance_of", "type": { @@ -45093,7 +45260,7 @@ "name": "Result", "namespace": "_types" }, - "specLocation": "_types/Result.ts#L20-L27" + "specLocation": "_types/Result.ts#L20-L26" }, { "kind": "interface", @@ -45133,7 +45300,7 @@ "name": "Routing", "namespace": "_types" }, - "specLocation": "_types/common.ts#L66-L66", + "specLocation": "_types/common.ts#L72-L72", "type": { "kind": "instance_of", "type": { @@ -45182,6 +45349,62 @@ ], "specLocation": "_types/Rank.ts#L32-L37" }, + { + "codegenNames": [ + "long", + "double", + "string", + "boolean", + "null" + ], + "description": "A scalar value.", + "kind": "type_alias", + "name": { + "name": "ScalarValue", + "namespace": "_types" + }, + "specLocation": "_types/common.ts#L39-L43", + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } + }, { "kind": "interface", "name": { @@ -45474,7 +45697,7 @@ "name": "ScrollId", "namespace": "_types" }, - "specLocation": "_types/common.ts#L49-L49", + "specLocation": "_types/common.ts#L55-L55", "type": { "kind": "instance_of", "type": { @@ -45489,7 +45712,7 @@ "name": "ScrollIds", "namespace": "_types" }, - "specLocation": "_types/common.ts#L50-L50", + "specLocation": "_types/common.ts#L56-L56", "type": { "items": [ { @@ -45816,7 +46039,7 @@ "name": "SearchType", "namespace": "_types" }, - "specLocation": "_types/common.ts#L280-L285" + "specLocation": "_types/common.ts#L275-L280" }, { "kind": "interface", @@ -46131,7 +46354,7 @@ "name": "SequenceNumber", "namespace": "_types" }, - "specLocation": "_types/common.ts#L127-L127", + "specLocation": "_types/common.ts#L128-L128", "type": { "kind": "instance_of", "type": { @@ -46146,7 +46369,7 @@ "name": "Service", "namespace": "_types" }, - "specLocation": "_types/common.ts#L83-L83", + "specLocation": "_types/common.ts#L84-L84", "type": { "kind": "instance_of", "type": { @@ -46365,7 +46588,7 @@ "name": "Slices", "namespace": "_types" }, - "specLocation": "_types/common.ts#L366-L371", + "specLocation": "_types/common.ts#L361-L366", "type": { "items": [ { @@ -46398,7 +46621,7 @@ "name": "SlicesCalculation", "namespace": "_types" }, - "specLocation": "_types/common.ts#L373-L381" + "specLocation": "_types/common.ts#L368-L376" }, { "kind": "type_alias", @@ -46794,7 +47017,7 @@ "name": "SuggestMode", "namespace": "_types" }, - "specLocation": "_types/common.ts#L287-L300" + "specLocation": "_types/common.ts#L282-L295" }, { "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`", @@ -46803,7 +47026,7 @@ "name": "SuggestionName", "namespace": "_types" }, - "specLocation": "_types/common.ts#L150-L154", + "specLocation": "_types/common.ts#L151-L155", "type": { "kind": "instance_of", "type": { @@ -46872,7 +47095,7 @@ "name": "TaskId", "namespace": "_types" }, - "specLocation": "_types/common.ts#L131-L131", + "specLocation": "_types/common.ts#L132-L132", "type": { "items": [ { @@ -46948,7 +47171,7 @@ "name": "ThreadType", "namespace": "_types" }, - "specLocation": "_types/common.ts#L302-L308" + "specLocation": "_types/common.ts#L297-L303" }, { "description": "Time of day, expressed as HH:MM:SS", @@ -47002,7 +47225,7 @@ "name": "TimeUnit", "namespace": "_types" }, - "specLocation": "_types/Time.ts#L69-L84" + "specLocation": "_types/Time.ts#L69-L77" }, { "kind": "type_alias", @@ -47049,7 +47272,7 @@ } } ], - "specLocation": "_types/Geo.ts#L170-L173" + "specLocation": "_types/Geo.ts#L161-L164" }, { "kind": "interface", @@ -47081,7 +47304,7 @@ } } ], - "specLocation": "_types/Geo.ts#L175-L178" + "specLocation": "_types/Geo.ts#L166-L169" }, { "kind": "interface", @@ -47304,7 +47527,7 @@ "name": "Username", "namespace": "_types" }, - "specLocation": "_types/common.ts#L199-L199", + "specLocation": "_types/common.ts#L194-L194", "type": { "kind": "instance_of", "type": { @@ -47319,7 +47542,7 @@ "name": "Uuid", "namespace": "_types" }, - "specLocation": "_types/common.ts#L124-L124", + "specLocation": "_types/common.ts#L125-L125", "type": { "kind": "instance_of", "type": { @@ -47334,7 +47557,7 @@ "name": "VersionNumber", "namespace": "_types" }, - "specLocation": "_types/common.ts#L101-L101", + "specLocation": "_types/common.ts#L102-L102", "type": { "kind": "instance_of", "type": { @@ -47349,7 +47572,7 @@ "name": "VersionString", "namespace": "_types" }, - "specLocation": "_types/common.ts#L103-L103", + "specLocation": "_types/common.ts#L104-L104", "type": { "kind": "instance_of", "type": { @@ -47381,7 +47604,7 @@ "name": "VersionType", "namespace": "_types" }, - "specLocation": "_types/common.ts#L105-L121" + "specLocation": "_types/common.ts#L106-L122" }, { "kind": "enum", @@ -47397,7 +47620,7 @@ "name": "WaitForActiveShardOptions", "namespace": "_types" }, - "specLocation": "_types/common.ts#L310-L314" + "specLocation": "_types/common.ts#L305-L309" }, { "codegenNames": [ @@ -47409,7 +47632,7 @@ "name": "WaitForActiveShards", "namespace": "_types" }, - "specLocation": "_types/common.ts#L141-L142", + "specLocation": "_types/common.ts#L142-L143", "type": { "items": [ { @@ -47456,7 +47679,7 @@ "name": "WaitForEvents", "namespace": "_types" }, - "specLocation": "_types/common.ts#L316-L323" + "specLocation": "_types/common.ts#L311-L318" }, { "kind": "interface", @@ -47540,7 +47763,7 @@ } } ], - "specLocation": "_types/Geo.ts#L159-L161" + "specLocation": "_types/Geo.ts#L150-L152" }, { "kind": "interface", @@ -54477,7 +54700,7 @@ "name": "HoltWintersType", "namespace": "_types.aggregations" }, - "specLocation": "_types/aggregations/pipeline.ts#L283-L288" + "specLocation": "_types/aggregations/pipeline.ts#L283-L286" }, { "attachedBehaviors": [ @@ -56072,7 +56295,7 @@ } } ], - "specLocation": "_types/aggregations/pipeline.ts#L290-L305" + "specLocation": "_types/aggregations/pipeline.ts#L288-L303" }, { "inherits": { @@ -56124,7 +56347,7 @@ } } ], - "specLocation": "_types/aggregations/pipeline.ts#L307-L319" + "specLocation": "_types/aggregations/pipeline.ts#L305-L317" }, { "generics": [ @@ -56558,7 +56781,7 @@ } } ], - "specLocation": "_types/aggregations/pipeline.ts#L321-L326" + "specLocation": "_types/aggregations/pipeline.ts#L319-L324" }, { "kind": "enum", @@ -56593,7 +56816,7 @@ "name": "NormalizeMethod", "namespace": "_types.aggregations" }, - "specLocation": "_types/aggregations/pipeline.ts#L328-L354" + "specLocation": "_types/aggregations/pipeline.ts#L326-L352" }, { "attachedBehaviors": [ @@ -56905,7 +57128,7 @@ } } ], - "specLocation": "_types/aggregations/pipeline.ts#L356-L361" + "specLocation": "_types/aggregations/pipeline.ts#L354-L359" }, { "inherits": { @@ -57609,7 +57832,7 @@ } } ], - "specLocation": "_types/aggregations/pipeline.ts#L363-L369" + "specLocation": "_types/aggregations/pipeline.ts#L361-L367" }, { "inherits": { @@ -58822,7 +59045,7 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/pipeline.ts#L371-L371" + "specLocation": "_types/aggregations/pipeline.ts#L369-L369" }, { "description": "Result of the `rare_terms` aggregation when the field is a string.", @@ -59197,7 +59420,7 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/pipeline.ts#L373-L373" + "specLocation": "_types/aggregations/pipeline.ts#L371-L371" }, { "kind": "interface", @@ -64011,7 +64234,7 @@ }, { "name": "replacement", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -68296,7 +68519,7 @@ "name": "FieldType", "namespace": "_types.mapping" }, - "specLocation": "_types/mapping/Property.ts#L158-L202" + "specLocation": "_types/mapping/Property.ts#L160-L204" }, { "inherits": { @@ -69673,7 +69896,7 @@ "name": "Property", "namespace": "_types.mapping" }, - "specLocation": "_types/mapping/Property.ts#L93-L156", + "specLocation": "_types/mapping/Property.ts#L94-L158", "type": { "items": [ { @@ -69795,6 +70018,13 @@ "namespace": "_types.mapping" } }, + { + "kind": "instance_of", + "type": { + "name": "SparseVectorProperty", + "namespace": "_types.mapping" + } + }, { "kind": "instance_of", "type": { @@ -70107,7 +70337,7 @@ } } ], - "specLocation": "_types/mapping/Property.ts#L81-L91" + "specLocation": "_types/mapping/Property.ts#L82-L92" }, { "inherits": { @@ -70817,6 +71047,30 @@ }, "specLocation": "_types/mapping/meta-fields.ts#L67-L75" }, + { + "inherits": { + "type": { + "name": "PropertyBase", + "namespace": "_types.mapping" + } + }, + "kind": "interface", + "name": { + "name": "SparseVectorProperty", + "namespace": "_types.mapping" + }, + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "sparse_vector" + } + } + ], + "specLocation": "_types/mapping/core.ts#L193-L195" + }, { "kind": "interface", "name": { @@ -71792,7 +72046,7 @@ "name": "CombinedFieldsOperator", "namespace": "_types.query_dsl" }, - "specLocation": "_types/query_dsl/abstractions.ts#L473-L476" + "specLocation": "_types/query_dsl/abstractions.ts#L481-L484" }, { "inherits": { @@ -71888,7 +72142,7 @@ } } ], - "specLocation": "_types/query_dsl/abstractions.ts#L429-L463" + "specLocation": "_types/query_dsl/abstractions.ts#L437-L471" }, { "kind": "enum", @@ -71906,7 +72160,7 @@ "name": "CombinedFieldsZeroTerms", "namespace": "_types.query_dsl" }, - "specLocation": "_types/query_dsl/abstractions.ts#L478-L487" + "specLocation": "_types/query_dsl/abstractions.ts#L486-L495" }, { "inherits": { @@ -72584,7 +72838,7 @@ } ], "shortcutProperty": "field", - "specLocation": "_types/query_dsl/abstractions.ts#L489-L503" + "specLocation": "_types/query_dsl/abstractions.ts#L497-L511" }, { "kind": "interface", @@ -72642,7 +72896,7 @@ } } ], - "specLocation": "_types/query_dsl/abstractions.ts#L393-L410" + "specLocation": "_types/query_dsl/abstractions.ts#L401-L418" }, { "kind": "enum", @@ -73392,9 +73646,22 @@ "namespace": "_types.query_dsl" } } + }, + { + "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": { + "name": "boolean", + "namespace": "_builtins" + } + } } ], - "specLocation": "_types/query_dsl/geo.ts#L57-L79" + "specLocation": "_types/query_dsl/geo.ts#L57-L85" }, { "kind": "enum", @@ -73434,7 +73701,7 @@ } } ], - "specLocation": "_types/query_dsl/geo.ts#L81-L83" + "specLocation": "_types/query_dsl/geo.ts#L87-L89" }, { "attachedBehaviors": [ @@ -73504,7 +73771,7 @@ } } ], - "specLocation": "_types/query_dsl/geo.ts#L85-L93" + "specLocation": "_types/query_dsl/geo.ts#L91-L99" }, { "kind": "interface", @@ -73550,7 +73817,7 @@ } } ], - "specLocation": "_types/query_dsl/geo.ts#L100-L111" + "specLocation": "_types/query_dsl/geo.ts#L106-L117" }, { "attachedBehaviors": [ @@ -73606,7 +73873,7 @@ } } ], - "specLocation": "_types/query_dsl/geo.ts#L115-L125" + "specLocation": "_types/query_dsl/geo.ts#L121-L131" }, { "kind": "enum", @@ -73627,7 +73894,7 @@ "name": "GeoValidationMethod", "namespace": "_types.query_dsl" }, - "specLocation": "_types/query_dsl/geo.ts#L141-L151" + "specLocation": "_types/query_dsl/geo.ts#L147-L157" }, { "inherits": { @@ -76380,7 +76647,7 @@ } } ], - "specLocation": "_types/query_dsl/abstractions.ts#L416-L427" + "specLocation": "_types/query_dsl/abstractions.ts#L424-L435" }, { "docId": "query-dsl", @@ -77296,6 +77563,37 @@ } } }, + { + "availability": { + "serverless": {}, + "stack": { + "since": "8.13.0" + } + }, + "description": "Supports returning text_expansion query results by sending in precomputed tokens with the query.", + "docId": "query-dsl-weighted-tokens-query", + "name": "weighted_tokens", + "required": false, + "since": "8.13.0", + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": true, + "value": { + "kind": "instance_of", + "type": { + "name": "WeightedTokensQuery", + "namespace": "_types.query_dsl" + } + } + } + }, { "description": "Returns documents that contain terms matching a wildcard pattern.", "docId": "query-dsl-wildcard-query", @@ -77351,7 +77649,7 @@ } } ], - "specLocation": "_types/query_dsl/abstractions.ts#L98-L391", + "specLocation": "_types/query_dsl/abstractions.ts#L99-L399", "variants": { "kind": "container", "nonExhaustive": true @@ -79453,9 +79751,32 @@ "namespace": "_builtins" } } + }, + { + "availability": { + "serverless": { + "stability": "experimental" + }, + "stack": { + "since": "8.13.0", + "stability": "experimental" + } + }, + "description": "Token pruning configurations", + "name": "pruning_config", + "required": false, + "since": "8.13.0", + "stability": "experimental", + "type": { + "kind": "instance_of", + "type": { + "name": "TokenPruningConfig", + "namespace": "_types.query_dsl" + } + } } ], - "specLocation": "_types/query_dsl/TextExpansionQuery.ts#L22-L27" + "specLocation": "_types/query_dsl/TextExpansionQuery.ts#L23-L33" }, { "kind": "enum", @@ -79491,6 +79812,55 @@ }, "specLocation": "_types/query_dsl/fulltext.ts#L541-L567" }, + { + "kind": "interface", + "name": { + "name": "TokenPruningConfig", + "namespace": "_types.query_dsl" + }, + "properties": [ + { + "description": "Tokens whose frequency is more than this threshold times the average frequency of all tokens in the specified field are considered outliers and pruned.", + "name": "tokens_freq_ratio_threshold", + "required": false, + "serverDefault": 5, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "description": "Tokens whose weight is less than this threshold are considered nonsignificant and pruned.", + "name": "tokens_weight_threshold", + "required": false, + "serverDefault": 0.4, + "type": { + "kind": "instance_of", + "type": { + "name": "float", + "namespace": "_types" + } + } + }, + { + "description": "Whether to only score pruned tokens, vs only scoring kept tokens.", + "name": "only_score_pruned_tokens", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "_types/query_dsl/TokenPruningConfig.ts#L22-L35" + }, { "inherits": { "type": { @@ -79518,6 +79888,57 @@ ], "specLocation": "_types/query_dsl/term.ts#L264-L266" }, + { + "inherits": { + "type": { + "name": "QueryBase", + "namespace": "_types.query_dsl" + } + }, + "kind": "interface", + "name": { + "name": "WeightedTokensQuery", + "namespace": "_types.query_dsl" + }, + "properties": [ + { + "description": "The tokens representing this query", + "name": "tokens", + "required": true, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "float", + "namespace": "_types" + } + } + } + }, + { + "description": "Token pruning configurations", + "name": "pruning_config", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "TokenPruningConfig", + "namespace": "_types.query_dsl" + } + } + } + ], + "specLocation": "_types/query_dsl/WeightedTokensQuery.ts#L27-L32" + }, { "inherits": { "type": { @@ -79618,7 +80039,7 @@ } } ], - "specLocation": "_types/query_dsl/abstractions.ts#L465-L471" + "specLocation": "_types/query_dsl/abstractions.ts#L473-L479" }, { "kind": "enum", @@ -104309,8 +104730,8 @@ "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "QueryContainer", + "namespace": "_types.query_dsl" } } }, @@ -104337,7 +104758,7 @@ } } ], - "specLocation": "enrich/_types/Policy.ts#L33-L40" + "specLocation": "enrich/_types/Policy.ts#L34-L41" }, { "kind": "enum", @@ -104356,7 +104777,7 @@ "name": "PolicyType", "namespace": "enrich._types" }, - "specLocation": "enrich/_types/Policy.ts#L27-L31" + "specLocation": "enrich/_types/Policy.ts#L28-L32" }, { "kind": "interface", @@ -104388,7 +104809,7 @@ } } ], - "specLocation": "enrich/_types/Policy.ts#L23-L25" + "specLocation": "enrich/_types/Policy.ts#L24-L26" }, { "attachedBehaviors": [ @@ -105947,6 +106368,138 @@ }, "specLocation": "eql/search/types.ts#L20-L32" }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "description": "By default, ES|QL returns results as rows. For example, FROM returns each individual document as one row. For the JSON, YAML, CBOR and smile formats, ES|QL can return the results in a columnar fashion where one row represents all the values of a certain column in the results.", + "name": "columnar", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Specify a Query DSL query in the filter parameter to filter the set of documents that an ES|QL query runs on.", + "name": "filter", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "QueryContainer", + "namespace": "_types.query_dsl" + } + } + }, + { + "name": "locale", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "To avoid any attempts of hacking or code injection, extract the values in a separate list of parameters. Use question mark placeholders (?) in the query string for each of the parameters.", + "docId": "esql-query-params", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/esql-rest.html#esql-rest-params", + "name": "params", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "ScalarValue", + "namespace": "_types" + } + } + } + }, + { + "description": "The ES|QL query API accepts an ES|QL query string in the query parameter, runs it, and returns the results.", + "name": "query", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ] + }, + "description": "Executes an ES|QL request", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "esql.query" + }, + "path": [], + "query": [ + { + "description": "A short version of the Accept header, e.g. json, yaml.", + "name": "format", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "The character to use between values within a CSV row. Only valid for the CSV format.", + "name": "delimiter", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "esql/query/QueryRequest.ts#L24-L64" + }, + { + "body": { + "kind": "value", + "value": { + "kind": "instance_of", + "type": { + "name": "EsqlColumns", + "namespace": "_types" + } + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "esql.query" + }, + "specLocation": "esql/query/QueryResponse.ts#L22-L24" + }, { "kind": "interface", "name": { @@ -110189,7 +110742,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L398-L400" + "specLocation": "indices/_types/IndexSettings.ts#L397-L399" }, { "kind": "interface", @@ -110268,7 +110821,7 @@ "kind": "instance_of", "type": { "name": "ManagedBy", - "namespace": "_types" + "namespace": "indices._types" } } }, @@ -110402,7 +110955,7 @@ } } ], - "specLocation": "indices/_types/DataStream.ts#L33-L105" + "specLocation": "indices/_types/DataStream.ts#L39-L112" }, { "kind": "interface", @@ -110455,7 +111008,7 @@ "kind": "instance_of", "type": { "name": "ManagedBy", - "namespace": "_types" + "namespace": "indices._types" } } }, @@ -110472,7 +111025,7 @@ } } ], - "specLocation": "indices/_types/DataStream.ts#L114-L135" + "specLocation": "indices/_types/DataStream.ts#L121-L142" }, { "description": "Data lifecycle denotes that a data stream is managed by the data stream lifecycle and contains the configuration.", @@ -110719,7 +111272,7 @@ } } ], - "specLocation": "indices/_types/DataStream.ts#L107-L112" + "specLocation": "indices/_types/DataStream.ts#L114-L119" }, { "kind": "interface", @@ -110740,7 +111293,7 @@ } } ], - "specLocation": "indices/_types/DataStream.ts#L137-L139" + "specLocation": "indices/_types/DataStream.ts#L144-L146" }, { "kind": "interface", @@ -110859,7 +111412,7 @@ "name": "IndexCheckOnStartup", "namespace": "indices._types" }, - "specLocation": "indices/_types/IndexSettings.ts#L253-L260" + "specLocation": "indices/_types/IndexSettings.ts#L252-L259" }, { "kind": "interface", @@ -111305,7 +111858,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L245-L251" + "specLocation": "indices/_types/IndexSettings.ts#L244-L250" }, { "attachedBehaviors": [ @@ -112025,17 +112578,6 @@ } } }, - { - "name": "shards", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, { "name": "queries", "required": false, @@ -112107,7 +112649,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L69-L168" + "specLocation": "indices/_types/IndexSettings.ts#L69-L167" }, { "kind": "interface", @@ -112227,7 +112769,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L310-L316" + "specLocation": "indices/_types/IndexSettings.ts#L309-L315" }, { "kind": "interface", @@ -112320,7 +112862,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L267-L300" + "specLocation": "indices/_types/IndexSettings.ts#L266-L299" }, { "kind": "interface", @@ -112342,7 +112884,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L302-L308" + "specLocation": "indices/_types/IndexSettings.ts#L301-L307" }, { "kind": "interface", @@ -112374,7 +112916,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L318-L321" + "specLocation": "indices/_types/IndexSettings.ts#L317-L320" }, { "kind": "interface", @@ -112731,7 +113273,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L262-L265" + "specLocation": "indices/_types/IndexSettings.ts#L261-L264" }, { "kind": "interface", @@ -112752,7 +113294,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L534-L536" + "specLocation": "indices/_types/IndexSettings.ts#L533-L535" }, { "kind": "interface", @@ -112774,7 +113316,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L538-L545" + "specLocation": "indices/_types/IndexSettings.ts#L537-L544" }, { "kind": "interface", @@ -112828,7 +113370,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L547-L552" + "specLocation": "indices/_types/IndexSettings.ts#L546-L551" }, { "kind": "interface", @@ -112852,7 +113394,29 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L554-L561" + "specLocation": "indices/_types/IndexSettings.ts#L553-L560" + }, + { + "kind": "enum", + "members": [ + { + "codegenName": "ilm", + "name": "Index Lifecycle Management" + }, + { + "codegenName": "datastream", + "name": "Data stream lifecycle" + }, + { + "codegenName": "unmanaged", + "name": "Unmanaged" + } + ], + "name": { + "name": "ManagedBy", + "namespace": "indices._types" + }, + "specLocation": "indices/_types/DataStream.ts#L32-L37" }, { "description": "Mapping Limit Settings", @@ -112953,7 +113517,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L402-L415" + "specLocation": "indices/_types/IndexSettings.ts#L401-L414" }, { "kind": "interface", @@ -112976,7 +113540,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L427-L434" + "specLocation": "indices/_types/IndexSettings.ts#L426-L433" }, { "kind": "interface", @@ -112998,7 +113562,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L464-L470" + "specLocation": "indices/_types/IndexSettings.ts#L463-L469" }, { "kind": "interface", @@ -113020,7 +113584,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L455-L462" + "specLocation": "indices/_types/IndexSettings.ts#L454-L461" }, { "kind": "interface", @@ -113043,7 +113607,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L436-L444" + "specLocation": "indices/_types/IndexSettings.ts#L435-L443" }, { "kind": "interface", @@ -113066,7 +113630,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L446-L453" + "specLocation": "indices/_types/IndexSettings.ts#L445-L452" }, { "kind": "interface", @@ -113089,7 +113653,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L417-L425" + "specLocation": "indices/_types/IndexSettings.ts#L416-L424" }, { "kind": "interface", @@ -113110,7 +113674,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L323-L325" + "specLocation": "indices/_types/IndexSettings.ts#L322-L324" }, { "kind": "interface", @@ -113160,7 +113724,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L327-L330" + "specLocation": "indices/_types/IndexSettings.ts#L326-L329" }, { "kind": "interface", @@ -113218,7 +113782,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L394-L396" + "specLocation": "indices/_types/IndexSettings.ts#L393-L395" }, { "kind": "interface", @@ -113261,7 +113825,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L236-L239" + "specLocation": "indices/_types/IndexSettings.ts#L235-L238" }, { "kind": "enum", @@ -113279,7 +113843,7 @@ "name": "SegmentSortMissing", "namespace": "indices._types" }, - "specLocation": "indices/_types/IndexSegmentSort.ts#L43-L48" + "specLocation": "indices/_types/IndexSegmentSort.ts#L43-L46" }, { "kind": "enum", @@ -113354,7 +113918,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L226-L229" + "specLocation": "indices/_types/IndexSettings.ts#L225-L228" }, { "kind": "interface", @@ -113376,7 +113940,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L221-L224" + "specLocation": "indices/_types/IndexSettings.ts#L220-L223" }, { "kind": "interface", @@ -113406,7 +113970,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L241-L243" + "specLocation": "indices/_types/IndexSettings.ts#L240-L242" }, { "kind": "interface", @@ -113438,7 +114002,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L231-L234" + "specLocation": "indices/_types/IndexSettings.ts#L230-L233" }, { "kind": "interface", @@ -113525,7 +114089,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L170-L178" + "specLocation": "indices/_types/IndexSettings.ts#L169-L177" }, { "kind": "interface", @@ -113576,7 +114140,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L180-L185" + "specLocation": "indices/_types/IndexSettings.ts#L179-L184" }, { "kind": "interface", @@ -113605,7 +114169,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L187-L190" + "specLocation": "indices/_types/IndexSettings.ts#L186-L189" }, { "kind": "interface", @@ -113656,7 +114220,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L192-L197" + "specLocation": "indices/_types/IndexSettings.ts#L191-L196" }, { "kind": "interface", @@ -113707,7 +114271,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L199-L204" + "specLocation": "indices/_types/IndexSettings.ts#L198-L203" }, { "kind": "interface", @@ -113736,7 +114300,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L206-L209" + "specLocation": "indices/_types/IndexSettings.ts#L205-L208" }, { "kind": "interface", @@ -113765,7 +114329,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L211-L214" + "specLocation": "indices/_types/IndexSettings.ts#L210-L213" }, { "kind": "interface", @@ -113794,7 +114358,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L216-L219" + "specLocation": "indices/_types/IndexSettings.ts#L215-L218" }, { "kind": "interface", @@ -113848,7 +114412,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L472-L477" + "specLocation": "indices/_types/IndexSettings.ts#L471-L476" }, { "kind": "interface", @@ -113902,7 +114466,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L484-L489" + "specLocation": "indices/_types/IndexSettings.ts#L483-L488" }, { "kind": "interface", @@ -113934,7 +114498,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L479-L482" + "specLocation": "indices/_types/IndexSettings.ts#L478-L481" }, { "kind": "interface", @@ -114002,7 +114566,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L491-L500" + "specLocation": "indices/_types/IndexSettings.ts#L490-L499" }, { "isOpen": true, @@ -114032,7 +114596,7 @@ "name": "StorageType", "namespace": "indices._types" }, - "specLocation": "indices/_types/IndexSettings.ts#L502-L532" + "specLocation": "indices/_types/IndexSettings.ts#L501-L531" }, { "kind": "interface", @@ -114189,7 +114753,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L332-L354" + "specLocation": "indices/_types/IndexSettings.ts#L331-L353" }, { "kind": "enum", @@ -114213,7 +114777,7 @@ "name": "TranslogDurability", "namespace": "indices._types" }, - "specLocation": "indices/_types/IndexSettings.ts#L356-L371" + "specLocation": "indices/_types/IndexSettings.ts#L355-L370" }, { "kind": "interface", @@ -114249,7 +114813,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L373-L392" + "specLocation": "indices/_types/IndexSettings.ts#L372-L391" }, { "kind": "enum", @@ -127226,29 +127790,64 @@ "specLocation": "indices/validate_query/IndicesValidateQueryResponse.ts#L23-L30" }, { + "description": "Text Embedding results are represented as Dense Vectors\nof floats.", "kind": "type_alias", "name": { - "name": "InferenceResult", + "name": "DenseVector", "namespace": "inference._types" }, - "specLocation": "inference/_types/Results.ts#L23-L23", + "specLocation": "inference/_types/Results.ts#L29-L33", "type": { - "key": { + "kind": "array_of", + "value": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "float", + "namespace": "_types" + } + } + } + }, + { + "description": "InferenceResult is an aggregation of mutually exclusive variants", + "kind": "interface", + "name": { + "name": "InferenceResult", + "namespace": "inference._types" + }, + "properties": [ + { + "name": "text_embedding", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "TextEmbeddingResult", + "namespace": "inference._types" + } + } } }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", + { + "name": "sparse_embedding", + "required": false, "type": { - "name": "double", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "SparseEmbeddingResult", + "namespace": "inference._types" + } + } } } + ], + "specLocation": "inference/_types/Results.ts#L46-L53", + "variants": { + "kind": "container" } }, { @@ -127296,10 +127895,16 @@ } } ], - "specLocation": "inference/_types/Services.ts#L22-L38" + "specLocation": "inference/_types/Services.ts#L23-L39" }, { "description": "Represents a model as returned by the GET API", + "inherits": { + "type": { + "name": "ModelConfig", + "namespace": "inference._types" + } + }, "kind": "interface", "name": { "name": "ModelConfigContainer", @@ -127307,8 +127912,8 @@ }, "properties": [ { - "description": "The service type", - "name": "service", + "description": "The model Id", + "name": "model_id", "required": true, "type": { "kind": "instance_of", @@ -127319,62 +127924,127 @@ } }, { - "description": "Settings specific to the service", - "name": "service_settings", + "description": "The model's task type", + "name": "task_type", "required": true, "type": { "kind": "instance_of", "type": { - "name": "ServiceSettings", + "name": "TaskType", "namespace": "inference._types" } } - }, + } + ], + "specLocation": "inference/_types/Services.ts#L41-L53" + }, + { + "kind": "type_alias", + "name": { + "name": "ServiceSettings", + "namespace": "inference._types" + }, + "specLocation": "inference/_types/Services.ts#L55-L55", + "type": { + "kind": "user_defined_value" + } + }, + { + "kind": "interface", + "name": { + "name": "SparseEmbeddingResult", + "namespace": "inference._types" + }, + "properties": [ { - "description": "Task settings specific to the service and model", - "name": "task_settings", + "name": "embedding", "required": true, "type": { "kind": "instance_of", "type": { - "name": "TaskSettings", + "name": "SparseVector", "namespace": "inference._types" } } } ], - "specLocation": "inference/_types/Services.ts#L40-L56" + "specLocation": "inference/_types/Results.ts#L35-L37" }, { - "kind": "interface", + "description": "Sparse Embedding tokens are represented as a dictionary\nof string to double.", + "kind": "type_alias", "name": { - "name": "ServiceSettings", + "name": "SparseVector", "namespace": "inference._types" }, - "properties": [], - "specLocation": "inference/_types/Services.ts#L58-L58" + "specLocation": "inference/_types/Results.ts#L23-L27", + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "float", + "namespace": "_types" + } + } + } }, { - "kind": "interface", + "kind": "type_alias", "name": { "name": "TaskSettings", "namespace": "inference._types" }, - "properties": [], - "specLocation": "inference/_types/Services.ts#L60-L60" + "specLocation": "inference/_types/Services.ts#L57-L57", + "type": { + "kind": "user_defined_value" + } }, { "kind": "enum", "members": [ { "name": "sparse_embedding" + }, + { + "name": "text_embedding" } ], "name": { "name": "TaskType", "namespace": "inference._types" }, - "specLocation": "inference/_types/TaskType.ts#L20-L22" + "specLocation": "inference/_types/TaskType.ts#L20-L26" + }, + { + "description": "The text embedding result object", + "kind": "interface", + "name": { + "name": "TextEmbeddingResult", + "namespace": "inference._types" + }, + "properties": [ + { + "name": "embedding", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "DenseVector", + "namespace": "inference._types" + } + } + } + ], + "specLocation": "inference/_types/Results.ts#L39-L44" }, { "attachedBehaviors": [ @@ -127492,21 +128162,30 @@ }, { "body": { - "kind": "value", - "value": { - "kind": "instance_of", - "type": { - "name": "ModelConfigContainer", - "namespace": "inference._types" + "kind": "properties", + "properties": [ + { + "name": "models", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "ModelConfigContainer", + "namespace": "inference._types" + } + } + } } - } + ] }, "kind": "response", "name": { "name": "Response", "namespace": "inference.get_model" }, - "specLocation": "inference/get_model/GetModelResponse.ts#L22-L24" + "specLocation": "inference/get_model/GetModelResponse.ts#L22-L26" }, { "attachedBehaviors": [ @@ -127516,15 +128195,30 @@ "kind": "properties", "properties": [ { - "description": "Text input to the model", + "description": "Text input to the model.\nEither a string or an array of strings.", "name": "input", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "kind": "union_of" } }, { @@ -127580,31 +128274,25 @@ } ], "query": [], - "specLocation": "inference/inference/InferenceRequest.ts#L25-L52" + "specLocation": "inference/inference/InferenceRequest.ts#L25-L53" }, { "body": { - "kind": "properties", - "properties": [ - { - "name": "predicted_value", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "InferenceResult", - "namespace": "inference._types" - } - } + "kind": "value", + "value": { + "kind": "instance_of", + "type": { + "name": "InferenceResult", + "namespace": "inference._types" } - ] + } }, "kind": "response", "name": { "name": "Response", "namespace": "inference.inference" }, - "specLocation": "inference/inference/InferenceResponse.ts#L22-L26" + "specLocation": "inference/inference/InferenceResponse.ts#L22-L24" }, { "attachedBehaviors": [ @@ -129564,9 +130252,21 @@ "namespace": "_types" } } + }, + { + "description": "Arbitrary metadata about the ingest pipeline. This map is not automatically generated by Elasticsearch.", + "name": "_meta", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Metadata", + "namespace": "_types" + } + } } ], - "specLocation": "ingest/_types/Pipeline.ts#L23-L41" + "specLocation": "ingest/_types/Pipeline.ts#L23-L45" }, { "kind": "interface", @@ -129615,7 +130315,7 @@ } } ], - "specLocation": "ingest/_types/Pipeline.ts#L57-L71" + "specLocation": "ingest/_types/Pipeline.ts#L61-L75" }, { "inherits": { @@ -138908,7 +139608,7 @@ "name": "DeploymentAllocationState", "namespace": "ml._types" }, - "specLocation": "ml/_types/TrainedModel.ts#L288-L301" + "specLocation": "ml/_types/TrainedModel.ts#L289-L302" }, { "kind": "enum", @@ -138930,7 +139630,7 @@ "name": "DeploymentAssignmentState", "namespace": "ml._types" }, - "specLocation": "ml/_types/TrainedModel.ts#L303-L308" + "specLocation": "ml/_types/TrainedModel.ts#L304-L309" }, { "kind": "enum", @@ -138952,7 +139652,7 @@ "name": "DeploymentState", "namespace": "ml._types" }, - "specLocation": "ml/_types/TrainedModel.ts#L273-L286" + "specLocation": "ml/_types/TrainedModel.ts#L274-L287" }, { "kind": "interface", @@ -139717,7 +140417,7 @@ } } ], - "specLocation": "ml/_types/TrainedModel.ts#L216-L230" + "specLocation": "ml/_types/TrainedModel.ts#L217-L231" }, { "kind": "interface", @@ -143010,7 +143710,7 @@ "name": "RoutingState", "namespace": "ml._types" }, - "specLocation": "ml/_types/TrainedModel.ts#L350-L371" + "specLocation": "ml/_types/TrainedModel.ts#L351-L372" }, { "kind": "enum", @@ -143673,7 +144373,7 @@ } } ], - "specLocation": "ml/_types/TrainedModel.ts#L232-L239" + "specLocation": "ml/_types/TrainedModel.ts#L233-L240" }, { "kind": "interface", @@ -143710,7 +144410,7 @@ } } ], - "specLocation": "ml/_types/TrainedModel.ts#L241-L246" + "specLocation": "ml/_types/TrainedModel.ts#L242-L247" }, { "kind": "interface", @@ -143756,7 +144456,7 @@ } } ], - "specLocation": "ml/_types/TrainedModel.ts#L248-L255" + "specLocation": "ml/_types/TrainedModel.ts#L249-L256" }, { "kind": "interface", @@ -143835,7 +144535,7 @@ } } ], - "specLocation": "ml/_types/TrainedModel.ts#L402-L417" + "specLocation": "ml/_types/TrainedModel.ts#L403-L418" }, { "kind": "interface", @@ -143893,7 +144593,7 @@ } } ], - "specLocation": "ml/_types/TrainedModel.ts#L373-L391" + "specLocation": "ml/_types/TrainedModel.ts#L374-L392" }, { "kind": "interface", @@ -144005,7 +144705,7 @@ } } ], - "specLocation": "ml/_types/TrainedModel.ts#L315-L348" + "specLocation": "ml/_types/TrainedModel.ts#L316-L349" }, { "kind": "interface", @@ -144240,9 +144940,20 @@ "namespace": "ml._types" } } + }, + { + "name": "prefix_strings", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "TrainedModelPrefixStrings", + "namespace": "ml._types" + } + } } ], - "specLocation": "ml/_types/TrainedModel.ts#L165-L199" + "specLocation": "ml/_types/TrainedModel.ts#L165-L200" }, { "kind": "interface", @@ -144267,7 +144978,7 @@ } } ], - "specLocation": "ml/_types/TrainedModel.ts#L201-L204" + "specLocation": "ml/_types/TrainedModel.ts#L202-L205" }, { "kind": "interface", @@ -144344,7 +145055,7 @@ } } ], - "specLocation": "ml/_types/TrainedModel.ts#L206-L214" + "specLocation": "ml/_types/TrainedModel.ts#L207-L215" }, { "kind": "interface", @@ -144390,7 +145101,7 @@ } } ], - "specLocation": "ml/_types/TrainedModel.ts#L393-L400" + "specLocation": "ml/_types/TrainedModel.ts#L394-L401" }, { "kind": "interface", @@ -144999,7 +145710,7 @@ } } ], - "specLocation": "ml/_types/TrainedModel.ts#L419-L421" + "specLocation": "ml/_types/TrainedModel.ts#L420-L422" }, { "kind": "interface", @@ -145020,7 +145731,41 @@ } } ], - "specLocation": "ml/_types/TrainedModel.ts#L423-L425" + "specLocation": "ml/_types/TrainedModel.ts#L424-L426" + }, + { + "kind": "interface", + "name": { + "name": "TrainedModelPrefixStrings", + "namespace": "ml._types" + }, + "properties": [ + { + "description": "String prepended to input at ingest", + "name": "ingest", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "String prepended to input at search", + "name": "search", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "ml/_types/TrainedModel.ts#L428-L437" }, { "kind": "interface", @@ -145167,7 +145912,7 @@ "name": "TrainedModelType", "namespace": "ml._types" }, - "specLocation": "ml/_types/TrainedModel.ts#L257-L271" + "specLocation": "ml/_types/TrainedModel.ts#L258-L272" }, { "kind": "enum", @@ -145183,7 +145928,7 @@ "name": "TrainingPriority", "namespace": "ml._types" }, - "specLocation": "ml/_types/TrainedModel.ts#L310-L313" + "specLocation": "ml/_types/TrainedModel.ts#L311-L314" }, { "kind": "interface", @@ -155653,6 +156398,24 @@ } } }, + { + "availability": { + "stack": { + "since": "8.8.0" + } + }, + "description": "A unique identifier for the deployment of the model.", + "name": "deployment_id", + "required": false, + "since": "8.8.0", + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, { "description": "The number of model allocations on each node where the model is deployed.\nAll allocations on a node share the same copy of the model in memory but use\na separate set of threads to evaluate the model.\nIncreasing this value generally increases the throughput.\nIf this setting is greater than the number of hardware threads\nit will automatically be changed to a value less than the number of hardware threads.", "name": "number_of_allocations", @@ -155731,7 +156494,7 @@ } } ], - "specLocation": "ml/start_trained_model_deployment/MlStartTrainedModelDeploymentRequest.ts#L29-L87" + "specLocation": "ml/start_trained_model_deployment/MlStartTrainedModelDeploymentRequest.ts#L29-L92" }, { "body": { @@ -170537,7 +171300,7 @@ "type": { "kind": "instance_of", "type": { - "name": "Name", + "name": "Names", "namespace": "_types" } } @@ -170563,29 +171326,12 @@ "namespace": "_types" } } - }, - { - "name": "metadata", - "required": false, - "type": { - "kind": "user_defined_value" - } - }, - { - "name": "realm", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Realm", - "namespace": "security._types" - } - } } ], - "specLocation": "security/_types/RoleMappingRule.ts#L33-L42", + "specLocation": "security/_types/RoleMappingRule.ts#L36-L44", "variants": { - "kind": "container" + "kind": "container", + "nonExhaustive": true } }, { @@ -170867,27 +171613,6 @@ ], "specLocation": "security/_types/Privileges.ts#L197-L199" }, - { - "kind": "interface", - "name": { - "name": "Realm", - "namespace": "security._types" - }, - "properties": [ - { - "name": "name", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Name", - "namespace": "_types" - } - } - } - ], - "specLocation": "security/_types/RoleMappingRule.ts#L44-L46" - }, { "kind": "interface", "name": { @@ -171253,7 +171978,7 @@ "kind": "instance_of", "type": { "name": "RoleTemplate", - "namespace": "security.get_role" + "namespace": "security._types" } } } @@ -171319,11 +172044,43 @@ } } ], - "specLocation": "security/_types/RoleMappingRule.ts#L23-L31", + "specLocation": "security/_types/RoleMappingRule.ts#L23-L34", "variants": { "kind": "container" } }, + { + "kind": "interface", + "name": { + "name": "RoleTemplate", + "namespace": "security._types" + }, + "properties": [ + { + "name": "format", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "TemplateFormat", + "namespace": "security._types" + } + } + }, + { + "name": "template", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Script", + "namespace": "_types" + } + } + } + ], + "specLocation": "security/_types/RoleTemplate.ts#L28-L31" + }, { "codegenNames": [ "query_string", @@ -171471,6 +172228,22 @@ "kind": "union_of" } }, + { + "kind": "enum", + "members": [ + { + "name": "string" + }, + { + "name": "json" + } + ], + "name": { + "name": "TemplateFormat", + "namespace": "security._types" + }, + "specLocation": "security/_types/RoleTemplate.ts#L22-L25" + }, { "kind": "interface", "name": { @@ -174186,9 +174959,29 @@ "namespace": "_builtins" } } + }, + { + "availability": { + "serverless": {}, + "stack": { + "since": "8.10.0" + } + }, + "description": "A boolean flag that can be used to query API keys that are currently active. An API key is considered active if it is neither invalidated, nor expired at query time. You can specify this together with other parameters such as `owner` or `name`. If `active_only` is false, the response will include both active and inactive (expired or invalidated) keys.", + "name": "active_only", + "required": false, + "serverDefault": false, + "since": "8.10.0", + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } } ], - "specLocation": "security/get_api_key/SecurityGetApiKeyRequest.ts#L23-L72" + "specLocation": "security/get_api_key/SecurityGetApiKeyRequest.ts#L23-L79" }, { "body": { @@ -174525,7 +175318,7 @@ "kind": "instance_of", "type": { "name": "RoleTemplate", - "namespace": "security.get_role" + "namespace": "security._types" } } } @@ -174587,54 +175380,6 @@ ], "specLocation": "security/get_role/types.ts#L29-L42" }, - { - "kind": "interface", - "name": { - "name": "RoleTemplate", - "namespace": "security.get_role" - }, - "properties": [ - { - "name": "format", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "TemplateFormat", - "namespace": "security.get_role" - } - } - }, - { - "name": "template", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Script", - "namespace": "_types" - } - } - } - ], - "specLocation": "security/get_role/types.ts#L50-L53" - }, - { - "kind": "enum", - "members": [ - { - "name": "string" - }, - { - "name": "json" - } - ], - "name": { - "name": "TemplateFormat", - "namespace": "security.get_role" - }, - "specLocation": "security/get_role/types.ts#L44-L47" - }, { "attachedBehaviors": [ "CommonQueryParameters" @@ -177228,6 +177973,20 @@ } } }, + { + "name": "role_templates", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "RoleTemplate", + "namespace": "security._types" + } + } + } + }, { "name": "rules", "required": false, @@ -177295,7 +178054,7 @@ } } ], - "specLocation": "security/put_role_mapping/SecurityPutRoleMappingRequest.ts#L24-L43" + "specLocation": "security/put_role_mapping/SecurityPutRoleMappingRequest.ts#L25-L45" }, { "body": { @@ -178547,6 +179306,18 @@ "namespace": "_types" } } + }, + { + "description": "Expiration time for the API key.", + "name": "expiration", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } } ] }, @@ -178577,7 +179348,7 @@ } ], "query": [], - "specLocation": "security/update_api_key/Request.ts#L25-L62" + "specLocation": "security/update_api_key/Request.ts#L26-L65" }, { "body": { @@ -191131,7 +191902,7 @@ } } ], - "specLocation": "watcher/_types/Schedule.ts#L110-L113" + "specLocation": "watcher/_types/Schedule.ts#L105-L108" }, { "kind": "interface", @@ -191944,7 +192715,7 @@ "name": "Month", "namespace": "watcher._types" }, - "specLocation": "watcher/_types/Schedule.ts#L70-L83" + "specLocation": "watcher/_types/Schedule.ts#L65-L78" }, { "kind": "interface", @@ -192547,7 +193318,7 @@ } } ], - "specLocation": "watcher/_types/Schedule.ts#L85-L96", + "specLocation": "watcher/_types/Schedule.ts#L80-L91", "variants": { "kind": "container" } @@ -192563,7 +193334,7 @@ "name": "ScheduleTimeOfDay", "namespace": "watcher._types" }, - "specLocation": "watcher/_types/Schedule.ts#L103-L108", + "specLocation": "watcher/_types/Schedule.ts#L98-L103", "type": { "items": [ { @@ -192614,7 +193385,7 @@ } } ], - "specLocation": "watcher/_types/Schedule.ts#L98-L101" + "specLocation": "watcher/_types/Schedule.ts#L93-L96" }, { "kind": "interface", @@ -193422,7 +194193,7 @@ } } ], - "specLocation": "watcher/_types/Schedule.ts#L115-L118" + "specLocation": "watcher/_types/Schedule.ts#L110-L113" }, { "kind": "interface", @@ -193460,7 +194231,7 @@ } } ], - "specLocation": "watcher/_types/Schedule.ts#L120-L123" + "specLocation": "watcher/_types/Schedule.ts#L115-L118" }, { "kind": "interface", @@ -193512,7 +194283,7 @@ } } ], - "specLocation": "watcher/_types/Schedule.ts#L125-L129" + "specLocation": "watcher/_types/Schedule.ts#L120-L124" }, { "kind": "interface", diff --git a/output/schema/schema/validation-errors.json b/output/schema/schema/validation-errors.json index bc7bef54a8..06f921e197 100644 --- a/output/schema/schema/validation-errors.json +++ b/output/schema/schema/validation-errors.json @@ -552,12 +552,30 @@ ], "response": [] }, + "esql.query": { + "request": [], + "response": [ + "type_alias definition _types:EsqlColumns / instance_of - No type definition for '_builtins:binary'" + ] + }, "features.get_features": { "request": [ "Request: missing json spec query parameter 'master_timeout'" ], "response": [] }, + "fleet.delete_secret": { + "request": [ + "Missing request & response" + ], + "response": [] + }, + "fleet.get_secret": { + "request": [ + "Missing request & response" + ], + "response": [] + }, "fleet.msearch": { "request": [ "Request: query parameter 'allow_no_indices' does not exist in the json spec", @@ -578,6 +596,12 @@ "type_alias definition _global.msearch:ResponseItem / union_of / instance_of / Generics / instance_of - No type definition for '_global.msearch:TDocument'" ] }, + "fleet.post_secret": { + "request": [ + "Missing request & response" + ], + "response": [] + }, "fleet.search": { "request": [ "Request: query parameter 'allow_no_indices' does not exist in the json spec", @@ -843,6 +867,12 @@ "response definition indices.refresh:Response / body / instance_of - Non-leaf type cannot be used here: '_types:ShardsOperationResponseBase'" ] }, + "indices.reload_search_analyzers": { + "request": [ + "Request: missing json spec query parameter 'resource'" + ], + "response": [] + }, "indices.simulate_index_template": { "request": [ "Request: missing json spec query parameter 'cause'" @@ -867,6 +897,12 @@ "response definition inference.delete_model:Response / body / instance_of - Non-leaf type cannot be used here: '_types:AcknowledgedResponseBase'" ] }, + "inference.put_model": { + "request": [ + "request definition inference.put_model:Request / body / instance_of - Non-leaf type cannot be used here: 'inference._types:ModelConfig'" + ], + "response": [] + }, "ingest.delete_pipeline": { "request": [], "response": [ @@ -1035,12 +1071,6 @@ "response definition ml.set_upgrade_mode:Response / body / instance_of - Non-leaf type cannot be used here: '_types:AcknowledgedResponseBase'" ] }, - "ml.start_trained_model_deployment": { - "request": [ - "Request: missing json spec query parameter 'deployment_id'" - ], - "response": [] - }, "ml.stop_datafeed": { "request": [ "Request: missing json spec query parameter 'allow_no_datafeeds'" @@ -1228,6 +1258,18 @@ "response definition security.enable_user_profile:Response / body / instance_of - Non-leaf type cannot be used here: '_types:AcknowledgedResponseBase'" ] }, + "security.get_api_key": { + "request": [ + "Request: query parameter 'active_only' does not exist in the json spec" + ], + "response": [] + }, + "security.get_settings": { + "request": [ + "Missing request & response" + ], + "response": [] + }, "security.get_user": { "request": [], "response": [ @@ -1284,6 +1326,12 @@ ], "response": [] }, + "security.update_settings": { + "request": [ + "Missing request & response" + ], + "response": [] + }, "security.update_user_profile_data": { "request": [], "response": [ diff --git a/output/schema/validation-errors.json b/output/schema/validation-errors.json index 06f921e197..e86929f5d3 100644 --- a/output/schema/validation-errors.json +++ b/output/schema/validation-errors.json @@ -1454,12 +1454,6 @@ ], "response": [] }, - "text_structure.find_structure": { - "request": [ - "Request: missing json spec query parameter 'ecs_compatibility'" - ], - "response": [] - }, "transform.delete_transform": { "request": [], "response": [ diff --git a/output/typescript/types.ts b/output/typescript/types.ts index 0cf814db6c..7ab67dd7b3 100644 --- a/output/typescript/types.ts +++ b/output/typescript/types.ts @@ -17760,6 +17760,7 @@ export interface TextStructureFindStructureRequest { charset?: string column_names?: string delimiter?: string + ecs_compatibility?: string explain?: boolean format?: string grok_pattern?: string @@ -17804,6 +17805,29 @@ export interface TextStructureFindStructureTopHit { value: any } +export interface TextStructureTestGrokPatternMatchedField { + match: string + offset: integer + length: integer +} + +export interface TextStructureTestGrokPatternMatchedText { + matched: boolean + fields?: Record +} + +export interface TextStructureTestGrokPatternRequest extends RequestBase { + ecs_compatibility?: string + body?: { + grok_pattern: string + text: string[] + } +} + +export interface TextStructureTestGrokPatternResponse { + matches: TextStructureTestGrokPatternMatchedText[] +} + export interface TransformDestination { index?: IndexName pipeline?: string diff --git a/specification/_json_spec/text_structure.test_grok_pattern.json b/specification/_json_spec/text_structure.test_grok_pattern.json new file mode 100644 index 0000000000..e0361d30b5 --- /dev/null +++ b/specification/_json_spec/text_structure.test_grok_pattern.json @@ -0,0 +1,32 @@ +{ + "text_structure.test_grok_pattern": { + "documentation": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/test-grok-pattern-api.html", + "description": "Tests a Grok pattern on some text." + }, + "stability": "stable", + "visibility": "public", + "headers": { + "accept": ["application/json"], + "content_type": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_text_structure/test_grok_pattern", + "methods": ["GET", "POST"] + } + ] + }, + "params": { + "ecs_compatibility": { + "type": "string", + "description": "Optional parameter to specify the compatibility mode with ECS Grok patterns - may be either 'v1' or 'disabled'" + } + }, + "body": { + "description": "The Grok pattern and text.", + "required": true + } + } +} diff --git a/specification/text_structure/find_structure/FindStructureRequest.ts b/specification/text_structure/find_structure/FindStructureRequest.ts index 29c2ee995f..1a00af2c62 100644 --- a/specification/text_structure/find_structure/FindStructureRequest.ts +++ b/specification/text_structure/find_structure/FindStructureRequest.ts @@ -34,6 +34,8 @@ export interface Request { column_names?: string /** If you have set format to delimited, you can specify the character used to delimit the values in each row. Only a single character is supported; the delimiter cannot have multiple characters. By default, the API considers the following possibilities: comma, tab, semi-colon, and pipe (|). In this default scenario, all rows must have the same number of fields for the delimited format to be detected. If you specify a delimiter, up to 10% of the rows can have a different number of columns than the first row. */ delimiter?: string + /** The mode of compatibility with ECS compliant Grok patterns (disabled or v1, default: disabled). */ + ecs_compatibility?: string /** * If this parameter is set to true, the response includes a field named explanation, which is an array of strings that indicate how the structure finder produced its result. * @server_default false diff --git a/specification/text_structure/test_grok_pattern/TestGrokPatternRequest.ts b/specification/text_structure/test_grok_pattern/TestGrokPatternRequest.ts new file mode 100644 index 0000000000..df403dd95f --- /dev/null +++ b/specification/text_structure/test_grok_pattern/TestGrokPatternRequest.ts @@ -0,0 +1,43 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import { RequestBase } from '@_types/Base' + +/** + * @rest_spec_name text_structure.test_grok_pattern + * @availability stack since=8.13.0 stability=stable + * @availability serverless stability=stable visibility=private + */ +export interface Request extends RequestBase { + query_parameters: { + /** The mode of compatibility with ECS compliant Grok patterns (disabled or v1, default: disabled). */ + ecs_compatibility?: string + } + body: { + /** + * Grok pattern to run on the text. + */ + grok_pattern: string + + /** + * Lines of text to run the Grok pattern on. + */ + text: string[] + } +} diff --git a/specification/text_structure/test_grok_pattern/TestGrokPatternResponse.ts b/specification/text_structure/test_grok_pattern/TestGrokPatternResponse.ts new file mode 100644 index 0000000000..d74f1592ca --- /dev/null +++ b/specification/text_structure/test_grok_pattern/TestGrokPatternResponse.ts @@ -0,0 +1,26 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import { MatchedText } from '@text_structure/test_grok_pattern/types' + +export class Response { + body: { + matches: MatchedText[] + } +} diff --git a/specification/text_structure/test_grok_pattern/types.ts b/specification/text_structure/test_grok_pattern/types.ts new file mode 100644 index 0000000000..0777987a66 --- /dev/null +++ b/specification/text_structure/test_grok_pattern/types.ts @@ -0,0 +1,32 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import { integer } from '@_types/Numeric' +import { Dictionary } from '@spec_utils/Dictionary' + +export class MatchedField { + match: string + offset: integer + length: integer +} + +export class MatchedText { + matched: boolean + fields?: Dictionary +}