Backport #2540 to 8.16 (#2542)

(cherry picked from commit ed3cace127)

Co-authored-by: Josh Mock <joshua.mock@elastic.co>

.buildkite/make.mjs

@@ -1,6 +1,20 @@
 /*
- * Copyright Elasticsearch B.V. and contributors
- * SPDX-License-Identifier: Apache-2.0
+ * 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.
  */
 
 /* global $ argv */
@@ -109,7 +123,7 @@ async function codegen (args) {
   await $`rm -rf ${join(import.meta.url, '..', 'src', 'api')}`
   await $`mkdir ${join(import.meta.url, '..', 'src', 'api')}`
   await $`cp -R ${join(import.meta.url, '..', '..', 'elastic-client-generator-js', 'output')}/* ${join(import.meta.url, '..', 'src', 'api')}`
-  await $`mv ${join(import.meta.url, '..', 'src', 'api', 'reference.md')} ${join(import.meta.url, '..', 'docs', 'reference', 'api-reference.md')}`
+  await $`mv ${join(import.meta.url, '..', 'src', 'api', 'reference.asciidoc')} ${join(import.meta.url, '..', 'docs', 'reference.asciidoc')}`
   await $`npm run build`
 
   // run docs example generation

.buildkite/pipeline.yml

@@ -25,7 +25,7 @@ steps:
       provider: "gcp"
       image: family/core-ubuntu-2204
     plugins:
-      - junit-annotate#v2.6.0:
+      - junit-annotate#v2.4.1:
           artifacts: "junit-output/junit-*.xml"
           job-uuid-file-pattern: "junit-(.*).xml"
           fail-build-on-error: true

.github/make.sh

@@ -65,7 +65,7 @@ codegen)
   if [ -v "$VERSION" ] || [[ -z "$VERSION" ]]; then
     # fall back to branch name or `main` if no VERSION is set
     branch_name=$(git rev-parse --abbrev-ref HEAD)
-    if [[ "$branch_name" =~ ^[0-9]+\.([0-9]+|x) ]]; then
+    if [[ "$branch_name" =~ ^[0-9]+\.[0-9]+ ]]; then
       echo -e "\033[36;1mTARGET: codegen -> No VERSION argument found, using branch name: \`$branch_name\`\033[0m"
       VERSION="$branch_name"
     else

.github/stale.yml

@@ -0,0 +1,26 @@
+# Number of days of inactivity before an issue becomes stale
+daysUntilStale: 15
+
+# Number of days of inactivity before a stale issue is closed
+daysUntilClose: 7
+
+# Issues with these labels will never be considered stale
+exemptLabels:
+  - "discussion"
+  - "feature request"
+  - "bug"
+  - "todo"
+  - "good first issue"
+
+# Label to use when marking an issue as stale
+staleLabel: stale
+
+# Comment to post when marking an issue as stale. Set to `false` to disable
+markComment: |
+  We understand that this might be important for you, but this issue has been automatically marked as stale because it has not had recent activity either from our end or yours.
+  It will be closed if no further activity occurs, please write a comment if you would like to keep this going.
+
+  Note: in the past months we have built a new client, that has just landed in master. If you want to open an issue or a pr for the legacy client, you should do that in https://github.com/elastic/elasticsearch-js-legacy
+
+# Comment to post when closing a stale issue. Set to `false` to disable
+closeComment: false

.github/workflows/docs-build.yml

@@ -1,19 +0,0 @@
-name: docs-build
-
-on:
-  push:
-    branches:
-      - main
-  pull_request_target: ~
-  merge_group: ~
-
-jobs:
-  docs-preview:
-    uses: elastic/docs-builder/.github/workflows/preview-build.yml@main
-    with:
-      path-pattern: docs/**
-    permissions:
-      deployments: write
-      id-token: write
-      contents: read
-      pull-requests: read

.github/workflows/docs-cleanup.yml

@@ -1,14 +0,0 @@
-name: docs-cleanup
-
-on:
-  pull_request_target:
-    types:
-      - closed
-
-jobs:
-  docs-preview:
-    uses: elastic/docs-builder/.github/workflows/preview-cleanup.yml@main
-    permissions:
-      contents: none
-      id-token: write
-      deployments: write

.github/workflows/nodejs.yml

@@ -11,10 +11,10 @@ jobs:
     outputs:
       src-only: "${{ steps.changes.outputs.src-only }}"
     steps:
-      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+      - uses: actions/checkout@v4
         with:
           persist-credentials: false
-      - uses: dorny/paths-filter/@de90cc6fb38fc0963ad72b210f1f284cd68cea36 # v3.0.2
+      - uses: dorny/paths-filter/@v3.0.2
         id: changes
         with:
           filters: |
@@ -36,12 +36,12 @@ jobs:
         os: [ubuntu-latest, windows-latest, macOS-latest]
 
     steps:
-      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+      - uses: actions/checkout@v4
         with:
           persist-credentials: false
 
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a # v4
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
 
@@ -66,12 +66,12 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+      - uses: actions/checkout@v4
         with:
           persist-credentials: false
 
       - name: Use Node.js
-        uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a # v4
+        uses: actions/setup-node@v4
         with:
           node-version: 22.x
 
@@ -83,9 +83,6 @@ jobs:
         run: |
           npm run license-checker
 
-      - name: SPDX header check
-        run: npm run license-header
-
   test-bun:
     name: Test Bun
     runs-on: ${{ matrix.os }}
@@ -99,12 +96,12 @@ jobs:
         os: [ubuntu-latest, windows-latest, macOS-latest]
 
     steps:
-      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+      - uses: actions/checkout@v4
         with:
           persist-credentials: false
 
       - name: Use Bun
-        uses: oven-sh/setup-bun@4bc047ad259df6fc24a6c9b0f9a0cb08cf17fbe5 # v2
+        uses: oven-sh/setup-bun@v2
 
       - name: Install
         run: |
@@ -121,3 +118,13 @@ jobs:
       - name: ECMAScript module test
         run: |
           bun run test:esm
+
+  auto-approve:
+    name: Auto-approve
+    needs: [test, license]
+    runs-on: ubuntu-latest
+    permissions:
+      pull-requests: write
+    if: github.actor == 'elasticmachine'
+    steps:
+      - uses: hmarr/auto-approve-action@v4

.github/workflows/npm-publish.yml

@@ -12,49 +12,27 @@ jobs:
       contents: write
       id-token: write
     steps:
-      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+      - uses: actions/checkout@v4
         with:
           persist-credentials: false
           ref: ${{ github.event.inputs.branch }}
-      - uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a # v4
+      - uses: actions/setup-node@v4
         with:
           node-version: "22.x"
           registry-url: "https://registry.npmjs.org"
       - run: npm install -g npm
       - run: npm install
       - run: npm test
-      - name: npm publish
-        run: |
-          version=$(jq -r .version package.json)
-          tag_meta=$(echo "$version" | cut -s -d '-' -f2)
-          if [[ -z "$tag_meta" ]]; then
-            npm publish --provenance --access public
-          else
-            tag=$(echo "$tag_meta" | cut -d '.' -f1)
-            npm publish --provenance --access public --tag "$tag"
-          fi
+      - run: npm publish --provenance --access public
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
-      - name: Publish version on GitHub
-        run: |
+      - run: |
           version=$(jq -r .version package.json)
-          tag_meta=$(echo "$version" | cut -s -d '-' -f2)
-          if [[ -z "$tag_meta" ]]; then
-            gh release create \
-              -n "[Changelog](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/$BRANCH_NAME/changelog-client.html)"
-              --target "$BRANCH_NAME" \
-              --title "v$version" \
-              "v$version"
-          else
-            tag_main=$(echo "$version" | cut -d '-' -f1)
-            gh release create \
-              -n "This is a $tag_main pre-release. Changes may not be stable." \
-              --latest=false \
-              --prerelease \
-              --target "$BRANCH_NAME" \
-              --title "v$version" \
-              "v$version"
-          fi
+          gh release create \
+            -n "[Changelog](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/$BRANCH_NAME/changelog-client.html)" \
+            --target "$BRANCH_NAME" \
+            -t "v$version" \
+            "v$version"
         env:
           BRANCH_NAME: ${{ github.event.inputs.branch }}
           GH_TOKEN: ${{ github.token }}

.github/workflows/serverless-patch.sh

@@ -0,0 +1,43 @@
+#!/usr/bin/env bash
+
+set -exuo pipefail
+
+merge_commit_sha=$(jq -r '.pull_request.merge_commit_sha' "$GITHUB_EVENT_PATH")
+pull_request_id=$(jq -r '.pull_request.number' "$GITHUB_EVENT_PATH")
+pr_shortcode="elastic/elasticsearch-js#$pull_request_id"
+
+# generate patch file
+cd "$GITHUB_WORKSPACE/stack"
+git format-patch -1 --stdout "$merge_commit_sha" > /tmp/patch.diff
+
+# set committer info
+git config --global user.email "elasticmachine@users.noreply.github.com"
+git config --global user.name "Elastic Machine"
+
+# apply patch file
+cd "$GITHUB_WORKSPACE/serverless"
+git am -C1 --reject /tmp/patch.diff || git am --quit
+
+# generate PR body comment
+comment="Patch applied from $pr_shortcode"
+
+# enumerate rejected patches in PR comment
+has_rejects='false'
+for f in ./**/*.rej; do
+  has_rejects='true'
+  comment="$comment
+
+## Rejected patch \`$f\` must be resolved:
+
+\`\`\`diff
+$(cat "$f")
+\`\`\`
+"
+done
+
+# delete .rej files
+rm -fv ./**/*.rej
+
+# send data to output parameters
+echo "$comment" > /tmp/pr_body
+echo "PR_DRAFT=$has_rejects" >> "$GITHUB_OUTPUT"

.github/workflows/serverless-patch.yml

@@ -0,0 +1,53 @@
+---
+name: Apply PR changes to serverless
+on:
+  pull_request_target:
+    types:
+      - closed
+      - labeled
+
+jobs:
+  apply-patch:
+    name: Apply patch
+    runs-on: ubuntu-latest
+    # Only react to merged PRs for security reasons.
+    # See https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#pull_request_target.
+    if: >
+      github.event.pull_request.merged
+      && (
+        (
+          github.event.action == 'closed'
+          && contains(github.event.pull_request.labels.*.name, 'apply-to-serverless')
+        )
+        ||
+        (
+          github.event.action == 'labeled'
+          && github.event.label.name == 'apply-to-serverless'
+        )
+      )
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+          repository: elastic/elasticsearch-js
+          ref: main
+          path: stack
+          fetch-depth: 0
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+          repository: elastic/elasticsearch-serverless-js
+          ref: main
+          path: serverless
+      - name: Apply patch from stack to serverless
+        id: apply-patch
+        run: $GITHUB_WORKSPACE/stack/.github/workflows/serverless-patch.sh
+      - uses: peter-evans/create-pull-request@v6
+        with:
+          token: ${{ secrets.GH_TOKEN }}
+          path: serverless
+          title: "Apply patch from elastic/elasticsearch-js#${{ github.event.pull_request.number }}"
+          commit-message: "Apply patch from elastic/elasticsearch-js#${{ github.event.pull_request.number }}"
+          body-path: /tmp/pr_body
+          draft: "${{ steps.apply-patch.outputs.PR_DRAFT }}"
+          add-paths: ":!*.rej"

.github/workflows/stale.yml

@@ -1,21 +1,21 @@
 ---
-name: "Close stale issues and PRs"
+name: 'Close stale issues and PRs'
 on:
   schedule:
-    - cron: "30 1 * * *"
+    - cron: '30 1 * * *'
 
 jobs:
   stale:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/stale@5bef64f19d7facfb25b37b414482c7164d639639 # v9
+      - uses: actions/stale@v8
         with:
           stale-issue-label: stale
           stale-pr-label: stale
           days-before-stale: 90
           days-before-close: 14
-          exempt-issue-labels: "good first issue,tracking"
+          exempt-issue-labels: 'good first issue'
           close-issue-label: closed-stale
           close-pr-label: closed-stale
-          stale-issue-message: "This issue is stale because it has been open 90 days with no activity. Remove the `stale` label, or leave a comment, or this will be closed in 14 days."
-          stale-pr-message: "This pull request is stale because it has been open 90 days with no activity. Remove the `stale` label, or leave a comment, or this will be closed in 14 days."
+          stale-issue-message: 'This issue is stale because it has been open 90 days with no activity. Remove the `stale` label, or leave a comment, or this will be closed in 14 days.'
+          stale-pr-message: 'This pull request is stale because it has been open 90 days with no activity. Remove the `stale` label, or leave a comment, or this will be closed in 14 days.'

catalog-info.yaml

@@ -28,9 +28,6 @@ spec:
     spec:
       repository: elastic/elasticsearch-js
       pipeline_file: .buildkite/pipeline.yml
-      env:
-        ELASTIC_SLACK_NOTIFICATIONS_ENABLED: "true"
-        SLACK_NOTIFICATIONS_CHANNEL: "#devtools-notify-javascript"
       teams:
         devtools-team:
           access_level: MANAGE_BUILD_AND_READ
@@ -45,12 +42,6 @@ spec:
         main:
           branch: "main"
           cronline: "@daily"
-        8_x:
-          branch: "8.x"
-          cronline: "@daily"
-        8_17:
-          branch: "8.17"
-          cronline: "@daily"
-        8_18:
-          branch: "8.18"
+        8_14:
+          branch: "8.14"
           cronline: "@daily"

docs/advanced-config.asciidoc

@@ -1,27 +1,25 @@
----
-mapped_pages:
-  - https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/advanced-config.html
----
+[[advanced-config]]
+=== Advanced configuration
 
-# Advanced configuration [advanced-config]
-
-If you need to customize the client behavior heavily, you are in the right place! The client enables you to customize the following internals:
+If you need to customize the client behavior heavily, you are in the right 
+place! The client enables you to customize the following internals:
 
 * `ConnectionPool` class
 * `Connection` class
 * `Serializer` class
 
-::::{note}
-For information about the `Transport` class, refer to [Transport](/reference/transport.md).
-::::
+NOTE: For information about the `Transport` class, refer to <<transport>>.
 
 
+[discrete]
+==== `ConnectionPool`
 
-## `ConnectionPool` [_connectionpool]
+This class is responsible for keeping in memory all the {es} Connection that you 
+are using. There is a single Connection for every node. The connection pool 
+handles the resurrection strategies and the updates of the pool.
 
-This class is responsible for keeping in memory all the {{es}} Connection that you are using. There is a single Connection for every node. The connection pool handles the resurrection strategies and the updates of the pool.
-
-```js
+[source,js]
+----
 const { Client, ConnectionPool } = require('@elastic/elasticsearch')
 
 class MyConnectionPool extends ConnectionPool {
@@ -36,14 +34,19 @@ const client = new Client({
   cloud: { id: '<cloud-id>' },
   auth: { apiKey: 'base64EncodedKey' }
 })
-```
+----
 
 
-## `Connection` [_connection]
+[discrete]
+==== `Connection`
 
-This class represents a single node, it holds every information we have on the node, such as roles, id, URL, custom headers and so on. The actual HTTP request is performed here, this means that if you want to swap the default HTTP client (Node.js core), you should override the `request` method of this class.
+This class represents a single node, it holds every information we have on the 
+node, such as roles, id, URL, custom headers and so on. The actual HTTP request 
+is performed here, this means that if you want to swap the default HTTP client 
+(Node.js core), you should override the `request` method of this class.
 
-```js
+[source,js]
+----
 const { Client, BaseConnection } = require('@elastic/elasticsearch')
 
 class MyConnection extends BaseConnection {
@@ -57,19 +60,22 @@ const client = new Client({
   cloud: { id: '<cloud-id>' },
   auth: { apiKey: 'base64EncodedKey' }
 })
-```
+----
 
 
-## `Serializer` [_serializer]
+[discrete]
+==== `Serializer`
 
-This class is responsible for the serialization of every request, it offers the following methods:
+This class is responsible for the serialization of every request, it offers the 
+following methods:
 
 * `serialize(object: any): string;` serializes request objects.
 * `deserialize(json: string): any;` deserializes response strings.
 * `ndserialize(array: any[]): string;` serializes bulk request objects.
 * `qserialize(object: any): string;` serializes request query parameters.
 
-```js
+[source,js]
+----
 const { Client, Serializer } = require('@elastic/elasticsearch')
 
 class MySerializer extends Serializer {
@@ -83,10 +89,11 @@ const client = new Client({
   cloud: { id: '<cloud-id>' },
   auth: { apiKey: 'base64EncodedKey' }
 })
-```
+----
 
-
-## Redaction of potentially sensitive data [redaction]
+[discrete]
+[[redaction]]
+==== Redaction of potentially sensitive data
 
 When the client raises an `Error` that originated at the HTTP layer, like a `ConnectionError` or `TimeoutError`, a `meta` object is often attached to the error object that includes metadata useful for debugging, like request and response information. Because this can include potentially sensitive data, like authentication secrets in an `Authorization` header, the client takes measures to redact common sources of sensitive data when this metadata is attached and serialized.
 
@@ -94,7 +101,8 @@ If your configuration requires extra headers or other configurations that may in
 
 By default, the `redaction` option is set to `{ type: 'replace' }`, which recursively searches for sensitive key names, case insensitive, and replaces their values with the string `[redacted]`.
 
-```js
+[source,js]
+----
 const { Client } = require('@elastic/elasticsearch')
 
 const client = new Client({
@@ -107,11 +115,12 @@ try {
 } catch (err) {
   console.log(err.meta.meta.request.options.headers.authorization) // prints "[redacted]"
 }
-```
+----
 
 If you would like to redact additional properties, you can include additional key names to search and replace:
 
-```js
+[source,js]
+----
 const { Client } = require('@elastic/elasticsearch')
 
 const client = new Client({
@@ -129,11 +138,12 @@ try {
 } catch (err) {
   console.log(err.meta.meta.request.options.headers['X-My-Secret-Password']) // prints "[redacted]"
 }
-```
+----
 
-Alternatively, if you know you’re not going to use the metadata at all, setting the redaction type to `remove` will remove all optional sources of potentially sensitive data entirely, or replacing them with `null` for required properties.
+Alternatively, if you know you're not going to use the metadata at all, setting the redaction type to `remove` will remove all optional sources of potentially sensitive data entirely, or replacing them with `null` for required properties.
 
-```js
+[source,js]
+----
 const { Client } = require('@elastic/elasticsearch')
 
 const client = new Client({
@@ -147,16 +157,14 @@ try {
 } catch (err) {
   console.log(err.meta.meta.request.options.headers) // undefined
 }
-```
+----
 
 Finally, if you prefer to turn off redaction altogether, perhaps while debugging on a local developer environment, you can set the redaction type to `off`. This will revert the client to pre-8.11.0 behavior, where basic redaction is only performed during common serialization methods like `console.log` and `JSON.stringify`.
 
-::::{warning}
-Setting `redaction.type` to `off` is not recommended in production environments.
-::::
+WARNING: Setting `redaction.type` to `off` is not recommended in production environments.
 
-
-```js
+[source,js]
+----
 const { Client } = require('@elastic/elasticsearch')
 
 const client = new Client({
@@ -170,10 +178,18 @@ try {
 } catch (err) {
   console.log(err.meta.meta.request.options.headers.authorization) // the actual header value will be logged
 }
-```
+----
 
+[discrete]
+==== Migrate to v8
 
-## Migrate to v8 [_migrate_to_v8]
-
-The Node.js client can be configured to emit an HTTP header `Accept: application/vnd.elasticsearch+json; compatible-with=7` which signals to Elasticsearch that the client is requesting `7.x` version of request and response bodies. This allows for upgrading from 7.x to 8.x version of Elasticsearch without upgrading everything at once. Elasticsearch should be upgraded first after the compatibility header is configured and clients should be upgraded second. To enable to setting, configure the environment variable `ELASTIC_CLIENT_APIVERSIONING` to `true`.
-
+The Node.js client can be configured to emit an HTTP header
+`Accept: application/vnd.elasticsearch+json; compatible-with=7`
+which signals to Elasticsearch that the client is requesting
+`7.x` version of request and response bodies. This allows for
+upgrading from 7.x to 8.x version of Elasticsearch without upgrading
+everything at once. Elasticsearch should be upgraded first after
+the compatibility header is configured and clients should be upgraded
+second.
+To enable to setting, configure the environment variable
+`ELASTIC_CLIENT_APIVERSIONING` to `true`.

docs/basic-config.asciidoc

@@ -0,0 +1,270 @@
+[[basic-config]]
+=== Basic configuration
+
+This page shows you the possible basic configuration options that the clients
+offers.
+
+
+[source,js]
+----
+const { Client } = require('@elastic/elasticsearch')
+
+const client = new Client({
+  cloud: { id: '<cloud-id>' },
+  auth: { apiKey: 'base64EncodedKey' },
+  maxRetries: 5,
+  requestTimeout: 60000,
+  sniffOnStart: true
+})
+----
+
+
+[cols=2*]
+|===
+|`node` or `nodes`
+a|The Elasticsearch endpoint to use. +
+It can be a single string or an array of strings:
+[source,js]
+----
+node: 'http://localhost:9200'
+----
+Or it can be an object (or an array of objects) that represents the node:
+[source,js]
+----
+node: {
+  url: new URL('http://localhost:9200'),
+  tls: 'tls options',
+  agent: 'http agent options',
+  id: 'custom node id',
+  headers: { 'custom': 'headers' }
+  roles: {
+    master: true,
+    data: true,
+    ingest: true,
+    ml: false
+  }
+}
+----
+
+|`auth`
+a|Your authentication data. You can use both basic authentication and
+{ref}/security-api-create-api-key.html[ApiKey]. +
+See <<authentication,Authentication>> for more details. +
+_Default:_ `null`
+
+Basic authentication:
+[source,js]
+----
+auth: {
+  username: 'elastic',
+  password: 'changeme'
+}
+----
+{ref}/security-api-create-api-key.html[ApiKey] authentication:
+[source,js]
+----
+auth: {
+  apiKey: 'base64EncodedKey'
+}
+----
+Bearer authentication, useful for https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-service-token.html[service account tokens]. Be aware that it does not handle automatic token refresh:
+[source,js]
+----
+auth: {
+  bearer: 'token'
+}
+----
+
+
+|`maxRetries`
+|`number` - Max number of retries for each request. +
+_Default:_ `3`
+
+|`requestTimeout`
+|`number` - Max request timeout in milliseconds for each request. +
+_Default:_ `30000`
+
+|`pingTimeout`
+|`number` - Max ping request timeout in milliseconds for each request. +
+_Default:_ `3000`
+
+|`sniffInterval`
+|`number, boolean` - Perform a sniff operation every `n` milliseconds. Sniffing might not be the best solution for you, take a look https://www.elastic.co/blog/elasticsearch-sniffing-best-practices-what-when-why-how[here] to know more. +
+_Default:_ `false`
+
+|`sniffOnStart`
+|`boolean` - Perform a sniff once the client is started. Sniffing might not be the best solution for you, take a look https://www.elastic.co/blog/elasticsearch-sniffing-best-practices-what-when-why-how[here] to know more. +
+_Default:_ `false`
+
+|`sniffEndpoint`
+|`string` - Endpoint to ping during a sniff. +
+_Default:_ `'_nodes/_all/http'`
+
+|`sniffOnConnectionFault`
+|`boolean` - Perform a sniff on connection fault. Sniffing might not be the best solution for you, take a look https://www.elastic.co/blog/elasticsearch-sniffing-best-practices-what-when-why-how[here] to know more. +
+_Default:_ `false`
+
+|`resurrectStrategy`
+|`string` - Configure the node resurrection strategy. +
+_Options:_ `'ping'`, `'optimistic'`, `'none'` +
+_Default:_ `'ping'`
+
+|`suggestCompression`
+|`boolean` - Adds `accept-encoding` header to every request. +
+_Default:_ `false`
+
+|`compression`
+|`string, boolean` - Enables gzip request body compression. +
+_Options:_ `'gzip'`, `false` +
+_Default:_ `false`
+
+|`tls`
+|`http.SecureContextOptions` - tls https://nodejs.org/api/tls.html[configuraton]. +
+_Default:_ `null`
+
+|`proxy`
+a|`string, URL` - If you are using an http(s) proxy, you can put its url here.
+The client will automatically handle the connection to it. +
+_Default:_ `null`
+[source,js]
+----
+const client = new Client({
+  node: 'http://localhost:9200',
+  proxy: 'http://localhost:8080'
+})
+
+// Proxy with basic authentication
+const client = new Client({
+  node: 'http://localhost:9200',
+  proxy: 'http://user:pwd@localhost:8080'
+})
+----
+
+|`agent`
+a|`http.AgentOptions, function` - http agent https://nodejs.org/api/http.html#http_new_agent_options[options],
+or a function that returns an actual http agent instance. If you want to disable the http agent use entirely
+(and disable the `keep-alive` feature), set the agent to `false`. +
+_Default:_ `null`
+[source,js]
+----
+const client = new Client({
+  node: 'http://localhost:9200',
+  agent: { agent: 'options' }
+})
+
+const client = new Client({
+  node: 'http://localhost:9200',
+  // the function takes as parameter the option
+  // object passed to the Connection constructor
+  agent: (opts) => new CustomAgent()
+})
+
+const client = new Client({
+  node: 'http://localhost:9200',
+  // Disable agent and keep-alive
+  agent: false
+})
+----
+
+|`nodeFilter`
+a|`function` - Filters which node not to use for a request. +
+_Default:_
+[source,js]
+----
+function defaultNodeFilter (node) {
+  // avoid master only nodes
+  if (node.roles.master === true &&
+      node.roles.data === false &&
+      node.roles.ingest === false) {
+    return false
+  }
+  return true
+}
+----
+
+|`nodeSelector`
+a|`function` - custom selection strategy. +
+_Options:_ `'round-robin'`, `'random'`, custom function +
+_Default:_ `'round-robin'` +
+_Custom function example:_
+[source,js]
+----
+function nodeSelector (connections) {
+  const index = calculateIndex()
+  return connections[index]
+}
+----
+
+|`generateRequestId`
+a|`function` - function to generate the request id for every request, it takes
+two parameters, the request parameters and options. +
+By default it generates an incremental integer for every request. +
+_Custom function example:_
+[source,js]
+----
+function generateRequestId (params, options) {
+  // your id generation logic
+  // must be syncronous
+  return 'id'
+}
+----
+
+|`name`
+|`string, symbol` - The name to identify the client instance in the events. +
+_Default:_ `elasticsearch-js`
+
+|`opaqueIdPrefix`
+|`string` - A string that will be use to prefix any `X-Opaque-Id` header. +
+See https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/observability.html#_x-opaque-id_support[`X-Opaque-Id` support] for more details. +
+_Default:_ `null`
+
+|`headers`
+|`object` - A set of custom headers to send in every request. +
+_Default:_ `{}`
+
+|`context`
+|`object` - A custom object that you can use for observability in your events.
+It will be merged with the API level context option. +
+_Default:_ `null`
+
+|`enableMetaHeader`
+|`boolean` - If true, adds an header named `'x-elastic-client-meta'`, containing some minimal telemetry data,
+such as the client and platform version. +
+_Default:_ `true`
+
+|`cloud`
+a|`object` - Custom configuration for connecting to
+https://cloud.elastic.co[Elastic Cloud]. See https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/auth-reference.html[Authentication]
+for more details. +
+_Default:_ `null` +
+_Cloud configuration example:_
+[source,js]
+----
+const client = new Client({
+  cloud: {
+    id: '<cloud-id>'
+  },
+  auth: {
+    username: 'elastic',
+    password: 'changeme'
+  }
+})
+----
+
+|`disablePrototypePoisoningProtection`
+|`boolean`, `'proto'`, `'constructor'` - The client can protect you against prototype poisoning attacks. Read https://web.archive.org/web/20200319091159/https://hueniverse.com/square-brackets-are-the-enemy-ff5b9fd8a3e8?gi=184a27ee2a08[this article] to learn more about this security concern. If needed, you can enable prototype poisoning protection entirely (`false`) or one of the two checks (`'proto'` or `'constructor'`). For performance reasons, it is disabled by default. Read the `secure-json-parse` https://github.com/fastify/secure-json-parse[documentation] to learn more. +
+_Default:_ `true`
+
+|`caFingerprint`
+|`string` - If configured, verify that the fingerprint of the CA certificate that has signed the certificate of the server matches the supplied fingerprint. Only accepts SHA256 digest fingerprints. +
+_Default:_ `null`
+
+|`maxResponseSize`
+|`number` - When configured, it verifies that the uncompressed response size is lower than the configured number, if it's higher it will abort the request. It cannot be higher than buffer.constants.MAX_STRING_LENGTH +
+_Default:_ `null`
+
+|`maxCompressedResponseSize`
+|`number` - When configured, it verifies that the compressed response size is lower than the configured number, if it's higher it will abort the request. It cannot be higher than buffer.constants.MAX_LENGTH +
+_Default:_ `null`
+
+|===

docs/changelog.asciidoc

@@ -0,0 +1,905 @@
+[[changelog-client]]
+== Release notes
+
+[discrete]
+=== 8.16.3
+
+[discrete]
+==== Fixes
+
+[discrete]
+===== Improved support for Elasticsearch `v8.16`
+
+Updated TypeScript types based on fixes and improvements to the Elasticsearch specification.
+
+[discrete]
+=== 8.16.2
+
+[discrete]
+==== Fixes
+
+[discrete]
+===== Improved support for Elasticsearch `v8.16`
+
+Updated TypeScript types based on fixes and improvements to the Elasticsearch specification.
+
+[discrete]
+===== Drop testing artifacts from npm package
+
+Tap, the unit testing tool used by this project, was recently upgraded and started writing to a `.tap` directory. Since tests are run prior to an `npm publish` in CI, this directory was being included in the published package and bloating its size.
+
+[discrete]
+=== 8.16.1
+
+[discrete]
+==== Fixes
+
+[discrete]
+===== Fix ECMAScript imports
+
+Fixed package configuration to correctly support native ECMAScript `import` syntax.
+
+[discrete]
+=== 8.16.0
+
+[discrete]
+==== Features
+
+[discrete]
+===== Support for Elasticsearch `v8.16`
+
+You can find all the API changes
+https://www.elastic.co/guide/en/elasticsearch/reference/8.16/release-notes-8.16.0.html[here].
+
+[discrete]
+===== Support Apache Arrow in ES|QL helper
+
+The ES|QL helper can now return results as an Apache Arrow `Table` or `RecordBatchReader`, which enables high-performance calculations on ES|QL results, even if the response data is larger than the system's available memory. See <<esql-helper>> for more information.
+
+[discrete]
+==== Fixes
+
+[discrete]
+===== Pass prototype poisoning options to serializer correctly
+
+The client's `disablePrototypePoisoningProtection` option was set to `true` by default, but when it was set to any other value it was ignored, making it impossible to enable prototype poisoning protection without providing a custom serializer implementation.
+
+[discrete]
+=== 8.15.3
+
+[discrete]
+==== Fixes
+
+[discrete]
+===== Improved support for Elasticsearch `v8.15`
+
+Updated TypeScript types based on fixes and improvements to the Elasticsearch specification.
+
+[discrete]
+===== Drop testing artifacts from npm package
+
+Tap, the unit testing tool, was recently upgraded and started writing to a `.tap` directory. Since tests are run prior to an `npm publish` in CI, this directory was being included in the published package and bloating its size.
+
+[discrete]
+=== 8.15.2
+
+[discrete]
+==== Fixes
+
+[discrete]
+===== Improved support for Elasticsearch `v8.15`
+
+Updated TypeScript types based on fixes and improvements to the Elasticsearch specification.
+
+[discrete]
+=== 8.15.1
+
+[discrete]
+==== Fixes
+
+[discrete]
+===== Improved support for Elasticsearch `v8.15`
+
+Updated TypeScript types based on fixes and improvements to the Elasticsearch specification.
+
+[discrete]
+=== 8.15.0
+
+[discrete]
+==== Features
+
+[discrete]
+===== Support for Elasticsearch `v8.15.0`
+
+You can find all the API changes
+https://www.elastic.co/guide/en/elasticsearch/reference/8.15/release-notes-8.15.0.html[here].
+
+[discrete]
+===== OpenTelemetry zero-code instrumentation support
+
+For those that use an observability service that supports OpenTelemetry spans, the client will now automatically generate traces for each Elasticsearch request it makes.
+See {jsclient}/observability.html#_opentelemetry[the docs]
+for more information.
+
+[discrete]
+=== 8.14.1
+
+[discrete]
+==== Features
+
+[discrete]
+===== Improved support for Elasticsearch `8.14`
+
+Updated types based on fixes and changes to the Elasticsearch specification.
+
+[discrete]
+=== 8.14.0
+
+[discrete]
+==== Features
+
+[discrete]
+===== Support for Elasticsearch `v8.14.0`
+
+You can find all the API changes
+https://www.elastic.co/guide/en/elasticsearch/reference/8.14/release-notes-8.14.0.html[here].
+
+[discrete]
+===== ES|QL object API helper
+
+A helper method has been added that parses the response of an ES|QL query and converts it into an array of objects.
+A TypeScript type parameter can also be provided to improve developer experience when working with the result. https://github.com/elastic/elasticsearch-js/pull/2238[#2238]
+
+[discrete]
+===== `onSuccess` callback added to bulk helper
+
+The bulk helper now supports an `onSuccess` callback that will be called for each successful operation. https://github.com/elastic/elasticsearch-js/pull/2199[#2199]
+
+[discrete]
+===== Request retries are more polite
+
+https://github.com/elastic/elastic-transport-js/releases/tag/v8.6.0[`@elastic/transport` v8.6.0] was released, which refactored when and how failed requests are retried. Timed-out requests are no longer retried by default, and retries now use exponential backoff rather than running immediately.
+
+
+[discrete]
+=== 8.13.1
+
+[discrete]
+==== Fixes
+
+[discrete]
+===== Pin @elastic/transport to `~8.4.1`
+
+Switching from `^8.4.1` to `~8.4.1` ensures 8.13 client users are not required to update to Node.js v18+, which is a new requirement set by `@elastic/transport` v8.5.0. See https://github.com/elastic/elastic-transport-js/issues/91[elastic/elastic-transport-js#91] for details.
+
+v8.13.0 was also released depending on v8.4.0 of `@elastic/transport` instead of v8.4.1, which was unintentional.
+
+[discrete]
+=== 8.13.0
+
+[discrete]
+==== Features
+
+[discrete]
+===== Support for Elasticsearch `v8.13.0`
+
+You can find all the API changes
+https://www.elastic.co/guide/en/elasticsearch/reference/8.13/release-notes-8.13.0.html[here].
+
+[discrete]
+==== Fixes
+
+[discrete]
+===== Ensure new connections inherit client's set defaults https://github.com/elastic/elasticsearch-js/pull/2159[#2159]
+
+When instantiating a client, any connection-related defaults (e.g. `requestTimeout`) set on that client instance would not be inherited by nodes if they were entered as strings rather than a `ConnectionOptions` object.
+
+[discrete]
+=== 8.12.3
+
+[discrete]
+==== Fixes
+
+[discrete]
+===== Bump @elastic/transport to `~8.4.1`
+
+Switching from `^8.4.1` to `~8.4.1` ensures 8.12 client users are not required to update to Node.js v18+, which is a new requirement set by `@elastic/transport` v8.5.0. See https://github.com/elastic/elastic-transport-js/issues/91[elastic/elastic-transport-js#91] for details.
+
+[discrete]
+=== 8.12.2
+
+[discrete]
+==== Fixes
+
+[discrete]
+===== Upgrade transport to 8.4.1 https://github.com/elastic/elasticsearch-js/pull/2137[#2137]
+
+Upgrades `@elastic/transport` to 8.4.1 to resolve https://github.com/elastic/elastic-transport-js/pull/83[a bug] where arrays in error diagnostics were unintentionally transformed into objects.
+
+[discrete]
+=== 8.12.1
+
+[discrete]
+==== Fixes
+
+[discrete]
+===== Fix hang in bulk helper semaphore https://github.com/elastic/elasticsearch-js/pull/2027[#2027]
+
+The failing state could be reached when a server's response times are slower than flushInterval.
+
+[discrete]
+=== 8.12.0
+
+[discrete]
+=== Features
+
+[discrete]
+===== Support for Elasticsearch `v8.12.0`
+
+You can find all the API changes
+https://www.elastic.co/guide/en/elasticsearch/reference/8.12/release-notes-8.12.0.html[here].
+
+[discrete]
+=== 8.11.1
+
+[discrete]
+==== Fixes
+
+[discrete]
+===== Bump @elastic/transport to `~8.4.0`
+
+Switching from `^8.4.0` to `~8.4.0` ensures 8.11 client users are not required to update to Node.js v18+, which is a new requirement set by `@elastic/transport` v8.5.0. See https://github.com/elastic/elastic-transport-js/issues/91[elastic/elastic-transport-js#91] for details.
+
+[discrete]
+=== 8.11.0
+
+[discrete]
+==== Features
+
+[discrete]
+===== Support for Elasticsearch `v8.11.0`
+
+You can find all the API changes
+https://www.elastic.co/guide/en/elasticsearch/reference/8.11/release-notes-8.11.0.html[here].
+
+[discrete]
+===== Enhanced support for redacting potentially sensitive data https://github.com/elastic/elasticsearch-js/pull/2095[#2095]
+
+`@elastic/transport` https://github.com/elastic/elastic-transport-js/releases/tag/v8.4.0[version 8.4.0] introduces enhanced measures for ensuring that request metadata attached to some `Error` objects is redacted. This functionality is primarily to address custom logging solutions that don't use common serialization methods like `JSON.stringify`, `console.log`, or `util.inspect`, which were already accounted for.
+
+See <<redaction>> for more information.
+
+[discrete]
+=== 8.10.1
+
+[discrete]
+==== Fixes
+
+[discrete]
+===== Bump @elastic/transport to `~8.3.4`
+
+Switching from `^8.3.4` to `~8.3.4` ensures 8.10 client users are not required to update to Node.js v18+, which is a new requirement set by `@elastic/transport` v8.5.0. See https://github.com/elastic/elastic-transport-js/issues/91[elastic/elastic-transport-js#91] for details.
+
+[discrete]
+=== 8.10.0
+
+[discrete]
+==== Features
+
+[discrete]
+===== Support for Elasticsearch `v8.10.0`
+
+You can find all the API changes
+https://www.elastic.co/guide/en/elasticsearch/reference/8.10/release-notes-8.10.0.html[here].
+
+[discrete]
+=== 8.9.2
+
+[discrete]
+==== Fixes
+
+[discrete]
+===== Bump @elastic/transport to `~8.3.4`
+
+Switching from `^8.3.4` to `~8.3.4` ensures 8.9 client users are not required to update to Node.js v18+, which is a new requirement set by `@elastic/transport` v8.5.0. See https://github.com/elastic/elastic-transport-js/issues/91[elastic/elastic-transport-js#91] for details.
+
+[discrete]
+=== 8.9.1
+
+[discrete]
+==== Fixes
+
+[discrete]
+===== Upgrade Transport https://github.com/elastic/elasticsearch-js/pull/1968[#1968]
+
+Upgrades `@elastic/transport` to the latest patch release to fix https://github.com/elastic/elastic-transport-js/pull/69[a bug] that could cause the process to exit when handling malformed `HEAD` requests.
+
+[discrete]
+=== 8.9.0
+
+[discrete]
+==== Features
+
+[discrete]
+===== Support for Elasticsearch `v8.9.0`
+
+You can find all the API changes
+https://www.elastic.co/guide/en/elasticsearch/reference/8.9/release-notes-8.9.0.html[here].
+
+[discrete]
+===== Allow document to be overwritten in `onDocument` iteratee of bulk helper https://github.com/elastic/elasticsearch-js/pull/1732[#1732]
+
+In the {jsclient}/client-helpers.html#bulk-helper[bulk helper], documents could not be modified before being sent to Elasticsearch. It is now possible to {jsclient}/client-helpers.html#_modifying_a_document_before_operation[modify a document] before sending it.
+
+[discrete]
+==== Fixes
+
+[discrete]
+===== Updated `user-agent` header https://github.com/elastic/elasticsearch-js/pull/1954[#1954]
+
+The `user-agent` header the client used to connect to Elasticsearch was using a non-standard format that has been improved.
+
+[discrete]
+=== 8.8.2
+
+[discrete]
+==== Fixes
+
+[discrete]
+===== Bump @elastic/transport to `~8.3.2`
+
+Switching from `^8.3.2` to `~8.3.2` ensures 8.8 client users are not required to update to Node.js v18+, which is a new requirement set by `@elastic/transport` v8.5.0. See https://github.com/elastic/elastic-transport-js/issues/91[elastic/elastic-transport-js#91] for details.
+
+[discrete]
+=== 8.8.1
+
+[discrete]
+==== Features
+
+[discrete]
+===== Support for Elasticsearch `v8.8.1`
+
+You can find all the API changes
+https://www.elastic.co/guide/en/elasticsearch/reference/8.8/release-notes-8.8.1.html[here].
+
+[discrete]
+==== Fixes
+
+[discrete]
+===== Fix index drift bug in bulk helper https://github.com/elastic/elasticsearch-js/pull/1759[#1759]
+
+Fixes a bug in the bulk helper that would cause `onDrop` to send back the wrong JSON document or error on a nonexistent document when an error occurred on a bulk HTTP request that contained a `delete` action.
+
+[discrete]
+===== Fix a memory leak caused by an outdated version of Undici https://github.com/elastic/elasticsearch-js/pull/1902[#1902]
+
+Undici 5.5.1, used by https://github.com/elastic/elastic-transport-js[elastic-transport-js], could create a memory leak when a high volume of requests created too many HTTP `abort` listeners. Upgrading Undici to 5.22.1 removed the memory leak.
+
+[discrete]
+=== 8.8.0
+
+[discrete]
+==== Features
+
+[discrete]
+===== Support for Elasticsearch `v8.8.0`
+
+You can find all the API changes
+https://www.elastic.co/guide/en/elasticsearch/reference/8.8/release-notes-8.8.0.html[here].
+
+[discrete]
+==== Fixes
+
+[discrete]
+===== Fix type declarations for legacy types with a body key https://github.com/elastic/elasticsearch-js/pull/1784[#1784]
+
+Prior releases contained a bug where type declarations for legacy types that include a `body` key were not actually importing the type that includes the `body` key.
+
+[discrete]
+=== 8.7.3
+
+[discrete]
+==== Fixes
+
+[discrete]
+===== Bump @elastic/transport to `~8.3.1`
+
+Switching from `^8.3.1` to `~8.3.1` ensures 8.7 client users are not required to update to Node.js v18+, which is a new requirement set by `@elastic/transport` v8.5.0. See https://github.com/elastic/elastic-transport-js/issues/91[elastic/elastic-transport-js#91] for details.
+
+[discrete]
+=== 8.7.0
+
+[discrete]
+===== Support for Elasticsearch `v8.7.0`
+
+You can find all the API changes
+https://www.elastic.co/guide/en/elasticsearch/reference/8.7/release-notes-8.7.0.html[here].
+
+[discrete]
+=== 8.6.1
+
+[discrete]
+==== Fixes
+
+[discrete]
+===== Bump @elastic/transport to `~8.3.1`
+
+Switching from `^8.3.1` to `~8.3.1` ensures 8.6 client users are not required to update to Node.js v18+, which is a new requirement set by `@elastic/transport` v8.5.0. See https://github.com/elastic/elastic-transport-js/issues/91[elastic/elastic-transport-js#91] for details.
+
+[discrete]
+=== 8.6.0
+
+[discrete]
+===== Bump @elastic/transport to 8.3.1+ https://github.com/elastic/elasticsearch-js/pull/1802[#1802]
+
+The `@elastic/transport` dependency has been bumped to `~8.3.1` to ensure
+fixes to the `maxResponseSize` option are available in the client.
+
+[discrete]
+===== Support for Elasticsearch `v8.6.0`
+
+You can find all the API changes
+https://www.elastic.co/guide/en/elasticsearch/reference/8.6/release-notes-8.6.0.html[here].
+
+[discrete]
+=== 8.5.0
+
+[discrete]
+===== Support for Elasticsearch `v8.5.0`
+
+You can find all the API changes
+https://www.elastic.co/guide/en/elasticsearch/reference/8.5/release-notes-8.5.0.html[here].
+
+[discrete]
+=== 8.4.0
+
+[discrete]
+===== Support for Elasticsearch `v8.4.0`
+
+You can find all the API changes
+https://www.elastic.co/guide/en/elasticsearch/reference/8.4/release-notes-8.4.0.html[here].
+
+[discrete]
+=== 8.2.1
+
+[discrete]
+==== Fixes
+
+[discrete]
+===== Support for Elasticsearch `v8.2.1`
+
+You can find all the API changes
+https://www.elastic.co/guide/en/elasticsearch/reference/8.2/release-notes-8.2.1.html[here].
+
+[discrete]
+===== Fix ndjson APIs https://github.com/elastic/elasticsearch-js/pull/1688[#1688]
+
+The previous release contained a bug that broken ndjson APIs.
+We have released `v8.2.0-patch.1` to address this.
+This fix is the same as the one we have released and we strongly recommend upgrading to this version.
+
+[discrete]
+===== Fix node shutdown apis https://github.com/elastic/elasticsearch-js/pull/1697[#1697]
+
+The shutdown APIs wheren't complete, this fix completes them.
+
+[discrete]
+==== Types: move query keys to body https://github.com/elastic/elasticsearch-js/pull/1693[#1693]
+
+The types definitions where wrongly representing the types of fields present in both query and body.
+
+[discrete]
+=== 8.2.0
+
+[discrete]
+==== Breaking changes
+
+[discrete]
+===== Drop Node.js v12 https://github.com/elastic/elasticsearch-js/pull/1670[#1670]
+
+According to our https://github.com/elastic/elasticsearch-js#nodejs-support[Node.js support matrix].
+
+[discrete]
+==== Features
+
+[discrete]
+===== Support for Elasticsearch `v8.2`
+
+You can find all the API changes
+https://www.elastic.co/guide/en/elasticsearch/reference/8.2/release-notes-8.2.0.html[here].
+
+[discrete]
+===== More lenient parameter checks https://github.com/elastic/elasticsearch-js/pull/1662[#1662]
+
+When creating a new client, an `undefined` `caFingerprint` no longer trigger an error for a http connection.
+
+[discrete]
+===== Update TypeScript docs and export estypes https://github.com/elastic/elasticsearch-js/pull/1675[#1675]
+
+You can import the full TypeScript requests & responses definitions as it follows:
+[source,ts]
+----
+import { estypes } from '@elastic/elasticsearch'
+----
+
+If you need the legacy definitions with the body, you can do the following:
+
+[source,ts]
+----
+import { estypesWithBody } from '@elastic/elasticsearch'
+----
+
+[discrete]
+==== Fixes
+
+[discrete]
+===== Updated hpagent to the latest version https://github.com/elastic/elastic-transport-js/pull/49[transport/#49]
+
+You can fing the related changes https://github.com/delvedor/hpagent/releases/tag/v1.0.0[here].
+
+[discrete]
+=== 8.1.0
+
+[discrete]
+==== Features
+
+[discrete]
+===== Support for Elasticsearch `v8.1`
+
+You can find all the API changes
+https://www.elastic.co/guide/en/elasticsearch/reference/8.1/release-notes-8.1.0.html[here].
+
+[discrete]
+===== Export SniffingTransport https://github.com/elastic/elasticsearch-js/pull/1653[#1653]
+
+Now the client exports the SniffingTransport class.
+
+[discrete]
+==== Fixes
+
+[discrete]
+===== Fix onFlushTimeout timer not being cleared when upstream errors https://github.com/elastic/elasticsearch-js/pull/1616[#1616]
+
+Fixes a memory leak caused by an error in the upstream dataset of the bulk helper.
+
+[discrete]
+===== Cleanup abort listener https://github.com/elastic/elastic-transport-js/pull/42[transport/#42]
+
+The legacy http client was not cleaning up the abort listener, which could cause a memory leak.
+
+[discrete]
+===== Improve undici performances https://github.com/elastic/elastic-transport-js/pull/41[transport/#41]
+
+Improve the stream body collection and keep alive timeout.
+
+[discrete]
+=== 8.0.0
+
+[discrete]
+==== Features
+
+[discrete]
+===== Support for Elasticsearch `v8.0`
+
+You can find all the API changes
+https://www.elastic.co/guide/en/elasticsearch/reference/8.0/release-notes-8.0.0.html[here].
+
+[discrete]
+===== Drop old typescript definitions
+
+*Breaking: Yes* | *Migration effort: Medium*
+
+The current TypeScript definitions will be removed from the client, and the new definitions, which contain request and response definitions as well will be shipped by default.
+
+[discrete]
+===== Drop callback-style API
+
+*Breaking: Yes* | *Migration effort: Large*
+
+Maintaining both API styles is not a problem per se, but it makes error handling more convoluted due to async stack traces.
+Moving to a full-promise API will solve this issue.
+
+[source,js]
+----
+// callback-style api
+client.search({ params }, { options }, (err, result) => {
+ console.log(err || result)
+})
+
+// promise-style api
+client.search({ params }, { options })
+  .then(console.log)
+  .catch(console.log)
+
+// async-style (sugar syntax on top of promises)
+const response = await client.search({ params }, { options })
+console.log(response)
+----
+
+If you are already using the promise-style API, this won't be a breaking change for you.
+
+[discrete]
+===== Remove the current abort API and use the new AbortController standard
+
+*Breaking: Yes* | *Migration effort: Small*
+
+The old abort API makes sense for callbacks but it's annoying to use with promises
+
+[source,js]
+----
+// callback-style api
+const request = client.search({ params }, { options }, (err, result) => {
+ console.log(err) // RequestAbortedError
+})
+
+request.abort()
+
+// promise-style api
+const promise = client.search({ params }, { options })
+
+promise
+  .then(console.log)
+  .catch(console.log) // RequestAbortedError
+
+promise.abort()
+----
+
+Node v12 has added the standard https://nodejs.org/api/globals.html#globals_class_abortcontroller[`AbortController`] API which is designed to work well with both callbacks and promises.
+[source,js]
+----
+const ac = new AbortController()
+client.search({ params }, { signal: ac.signal })
+  .then(console.log)
+  .catch(console.log) // RequestAbortedError
+
+ac.abort()
+----
+
+[discrete]
+===== Remove the body key from the request
+
+*Breaking: Yes* | *Migration effort: Small*
+
+Thanks to the new types we are developing now we know exactly where a parameter should go.
+The client API leaks HTTP-related notions in many places, and removing them would definitely improve the DX.
+
+This could be a rather big breaking change, so a double solution could be used during the 8.x lifecycle. (accepting body keys without them being wrapped in the body as well as the current solution).
+
+To convert code from 7.x, you need to remove the `body` parameter in all the endpoints request.
+For instance, this is an example for the `search` endpoint:
+
+[source,js]
+----
+// from
+const response = await client.search({
+  index: 'test',
+  body: {
+    query: {
+      match_all: {}
+    }
+  }
+})
+
+// to
+const response = await client.search({
+  index: 'test',
+  query: {
+    match_all: {}
+  }
+})
+----
+
+[discrete]
+===== Migrate to new separate transport
+
+*Breaking: Yes* | *Migration effort: Small to none*
+
+The separated transport has been rewritten in TypeScript and has already dropped the callback style API.
+Given that now is separated, most of the Elasticsearch specific concepts have been removed, and the client will likely need to extend parts of it for reintroducing them.
+If you weren't extending the internals of the client, this won't be a breaking change for you.
+
+[discrete]
+===== The returned value of API calls is the body and not the HTTP related keys
+
+*Breaking: Yes* | *Migration effort: Small*
+
+The client API leaks HTTP-related notions in many places, and removing them would definitely improve the DX.
+The client will expose a new request-specific option to still get the full response details.
+
+The new behaviour returns the `body` value directly as response.
+If you want to have the 7.x response format, you need to add `meta : true` in the request.
+This will return all the HTTP meta information, including the `body`.
+
+For instance, this is an example for the `search` endpoint:
+
+[source,js]
+----
+// from
+const response = await client.search({
+  index: 'test',
+  body: {
+    query: {
+      match_all: {}
+    }
+  }
+})
+console.log(response) // { body: SearchResponse, statusCode: number, headers: object, warnings: array }
+
+// to
+const response = await client.search({
+  index: 'test',
+  query: {
+    match_all: {}
+  }
+})
+console.log(response) // SearchResponse
+
+// with a bit of TypeScript and JavaScript magic...
+const response = await client.search({
+  index: 'test',
+  query: {
+    match_all: {}
+  }
+}, {
+  meta: true
+})
+console.log(response) // { body: SearchResponse, statusCode: number, headers: object, warnings: array }
+----
+
+[discrete]
+===== Use a weighted connection pool
+
+*Breaking: Yes* | *Migration effort: Small to none*
+
+Move from the current cluster connection pool to a weight-based implementation.
+This new implementation offers better performances and runs less code in the background, the old connection pool can still be used.
+If you weren't extending the internals of the client, this won't be a breaking change for you.
+
+[discrete]
+===== Migrate to the "undici" http client
+
+*Breaking: Yes* | *Migration effort: Small to none*
+
+By default, the HTTP client will no longer be the default Node.js HTTP client, but https://github.com/nodejs/undici[undici] instead.
+Undici is a brand new HTTP client written from scratch, it offers vastly improved performances and has better support for promises.
+Furthermore, it offers comprehensive and predictable error handling. The old HTTP client can still be used.
+If you weren't extending the internals of the client, this won't be a breaking change for you.
+
+[discrete]
+===== Drop support for old camelCased keys
+
+*Breaking: Yes* | *Migration effort: Medium*
+
+Currently, every path or query parameter could be expressed in both `snake_case` and `camelCase`. Internally the client will convert everything to `snake_case`.
+This was done in an effort to reduce the friction of migrating from the legacy to the new client, but now it no longer makes sense.
+If you are already using `snake_case` keys, this won't be a breaking change for you.
+
+[discrete]
+===== Rename `ssl` option to `tls`
+
+*Breaking: Yes* | *Migration effort: Small*
+
+People usually refers to this as `tls`, furthermore, internally we use the tls API and Node.js refers to it as tls everywhere.
+[source,js]
+----
+// before
+const client = new Client({
+  node: 'https://localhost:9200',
+  ssl: {
+    rejectUnauthorized: false
+  }
+})
+
+// after
+const client = new Client({
+  node: 'https://localhost:9200',
+  tls: {
+    rejectUnauthorized: false
+  }
+})
+----
+
+[discrete]
+===== Remove prototype poisoning protection
+
+*Breaking: Yes* | *Migration effort: Small*
+
+Prototype poisoning protection is very useful, but it can cause performances issues with big payloads.
+In v8 it will be removed, and the documentation will show how to add it back with a custom serializer.
+
+[discrete]
+===== Remove client extensions API
+
+*Breaking: Yes* | *Migration effort: Large*
+
+Nowadays the client support the entire Elasticsearch API, and the `transport.request` method can be used if necessary. The client extensions API have no reason to exist.
+[source,js]
+----
+client.extend('utility.index', ({ makeRequest }) => {
+  return function _index (params, options) {
+    // your code
+  }
+})
+
+client.utility.index(...)
+----
+
+If you weren't using client extensions, this won't be a breaking change for you.
+
+[discrete]
+===== Move to TypeScript
+
+*Breaking: No* | *Migration effort: None*
+
+The new separated transport is already written in TypeScript, and it makes sense that the client v8 will be fully written in TypeScript as well.
+
+[discrete]
+===== Move from emitter-like interface to a diagnostic method
+
+*Breaking: Yes* | *Migration effort: Small*
+
+Currently, the client offers a subset of methods of the `EventEmitter` class, v8 will ship with a `diagnostic` property which will be a proper event emitter.
+[source,js]
+----
+// from
+client.on('request', console.log)
+
+// to
+client.diagnostic.on('request', console.log)
+----
+
+[discrete]
+===== Remove username & password properties from Cloud configuration
+
+*Breaking: Yes* | *Migration effort: Small*
+
+The Cloud configuration does not support ApiKey and Bearer auth, while the `auth` options does.
+There is no need to keep the legacy basic auth support in the cloud configuration.
+[source,js]
+----
+// before
+const client = new Client({
+  cloud: {
+    id: '<cloud-id>',
+    username: 'elastic',
+    password: 'changeme'
+  }
+})
+
+// after
+const client = new Client({
+  cloud: {
+    id: '<cloud-id>'
+  },
+  auth: {
+    username: 'elastic',
+    password: 'changeme'
+  }
+})
+----
+
+If you are already passing the basic auth options in the `auth` configuration, this won't be a breaking change for you.
+
+[discrete]
+===== Calling `client.close` will reject new requests
+
+Once you call `client.close` every new request after that will be rejected with a `NoLivingConnectionsError`. In-flight requests will be executed normally unless an in-flight request requires a retry, in which case it will be rejected.
+
+[discrete]
+===== Parameters rename
+
+- `ilm.delete_lifecycle`: `policy` parameter has been renamed to `name`
+- `ilm.get_lifecycle`: `policy` parameter has been renamed to `name`
+- `ilm.put_lifecycle`: `policy` parameter has been renamed to `name`
+- `snapshot.cleanup_repository`: `repository` parameter has been renamed to `name`
+- `snapshot.create_repository`: `repository` parameter has been renamed to `name`
+- `snapshot.delete_repository`: `repository` parameter has been renamed to `name`
+- `snapshot.get_repository`: `repository` parameter has been renamed to `name`
+- `snapshot.verify_repository`: `repository` parameter has been renamed to `name`
+
+[discrete]
+===== Removal of snake_cased methods
+
+The v7 client provided snake_cased methods, such as `client.delete_by_query`. This is no longer supported, now only camelCased method are present.
+So `client.delete_by_query` can be accessed with `client.deleteByQuery`
+

docs/child.asciidoc

@@ -0,0 +1,36 @@
+[[child]]
+=== Creating a child client
+
+There are some use cases where you may need multiple instances of the client. 
+You can easily do that by calling `new Client()` as many times as you need, but 
+you will lose all the benefits of using one single client, such as the long 
+living connections and the connection pool handling. To avoid this problem, the 
+client offers a `child` API, which returns a new client instance that shares the 
+connection pool with the parent client.
+
+NOTE: The event emitter is shared between the parent and the child(ren). If you 
+extend the parent client, the child client will have the same extensions, while 
+if the child client adds an extension, the parent client will not be extended.
+
+You can pass to the `child` every client option you would pass to a normal 
+client, but the connection pool specific options (`ssl`, `agent`, `pingTimeout`, 
+`Connection`, and `resurrectStrategy`).
+
+CAUTION: If you call `close` in any of the parent/child clients, every client 
+will be closed.
+
+[source,js]
+----
+const { Client } = require('@elastic/elasticsearch')
+const client = new Client({
+  cloud: { id: '<cloud-id>' },
+  auth: { apiKey: 'base64EncodedKey' }
+})
+const child = client.child({
+  headers: { 'x-foo': 'bar' },
+  requestTimeout: 1000
+})
+
+client.info().then(console.log, console.log)
+child.info().then(console.log, console.log)
+----

docs/configuration.asciidoc

@@ -0,0 +1,12 @@
+[[client-configuration]]
+== Configuration
+
+
+The client is designed to be easily configured for your needs. In the following
+section, you can see the possible options that you can use to configure it.
+
+* <<basic-config>>
+* <<advanced-config>>
+* <<timeout-best-practices>>
+* <<child>>
+* <<client-testing>>

docs/connecting.asciidoc

@@ -0,0 +1,738 @@
+[[client-connecting]]
+== Connecting
+
+This page contains the information you need to connect and use the Client with
+{es}.
+
+**On this page**
+
+* <<authentication, Authentication options>>
+* <<client-usage, Using the client>>
+* <<client-faas-env, Using the Client in a Function-as-a-Service Environment>>
+* <<client-connect-proxy, Connecting through a proxy>>
+* <<client-error-handling, Handling errors>>
+* <<keep-alive, Keep-alive connections>>
+* <<close-connections, Closing a client's connections>>
+* <<product-check, Automatic product check>>
+
+[[authentication]]
+[discrete]
+=== Authentication
+
+This document contains code snippets to show you how to connect to various {es}
+providers.
+
+
+[discrete]
+[[auth-ec]]
+==== Elastic Cloud
+
+If you are using https://www.elastic.co/cloud[Elastic Cloud], the client offers
+an easy way to connect to it via the `cloud` option. You must pass the Cloud ID
+that you can find in the cloud console, then your username and password inside
+the `auth` option.
+
+NOTE: When connecting to Elastic Cloud, the client will automatically enable
+both request and response compression by default, since it yields significant
+throughput improvements. Moreover, the client will also set the tls option
+`secureProtocol` to `TLSv1_2_method` unless specified otherwise. You can still
+override this option by configuring them.
+
+IMPORTANT: Do not enable sniffing when using Elastic Cloud, since the nodes are
+behind a load balancer, Elastic Cloud will take care of everything for you.
+Take a look https://www.elastic.co/blog/elasticsearch-sniffing-best-practices-what-when-why-how[here]
+to know more.
+
+[source,js]
+----
+const { Client } = require('@elastic/elasticsearch')
+const client = new Client({
+  cloud: {
+    id: '<cloud-id>'
+  },
+  auth: {
+    username: 'elastic',
+    password: 'changeme'
+  }
+})
+----
+
+[discrete]
+[[connect-self-managed-new]]
+=== Connecting to a self-managed cluster
+
+By default {es} will start with security features like authentication and TLS
+enabled. To connect to the {es} cluster you'll need to configure the Node.js {es}
+client to use HTTPS with the generated CA certificate in order to make requests
+successfully.
+
+If you're just getting started with {es} we recommend reading the documentation
+on https://www.elastic.co/guide/en/elasticsearch/reference/current/settings.html[configuring]
+and
+https://www.elastic.co/guide/en/elasticsearch/reference/current/starting-elasticsearch.html[starting {es}]
+to ensure your cluster is running as expected.
+
+When you start {es} for the first time you'll see a distinct block like the one
+below in the output from {es} (you may have to scroll up if it's been a while):
+
+[source,sh]
+----
+
+-> Elasticsearch security features have been automatically configured!
+-> Authentication is enabled and cluster connections are encrypted.
+
+->  Password for the elastic user (reset with `bin/elasticsearch-reset-password -u elastic`):
+  lhQpLELkjkrawaBoaz0Q
+
+->  HTTP CA certificate SHA-256 fingerprint:
+  a52dd93511e8c6045e21f16654b77c9ee0f34aea26d9f40320b531c474676228
+...
+
+----
+
+Depending on the circumstances there are two options for verifying the HTTPS
+connection, either verifying with the CA certificate itself or via the HTTP CA
+certificate fingerprint.
+
+[discrete]
+[[auth-tls]]
+==== TLS configuration
+
+The generated root CA certificate can be found in the `certs` directory in your
+{es} config location (`$ES_CONF_PATH/certs/http_ca.crt`). If you're running {es}
+in Docker there is
+https://www.elastic.co/guide/en/elasticsearch/reference/current/docker.html[additional documentation for retrieving the CA certificate].
+
+Without any additional configuration you can specify `https://` node urls, and
+the certificates used to sign these requests will be verified. To turn off
+certificate verification, you must specify an `tls` object in the top level
+config and set `rejectUnauthorized: false`. The default `tls` values are the
+same that Node.js's https://nodejs.org/api/tls.html#tls_tls_connect_options_callback[`tls.connect()`]
+uses.
+
+[source,js]
+----
+const { Client } = require('@elastic/elasticsearch')
+const client = new Client({
+  node: 'https://localhost:9200',
+  auth: {
+    username: 'elastic',
+    password: 'changeme'
+  },
+  tls: {
+    ca: fs.readFileSync('./http_ca.crt'),
+    rejectUnauthorized: false
+  }
+})
+----
+
+[discrete]
+[[auth-ca-fingerprint]]
+==== CA fingerprint
+
+You can configure the client to only trust certificates that are signed by a specific CA certificate
+(CA certificate pinning) by providing a `caFingerprint` option.
+This will verify that the fingerprint of the CA certificate that has signed
+the certificate of the server matches the supplied value.
+You must configure a SHA256 digest.
+
+[source,js]
+----
+const { Client } = require('@elastic/elasticsearch')
+const client = new Client({
+  node: 'https://example.com'
+  auth: { ... },
+  // the fingerprint (SHA256) of the CA certificate that is used to sign
+  // the certificate that the Elasticsearch node presents for TLS.
+  caFingerprint: '20:0D:CA:FA:76:...',
+  tls: {
+    // might be required if it's a self-signed certificate
+    rejectUnauthorized: false
+  }
+})
+----
+
+The certificate fingerprint can be calculated using `openssl x509` with the
+certificate file:
+
+[source,sh]
+----
+openssl x509 -fingerprint -sha256 -noout -in /path/to/http_ca.crt
+----
+
+If you don't have access to the generated CA file from {es} you can use the
+following script to output the root CA fingerprint of the {es} instance with
+`openssl s_client`:
+
+[source,sh]
+----
+# Replace the values of 'localhost' and '9200' to the
+# corresponding host and port values for the cluster.
+openssl s_client -connect localhost:9200 -servername localhost -showcerts </dev/null 2>/dev/null \
+  | openssl x509 -fingerprint -sha256 -noout -in /dev/stdin
+----
+
+The output of `openssl x509` will look something like this:
+
+[source,sh]
+----
+SHA256 Fingerprint=A5:2D:D9:35:11:E8:C6:04:5E:21:F1:66:54:B7:7C:9E:E0:F3:4A:EA:26:D9:F4:03:20:B5:31:C4:74:67:62:28
+----
+
+
+[discrete]
+[[connect-no-security]]
+=== Connecting without security enabled
+
+WARNING: Running {es} without security enabled is not recommended.
+
+If your cluster is configured with
+https://www.elastic.co/guide/en/elasticsearch/reference/current/security-settings.html[security explicitly disabled]
+then you can connect via HTTP:
+
+[source,js]
+----
+const { Client } = require('@elastic/elasticsearch')
+const client = new Client({
+  node: 'http://example.com'
+})
+----
+
+[discrete]
+[[auth-strategies]]
+=== Authentication strategies
+
+Following you can find all the supported authentication strategies.
+
+[discrete]
+[[auth-apikey]]
+==== ApiKey authentication
+
+You can use the
+{ref-7x}/security-api-create-api-key.html[ApiKey]
+authentication by passing the `apiKey` parameter via the `auth` option. The
+`apiKey` parameter can be either a base64 encoded string or an object with the
+values that you can obtain from the
+{ref-7x}/security-api-create-api-key.html[create api key endpoint].
+
+NOTE: If you provide both basic authentication credentials and the ApiKey
+configuration, the ApiKey takes precedence.
+
+[source,js]
+----
+const { Client } = require('@elastic/elasticsearch')
+const client = new Client({
+  node: 'https://localhost:9200',
+  auth: {
+    apiKey: 'base64EncodedKey'
+  }
+})
+----
+
+[source,js]
+----
+const { Client } = require('@elastic/elasticsearch')
+const client = new Client({
+  node: 'https://localhost:9200',
+  auth: {
+    apiKey: {
+      id: 'foo',
+      api_key: 'bar'
+    }
+  }
+})
+----
+
+[discrete]
+[[auth-bearer]]
+==== Bearer authentication
+
+You can provide your credentials by passing the `bearer` token
+parameter via the `auth` option.
+Useful for https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-service-token.html[service account tokens].
+Be aware that it does not handle automatic token refresh.
+
+[source,js]
+----
+const { Client } = require('@elastic/elasticsearch')
+const client = new Client({
+  node: 'https://localhost:9200',
+  auth: {
+    bearer: 'token'
+  }
+})
+----
+
+
+[discrete]
+[[auth-basic]]
+==== Basic authentication
+
+You can provide your credentials by passing the `username` and `password`
+parameters via the `auth` option.
+
+NOTE: If you provide both basic authentication credentials and the Api Key
+configuration, the Api Key will take precedence.
+
+[source,js]
+----
+const { Client } = require('@elastic/elasticsearch')
+const client = new Client({
+  node: 'https://localhost:9200',
+  auth: {
+    username: 'elastic',
+    password: 'changeme'
+  }
+})
+----
+
+
+Otherwise, you can provide your credentials in the node(s) URL.
+
+[source,js]
+----
+const { Client } = require('@elastic/elasticsearch')
+const client = new Client({
+  node: 'https://username:password@localhost:9200'
+})
+----
+
+
+[discrete]
+[[client-usage]]
+=== Usage
+
+Using the client is straightforward, it supports all the public APIs of {es},
+and every method exposes the same signature.
+
+
+[source,js]
+----
+const { Client } = require('@elastic/elasticsearch')
+const client = new Client({
+  cloud: { id: '<cloud-id>' },
+  auth: { apiKey: 'base64EncodedKey' }
+})
+
+const result = await client.search({
+  index: 'my-index',
+  query: {
+    match: { hello: 'world' }
+  }
+})
+----
+
+The returned value of every API call is the response body from {es}.
+If you need to access additonal metadata, such as the status code or headers,
+you must specify `meta: true` in the request options:
+
+[source,js]
+----
+const { Client } = require('@elastic/elasticsearch')
+const client = new Client({
+  cloud: { id: '<cloud-id>' },
+  auth: { apiKey: 'base64EncodedKey' }
+})
+
+const result = await client.search({
+  index: 'my-index',
+  query: {
+    match: { hello: 'world' }
+  }
+}, { meta: true })
+----
+
+In this case, the result will be:
+[source,ts]
+----
+{
+  body: object | boolean
+  statusCode: number
+  headers: object
+  warnings: string[],
+  meta: object
+}
+----
+
+NOTE: The body is a boolean value when you use `HEAD` APIs.
+
+[discrete]
+==== Aborting a request
+
+If needed, you can abort a running request by using the `AbortController` standard.
+
+CAUTION: If you abort a request, the request will fail with a
+`RequestAbortedError`.
+
+
+[source,js]
+----
+const AbortController = require('node-abort-controller')
+const { Client } = require('@elastic/elasticsearch')
+const client = new Client({
+  cloud: { id: '<cloud-id>' },
+  auth: { apiKey: 'base64EncodedKey' }
+})
+
+const abortController = new AbortController()
+setImmediate(() => abortController.abort())
+
+const result = await client.search({
+  index: 'my-index',
+  query: {
+    match: { hello: 'world' }
+  }
+}, { signal: abortController.signal })
+----
+
+[discrete]
+==== Request specific options
+
+If needed you can pass request specific options in a second object:
+
+[source,js]
+----
+const result = await client.search({
+  index: 'my-index',
+  body: {
+    query: {
+      match: { hello: 'world' }
+    }
+  }
+}, {
+  ignore: [404],
+  maxRetries: 3
+})
+----
+
+
+The supported request specific options are:
+[cols=2*]
+|===
+|`ignore`
+|`number[]` -  HTTP status codes which should not be considered errors for this request. +
+_Default:_ `null`
+
+|`requestTimeout`
+|`number | string` - Max request timeout for the request in milliseconds, it overrides the client default. +
+_Default:_ `30000`
+
+|`retryOnTimeout`
+|`boolean` - Retry requests that have timed out.
+_Default:_ `false`
+
+|`maxRetries`
+|`number` - Max number of retries for the request, it overrides the client default. +
+_Default:_ `3`
+
+|`compression`
+|`string | boolean` - Enables body compression for the request. +
+_Options:_ `false`, `'gzip'` +
+_Default:_ `false`
+
+|`asStream`
+|`boolean` - Instead of getting the parsed body back, you get the raw Node.js stream of data. +
+_Default:_ `false`
+
+|`headers`
+|`object` - Custom headers for the request. +
+_Default:_ `null`
+
+|`querystring`
+|`object` - Custom querystring for the request. +
+_Default:_ `null`
+
+|`id`
+|`any` - Custom request id. _(overrides the top level request id generator)_ +
+_Default:_ `null`
+
+|`context`
+|`any` - Custom object per request. _(you can use it to pass data to the clients events)_ +
+_Default:_ `null`
+
+|`opaqueId`
+|`string` - Set the `X-Opaque-Id` HTTP header. See {ref}/api-conventions.html#x-opaque-id
+_Default:_ `null`
+
+|`maxResponseSize`
+|`number` - When configured, it verifies that the uncompressed response size is lower than the configured number, if it's higher it will abort the request. It cannot be higher than buffer.constants.MAX_STRING_LENTGH +
+_Default:_ `null`
+
+|`maxCompressedResponseSize`
+|`number` - When configured, it verifies that the compressed response size is lower than the configured number, if it's higher it will abort the request. It cannot be higher than buffer.constants.MAX_LENTGH +
+_Default:_ `null`
+
+|`signal`
+|`AbortSignal` - The AbortSignal instance to allow request abortion. +
+_Default:_ `null`
+
+|`meta`
+|`boolean` - Rather than returning the body, return an object containing `body`, `statusCode`, `headers` and `meta` keys +
+_Default_: `false`
+
+|`redaction`
+|`object` - Options for redacting potentially sensitive data from error metadata. See <<redaction>>.
+
+|`retryBackoff`
+|`(min: number, max: number, attempt: number) => number;` - A function that calculates how long to sleep, in seconds, before the next request retry +
+_Default:_ A built-in function that uses exponential backoff with jitter.
+
+|===
+
+[discrete]
+[[client-faas-env]]
+=== Using the Client in a Function-as-a-Service Environment
+
+This section illustrates the best practices for leveraging the {es} client in a Function-as-a-Service (FaaS) environment.
+The most influential optimization is to initialize the client outside of the function, the global scope.
+This practice does not only improve performance but also enables background functionality as – for example – https://www.elastic.co/blog/elasticsearch-sniffing-best-practices-what-when-why-how[sniffing].
+The following examples provide a skeleton for the best practices.
+
+[discrete]
+==== GCP Cloud Functions
+
+[source,js]
+----
+'use strict'
+
+const { Client } = require('@elastic/elasticsearch')
+
+const client = new Client({
+  // client initialisation
+})
+
+exports.testFunction = async function (req, res) {
+  // use the client
+}
+----
+
+[discrete]
+==== AWS Lambda
+
+[source,js]
+----
+'use strict'
+
+const { Client } = require('@elastic/elasticsearch')
+
+const client = new Client({
+  // client initialisation
+})
+
+exports.handler = async function (event, context) {
+  // use the client
+}
+----
+
+[discrete]
+==== Azure Functions
+
+[source,js]
+----
+'use strict'
+
+const { Client } = require('@elastic/elasticsearch')
+
+const client = new Client({
+  // client initialisation
+})
+
+module.exports = async function (context, req) {
+  // use the client
+}
+----
+
+Resources used to assess these recommendations:
+
+- https://cloud.google.com/functions/docs/bestpractices/tips#use_global_variables_to_reuse_objects_in_future_invocations[GCP Cloud Functions: Tips & Tricks]
+- https://docs.aws.amazon.com/lambda/latest/dg/best-practices.html[Best practices for working with AWS Lambda functions]
+- https://docs.microsoft.com/en-us/azure/azure-functions/functions-reference-python?tabs=azurecli-linux%2Capplication-level#global-variables[Azure Functions Python developer guide]
+- https://docs.aws.amazon.com/lambda/latest/operatorguide/global-scope.html[AWS Lambda: Comparing the effect of global scope]
+
+
+[discrete]
+[[client-connect-proxy]]
+=== Connecting through a proxy
+
+~Added~ ~in~ ~`v7.10.0`~
+
+If you need to pass through an http(s) proxy for connecting to {es}, the client
+out of the box offers a handy configuration for helping you with it. Under the
+hood, it uses the https://github.com/delvedor/hpagent[`hpagent`] module.
+
+IMPORTANT: In versions 8.0+ of the client, the default `Connection` type is set to `UndiciConnection`, which does not support proxy configurations.
+To use a proxy, you will need to use the `HttpConnection` class from `@elastic/transport` instead.
+
+[source,js]
+----
+import { HttpConnection } from '@elastic/transport'
+
+const client = new Client({
+  node: 'http://localhost:9200',
+  proxy: 'http://localhost:8080',
+  Connection: HttpConnection,
+})
+----
+
+Basic authentication is supported as well:
+
+[source,js]
+----
+const client = new Client({
+  node: 'http://localhost:9200',
+  proxy: 'http:user:pwd@//localhost:8080',
+  Connection: HttpConnection,
+})
+----
+
+If you are connecting through a non-http(s) proxy, such as a `socks5` or `pac`,
+you can use the `agent` option to configure it.
+
+[source,js]
+----
+const SocksProxyAgent = require('socks-proxy-agent')
+const client = new Client({
+  node: 'http://localhost:9200',
+  agent () {
+    return new SocksProxyAgent('socks://127.0.0.1:1080')
+  },
+  Connection: HttpConnection,
+})
+----
+
+
+[discrete]
+[[client-error-handling]]
+=== Error handling
+
+The client exposes a variety of error objects that you can use to enhance your
+error handling. You can find all the error objects inside the `errors` key in
+the client.
+
+[source,js]
+----
+const { errors } = require('@elastic/elasticsearch')
+console.log(errors)
+----
+
+
+You can find the errors exported by the client in the table below.
+
+[cols=3*]
+|===
+|*Error*
+|*Description*
+|*Properties*
+
+|`ElasticsearchClientError`
+|Every error inherits from this class, it is the basic error generated by the client.
+a|* `name` - `string`
+* `message` - `string`
+
+|`TimeoutError`
+|Generated when a request exceeds the `requestTimeout` option.
+a|* `name` - `string`
+* `message` - `string`
+* `meta` - `object`, contains all the information about the request
+
+|`ConnectionError`
+|Generated when an error occurs during the request, it can be a connection error or a malformed stream of data.
+a|* `name` - `string`
+* `message` - `string`
+* `meta` - `object`, contains all the information about the request
+
+|`RequestAbortedError`
+|Generated if the user calls the `request.abort()` method.
+a|* `name` - `string`
+* `message` - `string`
+* `meta` - `object`, contains all the information about the request
+
+|`NoLivingConnectionsError`
+|Given the configuration, the ConnectionPool was not able to find a usable Connection for this request.
+a|* `name` - `string`
+* `message` - `string`
+* `meta` - `object`, contains all the information about the request
+
+|`SerializationError`
+|Generated if the serialization fails.
+a|* `name` - `string`
+* `message` - `string`
+* `data` - `object`, the object to serialize
+
+|`DeserializationError`
+|Generated if the deserialization fails.
+a|* `name` - `string`
+* `message` - `string`
+* `data` - `string`, the string to deserialize
+
+|`ConfigurationError`
+|Generated if there is a malformed configuration or parameter.
+a|* `name` - `string`
+* `message` - `string`
+
+|`ResponseError`
+|Generated when in case of a `4xx` or `5xx` response.
+a|* `name` - `string`
+* `message` - `string`
+* `meta` - `object`, contains all the information about the request
+* `body` - `object`, the response body
+* `statusCode` - `object`, the response headers
+* `headers` - `object`, the response status code
+|===
+
+[[keep-alive]]
+[discrete]
+=== Keep-alive connections
+
+By default, the client uses persistent, keep-alive connections to reduce the overhead of creating a new HTTP connection for each Elasticsearch request.
+If you are using the default `UndiciConnection` connection class, it maintains a pool of 256 connections with a keep-alive of 10 minutes.
+If you are using the legacy `HttpConnection` connection class, it maintains a pool of 256 connections with a keep-alive of 1 minute.
+
+If you need to disable keep-alive connections, you can override the HTTP agent with your preferred https://nodejs.org/api/http.html#http_new_agent_options[HTTP agent options]:
+
+[source,js]
+----
+const client = new Client({
+  node: 'http://localhost:9200',
+  // the function takes as parameter the option
+  // object passed to the Connection constructor
+  agent: (opts) => new CustomAgent()
+})
+----
+
+Or you can disable the HTTP agent entirely:
+
+[source,js]
+----
+const client = new Client({
+  node: 'http://localhost:9200',
+  // Disable agent and keep-alive
+  agent: false
+})
+----
+
+[discrete]
+[[close-connections]]
+=== Closing a client's connections
+
+If you would like to close all open connections being managed by an instance of the client, use the `close()` function:
+
+[source,js]
+----
+const client = new Client({
+  node: 'http://localhost:9200'
+});
+client.close();
+----
+
+[discrete]
+[[product-check]]
+=== Automatic product check
+
+Since v7.14.0, the client performs a required product check before the first call.
+This pre-flight product check allows the client to establish the version of Elasticsearch
+that it is communicating with. The product check requires one additional HTTP request to
+be sent to the server as part of the request pipeline before the main API call is sent.
+In most cases, this will succeed during the very first API call that the client sends.
+Once the product check completes, no further product check HTTP requests are sent for
+subsequent API calls.

docs/doc_examples/00ad41bde67beac991534ae0e04b1296.asciidoc

@@ -1,11 +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.getDataStream({
-  name: "my-data-stream",
-  filter_path: "data_streams.indices.index_name",
-});
-console.log(response);
-----

docs/doc_examples/0722b302b2b3275a988d858044f99d5d.asciidoc

@@ -1,10 +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.getMapping({
-  index: "kibana_sample_data_ecommerce",
-});
-console.log(response);
-----

docs/doc_examples/082e78c7a2061a7c4a52b494e5ede0e8.asciidoc

@@ -1,42 +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: "my-rank-vectors-bit",
-  mappings: {
-    properties: {
-      my_vector: {
-        type: "rank_vectors",
-        element_type: "bit",
-      },
-    },
-  },
-});
-console.log(response);
-
-const response1 = await client.bulk({
-  index: "my-rank-vectors-bit",
-  refresh: "true",
-  operations: [
-    {
-      index: {
-        _id: "1",
-      },
-    },
-    {
-      my_vector: [127, -127, 0, 1, 42],
-    },
-    {
-      index: {
-        _id: "2",
-      },
-    },
-    {
-      my_vector: "8100012a7f",
-    },
-  ],
-});
-console.log(response1);
-----

docs/doc_examples/0e83f140237d75469a428ff403564bb5.asciidoc

@@ -5,8 +5,10 @@
 ----
 const response = await client.cluster.putSettings({
   persistent: {
-    "cluster.routing.allocation.disk.watermark.low": "90%",
-    "cluster.routing.allocation.disk.watermark.high": "95%",
+    "cluster.routing.allocation.disk.watermark.low": "100gb",
+    "cluster.routing.allocation.disk.watermark.high": "50gb",
+    "cluster.routing.allocation.disk.watermark.flood_stage": "10gb",
+    "cluster.info.update.interval": "1m",
   },
 });
 console.log(response);

docs/doc_examples/120fcf9f55128d6a81d5e87a9c235bbd.asciidoc

@@ -1,20 +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.transport.request({
-  method: "POST",
-  path: "/_inference/chat_completion/openai-completion/_stream",
-  body: {
-    model: "gpt-4o",
-    messages: [
-      {
-        role: "user",
-        content: "What is Elastic?",
-      },
-    ],
-  },
-});
-console.log(response);
-----

docs/doc_examples/12adea5d76f73d94d80d42f53f67563f.asciidoc

@@ -1,11 +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.addBlock({
-  index: ".ml-anomalies-custom-example",
-  block: "read_only",
-});
-console.log(response);
-----

docs/doc_examples/1420a22aa817c7a996baaed0ad366d6f.asciidoc

@@ -6,15 +6,14 @@
 const response = await client.search({
   index: "test-index",
   query: {
-    match: {
-      my_semantic_field: "Which country is Paris in?",
-    },
-  },
-  highlight: {
-    fields: {
-      my_semantic_field: {
-        number_of_fragments: 2,
-        order: "score",
+    nested: {
+      path: "inference_field.inference.chunks",
+      query: {
+        sparse_vector: {
+          field: "inference_field.inference.chunks.embeddings",
+          inference_id: "my-inference-id",
+          query: "mountain lake",
+        },
       },
     },
   },

docs/doc_examples/1ead35c954963e83f89872048dabdbe9.asciidoc

@@ -1,19 +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.security.queryRole({
-  query: {
-    bool: {
-      must_not: {
-        term: {
-          "metadata._reserved": true,
-        },
-      },
-    },
-  },
-  sort: ["name"],
-});
-console.log(response);
-----

docs/doc_examples/23af230e824f48b9cd56a4cf973d788c.asciidoc

@@ -14,7 +14,6 @@ const response = await client.indices.putSettings({
     "index.search.slowlog.threshold.fetch.info": "800ms",
     "index.search.slowlog.threshold.fetch.debug": "500ms",
     "index.search.slowlog.threshold.fetch.trace": "200ms",
-    "index.search.slowlog.include.user": true,
   },
 });
 console.log(response);

docs/doc_examples/246763219ec06172f7aa57bba28d344a.asciidoc

@@ -1,67 +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: "my-rank-vectors-bit",
-  mappings: {
-    properties: {
-      my_vector: {
-        type: "rank_vectors",
-        element_type: "bit",
-      },
-    },
-  },
-});
-console.log(response);
-
-const response1 = await client.bulk({
-  index: "my-rank-vectors-bit",
-  refresh: "true",
-  operations: [
-    {
-      index: {
-        _id: "1",
-      },
-    },
-    {
-      my_vector: [127, -127, 0, 1, 42],
-    },
-    {
-      index: {
-        _id: "2",
-      },
-    },
-    {
-      my_vector: "8100012a7f",
-    },
-  ],
-});
-console.log(response1);
-
-const response2 = await client.search({
-  index: "my-rank-vectors-bit",
-  query: {
-    script_score: {
-      query: {
-        match_all: {},
-      },
-      script: {
-        source: "maxSimDotProduct(params.query_vector, 'my_vector')",
-        params: {
-          query_vector: [
-            [
-              0.35, 0.77, 0.95, 0.15, 0.11, 0.08, 0.58, 0.06, 0.44, 0.52, 0.21,
-              0.62, 0.65, 0.16, 0.64, 0.39, 0.93, 0.06, 0.93, 0.31, 0.92, 0,
-              0.66, 0.86, 0.92, 0.03, 0.81, 0.31, 0.2, 0.92, 0.95, 0.64, 0.19,
-              0.26, 0.77, 0.64, 0.78, 0.32, 0.97, 0.84,
-            ],
-          ],
-        },
-      },
-    },
-  },
-});
-console.log(response2);
-----

docs/doc_examples/272e27bf1fcc4fe5dbd4092679dd0342.asciidoc

@@ -1,11 +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.addBlock({
-  index: ".ml-anomalies-custom-example",
-  block: "write",
-});
-console.log(response);
-----

docs/doc_examples/2a21674c40f9b182a8944769d20b2357.asciidoc

@@ -1,26 +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.search({
-  index: "my-rank-vectors-float",
-  query: {
-    script_score: {
-      query: {
-        match_all: {},
-      },
-      script: {
-        source: "maxSimDotProduct(params.query_vector, 'my_vector')",
-        params: {
-          query_vector: [
-            [0.5, 10, 6],
-            [-0.5, 10, 10],
-          ],
-        },
-      },
-    },
-  },
-});
-console.log(response);
-----

docs/doc_examples/2f07b81fd47ec3b074242a760f0c4e9e.asciidoc

@@ -4,10 +4,9 @@
 [source, js]
 ----
 const response = await client.indices.putSettings({
-  index: "*",
+  index: "my-index-000001",
   settings: {
     "index.indexing.slowlog.include.user": true,
-    "index.indexing.slowlog.threshold.index.warn": "30s",
   },
 });
 console.log(response);

docs/doc_examples/2f72a63c73dd672ac2dc3997ad15dd41.asciidoc

@@ -1,23 +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: "test-index",
-  mappings: {
-    properties: {
-      source_field: {
-        type: "text",
-        fields: {
-          infer_field: {
-            type: "semantic_text",
-            inference_id: ".elser-2-elasticsearch",
-          },
-        },
-      },
-    },
-  },
-});
-console.log(response);
-----

docs/doc_examples/31832bd71c31c46a1ccf8d1c210d89d4.asciidoc

@@ -1,28 +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.search({
-  index: "my-index-*",
-  query: {
-    bool: {
-      must: [
-        {
-          match: {
-            "user.id": "kimchy",
-          },
-        },
-      ],
-      must_not: [
-        {
-          terms: {
-            _index: ["my-index-01"],
-          },
-        },
-      ],
-    },
-  },
-});
-console.log(response);
-----

docs/doc_examples/31bc93e429ad0de11dd2dd231e8f2c5e.asciidoc

@@ -3,8 +3,8 @@
 
 [source, js]
 ----
-const response = await client.migration.deprecations({
-  index: ".ml-anomalies-*",
+const response = await client.indices.unfreeze({
+  index: "my-index-000001",
 });
 console.log(response);
 ----

docs/doc_examples/32c8c86702ccd68eb70f1573409c2a1f.asciidoc

@@ -1,31 +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.ilm.putLifecycle({
-  name: "my_policy",
-  policy: {
-    phases: {
-      hot: {
-        actions: {
-          rollover: {
-            max_primary_shard_size: "50gb",
-          },
-          searchable_snapshot: {
-            snapshot_repository: "backing_repo",
-            replicate_for: "14d",
-          },
-        },
-      },
-      delete: {
-        min_age: "28d",
-        actions: {
-          delete: {},
-        },
-      },
-    },
-  },
-});
-console.log(response);
-----

docs/doc_examples/34cdeefb09bbbe5206957a8bc1bd513d.asciidoc

@@ -4,11 +4,9 @@
 [source, js]
 ----
 const response = await client.indices.putSettings({
-  index: ".reindexed-v9-ml-anomalies-custom-example",
+  index: "my-index-000001",
   settings: {
-    index: {
-      number_of_replicas: 0,
-    },
+    "index.search.slowlog.include.user": true,
   },
 });
 console.log(response);

docs/doc_examples/357edc9d10e98ed776401c7a439a1a55.asciidoc

@@ -6,7 +6,6 @@
 const response = await client.indices.resolveCluster({
   name: "not-present,clust*:my-index*,oldcluster:*",
   ignore_unavailable: "false",
-  timeout: "5s",
 });
 console.log(response);
 ----

docs/doc_examples/36792c81c053e0555407d1e83e7e054f.asciidoc

@@ -1,70 +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.search({
-  index: "movies",
-  size: 10,
-  retriever: {
-    rescorer: {
-      rescore: {
-        window_size: 50,
-        query: {
-          rescore_query: {
-            script_score: {
-              query: {
-                match_all: {},
-              },
-              script: {
-                source:
-                  "cosineSimilarity(params.queryVector, 'product-vector_final_stage') + 1.0",
-                params: {
-                  queryVector: [-0.5, 90, -10, 14.8, -156],
-                },
-              },
-            },
-          },
-        },
-      },
-      retriever: {
-        rrf: {
-          rank_window_size: 100,
-          retrievers: [
-            {
-              standard: {
-                query: {
-                  sparse_vector: {
-                    field: "plot_embedding",
-                    inference_id: "my-elser-model",
-                    query: "films that explore psychological depths",
-                  },
-                },
-              },
-            },
-            {
-              standard: {
-                query: {
-                  multi_match: {
-                    query: "crime",
-                    fields: ["plot", "title"],
-                  },
-                },
-              },
-            },
-            {
-              knn: {
-                field: "vector",
-                query_vector: [10, 22, 77],
-                k: 10,
-                num_candidates: 10,
-              },
-            },
-          ],
-        },
-      },
-    },
-  },
-});
-console.log(response);
-----

docs/doc_examples/3722dad876023e0757138dd5a6d3240e.asciidoc

@@ -1,23 +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: "my-index",
-  settings: {
-    index: {
-      number_of_shards: 3,
-      "blocks.write": true,
-    },
-  },
-  mappings: {
-    properties: {
-      field1: {
-        type: "text",
-      },
-    },
-  },
-});
-console.log(response);
-----

docs/doc_examples/38ba93890494bfa7beece58dffa44f98.asciidoc

@@ -0,0 +1,23 @@
+// 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.bulk({
+  index: "test-index",
+  operations: [
+    {
+      update: {
+        _id: "1",
+      },
+    },
+    {
+      doc: {
+        infer_field: "updated inference field",
+        source_field: "updated source field",
+      },
+    },
+  ],
+});
+console.log(response);
+----

docs/doc_examples/3a204b57072a104d9b50f3a9e064a8f6.asciidoc

@@ -1,19 +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.search({
-  index: ".ml-anomalies-custom-example",
-  size: 0,
-  aggs: {
-    job_ids: {
-      terms: {
-        field: "job_id",
-        size: 100,
-      },
-    },
-  },
-});
-console.log(response);
-----

docs/doc_examples/3bc4a3681e3ea9cb3de49f72085807d8.asciidoc

@@ -1,61 +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.search({
-  index: "retrievers_example",
-  retriever: {
-    linear: {
-      retrievers: [
-        {
-          retriever: {
-            standard: {
-              query: {
-                function_score: {
-                  query: {
-                    term: {
-                      topic: "ai",
-                    },
-                  },
-                  functions: [
-                    {
-                      script_score: {
-                        script: {
-                          source: "doc['timestamp'].value.millis",
-                        },
-                      },
-                    },
-                  ],
-                  boost_mode: "replace",
-                },
-              },
-              sort: {
-                timestamp: {
-                  order: "asc",
-                },
-              },
-            },
-          },
-          weight: 2,
-          normalizer: "minmax",
-        },
-        {
-          retriever: {
-            knn: {
-              field: "vector",
-              query_vector: [0.23, 0.67, 0.89],
-              k: 3,
-              num_candidates: 5,
-            },
-          },
-          weight: 1.5,
-        },
-      ],
-      rank_window_size: 10,
-    },
-  },
-  _source: false,
-});
-console.log(response);
-----

docs/doc_examples/3ea4c971b3f47735dcc207ee2645fa03.asciidoc

@@ -1,16 +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.updateAliases({
-  actions: [
-    {
-      remove_index: {
-        index: "my-index-2099.05.06-000001",
-      },
-    },
-  ],
-});
-console.log(response);
-----

docs/doc_examples/3f9dcf2aa42f3ecfb5ebfe48c1774103.asciidoc

@@ -1,18 +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.search({
-  index: "kibana_sample_data_ecommerce",
-  size: 0,
-  aggs: {
-    order_stats: {
-      stats: {
-        field: "taxful_total_price",
-      },
-    },
-  },
-});
-console.log(response);
-----

docs/doc_examples/41d24383d29b2808a65258a0a3256e96.asciidoc

@@ -1,18 +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: "jinaai-index",
-  mappings: {
-    properties: {
-      content: {
-        type: "semantic_text",
-        inference_id: "jinaai-embeddings",
-      },
-    },
-  },
-});
-console.log(response);
-----

docs/doc_examples/436d50b85fc8f0977d02059eec00719b.asciidoc

@@ -6,11 +6,15 @@
 const response = await client.update({
   index: "test",
   id: 1,
-  doc: {
-    product_price: 100,
+  script: {
+    source: "ctx._source.counter += params.count",
+    lang: "painless",
+    params: {
+      count: 4,
+    },
   },
   upsert: {
-    product_price: 50,
+    counter: 1,
   },
 });
 console.log(response);

docs/doc_examples/45954b8aaedfed57012be8b6538b0a24.asciidoc

@@ -1,47 +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.transport.request({
-  method: "POST",
-  path: "/_inference/chat_completion/openai-completion/_stream",
-  body: {
-    messages: [
-      {
-        role: "user",
-        content: [
-          {
-            type: "text",
-            text: "What's the price of a scarf?",
-          },
-        ],
-      },
-    ],
-    tools: [
-      {
-        type: "function",
-        function: {
-          name: "get_current_price",
-          description: "Get the current price of a item",
-          parameters: {
-            type: "object",
-            properties: {
-              item: {
-                id: "123",
-              },
-            },
-          },
-        },
-      },
-    ],
-    tool_choice: {
-      type: "function",
-      function: {
-        name: "get_current_price",
-      },
-    },
-  },
-});
-console.log(response);
-----

docs/doc_examples/4de4bb55bbc0a76c75d256f245a3ee3f.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.inference.put({
-  task_type: "sparse_embedding",
-  inference_id: "elser-model-eis",
-  inference_config: {
-    service: "elastic",
-    service_settings: {
-      model_name: "elser",
-    },
-  },
-});
-console.log(response);
-----

docs/doc_examples/519e46350316a33162740e5d7968aa2c.asciidoc

@@ -1,20 +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.search({
-  index: "image-index",
-  knn: {
-    field: "image-vector",
-    query_vector: [-5, 9, -12],
-    k: 10,
-    num_candidates: 100,
-    rescore_vector: {
-      oversample: 2,
-    },
-  },
-  fields: ["title", "file-type"],
-});
-console.log(response);
-----

docs/doc_examples/5836b09198feb1269ed12839b416123d.asciidoc

@@ -1,16 +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.search({
-  index: "jinaai-index",
-  query: {
-    semantic: {
-      field: "content",
-      query: "who inspired taking care of the sea?",
-    },
-  },
-});
-console.log(response);
-----

docs/doc_examples/59aa5216630f80c5dc298fc5bba4a819.asciidoc

@@ -1,10 +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.getSettings({
-  index: ".reindexed-v9-ml-anomalies-custom-example",
-});
-console.log(response);
-----

docs/doc_examples/6b67c6121efb86ee100d40c2646f77b5.asciidoc

@@ -1,15 +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.putSettings({
-  index: "*",
-  settings: {
-    "index.search.slowlog.include.user": true,
-    "index.search.slowlog.threshold.fetch.warn": "30s",
-    "index.search.slowlog.threshold.query.warn": "30s",
-  },
-});
-console.log(response);
-----

docs/doc_examples/6e498b9dc753b94abf2618c407fa5cd8.asciidoc

@@ -1,16 +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.reindex({
-  wait_for_completion: "false",
-  source: {
-    index: ".ml-anomalies-custom-example",
-  },
-  dest: {
-    index: ".reindexed-v9-ml-anomalies-custom-example",
-  },
-});
-console.log(response);
-----

docs/doc_examples/730045fae3743c39b612813a42c330c3.asciidoc

@@ -1,24 +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.search({
-  index: "my-index-000001",
-  query: {
-    prefix: {
-      full_name: {
-        value: "ki",
-      },
-    },
-  },
-  highlight: {
-    fields: {
-      full_name: {
-        matched_fields: ["full_name._index_prefix"],
-      },
-    },
-  },
-});
-console.log(response);
-----

docs/doc_examples/7478ff69113fb53f41ea07cdf911fa67.asciidoc

@@ -1,33 +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.search({
-  index: "kibana_sample_data_ecommerce",
-  size: 0,
-  aggs: {
-    daily_sales: {
-      date_histogram: {
-        field: "order_date",
-        calendar_interval: "day",
-      },
-      aggs: {
-        daily_revenue: {
-          sum: {
-            field: "taxful_total_price",
-          },
-        },
-        smoothed_revenue: {
-          moving_fn: {
-            buckets_path: "daily_revenue",
-            window: 3,
-            script: "MovingFunctions.unweightedAvg(values)",
-          },
-        },
-      },
-    },
-  },
-});
-console.log(response);
-----

docs/doc_examples/74b229a6e020113e5749099451979c89.asciidoc

@@ -0,0 +1,26 @@
+// 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.search({
+  index: "test-index",
+  query: {
+    nested: {
+      path: "inference_field.inference.chunks",
+      query: {
+        knn: {
+          field: "inference_field.inference.chunks.embeddings",
+          query_vector_builder: {
+            text_embedding: {
+              model_id: "my_inference_id",
+              model_text: "mountain lake",
+            },
+          },
+        },
+      },
+    },
+  },
+});
+console.log(response);
+----

docs/doc_examples/790684b45bef2bb848ea932f0fd0cfbd.asciidoc

@@ -1,35 +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.search({
-  query: {
-    intervals: {
-      my_text: {
-        all_of: {
-          ordered: false,
-          max_gaps: 1,
-          intervals: [
-            {
-              match: {
-                query: "my favorite food",
-                max_gaps: 0,
-                ordered: true,
-              },
-            },
-            {
-              match: {
-                query: "cold porridge",
-                max_gaps: 4,
-                ordered: true,
-              },
-            },
-          ],
-        },
-      },
-    },
-  },
-});
-console.log(response);
-----

docs/doc_examples/7dd0d9cc6c5982a2c003d301e90feeba.asciidoc

@@ -1,37 +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.search({
-  index: "kibana_sample_data_ecommerce",
-  size: 0,
-  aggs: {
-    daily_sales: {
-      date_histogram: {
-        field: "order_date",
-        calendar_interval: "day",
-        format: "yyyy-MM-dd",
-      },
-      aggs: {
-        revenue: {
-          sum: {
-            field: "taxful_total_price",
-          },
-        },
-        unique_customers: {
-          cardinality: {
-            field: "customer_id",
-          },
-        },
-        avg_basket_size: {
-          avg: {
-            field: "total_quantity",
-          },
-        },
-      },
-    },
-  },
-});
-console.log(response);
-----

docs/doc_examples/82bb6c61dab959f4446dc5ecab7ecbdf.asciidoc

@@ -1,34 +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.transport.request({
-  method: "POST",
-  path: "/_inference/chat_completion/openai-completion/_stream",
-  body: {
-    messages: [
-      {
-        role: "assistant",
-        content: "Let's find out what the weather is",
-        tool_calls: [
-          {
-            id: "call_KcAjWtAww20AihPHphUh46Gd",
-            type: "function",
-            function: {
-              name: "get_current_weather",
-              arguments: '{"location":"Boston, MA"}',
-            },
-          },
-        ],
-      },
-      {
-        role: "tool",
-        content: "The weather is cold",
-        tool_call_id: "call_KcAjWtAww20AihPHphUh46Gd",
-      },
-    ],
-  },
-});
-console.log(response);
-----

docs/doc_examples/844928da2ff9a1394af5347a5e2e4f78.asciidoc

@@ -11,8 +11,6 @@ const response = await client.indices.putSettings({
     "index.indexing.slowlog.threshold.index.debug": "2s",
     "index.indexing.slowlog.threshold.index.trace": "500ms",
     "index.indexing.slowlog.source": "1000",
-    "index.indexing.slowlog.reformat": true,
-    "index.indexing.slowlog.include.user": true,
   },
 });
 console.log(response);

docs/doc_examples/89f547649895176c246bb8c41313ff21.asciidoc

@@ -1,12 +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.esql.query({
-  query:
-    '\nFROM library\n| EVAL year = DATE_EXTRACT("year", release_date)\n| WHERE page_count > ? AND match(author, ?, {"minimum_should_match": ?})\n| LIMIT 5\n',
-  params: [300, "Frank Herbert", 2],
-});
-console.log(response);
-----

docs/doc_examples/8b144b3eb20872595fd7cbc6c245c7c8.asciidoc

@@ -3,8 +3,8 @@
 
 [source, js]
 ----
-const response = await client.indices.getAlias({
-  index: ".ml-anomalies-custom-example",
+const response = await client.security.queryRole({
+  sort: ["name"],
 });
 console.log(response);
 ----

docs/doc_examples/8c639d3eef5c2de29e12bd9c6a42d3d4.asciidoc

@@ -1,39 +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.search({
-  index: "kibana_sample_data_ecommerce",
-  size: 0,
-  aggs: {
-    categories: {
-      terms: {
-        field: "category.keyword",
-        size: 5,
-        order: {
-          total_revenue: "desc",
-        },
-      },
-      aggs: {
-        total_revenue: {
-          sum: {
-            field: "taxful_total_price",
-          },
-        },
-        avg_order_value: {
-          avg: {
-            field: "taxful_total_price",
-          },
-        },
-        total_items: {
-          sum: {
-            field: "total_quantity",
-          },
-        },
-      },
-    },
-  },
-});
-console.log(response);
-----

docs/doc_examples/9250ac57ec81d5192e8ad4c462438489.asciidoc

@@ -1,42 +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.bulk({
-  index: "jinaai-index",
-  operations: [
-    {
-      index: {
-        _index: "jinaai-index",
-        _id: "1",
-      },
-    },
-    {
-      content:
-        "Sarah Johnson is a talented marine biologist working at the Oceanographic Institute. Her groundbreaking research on coral reef ecosystems has garnered international attention and numerous accolades.",
-    },
-    {
-      index: {
-        _index: "jinaai-index",
-        _id: "2",
-      },
-    },
-    {
-      content:
-        "She spends months at a time diving in remote locations, meticulously documenting the intricate relationships between various marine species. ",
-    },
-    {
-      index: {
-        _index: "jinaai-index",
-        _id: "3",
-      },
-    },
-    {
-      content:
-        "Her dedication to preserving these delicate underwater environments has inspired a new generation of conservationists.",
-    },
-  ],
-});
-console.log(response);
-----

docs/doc_examples/93c77c65f1e11382f8043d0300e87b89.asciidoc

@@ -7,14 +7,14 @@ const response = await client.indices.create({
   index: "test-index",
   mappings: {
     properties: {
-      source_field: {
-        type: "text",
-        copy_to: "infer_field",
-      },
       infer_field: {
         type: "semantic_text",
         inference_id: ".elser-2-elasticsearch",
       },
+      source_field: {
+        type: "text",
+        copy_to: "infer_field",
+      },
     },
   },
 });

docs/doc_examples/9ad0864bcd665b63551e944653d32423.asciidoc

@@ -30,13 +30,6 @@ const response = await client.search({
       ],
     },
   },
-  highlight: {
-    fields: {
-      semantic_text: {
-        number_of_fragments: 2,
-      },
-    },
-  },
 });
 console.log(response);
 ----

docs/doc_examples/9cc952d4a03264b700136cbc45abc8c6.asciidoc

@@ -1,30 +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: "my-rank-vectors-byte",
-  mappings: {
-    properties: {
-      my_vector: {
-        type: "rank_vectors",
-        element_type: "byte",
-      },
-    },
-  },
-});
-console.log(response);
-
-const response1 = await client.index({
-  index: "my-rank-vectors-byte",
-  id: 1,
-  document: {
-    my_vector: [
-      [1, 2, 3],
-      [4, 5, 6],
-    ],
-  },
-});
-console.log(response1);
-----

docs/doc_examples/9d47f02a063444da9f098858a1830d28.asciidoc

@@ -5,7 +5,7 @@
 ----
 const response = await client.cluster.putSettings({
   persistent: {
-    "migrate.data_stream_reindex_max_request_per_second": 10000,
+    "cluster.routing.allocation.disk.watermark.low": "30gb",
   },
 });
 console.log(response);

docs/doc_examples/a225fc8c134cb21a85bc6025dac9368b.asciidoc

@@ -7,7 +7,7 @@ const response = await client.inference.put({
   task_type: "sparse_embedding",
   inference_id: "elser_embeddings",
   inference_config: {
-    service: "elasticsearch",
+    service: "elser",
     service_settings: {
       num_allocations: 1,
       num_threads: 1,

docs/doc_examples/a46f566ca031375658c22f89b87dc6d2.asciidoc

@@ -1,12 +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.cat.indices({
-  index: ".ml-anomalies-custom-example",
-  v: "true",
-  h: "index,store.size",
-});
-console.log(response);
-----

docs/doc_examples/a675fafa7c688cb3ea1be09bf887ebf0.asciidoc

@@ -1,12 +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.get({
-  index: ".migrated-ds-my-data-stream-2025.01.23-000001",
-  human: "true",
-  filter_path: "*.settings.index.version.created_string",
-});
-console.log(response);
-----

docs/doc_examples/b590241c4296299b836fbb5a95bdd2dc.asciidoc

@@ -1,18 +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.search({
-  index: "kibana_sample_data_ecommerce",
-  size: 0,
-  aggs: {
-    avg_order_value: {
-      avg: {
-        field: "taxful_total_price",
-      },
-    },
-  },
-});
-console.log(response);
-----

docs/doc_examples/b6d278737d27973e498ac61cda9e5126.asciidoc

@@ -1,21 +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.search({
-  index: "kibana_sample_data_ecommerce",
-  size: 0,
-  aggs: {
-    daily_orders: {
-      date_histogram: {
-        field: "order_date",
-        calendar_interval: "day",
-        format: "yyyy-MM-dd",
-        min_doc_count: 0,
-      },
-    },
-  },
-});
-console.log(response);
-----

docs/doc_examples/bccd4eb26b1a325d103b12e198a13c08.asciidoc

@@ -1,12 +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.getSettings({
-  index: "_all",
-  expand_wildcards: "all",
-  filter_path: "*.settings.index.*.slowlog",
-});
-console.log(response);
-----

docs/doc_examples/bdc55256fa5f701680631a149dbb75a9.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.search({
-  index: "kibana_sample_data_ecommerce",
-  size: 0,
-  aggs: {
-    sales_by_category: {
-      terms: {
-        field: "category.keyword",
-        size: 5,
-        order: {
-          _count: "desc",
-        },
-      },
-    },
-  },
-});
-console.log(response);
-----

docs/doc_examples/bdd28276618235487ac96bd6679bc206.asciidoc

@@ -1,31 +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.search({
-  index: "kibana_sample_data_ecommerce",
-  size: 0,
-  aggs: {
-    daily_sales: {
-      date_histogram: {
-        field: "order_date",
-        calendar_interval: "day",
-      },
-      aggs: {
-        revenue: {
-          sum: {
-            field: "taxful_total_price",
-          },
-        },
-        cumulative_revenue: {
-          cumulative_sum: {
-            buckets_path: "revenue",
-          },
-        },
-      },
-    },
-  },
-});
-console.log(response);
-----

docs/doc_examples/bee3fda7bb07086243424b62e5b16ca7.asciidoc

@@ -5,9 +5,6 @@
 ----
 const response = await client.indices.create({
   index: "retrievers_example_nested",
-  settings: {
-    number_of_shards: 1,
-  },
   mappings: {
     properties: {
       nested_field: {
@@ -21,9 +18,6 @@ const response = await client.indices.create({
             dims: 3,
             similarity: "l2_norm",
             index: true,
-            index_options: {
-              type: "flat",
-            },
           },
         },
       },

docs/doc_examples/bf3c3bc41c593a80faebef1df353e483.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: "rerank",
-  inference_id: "jinaai-rerank",
-  inference_config: {
-    service: "jinaai",
-    service_settings: {
-      api_key: "<api_key>",
-      model_id: "jina-reranker-v2-base-multilingual",
-    },
-    task_settings: {
-      top_n: 10,
-      return_documents: true,
-    },
-  },
-});
-console.log(response);
-----

docs/doc_examples/c3b77e11b16e37e9e37e28dec922432e.asciidoc

@@ -1,11 +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.esql.query({
-  query:
-    '\nFROM library\n| WHERE match(author, "Frank Herbert", {"minimum_should_match": 2, "operator": "AND"})\n| LIMIT 5\n',
-});
-console.log(response);
-----

docs/doc_examples/cdb7613b445e6ed6e8b473f9cae1af90.asciidoc

@@ -1,35 +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.search({
-  query: {
-    intervals: {
-      my_text: {
-        all_of: {
-          ordered: true,
-          max_gaps: 1,
-          intervals: [
-            {
-              match: {
-                query: "my favorite food",
-                max_gaps: 0,
-                ordered: true,
-              },
-            },
-            {
-              match: {
-                query: "cold porridge",
-                max_gaps: 4,
-                ordered: true,
-              },
-            },
-          ],
-        },
-      },
-    },
-  },
-});
-console.log(response);
-----

docs/doc_examples/d29031409016b2b798148ef173a196ae.asciidoc

@@ -6,13 +6,13 @@
 const response = await client.indices.create({
   index: "test-index",
   query: {
-    match: {
-      my_field: "Which country is Paris in?",
+    semantic: {
+      field: "my_semantic_field",
     },
   },
   highlight: {
     fields: {
-      my_field: {
+      my_semantic_field: {
         type: "semantic",
         number_of_fragments: 2,
         order: "score",

docs/doc_examples/d2e7dead222cfbebbd2c21a7cc1893b4.asciidoc

@@ -1,11 +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.cluster.state({
-  metric: "metadata",
-  filter_path: "metadata.indices.*.system",
-});
-console.log(response);
-----

docs/doc_examples/d3672a87a857ddb87519788236e57497.asciidoc

@@ -1,28 +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.search({
-  index: "jinaai-index",
-  retriever: {
-    text_similarity_reranker: {
-      retriever: {
-        standard: {
-          query: {
-            semantic: {
-              field: "content",
-              query: "who inspired taking care of the sea?",
-            },
-          },
-        },
-      },
-      field: "content",
-      rank_window_size: 100,
-      inference_id: "jinaai-rerank",
-      inference_text: "who inspired taking care of the sea?",
-    },
-  },
-});
-console.log(response);
-----

docs/doc_examples/d3a0f648d0fd50b54a4e9ebe363c5047.asciidoc

@@ -1,44 +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.search({
-  index: "retrievers_example",
-  retriever: {
-    linear: {
-      retrievers: [
-        {
-          retriever: {
-            standard: {
-              query: {
-                query_string: {
-                  query: "(information retrieval) OR (artificial intelligence)",
-                  default_field: "text",
-                },
-              },
-            },
-          },
-          weight: 2,
-          normalizer: "minmax",
-        },
-        {
-          retriever: {
-            knn: {
-              field: "vector",
-              query_vector: [0.23, 0.67, 0.89],
-              k: 3,
-              num_candidates: 5,
-            },
-          },
-          weight: 1.5,
-          normalizer: "minmax",
-        },
-      ],
-      rank_window_size: 10,
-    },
-  },
-  _source: false,
-});
-console.log(response);
-----

docs/doc_examples/d6a4548b29e939fb197189c20c7c016f.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.inference.put({
-  task_type: "chat_completion",
-  inference_id: "chat-completion-endpoint",
-  inference_config: {
-    service: "elastic",
-    service_settings: {
-      model_id: "model-1",
-    },
-  },
-});
-console.log(response);
-----

docs/doc_examples/dd16c9c981551c9da47ebb5ef5105fa0.asciidoc

@@ -1,57 +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.updateAliases({
-  actions: [
-    {
-      add: {
-        index: ".reindexed-v9-ml-anomalies-custom-example",
-        alias: ".ml-anomalies-example1",
-        filter: {
-          term: {
-            job_id: {
-              value: "example1",
-            },
-          },
-        },
-        is_hidden: true,
-      },
-    },
-    {
-      add: {
-        index: ".reindexed-v9-ml-anomalies-custom-example",
-        alias: ".ml-anomalies-example2",
-        filter: {
-          term: {
-            job_id: {
-              value: "example2",
-            },
-          },
-        },
-        is_hidden: true,
-      },
-    },
-    {
-      remove: {
-        index: ".ml-anomalies-custom-example",
-        aliases: ".ml-anomalies-*",
-      },
-    },
-    {
-      remove_index: {
-        index: ".ml-anomalies-custom-example",
-      },
-    },
-    {
-      add: {
-        index: ".reindexed-v9-ml-anomalies-custom-example",
-        alias: ".ml-anomalies-custom-example",
-        is_hidden: true,
-      },
-    },
-  ],
-});
-console.log(response);
-----

docs/doc_examples/ddaadd91b7743a1c7e946ce1b593cd1b.asciidoc

@@ -3,13 +3,11 @@
 
 [source, js]
 ----
-const response = await client.inference.put({
+const response = await client.inference.inference({
   task_type: "my-inference-endpoint",
   inference_id: "_update",
-  inference_config: {
-    service_settings: {
-      api_key: "<API_KEY>",
-    },
+  service_settings: {
+    api_key: "<API_KEY>",
   },
 });
 console.log(response);

docs/doc_examples/e20037f66bf54bcac7d10f536f031f34.asciidoc

@@ -4,11 +4,9 @@
 [source, js]
 ----
 const response = await client.indices.putSettings({
-  index: ".reindexed-v9-ml-anomalies-custom-example",
+  index: "my-index-000001",
   settings: {
-    index: {
-      number_of_replicas: "<original_number_of_replicas>",
-    },
+    "index.blocks.read_only_allow_delete": null,
   },
 });
 console.log(response);

docs/doc_examples/e375c7da666276c4df6664c6821cd5f4.asciidoc

@@ -1,29 +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: "my-rank-vectors-float",
-  mappings: {
-    properties: {
-      my_vector: {
-        type: "rank_vectors",
-      },
-    },
-  },
-});
-console.log(response);
-
-const response1 = await client.index({
-  index: "my-rank-vectors-float",
-  id: 1,
-  document: {
-    my_vector: [
-      [0.5, 10, 6],
-      [-0.5, 10, 10],
-    ],
-  },
-});
-console.log(response1);
-----

docs/doc_examples/ee05714a83d75fb6858e3b9fcbeb8f8b.asciidoc

@@ -5,9 +5,6 @@
 ----
 const response = await client.indices.create({
   index: "retrievers_example",
-  settings: {
-    number_of_shards: 1,
-  },
   mappings: {
     properties: {
       vector: {
@@ -15,9 +12,6 @@ const response = await client.indices.create({
         dims: 3,
         similarity: "l2_norm",
         index: true,
-        index_options: {
-          type: "flat",
-        },
       },
       text: {
         type: "text",
@@ -28,9 +22,6 @@ const response = await client.indices.create({
       topic: {
         type: "keyword",
       },
-      timestamp: {
-        type: "date",
-      },
     },
   },
 });
@@ -44,7 +35,6 @@ const response1 = await client.index({
     text: "Large language models are revolutionizing information retrieval by boosting search precision, deepening contextual understanding, and reshaping user experiences in data-rich environments.",
     year: 2024,
     topic: ["llm", "ai", "information_retrieval"],
-    timestamp: "2021-01-01T12:10:30",
   },
 });
 console.log(response1);
@@ -57,7 +47,6 @@ const response2 = await client.index({
     text: "Artificial intelligence is transforming medicine, from advancing diagnostics and tailoring treatment plans to empowering predictive patient care for improved health outcomes.",
     year: 2023,
     topic: ["ai", "medicine"],
-    timestamp: "2022-01-01T12:10:30",
   },
 });
 console.log(response2);
@@ -70,7 +59,6 @@ const response3 = await client.index({
     text: "AI is redefining security by enabling advanced threat detection, proactive risk analysis, and dynamic defenses against increasingly sophisticated cyber threats.",
     year: 2024,
     topic: ["ai", "security"],
-    timestamp: "2023-01-01T12:10:30",
   },
 });
 console.log(response3);
@@ -83,7 +71,6 @@ const response4 = await client.index({
     text: "Elastic introduces Elastic AI Assistant, the open, generative AI sidekick powered by ESRE to democratize cybersecurity and enable users of every skill level.",
     year: 2023,
     topic: ["ai", "elastic", "assistant"],
-    timestamp: "2024-01-01T12:10:30",
   },
 });
 console.log(response4);
@@ -96,7 +83,6 @@ const response5 = await client.index({
     text: "Learn how to spin up a deployment of our hosted Elasticsearch Service and use Elastic Observability to gain deeper insight into the behavior of your applications and systems.",
     year: 2024,
     topic: ["documentation", "observability", "elastic"],
-    timestamp: "2025-01-01T12:10:30",
   },
 });
 console.log(response5);

docs/doc_examples/f9ee5d55a73f4c1fe7d507609047aefd.asciidoc

@@ -12,13 +12,6 @@ const response = await client.search({
       fields: ["my_field", "my_field._2gram", "my_field._3gram"],
     },
   },
-  highlight: {
-    fields: {
-      my_field: {
-        matched_fields: ["my_field._index_prefix"],
-      },
-    },
-  },
 });
 console.log(response);
 ----

docs/doc_examples/fff86117c47f974074284644e8a97a99.asciidoc

@@ -1,18 +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: "text_embedding",
-  inference_id: "jinaai-embeddings",
-  inference_config: {
-    service: "jinaai",
-    service_settings: {
-      model_id: "jina-embeddings-v3",
-      api_key: "<api_key>",
-    },
-  },
-});
-console.log(response);
-----

docs/docset.yml

@@ -1,489 +0,0 @@
-project: 'Node.js client'
-exclude:
-  - examples/proxy/README.md
-cross_links:
-  - docs-content
-  - elasticsearch
-toc:
-  - toc: reference
-  - toc: release-notes
-subs:
-  ref:   "https://www.elastic.co/guide/en/elasticsearch/reference/current"
-  ref-bare:   "https://www.elastic.co/guide/en/elasticsearch/reference"
-  ref-8x:   "https://www.elastic.co/guide/en/elasticsearch/reference/8.1"
-  ref-80:   "https://www.elastic.co/guide/en/elasticsearch/reference/8.0"
-  ref-7x:   "https://www.elastic.co/guide/en/elasticsearch/reference/7.17"
-  ref-70:   "https://www.elastic.co/guide/en/elasticsearch/reference/7.0"
-  ref-60:   "https://www.elastic.co/guide/en/elasticsearch/reference/6.0"
-  ref-64:   "https://www.elastic.co/guide/en/elasticsearch/reference/6.4"
-  xpack-ref:   "https://www.elastic.co/guide/en/x-pack/6.2"
-  logstash-ref:   "https://www.elastic.co/guide/en/logstash/current"
-  kibana-ref:   "https://www.elastic.co/guide/en/kibana/current"
-  kibana-ref-all:   "https://www.elastic.co/guide/en/kibana"
-  beats-ref-root:   "https://www.elastic.co/guide/en/beats"
-  beats-ref:   "https://www.elastic.co/guide/en/beats/libbeat/current"
-  beats-ref-60:   "https://www.elastic.co/guide/en/beats/libbeat/6.0"
-  beats-ref-63:   "https://www.elastic.co/guide/en/beats/libbeat/6.3"
-  beats-devguide:   "https://www.elastic.co/guide/en/beats/devguide/current"
-  auditbeat-ref:   "https://www.elastic.co/guide/en/beats/auditbeat/current"
-  packetbeat-ref:   "https://www.elastic.co/guide/en/beats/packetbeat/current"
-  metricbeat-ref:   "https://www.elastic.co/guide/en/beats/metricbeat/current"
-  filebeat-ref:   "https://www.elastic.co/guide/en/beats/filebeat/current"
-  functionbeat-ref:   "https://www.elastic.co/guide/en/beats/functionbeat/current"
-  winlogbeat-ref:   "https://www.elastic.co/guide/en/beats/winlogbeat/current"
-  heartbeat-ref:   "https://www.elastic.co/guide/en/beats/heartbeat/current"
-  journalbeat-ref:   "https://www.elastic.co/guide/en/beats/journalbeat/current"
-  ingest-guide:   "https://www.elastic.co/guide/en/ingest/current"
-  fleet-guide:   "https://www.elastic.co/guide/en/fleet/current"
-  apm-guide-ref:   "https://www.elastic.co/guide/en/apm/guide/current"
-  apm-guide-7x:   "https://www.elastic.co/guide/en/apm/guide/7.17"
-  apm-app-ref:   "https://www.elastic.co/guide/en/kibana/current"
-  apm-agents-ref:   "https://www.elastic.co/guide/en/apm/agent"
-  apm-android-ref:   "https://www.elastic.co/guide/en/apm/agent/android/current"
-  apm-py-ref:   "https://www.elastic.co/guide/en/apm/agent/python/current"
-  apm-py-ref-3x:   "https://www.elastic.co/guide/en/apm/agent/python/3.x"
-  apm-node-ref-index:   "https://www.elastic.co/guide/en/apm/agent/nodejs"
-  apm-node-ref:   "https://www.elastic.co/guide/en/apm/agent/nodejs/current"
-  apm-node-ref-1x:   "https://www.elastic.co/guide/en/apm/agent/nodejs/1.x"
-  apm-rum-ref:   "https://www.elastic.co/guide/en/apm/agent/rum-js/current"
-  apm-ruby-ref:   "https://www.elastic.co/guide/en/apm/agent/ruby/current"
-  apm-java-ref:   "https://www.elastic.co/guide/en/apm/agent/java/current"
-  apm-go-ref:   "https://www.elastic.co/guide/en/apm/agent/go/current"
-  apm-dotnet-ref:   "https://www.elastic.co/guide/en/apm/agent/dotnet/current"
-  apm-php-ref:   "https://www.elastic.co/guide/en/apm/agent/php/current"
-  apm-ios-ref:   "https://www.elastic.co/guide/en/apm/agent/swift/current"
-  apm-lambda-ref:   "https://www.elastic.co/guide/en/apm/lambda/current"
-  apm-attacher-ref:   "https://www.elastic.co/guide/en/apm/attacher/current"
-  docker-logging-ref:   "https://www.elastic.co/guide/en/beats/loggingplugin/current"
-  esf-ref:   "https://www.elastic.co/guide/en/esf/current"
-  kinesis-firehose-ref:   "https://www.elastic.co/guide/en/kinesis/{{kinesis_version}}"
-  estc-welcome-current:   "https://www.elastic.co/guide/en/starting-with-the-elasticsearch-platform-and-its-solutions/current"
-  estc-welcome:   "https://www.elastic.co/guide/en/starting-with-the-elasticsearch-platform-and-its-solutions/current"
-  estc-welcome-all:   "https://www.elastic.co/guide/en/starting-with-the-elasticsearch-platform-and-its-solutions"
-  hadoop-ref:   "https://www.elastic.co/guide/en/elasticsearch/hadoop/current"
-  stack-ref:   "https://www.elastic.co/guide/en/elastic-stack/current"
-  stack-ref-67:   "https://www.elastic.co/guide/en/elastic-stack/6.7"
-  stack-ref-68:   "https://www.elastic.co/guide/en/elastic-stack/6.8"
-  stack-ref-70:   "https://www.elastic.co/guide/en/elastic-stack/7.0"
-  stack-ref-80:   "https://www.elastic.co/guide/en/elastic-stack/8.0"
-  stack-ov:   "https://www.elastic.co/guide/en/elastic-stack-overview/current"
-  stack-gs:   "https://www.elastic.co/guide/en/elastic-stack-get-started/current"
-  stack-gs-current:   "https://www.elastic.co/guide/en/elastic-stack-get-started/current"
-  javaclient:   "https://www.elastic.co/guide/en/elasticsearch/client/java-api/current"
-  java-api-client:   "https://www.elastic.co/guide/en/elasticsearch/client/java-api-client/current"
-  java-rest:   "https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current"
-  jsclient:   "https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current"
-  jsclient-current:   "https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current"
-  es-ruby-client:   "https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current"
-  es-dotnet-client:   "https://www.elastic.co/guide/en/elasticsearch/client/net-api/current"
-  es-php-client:   "https://www.elastic.co/guide/en/elasticsearch/client/php-api/current"
-  es-python-client:   "https://www.elastic.co/guide/en/elasticsearch/client/python-api/current"
-  defguide:   "https://www.elastic.co/guide/en/elasticsearch/guide/2.x"
-  painless:   "https://www.elastic.co/guide/en/elasticsearch/painless/current"
-  plugins:   "https://www.elastic.co/guide/en/elasticsearch/plugins/current"
-  plugins-8x:   "https://www.elastic.co/guide/en/elasticsearch/plugins/8.1"
-  plugins-7x:   "https://www.elastic.co/guide/en/elasticsearch/plugins/7.17"
-  plugins-6x:   "https://www.elastic.co/guide/en/elasticsearch/plugins/6.8"
-  glossary:   "https://www.elastic.co/guide/en/elastic-stack-glossary/current"
-  upgrade_guide:   "https://www.elastic.co/products/upgrade_guide"
-  blog-ref:   "https://www.elastic.co/blog/"
-  curator-ref:   "https://www.elastic.co/guide/en/elasticsearch/client/curator/current"
-  curator-ref-current:   "https://www.elastic.co/guide/en/elasticsearch/client/curator/current"
-  metrics-ref:   "https://www.elastic.co/guide/en/metrics/current"
-  metrics-guide:   "https://www.elastic.co/guide/en/metrics/guide/current"
-  logs-ref:   "https://www.elastic.co/guide/en/logs/current"
-  logs-guide:   "https://www.elastic.co/guide/en/logs/guide/current"
-  uptime-guide:   "https://www.elastic.co/guide/en/uptime/current"
-  observability-guide:   "https://www.elastic.co/guide/en/observability/current"
-  observability-guide-all:   "https://www.elastic.co/guide/en/observability"
-  siem-guide:   "https://www.elastic.co/guide/en/siem/guide/current"
-  security-guide:   "https://www.elastic.co/guide/en/security/current"
-  security-guide-all:   "https://www.elastic.co/guide/en/security"
-  endpoint-guide:   "https://www.elastic.co/guide/en/endpoint/current"
-  sql-odbc:   "https://www.elastic.co/guide/en/elasticsearch/sql-odbc/current"
-  ecs-ref:   "https://www.elastic.co/guide/en/ecs/current"
-  ecs-logging-ref:   "https://www.elastic.co/guide/en/ecs-logging/overview/current"
-  ecs-logging-go-logrus-ref:   "https://www.elastic.co/guide/en/ecs-logging/go-logrus/current"
-  ecs-logging-go-zap-ref:   "https://www.elastic.co/guide/en/ecs-logging/go-zap/current"
-  ecs-logging-go-zerolog-ref:   "https://www.elastic.co/guide/en/ecs-logging/go-zap/current"
-  ecs-logging-java-ref:   "https://www.elastic.co/guide/en/ecs-logging/java/current"
-  ecs-logging-dotnet-ref:   "https://www.elastic.co/guide/en/ecs-logging/dotnet/current"
-  ecs-logging-nodejs-ref:   "https://www.elastic.co/guide/en/ecs-logging/nodejs/current"
-  ecs-logging-php-ref:   "https://www.elastic.co/guide/en/ecs-logging/php/current"
-  ecs-logging-python-ref:   "https://www.elastic.co/guide/en/ecs-logging/python/current"
-  ecs-logging-ruby-ref:   "https://www.elastic.co/guide/en/ecs-logging/ruby/current"
-  ml-docs:   "https://www.elastic.co/guide/en/machine-learning/current"
-  eland-docs:   "https://www.elastic.co/guide/en/elasticsearch/client/eland/current"
-  eql-ref:   "https://eql.readthedocs.io/en/latest/query-guide"
-  extendtrial:   "https://www.elastic.co/trialextension"
-  wikipedia:   "https://en.wikipedia.org/wiki"
-  forum:   "https://discuss.elastic.co/"
-  xpack-forum:   "https://discuss.elastic.co/c/50-x-pack"
-  security-forum:   "https://discuss.elastic.co/c/x-pack/shield"
-  watcher-forum:   "https://discuss.elastic.co/c/x-pack/watcher"
-  monitoring-forum:   "https://discuss.elastic.co/c/x-pack/marvel"
-  graph-forum:   "https://discuss.elastic.co/c/x-pack/graph"
-  apm-forum:   "https://discuss.elastic.co/c/apm"
-  enterprise-search-ref:   "https://www.elastic.co/guide/en/enterprise-search/current"
-  app-search-ref:   "https://www.elastic.co/guide/en/app-search/current"
-  workplace-search-ref:   "https://www.elastic.co/guide/en/workplace-search/current"
-  enterprise-search-node-ref:   "https://www.elastic.co/guide/en/enterprise-search-clients/enterprise-search-node/current"
-  enterprise-search-php-ref:   "https://www.elastic.co/guide/en/enterprise-search-clients/php/current"
-  enterprise-search-python-ref:   "https://www.elastic.co/guide/en/enterprise-search-clients/python/current"
-  enterprise-search-ruby-ref:   "https://www.elastic.co/guide/en/enterprise-search-clients/ruby/current"
-  elastic-maps-service:   "https://maps.elastic.co"
-  integrations-docs:   "https://docs.elastic.co/en/integrations"
-  integrations-devguide:   "https://www.elastic.co/guide/en/integrations-developer/current"
-  time-units:   "https://www.elastic.co/guide/en/elasticsearch/reference/current/api-conventions.html#time-units"
-  byte-units:   "https://www.elastic.co/guide/en/elasticsearch/reference/current/api-conventions.html#byte-units"
-  apm-py-ref-v:   "https://www.elastic.co/guide/en/apm/agent/python/current"
-  apm-node-ref-v:   "https://www.elastic.co/guide/en/apm/agent/nodejs/current"
-  apm-rum-ref-v:   "https://www.elastic.co/guide/en/apm/agent/rum-js/current"
-  apm-ruby-ref-v:   "https://www.elastic.co/guide/en/apm/agent/ruby/current"
-  apm-java-ref-v:   "https://www.elastic.co/guide/en/apm/agent/java/current"
-  apm-go-ref-v:   "https://www.elastic.co/guide/en/apm/agent/go/current"
-  apm-ios-ref-v:   "https://www.elastic.co/guide/en/apm/agent/swift/current"
-  apm-dotnet-ref-v:   "https://www.elastic.co/guide/en/apm/agent/dotnet/current"
-  apm-php-ref-v:   "https://www.elastic.co/guide/en/apm/agent/php/current"
-  ecloud:   "Elastic Cloud"
-  esf:   "Elastic Serverless Forwarder"
-  ess:   "Elasticsearch Service"
-  ece:   "Elastic Cloud Enterprise"
-  eck:   "Elastic Cloud on Kubernetes"
-  serverless-full:   "Elastic Cloud Serverless"
-  serverless-short:   "Serverless"
-  es-serverless:   "Elasticsearch Serverless"
-  es3:   "Elasticsearch Serverless"
-  obs-serverless:   "Elastic Observability Serverless"
-  sec-serverless:   "Elastic Security Serverless"
-  serverless-docs:   "https://docs.elastic.co/serverless"
-  cloud:   "https://www.elastic.co/guide/en/cloud/current"
-  ess-utm-params:   "?page=docs&placement=docs-body"
-  ess-baymax:   "?page=docs&placement=docs-body"
-  ess-trial:   "https://cloud.elastic.co/registration?page=docs&placement=docs-body"
-  ess-product:   "https://www.elastic.co/cloud/elasticsearch-service?page=docs&placement=docs-body"
-  ess-console:   "https://cloud.elastic.co?page=docs&placement=docs-body"
-  ess-console-name:   "Elasticsearch Service Console"
-  ess-deployments:   "https://cloud.elastic.co/deployments?page=docs&placement=docs-body"
-  ece-ref:   "https://www.elastic.co/guide/en/cloud-enterprise/current"
-  eck-ref:   "https://www.elastic.co/guide/en/cloud-on-k8s/current"
-  ess-leadin:   "You can run Elasticsearch on your own hardware or use our hosted Elasticsearch Service that is available on AWS, GCP, and Azure. https://cloud.elastic.co/registration{ess-utm-params}[Try the Elasticsearch Service for free]."
-  ess-leadin-short:   "Our hosted Elasticsearch Service is available on AWS, GCP, and Azure, and you can https://cloud.elastic.co/registration{ess-utm-params}[try it for free]."
-  ess-icon:   "image:https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg[link=\"https://cloud.elastic.co/registration{ess-utm-params}\", title=\"Supported on Elasticsearch Service\"]"
-  ece-icon:   "image:https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud_ece.svg[link=\"https://cloud.elastic.co/registration{ess-utm-params}\", title=\"Supported on Elastic Cloud Enterprise\"]"
-  cloud-only:   "This feature is designed for indirect use by https://cloud.elastic.co/registration{ess-utm-params}[Elasticsearch Service], https://www.elastic.co/guide/en/cloud-enterprise/{ece-version-link}[Elastic Cloud Enterprise], and https://www.elastic.co/guide/en/cloud-on-k8s/current[Elastic Cloud on Kubernetes]. Direct use is not supported."
-  ess-setting-change:   "image:https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg[link=\"{ess-trial}\", title=\"Supported on {ess}\"] indicates a change to a supported https://www.elastic.co/guide/en/cloud/current/ec-add-user-settings.html[user setting] for Elasticsearch Service."
-  ess-skip-section:   "If you use Elasticsearch Service, skip this section. Elasticsearch Service handles these changes for you."
-  api-cloud:   "https://www.elastic.co/docs/api/doc/cloud"
-  api-ece:   "https://www.elastic.co/docs/api/doc/cloud-enterprise"
-  api-kibana-serverless:   "https://www.elastic.co/docs/api/doc/serverless"
-  es-feature-flag:   "This feature is in development and not yet available for use. This documentation is provided for informational purposes only."
-  es-ref-dir:   "'{{elasticsearch-root}}/docs/reference'"
-  apm-app:   "APM app"
-  uptime-app:   "Uptime app"
-  synthetics-app:   "Synthetics app"
-  logs-app:   "Logs app"
-  metrics-app:   "Metrics app"
-  infrastructure-app:   "Infrastructure app"
-  siem-app:   "SIEM app"
-  security-app:   "Elastic Security app"
-  ml-app:   "Machine Learning"
-  dev-tools-app:   "Dev Tools"
-  ingest-manager-app:   "Ingest Manager"
-  stack-manage-app:   "Stack Management"
-  stack-monitor-app:   "Stack Monitoring"
-  alerts-ui:   "Alerts and Actions"
-  rules-ui:   "Rules"
-  rac-ui:   "Rules and Connectors"
-  connectors-ui:   "Connectors"
-  connectors-feature:   "Actions and Connectors"
-  stack-rules-feature:   "Stack Rules"
-  user-experience:   "User Experience"
-  ems:   "Elastic Maps Service"
-  ems-init:   "EMS"
-  hosted-ems:   "Elastic Maps Server"
-  ipm-app:   "Index Pattern Management"
-  ingest-pipelines:   "ingest pipelines"
-  ingest-pipelines-app:   "Ingest Pipelines"
-  ingest-pipelines-cap:   "Ingest pipelines"
-  ls-pipelines:   "Logstash pipelines"
-  ls-pipelines-app:   "Logstash Pipelines"
-  maint-windows:   "maintenance windows"
-  maint-windows-app:   "Maintenance Windows"
-  maint-windows-cap:   "Maintenance windows"
-  custom-roles-app:   "Custom Roles"
-  data-source:   "data view"
-  data-sources:   "data views"
-  data-source-caps:   "Data View"
-  data-sources-caps:   "Data Views"
-  data-source-cap:   "Data view"
-  data-sources-cap:   "Data views"
-  project-settings:   "Project settings"
-  manage-app:   "Management"
-  index-manage-app:   "Index Management"
-  data-views-app:   "Data Views"
-  rules-app:   "Rules"
-  saved-objects-app:   "Saved Objects"
-  tags-app:   "Tags"
-  api-keys-app:   "API keys"
-  transforms-app:   "Transforms"
-  connectors-app:   "Connectors"
-  files-app:   "Files"
-  reports-app:   "Reports"
-  maps-app:   "Maps"
-  alerts-app:   "Alerts"
-  crawler:   "Enterprise Search web crawler"
-  ents:   "Enterprise Search"
-  app-search-crawler:   "App Search web crawler"
-  agent:   "Elastic Agent"
-  agents:   "Elastic Agents"
-  fleet:   "Fleet"
-  fleet-server:   "Fleet Server"
-  integrations-server:   "Integrations Server"
-  ingest-manager:   "Ingest Manager"
-  ingest-management:   "ingest management"
-  package-manager:   "Elastic Package Manager"
-  integrations:   "Integrations"
-  package-registry:   "Elastic Package Registry"
-  artifact-registry:   "Elastic Artifact Registry"
-  aws:   "AWS"
-  stack:   "Elastic Stack"
-  xpack:   "X-Pack"
-  es:   "Elasticsearch"
-  kib:   "Kibana"
-  esms:   "Elastic Stack Monitoring Service"
-  esms-init:   "ESMS"
-  ls:   "Logstash"
-  beats:   "Beats"
-  auditbeat:   "Auditbeat"
-  filebeat:   "Filebeat"
-  heartbeat:   "Heartbeat"
-  metricbeat:   "Metricbeat"
-  packetbeat:   "Packetbeat"
-  winlogbeat:   "Winlogbeat"
-  functionbeat:   "Functionbeat"
-  journalbeat:   "Journalbeat"
-  es-sql:   "Elasticsearch SQL"
-  esql:   "ES|QL"
-  elastic-agent:   "Elastic Agent"
-  k8s:   "Kubernetes"
-  log-driver-long:   "Elastic Logging Plugin for Docker"
-  security:   "X-Pack security"
-  security-features:   "security features"
-  operator-feature:   "operator privileges feature"
-  es-security-features:   "Elasticsearch security features"
-  stack-security-features:   "Elastic Stack security features"
-  endpoint-sec:   "Endpoint Security"
-  endpoint-cloud-sec:   "Endpoint and Cloud Security"
-  elastic-defend:   "Elastic Defend"
-  elastic-sec:   "Elastic Security"
-  elastic-endpoint:   "Elastic Endpoint"
-  swimlane:   "Swimlane"
-  sn:   "ServiceNow"
-  sn-itsm:   "ServiceNow ITSM"
-  sn-itom:   "ServiceNow ITOM"
-  sn-sir:   "ServiceNow SecOps"
-  jira:   "Jira"
-  ibm-r:   "IBM Resilient"
-  webhook:   "Webhook"
-  webhook-cm:   "Webhook - Case Management"
-  opsgenie:   "Opsgenie"
-  bedrock:   "Amazon Bedrock"
-  gemini:   "Google Gemini"
-  hive:   "TheHive"
-  monitoring:   "X-Pack monitoring"
-  monitor-features:   "monitoring features"
-  stack-monitor-features:   "Elastic Stack monitoring features"
-  watcher:   "Watcher"
-  alert-features:   "alerting features"
-  reporting:   "X-Pack reporting"
-  report-features:   "reporting features"
-  graph:   "X-Pack graph"
-  graph-features:   "graph analytics features"
-  searchprofiler:   "Search Profiler"
-  xpackml:   "X-Pack machine learning"
-  ml:   "machine learning"
-  ml-cap:   "Machine learning"
-  ml-init:   "ML"
-  ml-features:   "machine learning features"
-  stack-ml-features:   "Elastic Stack machine learning features"
-  ccr:   "cross-cluster replication"
-  ccr-cap:   "Cross-cluster replication"
-  ccr-init:   "CCR"
-  ccs:   "cross-cluster search"
-  ccs-cap:   "Cross-cluster search"
-  ccs-init:   "CCS"
-  ilm:   "index lifecycle management"
-  ilm-cap:   "Index lifecycle management"
-  ilm-init:   "ILM"
-  dlm:   "data lifecycle management"
-  dlm-cap:   "Data lifecycle management"
-  dlm-init:   "DLM"
-  search-snap:   "searchable snapshot"
-  search-snaps:   "searchable snapshots"
-  search-snaps-cap:   "Searchable snapshots"
-  slm:   "snapshot lifecycle management"
-  slm-cap:   "Snapshot lifecycle management"
-  slm-init:   "SLM"
-  rollup-features:   "data rollup features"
-  ipm:   "index pattern management"
-  ipm-cap:   "Index pattern"
-  rollup:   "rollup"
-  rollup-cap:   "Rollup"
-  rollups:   "rollups"
-  rollups-cap:   "Rollups"
-  rollup-job:   "rollup job"
-  rollup-jobs:   "rollup jobs"
-  rollup-jobs-cap:   "Rollup jobs"
-  dfeed:   "datafeed"
-  dfeeds:   "datafeeds"
-  dfeed-cap:   "Datafeed"
-  dfeeds-cap:   "Datafeeds"
-  ml-jobs:   "machine learning jobs"
-  ml-jobs-cap:   "Machine learning jobs"
-  anomaly-detect:   "anomaly detection"
-  anomaly-detect-cap:   "Anomaly detection"
-  anomaly-job:   "anomaly detection job"
-  anomaly-jobs:   "anomaly detection jobs"
-  anomaly-jobs-cap:   "Anomaly detection jobs"
-  dataframe:   "data frame"
-  dataframes:   "data frames"
-  dataframe-cap:   "Data frame"
-  dataframes-cap:   "Data frames"
-  watcher-transform:   "payload transform"
-  watcher-transforms:   "payload transforms"
-  watcher-transform-cap:   "Payload transform"
-  watcher-transforms-cap:   "Payload transforms"
-  transform:   "transform"
-  transforms:   "transforms"
-  transform-cap:   "Transform"
-  transforms-cap:   "Transforms"
-  dataframe-transform:   "transform"
-  dataframe-transform-cap:   "Transform"
-  dataframe-transforms:   "transforms"
-  dataframe-transforms-cap:   "Transforms"
-  dfanalytics-cap:   "Data frame analytics"
-  dfanalytics:   "data frame analytics"
-  dataframe-analytics-config:   "'{dataframe} analytics config'"
-  dfanalytics-job:   "'{dataframe} analytics job'"
-  dfanalytics-jobs:   "'{dataframe} analytics jobs'"
-  dfanalytics-jobs-cap:   "'{dataframe-cap} analytics jobs'"
-  cdataframe:   "continuous data frame"
-  cdataframes:   "continuous data frames"
-  cdataframe-cap:   "Continuous data frame"
-  cdataframes-cap:   "Continuous data frames"
-  cdataframe-transform:   "continuous transform"
-  cdataframe-transforms:   "continuous transforms"
-  cdataframe-transforms-cap:   "Continuous transforms"
-  ctransform:   "continuous transform"
-  ctransform-cap:   "Continuous transform"
-  ctransforms:   "continuous transforms"
-  ctransforms-cap:   "Continuous transforms"
-  oldetection:   "outlier detection"
-  oldetection-cap:   "Outlier detection"
-  olscore:   "outlier score"
-  olscores:   "outlier scores"
-  fiscore:   "feature influence score"
-  evaluatedf-api:   "evaluate {dataframe} analytics API"
-  evaluatedf-api-cap:   "Evaluate {dataframe} analytics API"
-  binarysc:   "binary soft classification"
-  binarysc-cap:   "Binary soft classification"
-  regression:   "regression"
-  regression-cap:   "Regression"
-  reganalysis:   "regression analysis"
-  reganalysis-cap:   "Regression analysis"
-  depvar:   "dependent variable"
-  feature-var:   "feature variable"
-  feature-vars:   "feature variables"
-  feature-vars-cap:   "Feature variables"
-  classification:   "classification"
-  classification-cap:   "Classification"
-  classanalysis:   "classification analysis"
-  classanalysis-cap:   "Classification analysis"
-  infer-cap:   "Inference"
-  infer:   "inference"
-  lang-ident-cap:   "Language identification"
-  lang-ident:   "language identification"
-  data-viz:   "Data Visualizer"
-  file-data-viz:   "File Data Visualizer"
-  feat-imp:   "feature importance"
-  feat-imp-cap:   "Feature importance"
-  nlp:   "natural language processing"
-  nlp-cap:   "Natural language processing"
-  apm-agent:   "APM agent"
-  apm-go-agent:   "Elastic APM Go agent"
-  apm-go-agents:   "Elastic APM Go agents"
-  apm-ios-agent:   "Elastic APM iOS agent"
-  apm-ios-agents:   "Elastic APM iOS agents"
-  apm-java-agent:   "Elastic APM Java agent"
-  apm-java-agents:   "Elastic APM Java agents"
-  apm-dotnet-agent:   "Elastic APM .NET agent"
-  apm-dotnet-agents:   "Elastic APM .NET agents"
-  apm-node-agent:   "Elastic APM Node.js agent"
-  apm-node-agents:   "Elastic APM Node.js agents"
-  apm-php-agent:   "Elastic APM PHP agent"
-  apm-php-agents:   "Elastic APM PHP agents"
-  apm-py-agent:   "Elastic APM Python agent"
-  apm-py-agents:   "Elastic APM Python agents"
-  apm-ruby-agent:   "Elastic APM Ruby agent"
-  apm-ruby-agents:   "Elastic APM Ruby agents"
-  apm-rum-agent:   "Elastic APM Real User Monitoring (RUM) JavaScript agent"
-  apm-rum-agents:   "Elastic APM RUM JavaScript agents"
-  apm-lambda-ext:   "Elastic APM AWS Lambda extension"
-  project-monitors:   "project monitors"
-  project-monitors-cap:   "Project monitors"
-  private-location:   "Private Location"
-  private-locations:   "Private Locations"
-  pwd:   "YOUR_PASSWORD"
-  esh:   "ES-Hadoop"
-  default-dist:   "default distribution"
-  oss-dist:   "OSS-only distribution"
-  observability:   "Observability"
-  api-request-title:   "Request"
-  api-prereq-title:   "Prerequisites"
-  api-description-title:   "Description"
-  api-path-parms-title:   "Path parameters"
-  api-query-parms-title:   "Query parameters"
-  api-request-body-title:   "Request body"
-  api-response-codes-title:   "Response codes"
-  api-response-body-title:   "Response body"
-  api-example-title:   "Example"
-  api-examples-title:   "Examples"
-  api-definitions-title:   "Properties"
-  multi-arg:   "†footnoteref:[multi-arg,This parameter accepts multiple arguments.]"
-  multi-arg-ref:   "†footnoteref:[multi-arg]"
-  yes-icon:   "image:https://doc-icons.s3.us-east-2.amazonaws.com/icon-yes.png[Yes,20,15]"
-  no-icon:   "image:https://doc-icons.s3.us-east-2.amazonaws.com/icon-no.png[No,20,15]"
-  es-repo:   "https://github.com/elastic/elasticsearch/"
-  es-issue:   "https://github.com/elastic/elasticsearch/issues/"
-  es-pull:   "https://github.com/elastic/elasticsearch/pull/"
-  es-commit:   "https://github.com/elastic/elasticsearch/commit/"
-  kib-repo:   "https://github.com/elastic/kibana/"
-  kib-issue:   "https://github.com/elastic/kibana/issues/"
-  kibana-issue:   "'{kib-repo}issues/'"
-  kib-pull:   "https://github.com/elastic/kibana/pull/"
-  kibana-pull:   "'{kib-repo}pull/'"
-  kib-commit:   "https://github.com/elastic/kibana/commit/"
-  ml-repo:   "https://github.com/elastic/ml-cpp/"
-  ml-issue:   "https://github.com/elastic/ml-cpp/issues/"
-  ml-pull:   "https://github.com/elastic/ml-cpp/pull/"
-  ml-commit:   "https://github.com/elastic/ml-cpp/commit/"
-  apm-repo:   "https://github.com/elastic/apm-server/"
-  apm-issue:   "https://github.com/elastic/apm-server/issues/"
-  apm-pull:   "https://github.com/elastic/apm-server/pull/"
-  kibana-blob:   "https://github.com/elastic/kibana/blob/current/"
-  apm-get-started-ref:   "https://www.elastic.co/guide/en/apm/get-started/current"
-  apm-server-ref:   "https://www.elastic.co/guide/en/apm/server/current"
-  apm-server-ref-v:   "https://www.elastic.co/guide/en/apm/server/current"
-  apm-server-ref-m:   "https://www.elastic.co/guide/en/apm/server/master"
-  apm-server-ref-62:   "https://www.elastic.co/guide/en/apm/server/6.2"
-  apm-server-ref-64:   "https://www.elastic.co/guide/en/apm/server/6.4"
-  apm-server-ref-70:   "https://www.elastic.co/guide/en/apm/server/7.0"
-  apm-overview-ref-v:   "https://www.elastic.co/guide/en/apm/get-started/current"
-  apm-overview-ref-70:   "https://www.elastic.co/guide/en/apm/get-started/7.0"
-  apm-overview-ref-m:   "https://www.elastic.co/guide/en/apm/get-started/master"
-  infra-guide:   "https://www.elastic.co/guide/en/infrastructure/guide/current"
-  a-data-source:   "a data view"
-  icon-bug:   "pass:[<span class=\"eui-icon icon-bug\"></span>]"
-  icon-checkInCircleFilled:   "pass:[<span class=\"eui-icon icon-checkInCircleFilled\"></span>]"
-  icon-warningFilled:   "pass:[<span class=\"eui-icon icon-warningFilled\"></span>]"

docs/examples/asStream.asciidoc

@@ -1,13 +1,11 @@
----
-mapped_pages:
-  - https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/as_stream_examples.html
----
+[[as_stream_examples]]
+=== asStream
 
-# asStream [as_stream_examples]
+Instead of getting the parsed body back, you will get the raw Node.js stream of
+data.
 
-Instead of getting the parsed body back, you will get the raw Node.js stream of data.
-
-```js
+[source,js]
+----
 'use strict'
 
 const { Client } = require('@elastic/elasticsearch')
@@ -68,14 +66,13 @@ async function run () {
 }
 
 run().catch(console.log)
-```
+----
 
-::::{tip}
-This can be useful if you need to pipe the {{es}}'s response to a proxy, or send it directly to another source.
-::::
+TIP: This can be useful if you need to pipe the {es}'s response to a proxy, or
+send it directly to another source.
 
-
-```js
+[source,js]
+----
 'use strict'
 
 const { Client } = require('@elastic/elasticsearch')
@@ -99,5 +96,4 @@ fastify.post('/search/:index', async (req, reply) => {
 })
 
 fastify.listen(3000)
-```
-
+----

docs/examples/bulk.asciidoc

@@ -1,18 +1,13 @@
----
-mapped_pages:
-  - https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/bulk_examples.html
----
+[[bulk_examples]]
+=== Bulk
 
-# Bulk [bulk_examples]
+With the {jsclient}/api-reference.html#_bulk[`bulk` API], you can perform multiple index/delete operations in a 
+single API call. The `bulk` API significantly increases indexing speed.
 
-With the [`bulk` API](/reference/api-reference.md#_bulk), you can perform multiple index/delete operations in a single API call. The `bulk` API significantly increases indexing speed.
+NOTE: You can also use the {jsclient}/client-helpers.html[bulk helper].
 
-::::{note}
-You can also use the [bulk helper](/reference/client-helpers.md#bulk-helper).
-::::
-
-
-```js
+[source,js]
+----
 'use strict'
 
 require('array.prototype.flatmap').shim()
@@ -95,5 +90,4 @@ async function run () {
 }
 
 run().catch(console.log)
-```
-
+----

docs/examples/exists.asciidoc

@@ -1,18 +1,12 @@
----
-mapped_pages:
-  - https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/exists_examples.html
----
-
-# Exists [exists_examples]
+[[exists_examples]]
+=== Exists
 
 Check that the document `/game-of-thrones/1` exists.
 
-::::{note}
-Since this API uses the `HEAD` method, the body value will be boolean.
-::::
+NOTE: Since this API uses the `HEAD` method, the body value will be boolean.
 
-
-```js
+[source,js]
+---------
 'use strict'
 
 const { Client } = require('@elastic/elasticsearch')
@@ -40,5 +34,4 @@ async function run () {
 }
 
 run().catch(console.log)
-```
-
+---------

docs/examples/get.asciidoc

@@ -1,13 +1,12 @@
----
-mapped_pages:
-  - https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/get_examples.html
----
+[[get_examples]]
+=== Get
 
-# Get [get_examples]
+The get API allows to get a typed JSON document from the index based on its id. 
+The following example gets a JSON document from an index called 
+`game-of-thrones`, under a type called `_doc`, with id valued `'1'`.
 
-The get API allows to get a typed JSON document from the index based on its id. The following example gets a JSON document from an index called `game-of-thrones`, under a type called `_doc`, with id valued `'1'`.
-
-```js
+[source,js]
+---------
 'use strict'
 
 const { Client } = require('@elastic/elasticsearch')
@@ -35,5 +34,4 @@ async function run () {
 }
 
 run().catch(console.log)
-```
-
+---------

docs/examples/ignore.asciidoc

@@ -1,13 +1,10 @@
----
-mapped_pages:
-  - https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/ignore_examples.html
----
-
-# Ignore [ignore_examples]
+[[ignore_examples]]
+=== Ignore
 
 HTTP status codes which should not be considered errors for this request.
 
-```js
+[source,js]
+----
 'use strict'
 
 const { Client } = require('@elastic/elasticsearch')
@@ -65,5 +62,4 @@ async function run () {
 }
 
 run().catch(console.log)
-```
-
+----

docs/examples/index.asciidoc

@@ -0,0 +1,34 @@
+[[examples]]
+== Examples
+
+Following you can find some examples on how to use the client.
+
+* Use of the <<as_stream_examples,asStream>> parameter;
+* Executing a <<bulk_examples,bulk>> request;
+* Executing a <<exists_examples,exists>> request;
+* Executing a <<get_examples,get>> request;
+* Executing a <<sql_query_examples,sql.query>> request;
+* Executing a <<update_examples,update>> request;
+* Executing a <<update_by_query_examples,update by query>> request;
+* Executing a <<reindex_examples,reindex>> request;
+* Use of the <<ignore_examples,ignore>> parameter;
+* Executing a <<msearch_examples,msearch>> request;
+* How do I <<scroll_examples,scroll>>?
+* Executing a <<search_examples,search>> request;
+* I need <<suggest_examples,suggestions>>;
+* How to use the <<transport_request_examples,transport.request>> method;
+
+include::asStream.asciidoc[]
+include::bulk.asciidoc[]
+include::exists.asciidoc[]
+include::get.asciidoc[]
+include::ignore.asciidoc[]
+include::msearch.asciidoc[]
+include::scroll.asciidoc[]
+include::search.asciidoc[]
+include::suggest.asciidoc[]
+include::transport.request.asciidoc[]
+include::sql.query.asciidoc[]
+include::update.asciidoc[]
+include::update_by_query.asciidoc[]
+include::reindex.asciidoc[]

docs/examples/msearch.asciidoc

@@ -1,13 +1,11 @@
----
-mapped_pages:
-  - https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/msearch_examples.html
----
+[[msearch_examples]]
+=== MSearch
 
-# MSearch [msearch_examples]
+The multi search API allows to execute several search requests within the same 
+API. 
 
-The multi search API allows to execute several search requests within the same API.
-
-```js
+[source,js]
+----
 'use strict'
 
 const { Client } = require('@elastic/elasticsearch')
@@ -59,5 +57,4 @@ async function run () {
 }
 
 run().catch(console.log)
-```
-
+----