Auto-generated code for 8.17 (#2528)

docs/doc_examples/0c52af573c9401a2a687e86a4beb182b.asciidoc

@@ -10,7 +10,7 @@ const response = await client.ingest.putPipeline({
     {
       attachment: {
         field: "data",
-        remove_binary: false,
+        remove_binary: true,
       },
     },
   ],

docs/doc_examples/2a67608dadbf220a2f040f3a79d3677d.asciidoc

@@ -0,0 +1,35 @@
+// This file is autogenerated, DO NOT EDIT
+// Use `node scripts/generate-docs-examples.js` to generate the docs examples
+
+[source, js]
+----
+const response = await client.ingest.putPipeline({
+  id: "attachment",
+  description: "Extract attachment information including original binary",
+  processors: [
+    {
+      attachment: {
+        field: "data",
+        remove_binary: false,
+      },
+    },
+  ],
+});
+console.log(response);
+
+const response1 = await client.index({
+  index: "my-index-000001",
+  id: "my_id",
+  pipeline: "attachment",
+  document: {
+    data: "e1xydGYxXGFuc2kNCkxvcmVtIGlwc3VtIGRvbG9yIHNpdCBhbWV0DQpccGFyIH0=",
+  },
+});
+console.log(response1);
+
+const response2 = await client.get({
+  index: "my-index-000001",
+  id: "my_id",
+});
+console.log(response2);
+----

docs/doc_examples/48e142e6c69014e0509d4c9251749d77.asciidoc

@@ -10,7 +10,8 @@ const response = await client.inference.put({
     service: "openai",
     service_settings: {
       api_key: "<api_key>",
-      model_id: "text-embedding-ada-002",
+      model_id: "text-embedding-3-small",
+      dimensions: 128,
     },
   },
 });

docs/doc_examples/49b31e23f8b9667b6a7b2734d55fb6ed.asciidoc

@@ -1,17 +0,0 @@
-// This file is autogenerated, DO NOT EDIT
-// Use `node scripts/generate-docs-examples.js` to generate the docs examples
-
-[source, js]
-----
-const response = await client.knnSearch({
-  index: "my-index",
-  knn: {
-    field: "image_vector",
-    query_vector: [0.3, 0.1, 1.2],
-    k: 10,
-    num_candidates: 100,
-  },
-  _source: ["name", "file_type"],
-});
-console.log(response);
-----

docs/doc_examples/53d9d2ec9cb8d211772d764e76fe6890.asciidoc

@@ -0,0 +1,18 @@
+// This file is autogenerated, DO NOT EDIT
+// Use `node scripts/generate-docs-examples.js` to generate the docs examples
+
+[source, js]
+----
+const response = await client.ingest.simulate({
+  id: "query_helper_pipeline",
+  docs: [
+    {
+      _source: {
+        content:
+          "artificial intelligence in medicine articles published in the last 12 months",
+      },
+    },
+  ],
+});
+console.log(response);
+----

docs/doc_examples/5a70db31f587b7ffed5e9bc1445430cb.asciidoc

@@ -1,22 +0,0 @@
-// This file is autogenerated, DO NOT EDIT
-// Use `node scripts/generate-docs-examples.js` to generate the docs examples
-
-[source, js]
-----
-const response = await client.indices.create({
-  index: "semantic-embeddings",
-  mappings: {
-    properties: {
-      semantic_text: {
-        type: "semantic_text",
-        inference_id: "my-elser-endpoint",
-      },
-      content: {
-        type: "text",
-        copy_to: "semantic_text",
-      },
-    },
-  },
-});
-console.log(response);
-----

docs/doc_examples/80135e8c644e34cc70ce8a4e7915d1a2.asciidoc

@@ -12,7 +12,7 @@ const response = await client.ingest.putPipeline({
         field: "data",
         indexed_chars: 11,
         indexed_chars_field: "max_size",
-        remove_binary: false,
+        remove_binary: true,
       },
     },
   ],

docs/doc_examples/8cad5d95a0e7c103f08be53d0b172558.asciidoc

@@ -1,22 +0,0 @@
-// This file is autogenerated, DO NOT EDIT
-// Use `node scripts/generate-docs-examples.js` to generate the docs examples
-
-[source, js]
-----
-const response = await client.inference.put({
-  task_type: "sparse_embedding",
-  inference_id: "my-elser-endpoint",
-  inference_config: {
-    service: "elser",
-    service_settings: {
-      adaptive_allocations: {
-        enabled: true,
-        min_number_of_allocations: 3,
-        max_number_of_allocations: 10,
-      },
-      num_threads: 1,
-    },
-  },
-});
-console.log(response);
-----

docs/doc_examples/931817b168e055ecf738785c721125dd.asciidoc

@@ -0,0 +1,32 @@
+// This file is autogenerated, DO NOT EDIT
+// Use `node scripts/generate-docs-examples.js` to generate the docs examples
+
+[source, js]
+----
+const response = await client.ingest.putPipeline({
+  id: "query_helper_pipeline",
+  processors: [
+    {
+      script: {
+        source:
+          "ctx.prompt = 'Please generate an elasticsearch search query on index `articles_index` for the following natural language query. Dates are in the field `@timestamp`, document types are in the field `type` (options are `news`, `publication`), categories in the field `category` and can be multiple (options are `medicine`, `pharmaceuticals`, `technology`), and document names are in the field `title` which should use a fuzzy match. Ignore fields which cannot be determined from the natural language query context: ' + ctx.content",
+      },
+    },
+    {
+      inference: {
+        model_id: "openai_chat_completions",
+        input_output: {
+          input_field: "prompt",
+          output_field: "query",
+        },
+      },
+    },
+    {
+      remove: {
+        field: "prompt",
+      },
+    },
+  ],
+});
+console.log(response);
+----

docs/doc_examples/93c77c65f1e11382f8043d0300e87b89.asciidoc

@@ -9,7 +9,7 @@ const response = await client.indices.create({
     properties: {
       infer_field: {
         type: "semantic_text",
-        inference_id: "my-elser-endpoint",
+        inference_id: ".elser-2-elasticsearch",
       },
       source_field: {
         type: "text",

docs/doc_examples/cecfaa659af6646b3b67d7b311586fa0.asciidoc

@@ -14,7 +14,7 @@ const response = await client.ingest.putPipeline({
           attachment: {
             target_field: "_ingest._value.attachment",
             field: "_ingest._value.data",
-            remove_binary: false,
+            remove_binary: true,
           },
         },
       },

docs/doc_examples/d29031409016b2b798148ef173a196ae.asciidoc

@@ -0,0 +1,24 @@
+// This file is autogenerated, DO NOT EDIT
+// Use `node scripts/generate-docs-examples.js` to generate the docs examples
+
+[source, js]
+----
+const response = await client.indices.create({
+  index: "test-index",
+  query: {
+    semantic: {
+      field: "my_semantic_field",
+    },
+  },
+  highlight: {
+    fields: {
+      my_semantic_field: {
+        type: "semantic",
+        number_of_fragments: 2,
+        order: "score",
+      },
+    },
+  },
+});
+console.log(response);
+----

docs/doc_examples/d5242b1ab0213f25e5e0742032274ce6.asciidoc

@@ -10,7 +10,7 @@ const response = await client.ingest.putPipeline({
     {
       attachment: {
         field: "data",
-        remove_binary: false,
+        remove_binary: true,
       },
     },
   ],

docs/doc_examples/e77c2f41a7eca765b0c5f734a66d919f.asciidoc

@@ -11,7 +11,7 @@ const response = await client.ingest.putPipeline({
       attachment: {
         field: "data",
         properties: ["content", "title"],
-        remove_binary: false,
+        remove_binary: true,
       },
     },
   ],

docs/doc_examples/ea8c4229afa6dd4f1321355542be9912.asciidoc

@@ -12,7 +12,7 @@ const response = await client.ingest.putPipeline({
         field: "data",
         indexed_chars: 11,
         indexed_chars_field: "max_size",
-        remove_binary: false,
+        remove_binary: true,
       },
     },
   ],

docs/reference.asciidoc

@@ -96,7 +96,8 @@ client.closePointInTime({ id })
 
 [discrete]
 === count
-Returns number of documents matching a query.
+Count search results.
+Get the number of documents matching a query.
 
 {ref}/search-count.html[Endpoint documentation]
 [source,ts]
@@ -1645,8 +1646,6 @@ the indices stats API.
 ** *`wait_for_completion_timeout` (Optional, string | -1 | 0)*: Blocks and waits until the search is completed up to a certain timeout.
 When the async search completes within the timeout, the response won’t include the ID as the results are not stored in the cluster.
 ** *`keep_on_completion` (Optional, boolean)*: If `true`, results are stored for later retrieval when the search completes within the `wait_for_completion_timeout`.
-** *`keep_alive` (Optional, string | -1 | 0)*: Specifies how long the async search needs to be available.
-Ongoing async searches and any saved search results are deleted after this period.
 ** *`allow_no_indices` (Optional, boolean)*: Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
 ** *`allow_partial_search_results` (Optional, boolean)*: Indicate if an error should be returned if there is a partial search failure or timeout
 ** *`analyzer` (Optional, string)*: The analyzer to use for the query string
@@ -1663,7 +1662,6 @@ A partial reduction is performed every time the coordinating node has received a
 ** *`max_concurrent_shard_requests` (Optional, number)*: The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests
 ** *`min_compatible_shard_node` (Optional, string)*
 ** *`preference` (Optional, string)*: Specify the node or shard the operation should be performed on (default: random)
-** *`pre_filter_shard_size` (Optional, number)*: The default value cannot be changed, which enforces the execution of a pre-filter roundtrip to retrieve statistics from each shard so that the ones that surely don’t hold any document matching the query get skipped.
 ** *`request_cache` (Optional, boolean)*: Specify if request cache should be used for this request or not, defaults to true
 ** *`routing` (Optional, string)*: A list of specific routing values
 ** *`search_type` (Optional, Enum("query_then_fetch" | "dfs_query_then_fetch"))*: Search operation type
@@ -3563,7 +3561,8 @@ client.enrich.deletePolicy({ name })
 
 [discrete]
 ==== execute_policy
-Creates the enrich index for an existing enrich policy.
+Run an enrich policy.
+Create the enrich index for an existing enrich policy.
 
 {ref}/execute-enrich-policy-api.html[Endpoint documentation]
 [source,ts]
@@ -3632,7 +3631,8 @@ client.enrich.stats()
 === eql
 [discrete]
 ==== delete
-Deletes an async EQL search or a stored synchronous EQL search.
+Delete an async EQL search.
+Delete an async EQL search or a stored synchronous EQL search.
 The API also deletes results for the search.
 
 {ref}/eql-search-api.html[Endpoint documentation]
@@ -3651,7 +3651,8 @@ A search ID is also provided if the request’s `keep_on_completion` parameter i
 
 [discrete]
 ==== get
-Returns the current status and available results for an async EQL search or a stored synchronous EQL search.
+Get async EQL search results.
+Get the current status and available results for an async EQL search or a stored synchronous EQL search.
 
 {ref}/get-async-eql-search-api.html[Endpoint documentation]
 [source,ts]
@@ -3671,7 +3672,8 @@ Defaults to no timeout, meaning the request waits for complete search results.
 
 [discrete]
 ==== get_status
-Returns the current status for an async EQL search or a stored synchronous EQL search without returning results.
+Get the async EQL status.
+Get the current status for an async EQL search or a stored synchronous EQL search without returning results.
 
 {ref}/get-async-eql-status-api.html[Endpoint documentation]
 [source,ts]
@@ -3687,7 +3689,9 @@ client.eql.getStatus({ id })
 
 [discrete]
 ==== search
-Returns results matching a query expressed in Event Query Language (EQL)
+Get EQL search results.
+Returns search results for an Event Query Language (EQL) query.
+EQL assumes each document in a data stream or index corresponds to an event.
 
 {ref}/eql-search-api.html[Endpoint documentation]
 [source,ts]
@@ -3744,7 +3748,8 @@ client.esql.asyncQueryGet()
 
 [discrete]
 ==== query
-Executes an ES|QL request
+Run an ES|QL query.
+Get search results for an ES|QL (Elasticsearch query language) query.
 
 {ref}/esql-rest.html[Endpoint documentation]
 [source,ts]
@@ -3963,7 +3968,12 @@ which is true by default.
 === graph
 [discrete]
 ==== explore
-Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index.
+Explore graph analytics.
+Extract and summarize information about the documents and terms in an Elasticsearch data stream or index.
+The easiest way to understand the behavior of this API is to use the Graph UI to explore connections.
+An initial request to the `_explore` API contains a seed query that identifies the documents of interest and specifies the fields that define the vertices and connections you want to include in the graph.
+Subsequent requests enable you to spider out from one more vertices of interest.
+You can exclude vertices that have already been returned.
 
 {ref}/graph-explore-api.html[Endpoint documentation]
 [source,ts]
@@ -4633,7 +4643,8 @@ Valid values are: `all`, `open`, `closed`, `hidden`, `none`.
 
 [discrete]
 ==== exists_index_template
-Returns information about whether a particular index template exists.
+Check index templates.
+Check whether index templates exist.
 
 {ref}/index-templates.html[Endpoint documentation]
 [source,ts]
@@ -5447,7 +5458,8 @@ Valid values are: `all`, `open`, `closed`, `hidden`, `none`.
 
 [discrete]
 ==== resolve_index
-Resolves the specified name(s) and/or index patterns for indices, aliases, and data streams.
+Resolve indices.
+Resolve the names and/or index patterns for indices, aliases, and data streams.
 Multiple patterns and remote clusters are supported.
 
 {ref}/indices-resolve-index-api.html[Endpoint documentation]
@@ -5884,7 +5896,8 @@ client.inference.streamInference()
 === ingest
 [discrete]
 ==== delete_geoip_database
-Deletes a geoip database configuration.
+Delete GeoIP database configurations.
+Delete one or more IP geolocation database configurations.
 
 {ref}/delete-geoip-database-api.html[Endpoint documentation]
 [source,ts]
@@ -5914,7 +5927,8 @@ client.ingest.deleteIpLocationDatabase()
 
 [discrete]
 ==== delete_pipeline
-Deletes one or more existing ingest pipeline.
+Delete pipelines.
+Delete one or more ingest pipelines.
 
 {ref}/delete-pipeline-api.html[Endpoint documentation]
 [source,ts]
@@ -5935,7 +5949,8 @@ If no response is received before the timeout expires, the request fails and ret
 
 [discrete]
 ==== geo_ip_stats
-Gets download statistics for GeoIP2 databases used with the geoip processor.
+Get GeoIP statistics.
+Get download statistics for GeoIP2 databases that are used with the GeoIP processor.
 
 {ref}/geoip-processor.html[Endpoint documentation]
 [source,ts]
@@ -5946,7 +5961,8 @@ client.ingest.geoIpStats()
 
 [discrete]
 ==== get_geoip_database
-Returns information about one or more geoip database configurations.
+Get GeoIP database configurations.
+Get information about one or more IP geolocation database configurations.
 
 {ref}/get-geoip-database-api.html[Endpoint documentation]
 [source,ts]
@@ -5977,7 +5993,8 @@ client.ingest.getIpLocationDatabase()
 
 [discrete]
 ==== get_pipeline
-Returns information about one or more ingest pipelines.
+Get pipelines.
+Get information about one or more ingest pipelines.
 This API returns a local reference of the pipeline.
 
 {ref}/get-pipeline-api.html[Endpoint documentation]
@@ -5999,8 +6016,9 @@ If no response is received before the timeout expires, the request fails and ret
 
 [discrete]
 ==== processor_grok
-Extracts structured fields out of a single text field within a document.
-You choose which field to extract matched fields from, as well as the grok pattern you expect will match.
+Run a grok processor.
+Extract structured fields out of a single text field within a document.
+You must choose which field to extract matched fields from, as well as the grok pattern you expect will match.
 A grok pattern is like a regular expression that supports aliased expressions that can be reused.
 
 {ref}/grok-processor.html[Endpoint documentation]
@@ -6012,7 +6030,8 @@ client.ingest.processorGrok()
 
 [discrete]
 ==== put_geoip_database
-Returns information about one or more geoip database configurations.
+Create or update GeoIP database configurations.
+Create or update IP geolocation database configurations.
 
 {ref}/put-geoip-database-api.html[Endpoint documentation]
 [source,ts]
@@ -6045,7 +6064,7 @@ client.ingest.putIpLocationDatabase()
 
 [discrete]
 ==== put_pipeline
-Creates or updates an ingest pipeline.
+Create or update a pipeline.
 Changes made using this API take effect immediately.
 
 {ref}/ingest.html[Endpoint documentation]
@@ -6072,7 +6091,9 @@ When a deprecated ingest pipeline is referenced as the default or final pipeline
 
 [discrete]
 ==== simulate
-Executes an ingest pipeline against a set of provided documents.
+Simulate a pipeline.
+Run an ingest pipeline against a set of provided documents.
+You can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request.
 
 {ref}/simulate-pipeline-api.html[Endpoint documentation]
 [source,ts]
@@ -8545,7 +8566,8 @@ If no response is received before the timeout expires, the request fails and ret
 === query_rules
 [discrete]
 ==== delete_rule
-Deletes a query rule within a query ruleset.
+Delete a query rule.
+Delete a query rule within a query ruleset.
 
 {ref}/delete-query-rule.html[Endpoint documentation]
 [source,ts]
@@ -8562,7 +8584,7 @@ client.queryRules.deleteRule({ ruleset_id, rule_id })
 
 [discrete]
 ==== delete_ruleset
-Deletes a query ruleset.
+Delete a query ruleset.
 
 {ref}/delete-query-ruleset.html[Endpoint documentation]
 [source,ts]
@@ -8578,7 +8600,8 @@ client.queryRules.deleteRuleset({ ruleset_id })
 
 [discrete]
 ==== get_rule
-Returns the details about a query rule within a query ruleset
+Get a query rule.
+Get details about a query rule within a query ruleset.
 
 {ref}/get-query-rule.html[Endpoint documentation]
 [source,ts]
@@ -8595,7 +8618,8 @@ client.queryRules.getRule({ ruleset_id, rule_id })
 
 [discrete]
 ==== get_ruleset
-Returns the details about a query ruleset
+Get a query ruleset.
+Get details about a query ruleset.
 
 {ref}/get-query-ruleset.html[Endpoint documentation]
 [source,ts]
@@ -8611,7 +8635,8 @@ client.queryRules.getRuleset({ ruleset_id })
 
 [discrete]
 ==== list_rulesets
-Returns summarized information about existing query rulesets.
+Get all query rulesets.
+Get summarized information about the query rulesets.
 
 {ref}/list-query-rulesets.html[Endpoint documentation]
 [source,ts]
@@ -8628,7 +8653,8 @@ client.queryRules.listRulesets({ ... })
 
 [discrete]
 ==== put_rule
-Creates or updates a query rule within a query ruleset.
+Create or update a query rule.
+Create or update a query rule within a query ruleset.
 
 {ref}/put-query-rule.html[Endpoint documentation]
 [source,ts]
@@ -8649,7 +8675,7 @@ client.queryRules.putRule({ ruleset_id, rule_id, type, criteria, actions })
 
 [discrete]
 ==== put_ruleset
-Creates or updates a query ruleset.
+Create or update a query ruleset.
 
 {ref}/put-query-ruleset.html[Endpoint documentation]
 [source,ts]
@@ -8666,7 +8692,8 @@ client.queryRules.putRuleset({ ruleset_id, rules })
 
 [discrete]
 ==== test
-Creates or updates a query ruleset.
+Test a query ruleset.
+Evaluate match criteria against a query ruleset to identify the rules that would match that criteria.
 
 {ref}/test-query-ruleset.html[Endpoint documentation]
 [source,ts]
@@ -10932,7 +10959,7 @@ client.snapshot.verifyRepository({ repository })
 === sql
 [discrete]
 ==== clear_cursor
-Clears the SQL cursor
+Clear an SQL search cursor.
 
 {ref}/clear-sql-cursor-api.html[Endpoint documentation]
 [source,ts]
@@ -10948,7 +10975,9 @@ client.sql.clearCursor({ cursor })
 
 [discrete]
 ==== delete_async
-Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it.
+Delete an async SQL search.
+Delete an async SQL search or a stored synchronous SQL search.
+If the search is still running, the API cancels it.
 
 {ref}/delete-async-sql-search-api.html[Endpoint documentation]
 [source,ts]
@@ -10964,7 +10993,8 @@ client.sql.deleteAsync({ id })
 
 [discrete]
 ==== get_async
-Returns the current status and available results for an async SQL search or stored synchronous SQL search
+Get async SQL search results.
+Get the current status and available results for an async SQL search or stored synchronous SQL search.
 
 {ref}/get-async-sql-search-api.html[Endpoint documentation]
 [source,ts]
@@ -10987,7 +11017,8 @@ meaning the request waits for complete search results.
 
 [discrete]
 ==== get_async_status
-Returns the current status of an async SQL search or a stored synchronous SQL search
+Get the async SQL search status.
+Get the current status of an async SQL search or a stored synchronous SQL search.
 
 {ref}/get-async-sql-search-status-api.html[Endpoint documentation]
 [source,ts]
@@ -11003,7 +11034,8 @@ client.sql.getAsyncStatus({ id })
 
 [discrete]
 ==== query
-Executes a SQL request
+Get SQL search results.
+Run an SQL request.
 
 {ref}/sql-search-api.html[Endpoint documentation]
 [source,ts]
@@ -11038,7 +11070,8 @@ precedence over mapped fields with the same name.
 
 [discrete]
 ==== translate
-Translates SQL into Elasticsearch queries
+Translate SQL into Elasticsearch queries.
+Translate an SQL search into a search API request containing Query DSL.
 
 {ref}/sql-translate-api.html[Endpoint documentation]
 [source,ts]
@@ -11088,7 +11121,7 @@ client.ssl.certificates()
 === synonyms
 [discrete]
 ==== delete_synonym
-Deletes a synonym set
+Delete a synonym set.
 
 {ref}/delete-synonyms-set.html[Endpoint documentation]
 [source,ts]
@@ -11104,7 +11137,8 @@ client.synonyms.deleteSynonym({ id })
 
 [discrete]
 ==== delete_synonym_rule
-Deletes a synonym rule in a synonym set
+Delete a synonym rule.
+Delete a synonym rule from a synonym set.
 
 {ref}/delete-synonym-rule.html[Endpoint documentation]
 [source,ts]
@@ -11121,7 +11155,7 @@ client.synonyms.deleteSynonymRule({ set_id, rule_id })
 
 [discrete]
 ==== get_synonym
-Retrieves a synonym set
+Get a synonym set.
 
 {ref}/get-synonyms-set.html[Endpoint documentation]
 [source,ts]
@@ -11139,7 +11173,8 @@ client.synonyms.getSynonym({ id })
 
 [discrete]
 ==== get_synonym_rule
-Retrieves a synonym rule from a synonym set
+Get a synonym rule.
+Get a synonym rule from a synonym set.
 
 {ref}/get-synonym-rule.html[Endpoint documentation]
 [source,ts]
@@ -11156,7 +11191,8 @@ client.synonyms.getSynonymRule({ set_id, rule_id })
 
 [discrete]
 ==== get_synonyms_sets
-Retrieves a summary of all defined synonym sets
+Get all synonym sets.
+Get a summary of all defined synonym sets.
 
 {ref}/list-synonyms-sets.html[Endpoint documentation]
 [source,ts]
@@ -11173,7 +11209,9 @@ client.synonyms.getSynonymsSets({ ... })
 
 [discrete]
 ==== put_synonym
-Creates or updates a synonym set.
+Create or update a synonym set.
+Synonyms sets are limited to a maximum of 10,000 synonym rules per set.
+If you need to manage more synonym rules, you can create multiple synonym sets.
 
 {ref}/put-synonyms-set.html[Endpoint documentation]
 [source,ts]
@@ -11190,7 +11228,8 @@ client.synonyms.putSynonym({ id, synonyms_set })
 
 [discrete]
 ==== put_synonym_rule
-Creates or updates a synonym rule in a synonym set
+Create or update a synonym rule.
+Create or update a synonym rule in a synonym set.
 
 {ref}/put-synonym-rule.html[Endpoint documentation]
 [source,ts]