From 33a71e3289cbbc4984d42d5c2f26cfccf65cc44e Mon Sep 17 00:00:00 2001 From: Liam Thompson <32779855+leemthompo@users.noreply.github.com> Date: Wed, 17 Apr 2024 14:37:07 +0200 Subject: [PATCH] [DOCS] Refactor book-scoped variables in `docs/reference/index.asciidoc` (#107413) * Remove `es-test-dir` book-scoped variable * Remove `plugins-examples-dir` book-scoped variable * Remove `:dependencies-dir:` and `:xes-repo-dir:` book-scoped variables - In `index.asciidoc`, two variables (`:dependencies-dir:` and `:xes-repo-dir:`) were removed. - In `sql/index.asciidoc`, the `:sql-tests:` path was updated to fuller path - In `esql/index.asciidoc`, the `:esql-tests:` path was updated idem * Replace `es-repo-dir` with `es-ref-dir` * Move `:include-xpack: true` to few files that use it, remove from index.asciidoc --- .../RestTestsFromDocSnippetTaskSpec.groovy | 6 +- .../categorize-text-aggregation.asciidoc | 6 +- .../inference-bucket-aggregation.asciidoc | 8 +- docs/reference/alias.asciidoc | 2 +- .../stemmer-override-tokenfilter.asciidoc | 2 +- docs/reference/api-conventions.asciidoc | 8 +- docs/reference/cat/alias.asciidoc | 14 +- docs/reference/cat/allocation.asciidoc | 18 +- docs/reference/cat/anomaly-detectors.asciidoc | 112 ++--- .../cat/component-templates.asciidoc | 14 +- docs/reference/cat/count.asciidoc | 10 +- docs/reference/cat/datafeeds.asciidoc | 40 +- .../reference/cat/dataframeanalytics.asciidoc | 20 +- docs/reference/cat/fielddata.asciidoc | 12 +- docs/reference/cat/health.asciidoc | 12 +- docs/reference/cat/indices.asciidoc | 20 +- docs/reference/cat/master.asciidoc | 14 +- docs/reference/cat/nodeattrs.asciidoc | 14 +- docs/reference/cat/nodes.asciidoc | 18 +- docs/reference/cat/pending_tasks.asciidoc | 16 +- docs/reference/cat/plugins.asciidoc | 14 +- docs/reference/cat/recovery.asciidoc | 22 +- docs/reference/cat/repositories.asciidoc | 14 +- docs/reference/cat/segments.asciidoc | 30 +- docs/reference/cat/shards.asciidoc | 16 +- docs/reference/cat/snapshots.asciidoc | 14 +- docs/reference/cat/tasks.asciidoc | 16 +- docs/reference/cat/templates.asciidoc | 14 +- docs/reference/cat/thread_pool.asciidoc | 16 +- docs/reference/cat/trainedmodel.asciidoc | 14 +- docs/reference/cat/transforms.asciidoc | 74 +-- .../delete-auto-follow-pattern.asciidoc | 2 +- .../get-auto-follow-pattern.asciidoc | 2 +- .../pause-auto-follow-pattern.asciidoc | 2 +- .../put-auto-follow-pattern.asciidoc | 2 +- .../resume-auto-follow-pattern.asciidoc | 2 +- .../ccr/apis/follow/get-follow-info.asciidoc | 2 +- .../apis/follow/post-pause-follow.asciidoc | 2 +- .../apis/follow/post-resume-follow.asciidoc | 2 +- .../ccr/apis/follow/post-unfollow.asciidoc | 2 +- .../ccr/apis/follow/put-follow.asciidoc | 2 +- .../reference/ccr/apis/get-ccr-stats.asciidoc | 2 +- docs/reference/ccr/getting-started.asciidoc | 2 +- docs/reference/cluster/get-settings.asciidoc | 4 +- docs/reference/cluster/health.asciidoc | 6 +- .../cluster/nodes-hot-threads.asciidoc | 4 +- docs/reference/cluster/nodes-info.asciidoc | 6 +- docs/reference/cluster/nodes-stats.asciidoc | 22 +- docs/reference/cluster/nodes-usage.asciidoc | 4 +- docs/reference/cluster/pending.asciidoc | 4 +- .../cluster/prevalidate-node-removal.asciidoc | 2 +- docs/reference/cluster/reroute.asciidoc | 2 +- docs/reference/cluster/state.asciidoc | 6 +- docs/reference/cluster/stats.asciidoc | 4 +- docs/reference/cluster/tasks.asciidoc | 14 +- .../cluster/update-desired-nodes.asciidoc | 2 +- .../cluster/update-settings.asciidoc | 6 +- .../data-streams/data-stream-apis.asciidoc | 32 +- .../lifecycle/apis/delete-lifecycle.asciidoc | 2 +- .../lifecycle/apis/explain-lifecycle.asciidoc | 2 +- .../apis/get-global-retention.asciidoc | 4 +- .../lifecycle/apis/get-lifecycle.asciidoc | 2 +- .../lifecycle/apis/put-lifecycle.asciidoc | 2 +- .../set-up-a-data-stream.asciidoc | 2 +- docs/reference/docs/bulk.asciidoc | 42 +- docs/reference/docs/delete-by-query.asciidoc | 44 +- docs/reference/docs/delete.asciidoc | 14 +- docs/reference/docs/get.asciidoc | 18 +- docs/reference/docs/index_.asciidoc | 18 +- docs/reference/docs/multi-get.asciidoc | 14 +- .../reference/docs/multi-termvectors.asciidoc | 22 +- docs/reference/docs/reindex.asciidoc | 12 +- docs/reference/docs/termvectors.asciidoc | 22 +- docs/reference/docs/update-by-query.asciidoc | 46 +- docs/reference/docs/update.asciidoc | 12 +- docs/reference/eql/eql-search-api.asciidoc | 6 +- docs/reference/eql/eql.asciidoc | 4 +- .../esql/esql-across-clusters.asciidoc | 10 +- docs/reference/esql/esql-enrich-data.asciidoc | 4 +- docs/reference/esql/esql-get-started.asciidoc | 6 +- .../esql/esql-index-options.asciidoc | 4 +- docs/reference/esql/index.asciidoc | 2 +- docs/reference/getting-started.asciidoc | 6 +- docs/reference/how-to/disk-usage.asciidoc | 2 +- docs/reference/how-to/indexing-speed.asciidoc | 2 +- docs/reference/how-to/knn-search.asciidoc | 2 +- ...lasticsearch-for-time-series-data.asciidoc | 12 +- .../ilm/apis/delete-lifecycle.asciidoc | 2 +- docs/reference/ilm/apis/explain.asciidoc | 2 +- .../reference/ilm/apis/get-lifecycle.asciidoc | 2 +- docs/reference/ilm/apis/get-status.asciidoc | 2 +- docs/reference/ilm/apis/move-to-step.asciidoc | 2 +- .../reference/ilm/apis/put-lifecycle.asciidoc | 2 +- .../apis/remove-policy-from-index.asciidoc | 2 +- docs/reference/ilm/apis/retry-policy.asciidoc | 2 +- docs/reference/ilm/apis/start.asciidoc | 2 +- docs/reference/ilm/apis/stop.asciidoc | 2 +- docs/reference/index-modules/blocks.asciidoc | 10 +- docs/reference/index.asciidoc | 7 - docs/reference/indices/add-alias.asciidoc | 2 +- docs/reference/indices/alias-exists.asciidoc | 4 +- docs/reference/indices/aliases.asciidoc | 2 +- .../indices/apis/reload-analyzers.asciidoc | 6 +- docs/reference/indices/clearcache.asciidoc | 6 +- docs/reference/indices/clone-index.asciidoc | 10 +- docs/reference/indices/close.asciidoc | 14 +- docs/reference/indices/create-index.asciidoc | 8 +- .../indices/dangling-index-delete.asciidoc | 4 +- .../indices/dangling-index-import.asciidoc | 4 +- .../indices/data-stream-stats.asciidoc | 2 +- docs/reference/indices/delete-alias.asciidoc | 2 +- .../delete-component-template.asciidoc | 4 +- .../indices/delete-data-stream.asciidoc | 2 +- .../indices/delete-index-template-v1.asciidoc | 2 +- .../indices/delete-index-template.asciidoc | 4 +- docs/reference/indices/delete-index.asciidoc | 8 +- docs/reference/indices/diskusage.asciidoc | 8 +- .../indices/downsample-data-stream.asciidoc | 2 +- .../indices/field-usage-stats.asciidoc | 12 +- docs/reference/indices/flush.asciidoc | 6 +- docs/reference/indices/forcemerge.asciidoc | 6 +- docs/reference/indices/get-alias.asciidoc | 6 +- .../indices/get-data-stream.asciidoc | 2 +- .../indices/get-field-mapping.asciidoc | 6 +- .../indices/get-index-template-v1.asciidoc | 8 +- docs/reference/indices/get-index.asciidoc | 12 +- docs/reference/indices/get-mapping.asciidoc | 10 +- docs/reference/indices/get-settings.asciidoc | 14 +- .../indices/index-template-exists-v1.asciidoc | 8 +- .../reference/indices/indices-exists.asciidoc | 12 +- docs/reference/indices/open-close.asciidoc | 10 +- .../indices/put-component-template.asciidoc | 10 +- .../indices/put-index-template-v1.asciidoc | 8 +- .../indices/put-index-template.asciidoc | 2 +- docs/reference/indices/put-mapping.asciidoc | 8 +- docs/reference/indices/recovery.asciidoc | 6 +- docs/reference/indices/refresh.asciidoc | 6 +- .../indices/resolve-cluster.asciidoc | 6 +- docs/reference/indices/resolve.asciidoc | 6 +- .../reference/indices/rollover-index.asciidoc | 16 +- docs/reference/indices/segments.asciidoc | 22 +- docs/reference/indices/shard-stores.asciidoc | 6 +- docs/reference/indices/shrink-index.asciidoc | 10 +- .../indices/simulate-template.asciidoc | 2 +- docs/reference/indices/split-index.asciidoc | 10 +- docs/reference/indices/stats.asciidoc | 18 +- .../indices/update-settings.asciidoc | 10 +- .../ingest/apis/delete-pipeline.asciidoc | 2 +- .../ingest/apis/get-pipeline.asciidoc | 2 +- .../ingest/apis/put-pipeline.asciidoc | 2 +- docs/reference/ingest/enrich.asciidoc | 4 +- .../ingest/processors/inference.asciidoc | 126 ++--- .../mapping/explicit-mapping.asciidoc | 4 +- .../mapping/mapping-settings-limit.asciidoc | 2 +- .../types/aggregate-metric-double.asciidoc | 4 +- .../mapping/types/dense-vector.asciidoc | 2 +- docs/reference/mapping/types/nested.asciidoc | 4 +- docs/reference/mapping/types/numeric.asciidoc | 6 +- .../migration/apis/deprecation.asciidoc | 2 +- .../migration/apis/feature-migration.asciidoc | 2 +- .../migrate_8_0/rest-api-changes.asciidoc | 2 +- .../anomaly-detection/apis/close-job.asciidoc | 4 +- .../apis/delete-calendar-event.asciidoc | 2 +- .../apis/delete-calendar-job.asciidoc | 4 +- .../apis/delete-calendar.asciidoc | 2 +- .../apis/delete-datafeed.asciidoc | 2 +- .../apis/delete-filter.asciidoc | 2 +- .../apis/delete-forecast.asciidoc | 2 +- .../apis/delete-job.asciidoc | 2 +- .../apis/delete-snapshot.asciidoc | 4 +- .../anomaly-detection/apis/flush-job.asciidoc | 2 +- .../anomaly-detection/apis/forecast.asciidoc | 2 +- .../apis/get-bucket.asciidoc | 14 +- .../apis/get-calendar-event.asciidoc | 4 +- .../apis/get-calendar.asciidoc | 4 +- .../apis/get-category.asciidoc | 4 +- .../apis/get-datafeed-stats.asciidoc | 32 +- .../apis/get-datafeed.asciidoc | 6 +- .../apis/get-filter.asciidoc | 4 +- .../apis/get-influencer.asciidoc | 14 +- ...-job-model-snapshot-upgrade-stats.asciidoc | 18 +- .../apis/get-job-stats.asciidoc | 106 ++-- .../anomaly-detection/apis/get-job.asciidoc | 42 +- .../apis/get-overall-buckets.asciidoc | 8 +- .../apis/get-record.asciidoc | 20 +- .../apis/get-snapshot.asciidoc | 12 +- .../anomaly-detection/apis/open-job.asciidoc | 2 +- .../anomaly-detection/apis/post-data.asciidoc | 2 +- .../apis/preview-datafeed.asciidoc | 2 +- .../apis/put-calendar-job.asciidoc | 4 +- .../apis/put-calendar.asciidoc | 2 +- .../apis/put-datafeed.asciidoc | 40 +- .../apis/put-filter.asciidoc | 2 +- .../anomaly-detection/apis/put-job.asciidoc | 132 ++--- .../anomaly-detection/apis/reset-job.asciidoc | 2 +- .../apis/revert-snapshot.asciidoc | 4 +- .../apis/start-datafeed.asciidoc | 2 +- .../apis/stop-datafeed.asciidoc | 2 +- .../apis/update-datafeed.asciidoc | 38 +- .../apis/update-filter.asciidoc | 2 +- .../apis/update-job.asciidoc | 60 +-- .../apis/update-snapshot.asciidoc | 6 +- .../apis/upgrade-job-model-snapshot.asciidoc | 4 +- .../apis/validate-detector.asciidoc | 36 +- .../ml/common/apis/get-ml-memory.asciidoc | 8 +- .../apis/delete-dfanalytics.asciidoc | 2 +- .../apis/explain-dfanalytics.asciidoc | 2 +- .../apis/get-dfanalytics-stats.asciidoc | 126 ++--- .../apis/get-dfanalytics.asciidoc | 10 +- .../apis/preview-dfanalytics.asciidoc | 2 +- .../apis/put-dfanalytics.asciidoc | 132 ++--- .../apis/start-dfanalytics.asciidoc | 4 +- .../apis/stop-dfanalytics.asciidoc | 6 +- .../apis/update-dfanalytics.asciidoc | 8 +- docs/reference/ml/ml-shared.asciidoc | 8 +- ...ar-trained-model-deployment-cache.asciidoc | 2 +- .../apis/delete-trained-models.asciidoc | 2 +- .../apis/get-trained-models-stats.asciidoc | 20 +- .../apis/get-trained-models.asciidoc | 456 +++++++++--------- .../infer-trained-model-deployment.asciidoc | 2 +- .../apis/infer-trained-model.asciidoc | 262 +++++----- ...put-trained-model-definition-part.asciidoc | 2 +- .../put-trained-model-vocabulary.asciidoc | 2 +- .../apis/put-trained-models.asciidoc | 138 +++--- .../start-trained-model-deployment.asciidoc | 4 +- .../stop-trained-model-deployment.asciidoc | 4 +- .../update-trained-model-deployment.asciidoc | 2 +- docs/reference/modules/cluster/misc.asciidoc | 2 +- .../cluster/remote-clusters-api-key.asciidoc | 2 +- .../cluster/remote-clusters-cert.asciidoc | 2 +- .../modules/indices/index_management.asciidoc | 4 +- docs/reference/modules/node.asciidoc | 10 +- docs/reference/query-dsl/knn-query.asciidoc | 2 +- .../query-dsl/script-score-query.asciidoc | 2 +- ...ear-repositories-metering-archive.asciidoc | 4 +- .../apis/get-repositories-metering.asciidoc | 4 +- docs/reference/rest-api/common-parms.asciidoc | 2 +- docs/reference/rest-api/defs.asciidoc | 2 +- docs/reference/rest-api/index.asciidoc | 92 ++-- .../security/disable-user-profile.asciidoc | 2 +- .../security/enable-user-profile.asciidoc | 2 +- .../rest-api/security/query-api-key.asciidoc | 2 +- .../rest-api/security/query-user.asciidoc | 2 +- .../update-user-profile-data.asciidoc | 6 +- docs/reference/rest-api/usage.asciidoc | 2 +- .../reference/rest-api/watcher/start.asciidoc | 2 +- docs/reference/rest-api/watcher/stop.asciidoc | 2 +- .../apis/create-stored-script-api.asciidoc | 2 +- .../apis/delete-stored-script-api.asciidoc | 2 +- .../apis/get-stored-script-api.asciidoc | 2 +- docs/reference/scripting/engine.asciidoc | 2 +- docs/reference/search/count.asciidoc | 28 +- docs/reference/search/explain.asciidoc | 24 +- docs/reference/search/field-caps.asciidoc | 6 +- docs/reference/search/knn-search.asciidoc | 22 +- .../search/multi-search-template-api.asciidoc | 2 +- docs/reference/search/multi-search.asciidoc | 10 +- docs/reference/search/rank-eval.asciidoc | 6 +- docs/reference/search/retriever.asciidoc | 18 +- docs/reference/search/rrf.asciidoc | 6 +- docs/reference/search/search-shards.asciidoc | 12 +- .../search/search-template-api.asciidoc | 16 +- .../search/search-vector-tile-api.asciidoc | 2 +- .../search-your-data/knn-search.asciidoc | 2 +- .../search-across-clusters.asciidoc | 2 +- .../search-with-synonyms.asciidoc | 2 +- .../semantic-search-inference.asciidoc | 12 +- .../search-your-data/semantic-search.asciidoc | 10 +- docs/reference/search/search.asciidoc | 48 +- docs/reference/search/validate.asciidoc | 20 +- .../apis/mount-snapshot.asciidoc | 2 +- .../apis/node-cache-stats.asciidoc | 2 +- .../settings/monitoring-settings.asciidoc | 50 +- .../settings/security-settings.asciidoc | 184 +++---- docs/reference/settings/ssl-settings.asciidoc | 50 +- docs/reference/setup/add-nodes.asciidoc | 2 +- docs/reference/setup/configuration.asciidoc | 2 +- .../important-settings/path-settings.asciidoc | 6 +- docs/reference/setup/install/deb.asciidoc | 2 + docs/reference/setup/install/rpm.asciidoc | 4 + .../setup/install/targz-start.asciidoc | 2 +- docs/reference/setup/install/targz.asciidoc | 2 + .../setup/install/zip-windows-start.asciidoc | 2 +- .../setup/install/zip-windows.asciidoc | 2 + docs/reference/setup/logging-config.asciidoc | 2 +- docs/reference/setup/restart-cluster.asciidoc | 12 +- .../shutdown/apis/shutdown-delete.asciidoc | 2 +- .../shutdown/apis/shutdown-get.asciidoc | 2 +- .../shutdown/apis/shutdown-put.asciidoc | 2 +- .../slm/apis/slm-get-status.asciidoc | 2 +- docs/reference/slm/apis/slm-put.asciidoc | 4 +- docs/reference/slm/apis/slm-start.asciidoc | 2 +- docs/reference/slm/apis/slm-stop.asciidoc | 2 +- .../apis/clean-up-repo-api.asciidoc | 2 +- .../apis/clone-snapshot-api.asciidoc | 2 +- .../apis/create-snapshot-api.asciidoc | 2 +- .../apis/delete-repo-api.asciidoc | 2 +- .../apis/delete-snapshot-api.asciidoc | 2 +- .../apis/get-repo-api.asciidoc | 2 +- .../apis/get-snapshot-api.asciidoc | 2 +- .../apis/get-snapshot-status-api.asciidoc | 2 +- .../apis/put-repo-api.asciidoc | 2 +- .../apis/restore-snapshot-api.asciidoc | 2 +- .../apis/verify-repo-api.asciidoc | 2 +- .../repository-read-only-url.asciidoc | 2 +- .../repository-shared-file-system.asciidoc | 4 +- .../sql/apis/sql-search-api.asciidoc | 2 +- docs/reference/sql/index.asciidoc | 2 +- docs/reference/sql/security.asciidoc | 2 +- docs/reference/tab-widgets/ilm.asciidoc | 2 +- .../tab-widgets/register-fs-repo.asciidoc | 4 +- .../tab-widgets/snapshot-repo.asciidoc | 2 +- .../apis/find-field-structure.asciidoc | 22 +- .../apis/find-message-structure.asciidoc | 22 +- .../apis/find-structure.asciidoc | 30 +- .../transform/apis/delete-transform.asciidoc | 2 +- .../apis/get-transform-stats.asciidoc | 52 +- .../transform/apis/get-transform.asciidoc | 8 +- .../transform/apis/preview-transform.asciidoc | 58 +-- .../transform/apis/put-transform.asciidoc | 68 +-- .../transform/apis/reset-transform.asciidoc | 2 +- .../apis/schedule-now-transform.asciidoc | 2 +- .../transform/apis/stop-transform.asciidoc | 2 +- .../transform/apis/update-transform.asciidoc | 56 +-- .../diagnose-unassigned-shards.asciidoc | 2 +- .../common-issues/high-cpu-usage.asciidoc | 2 +- .../high-jvm-memory-pressure.asciidoc | 2 +- .../troubleshooting/data/add-tier.asciidoc | 2 +- .../data-tiers-mixed-with-node-attr.asciidoc | 2 +- .../data/enable-cluster-allocation.asciidoc | 2 +- .../data/enable-index-allocation.asciidoc | 2 +- .../increase-cluster-shard-limit.asciidoc | 2 +- .../data/increase-shard-limit.asciidoc | 2 +- .../data/increase-tier-capacity.asciidoc | 2 +- .../data/restore-from-snapshot.asciidoc | 2 +- .../troubleshooting/data/start-ilm.asciidoc | 2 +- .../troubleshooting/data/start-slm.asciidoc | 2 +- .../disk/fix-data-node-out-of-disk.asciidoc | 4 +- .../disk/fix-master-node-out-of-disk.asciidoc | 2 +- .../disk/fix-other-node-out-of-disk.asciidoc | 2 +- .../snapshot/add-repository.asciidoc | 2 +- .../repeated-snapshot-failures.asciidoc | 2 +- .../troubleshooting-shards-capacity.asciidoc | 2 +- docs/reference/upgrade.asciidoc | 2 +- 344 files changed, 2331 insertions(+), 2328 deletions(-) diff --git a/build-tools-internal/src/test/groovy/org/elasticsearch/gradle/internal/doc/RestTestsFromDocSnippetTaskSpec.groovy b/build-tools-internal/src/test/groovy/org/elasticsearch/gradle/internal/doc/RestTestsFromDocSnippetTaskSpec.groovy index 6e86cba23588..45d389212195 100644 --- a/build-tools-internal/src/test/groovy/org/elasticsearch/gradle/internal/doc/RestTestsFromDocSnippetTaskSpec.groovy +++ b/build-tools-internal/src/test/groovy/org/elasticsearch/gradle/internal/doc/RestTestsFromDocSnippetTaskSpec.groovy @@ -454,11 +454,11 @@ Requires the `manage_ml` cluster privilege. This privilege is included in the ``:: (Required, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] ``:: (Required, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=snapshot-id] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=snapshot-id] [[ml-update-snapshot-request-body]] == {api-request-body-title} @@ -470,7 +470,7 @@ The following properties can be updated after the model snapshot is created: `retain`:: (Optional, Boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=retain] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=retain] [[ml-update-snapshot-example]] diff --git a/docs/reference/aggregations/bucket/categorize-text-aggregation.asciidoc b/docs/reference/aggregations/bucket/categorize-text-aggregation.asciidoc index 8ecd66d6ae7a..399e6ed87581 100644 --- a/docs/reference/aggregations/bucket/categorize-text-aggregation.asciidoc +++ b/docs/reference/aggregations/bucket/categorize-text-aggregation.asciidoc @@ -40,15 +40,15 @@ is an object it has the following properties: ===== `char_filter`:::: (array of strings or objects) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=char-filter] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=char-filter] `tokenizer`:::: (string or object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=tokenizer] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=tokenizer] `filter`:::: (array of strings or objects) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=filter] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=filter] ===== `categorization_filters`:: diff --git a/docs/reference/aggregations/pipeline/inference-bucket-aggregation.asciidoc b/docs/reference/aggregations/pipeline/inference-bucket-aggregation.asciidoc index 911a123ded28..064881925e8d 100644 --- a/docs/reference/aggregations/pipeline/inference-bucket-aggregation.asciidoc +++ b/docs/reference/aggregations/pipeline/inference-bucket-aggregation.asciidoc @@ -65,7 +65,7 @@ aggregations some options can be overridden for each of the two types of model. `num_top_feature_importance_values`:: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-regression-num-top-feature-importance-values] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-regression-num-top-feature-importance-values] [discrete] [[inference-agg-classification-opt]] @@ -73,15 +73,15 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-regression-num `num_top_classes`:: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-classification-num-top-classes] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-classification-num-top-classes] `num_top_feature_importance_values`:: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-classification-num-top-feature-importance-values] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-classification-num-top-feature-importance-values] `prediction_field_type`:: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-classification-prediction-field-type] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-classification-prediction-field-type] [[inference-bucket-agg-example]] diff --git a/docs/reference/alias.asciidoc b/docs/reference/alias.asciidoc index 5b30501ed7c9..e5c2db65778d 100644 --- a/docs/reference/alias.asciidoc +++ b/docs/reference/alias.asciidoc @@ -308,7 +308,7 @@ POST _aliases ---- // TEST[s/^/PUT _data_stream\/logs-nginx.access-prod\nPUT _data_stream\/logs-my_app-default\n/] -include::{es-repo-dir}/indices/aliases.asciidoc[tag=write-index-defaults] +include::{es-ref-dir}/indices/aliases.asciidoc[tag=write-index-defaults] TIP: We recommend using data streams to store append-only time series data. If you need to update or delete existing time series data, you can perform update or delete operations diff --git a/docs/reference/analysis/tokenfilters/stemmer-override-tokenfilter.asciidoc b/docs/reference/analysis/tokenfilters/stemmer-override-tokenfilter.asciidoc index 99cbe695f8f9..7d070a94cb0d 100644 --- a/docs/reference/analysis/tokenfilters/stemmer-override-tokenfilter.asciidoc +++ b/docs/reference/analysis/tokenfilters/stemmer-override-tokenfilter.asciidoc @@ -48,7 +48,7 @@ Where the file looks like: [source,stemmer_override] -------------------------------------------------- -include::{es-test-dir}/cluster/config/analysis/stemmer_override.txt[] +include::{elasticsearch-root}/docs/src/test/cluster/config/analysis/stemmer_override.txt[] -------------------------------------------------- You can also define the overrides rules inline: diff --git a/docs/reference/api-conventions.asciidoc b/docs/reference/api-conventions.asciidoc index 1a63af19b0a3..25881b707d72 100644 --- a/docs/reference/api-conventions.asciidoc +++ b/docs/reference/api-conventions.asciidoc @@ -205,18 +205,18 @@ on a remote cluster is currently not supported. For example, this will throw an Multi-target APIs that can target indices support the following query string parameters: -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] The defaults settings for the above parameters depend on the API being used. Some multi-target APIs that can target indices also support the following query string parameter: -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=ignore_throttled] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=ignore_throttled] NOTE: APIs with a single target, such as the <>, do not support multi-target syntax. diff --git a/docs/reference/cat/alias.asciidoc b/docs/reference/cat/alias.asciidoc index e7329d05534f..b6459eaa93b8 100644 --- a/docs/reference/cat/alias.asciidoc +++ b/docs/reference/cat/alias.asciidoc @@ -39,19 +39,19 @@ wildcards (`*`). To retrieve all aliases, omit this parameter or use `*` or [[cat-alias-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=http-format] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-h] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-h] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=help] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=local] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=local] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-s] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-v] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] [[cat-alias-api-example]] ==== {api-examples-title} diff --git a/docs/reference/cat/allocation.asciidoc b/docs/reference/cat/allocation.asciidoc index 7bab1926cff0..0891406d1be4 100644 --- a/docs/reference/cat/allocation.asciidoc +++ b/docs/reference/cat/allocation.asciidoc @@ -30,26 +30,26 @@ and their disk space. [[cat-allocation-api-path-params]] ==== {api-path-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=node-id] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=node-id] [[cat-allocation-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bytes] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=bytes] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=http-format] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=local] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=local] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-h] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-h] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=help] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-s] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-v] [[cat-allocation-api-response-body]] ==== {api-response-body-title} diff --git a/docs/reference/cat/anomaly-detectors.asciidoc b/docs/reference/cat/anomaly-detectors.asciidoc index 30272e67286c..607a88d1e1a5 100644 --- a/docs/reference/cat/anomaly-detectors.asciidoc +++ b/docs/reference/cat/anomaly-detectors.asciidoc @@ -43,20 +43,20 @@ For more information about {anomaly-detect}, see ``:: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] [[cat-anomaly-detectors-query-params]] ==== {api-query-parms-title} `allow_no_match`:: (Optional, Boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-no-match-jobs] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=allow-no-match-jobs] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bytes] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=bytes] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=http-format] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-h] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-h] + If you do not specify which columns to include, the API returns the default columns. If you explicitly specify one or more columns, it returns only the @@ -65,75 +65,75 @@ specified columns. Valid columns are: `assignment_explanation`, `ae`::: -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=assignment-explanation-anomaly-jobs] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=assignment-explanation-anomaly-jobs] `buckets.count`, `bc`, `bucketsCount`::: (Default) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=bucket-count-anomaly-jobs] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=bucket-count-anomaly-jobs] `buckets.time.exp_avg`, `btea`, `bucketsTimeExpAvg`::: -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=bucket-time-exponential-average] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=bucket-time-exponential-average] `buckets.time.exp_avg_hour`, `bteah`, `bucketsTimeExpAvgHour`::: -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=bucket-time-exponential-average-hour] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=bucket-time-exponential-average-hour] `buckets.time.max`, `btmax`, `bucketsTimeMax`::: -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=bucket-time-maximum] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=bucket-time-maximum] `buckets.time.min`, `btmin`, `bucketsTimeMin`::: -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=bucket-time-minimum] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=bucket-time-minimum] `buckets.time.total`, `btt`, `bucketsTimeTotal`::: -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=bucket-time-total] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=bucket-time-total] `data.buckets`, `db`, `dataBuckets`::: -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=bucket-count] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=bucket-count] `data.earliest_record`, `der`, `dataEarliestRecord`::: -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=earliest-record-timestamp] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=earliest-record-timestamp] `data.empty_buckets`, `deb`, `dataEmptyBuckets`::: -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=empty-bucket-count] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=empty-bucket-count] `data.input_bytes`, `dib`, `dataInputBytes`::: -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=input-bytes] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=input-bytes] `data.input_fields`, `dif`, `dataInputFields`::: -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=input-field-count] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=input-field-count] `data.input_records`, `dir`, `dataInputRecords`::: -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=input-record-count] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=input-record-count] `data.invalid_dates`, `did`, `dataInvalidDates`::: -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=invalid-date-count] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=invalid-date-count] `data.last`, `dl`, `dataLast`::: -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=last-data-time] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=last-data-time] `data.last_empty_bucket`, `dleb`, `dataLastEmptyBucket`::: -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=latest-empty-bucket-timestamp] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=latest-empty-bucket-timestamp] `data.last_sparse_bucket`, `dlsb`, `dataLastSparseBucket`::: -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=latest-sparse-record-timestamp] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=latest-sparse-record-timestamp] `data.latest_record`, `dlr`, `dataLatestRecord`::: -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=latest-record-timestamp] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=latest-record-timestamp] `data.missing_fields`, `dmf`, `dataMissingFields`::: -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=missing-field-count] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=missing-field-count] `data.out_of_order_timestamps`, `doot`, `dataOutOfOrderTimestamps`::: -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=out-of-order-timestamp-count] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=out-of-order-timestamp-count] `data.processed_fields`, `dpf`, `dataProcessedFields`::: -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=processed-field-count] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=processed-field-count] `data.processed_records`, `dpr`, `dataProcessedRecords`::: (Default) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=processed-record-count] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=processed-record-count] `data.sparse_buckets`, `dsb`, `dataSparseBuckets`::: -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=sparse-bucket-count] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=sparse-bucket-count] `forecasts.memory.avg`, `fmavg`, `forecastsMemoryAvg`::: The average memory usage in bytes for forecasts related to the {anomaly-job}. @@ -177,99 +177,99 @@ The total runtime in milliseconds for forecasts related to the {anomaly-job}. `forecasts.total`, `ft`, `forecastsTotal`::: (Default) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=forecast-total] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=forecast-total] `id`::: (Default) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] `model.bucket_allocation_failures`, `mbaf`, `modelBucketAllocationFailures`::: -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=bucket-allocation-failures-count] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=bucket-allocation-failures-count] `model.by_fields`, `mbf`, `modelByFields`::: -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=total-by-field-count] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=total-by-field-count] `model.bytes`, `mb`, `modelBytes`::: (Default) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=model-bytes] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=model-bytes] `model.bytes_exceeded`, `mbe`, `modelBytesExceeded`::: -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=model-bytes-exceeded] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=model-bytes-exceeded] `model.categorization_status`, `mcs`, `modelCategorizationStatus`::: -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=categorization-status] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=categorization-status] `model.categorized_doc_count`, `mcdc`, `modelCategorizedDocCount`::: -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=categorized-doc-count] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=categorized-doc-count] `model.dead_category_count`, `mdcc`, `modelDeadCategoryCount`::: -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=dead-category-count] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=dead-category-count] `model.failed_category_count`, `mdcc`, `modelFailedCategoryCount`::: -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=failed-category-count] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=failed-category-count] `model.frequent_category_count`, `mfcc`, `modelFrequentCategoryCount`::: -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=frequent-category-count] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=frequent-category-count] `model.log_time`, `mlt`, `modelLogTime`::: The timestamp when the model stats were gathered, according to server time. `model.memory_limit`, `mml`, `modelMemoryLimit`::: -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=model-memory-limit-anomaly-jobs] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=model-memory-limit-anomaly-jobs] `model.memory_status`, `mms`, `modelMemoryStatus`::: (Default) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=model-memory-status] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=model-memory-status] `model.over_fields`, `mof`, `modelOverFields`::: -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=total-over-field-count] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=total-over-field-count] `model.partition_fields`, `mpf`, `modelPartitionFields`::: -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=total-partition-field-count] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=total-partition-field-count] `model.rare_category_count`, `mrcc`, `modelRareCategoryCount`::: -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=rare-category-count] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=rare-category-count] `model.timestamp`, `mt`, `modelTimestamp`::: -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=model-timestamp] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=model-timestamp] `model.total_category_count`, `mtcc`, `modelTotalCategoryCount`::: -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=total-category-count] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=total-category-count] `node.address`, `na`, `nodeAddress`::: The network address of the node. + -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=node-jobs] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=node-jobs] `node.ephemeral_id`, `ne`, `nodeEphemeralId`::: The ephemeral ID of the node. + -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=node-jobs] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=node-jobs] `node.id`, `ni`, `nodeId`::: The unique identifier of the node. + -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=node-jobs] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=node-jobs] `node.name`, `nn`, `nodeName`::: The node name. + -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=node-jobs] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=node-jobs] `opened_time`, `ot`::: -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=open-time] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=open-time] `state`, `s`::: (Default) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=state-anomaly-job] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=state-anomaly-job] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=help] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-s] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=time] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=time] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-v] [[cat-anomaly-detectors-example]] ==== {api-examples-title} diff --git a/docs/reference/cat/component-templates.asciidoc b/docs/reference/cat/component-templates.asciidoc index e642899e7045..596c86befd1b 100644 --- a/docs/reference/cat/component-templates.asciidoc +++ b/docs/reference/cat/component-templates.asciidoc @@ -40,19 +40,19 @@ wildcard expressions. If omitted, all component templates are returned. [[cat-component-templates-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=http-format] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-h] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-h] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=help] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=local] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=local] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-s] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-v] [[cat-component-templates-api-example]] diff --git a/docs/reference/cat/count.asciidoc b/docs/reference/cat/count.asciidoc index 5fdae8768e1e..37e602c75902 100644 --- a/docs/reference/cat/count.asciidoc +++ b/docs/reference/cat/count.asciidoc @@ -43,15 +43,15 @@ and indices, omit this parameter or use `*` or `_all`. [[cat-count-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=http-format] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-h] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-h] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=help] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-s] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-v] [[cat-count-api-example]] diff --git a/docs/reference/cat/datafeeds.asciidoc b/docs/reference/cat/datafeeds.asciidoc index 82a7853a569c..9b6481191e59 100644 --- a/docs/reference/cat/datafeeds.asciidoc +++ b/docs/reference/cat/datafeeds.asciidoc @@ -42,18 +42,18 @@ NOTE: This API returns a maximum of 10,000 jobs. ``:: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=datafeed-id] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=datafeed-id] [[cat-datafeeds-query-params]] ==== {api-query-parms-title} `allow_no_match`:: (Optional, Boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-no-match-datafeeds] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=allow-no-match-datafeeds] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=http-format] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-h] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-h] + If you do not specify which columns to include, the API returns the default columns. If you explicitly specify one or more columns, it returns only the @@ -62,60 +62,60 @@ specified columns. Valid columns are: `assignment_explanation`, `ae`::: -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=assignment-explanation-datafeeds] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=assignment-explanation-datafeeds] `buckets.count`, `bc`, `bucketsCount`::: (Default) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=bucket-count] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=bucket-count] `id`::: (Default) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=datafeed-id] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=datafeed-id] `node.address`, `na`, `nodeAddress`::: The network address of the node. + -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=node-datafeeds] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=node-datafeeds] `node.ephemeral_id`, `ne`, `nodeEphemeralId`::: The ephemeral ID of the node. + -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=node-datafeeds] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=node-datafeeds] `node.id`, `ni`, `nodeId`::: The unique identifier of the node. + -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=node-datafeeds] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=node-datafeeds] `node.name`, `nn`, `nodeName`::: The node name. + -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=node-datafeeds] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=node-datafeeds] `search.bucket_avg`, `sba`, `searchBucketAvg`::: -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=search-bucket-avg] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=search-bucket-avg] `search.count`, `sc`, `searchCount`::: (Default) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=search-count] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=search-count] `search.exp_avg_hour`, `seah`, `searchExpAvgHour`::: -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=search-exp-avg-hour] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=search-exp-avg-hour] `search.time`, `st`, `searchTime`::: -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=search-time] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=search-time] `state`, `s`::: (Default) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=state-datafeed] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=state-datafeed] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=help] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-s] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=time] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=time] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-v] [[cat-datafeeds-example]] ==== {api-examples-title} diff --git a/docs/reference/cat/dataframeanalytics.asciidoc b/docs/reference/cat/dataframeanalytics.asciidoc index c39146ab2266..4c236ecf61ff 100644 --- a/docs/reference/cat/dataframeanalytics.asciidoc +++ b/docs/reference/cat/dataframeanalytics.asciidoc @@ -46,15 +46,15 @@ For more information, see <> and {ml-docs-setup-privileges} ``:: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-data-frame-analytics-default] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=job-id-data-frame-analytics-default] [[cat-dfanalytics-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=http-format] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-h] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-h] + If you do not specify which columns to include, the API returns the default columns. If you explicitly specify one or more columns, it returns only the @@ -63,14 +63,14 @@ specified columns. Valid columns are: `assignment_explanation`, `ae`::: -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=assignment-explanation-dfanalytics] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=assignment-explanation-dfanalytics] `create_time`, `ct`, `createTime`::: (Default) The time when the {dfanalytics-job} was created. `description`, `d`::: -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=description-dfa] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=description-dfa] `dest_index`, `di`, `destIndex`::: Name of the destination index. @@ -80,7 +80,7 @@ Contains messages about the reason why a {dfanalytics-job} failed. `id`::: (Default) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-data-frame-analytics] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=job-id-data-frame-analytics] `model_memory_limit`, `mml`, `modelMemoryLimit`::: The approximate maximum amount of memory resources that are permitted for the @@ -115,13 +115,13 @@ The type of analysis that the {dfanalytics-job} performs. `version`, `v`::: The {es} version number in which the {dfanalytics-job} was created. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=help] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-s] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=time] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=time] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-v] [[cat-dfanalytics-example]] diff --git a/docs/reference/cat/fielddata.asciidoc b/docs/reference/cat/fielddata.asciidoc index 55b9e1f56277..376ef1d97057 100644 --- a/docs/reference/cat/fielddata.asciidoc +++ b/docs/reference/cat/fielddata.asciidoc @@ -39,17 +39,17 @@ information. [[cat-fielddata-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bytes] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=bytes] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=http-format] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-h] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-h] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=help] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-s] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-v] [[cat-fielddata-api-example]] diff --git a/docs/reference/cat/health.asciidoc b/docs/reference/cat/health.asciidoc index 84661ae8ef32..04a11699d3ec 100644 --- a/docs/reference/cat/health.asciidoc +++ b/docs/reference/cat/health.asciidoc @@ -51,22 +51,22 @@ over a longer period of time. See <>. [[cat-health-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=http-format] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-h] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-h] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=help] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-s] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=time] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=time] `ts` (timestamps):: (Optional, Boolean) If `true`, returns `HH:MM:SS` and {wikipedia}/Unix_time[Unix `epoch`] timestamps. Defaults to `true`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-v] [[cat-health-api-example]] diff --git a/docs/reference/cat/indices.asciidoc b/docs/reference/cat/indices.asciidoc index 43b10c83264c..64b90c4f8e35 100644 --- a/docs/reference/cat/indices.asciidoc +++ b/docs/reference/cat/indices.asciidoc @@ -62,11 +62,11 @@ and indices, omit this parameter or use `*` or `_all`. [[cat-indices-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bytes] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=bytes] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=http-format] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-h] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-h] `health`:: + @@ -81,24 +81,24 @@ are: By default, the response includes indices of any health status. -- -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=help] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=include-unloaded-segments] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=include-unloaded-segments] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] [[pri-flag]] `pri` (primary shards):: (Optional, Boolean) If `true`, the response only includes information from primary shards. Defaults to `false`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-s] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=time] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=time] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-v] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] [[cat-indices-api-example]] diff --git a/docs/reference/cat/master.asciidoc b/docs/reference/cat/master.asciidoc index 151e0ac6516a..42348fc4939d 100644 --- a/docs/reference/cat/master.asciidoc +++ b/docs/reference/cat/master.asciidoc @@ -29,19 +29,19 @@ and name. [[cat-master-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=http-format] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-h] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-h] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=help] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=local] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=local] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-s] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-v] [[cat-master-api-example]] diff --git a/docs/reference/cat/nodeattrs.asciidoc b/docs/reference/cat/nodeattrs.asciidoc index d4e07f153da2..2db0c3fc2027 100644 --- a/docs/reference/cat/nodeattrs.asciidoc +++ b/docs/reference/cat/nodeattrs.asciidoc @@ -27,9 +27,9 @@ Returns information about custom node attributes. [[cat-nodeattrs-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=http-format] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-h] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-h] + -- If you do not specify which columns to include, the API returns the default columns in the order listed below. If you explicitly specify one or more columns, it only returns the specified columns. @@ -61,15 +61,15 @@ Process ID, such as `13061`. Bound transport port, such as `9300`. -- -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=help] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=local] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=local] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-s] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-v] [[cat-nodeattrs-api-example]] diff --git a/docs/reference/cat/nodes.asciidoc b/docs/reference/cat/nodes.asciidoc index da1ed532e41f..bfee57d1daad 100644 --- a/docs/reference/cat/nodes.asciidoc +++ b/docs/reference/cat/nodes.asciidoc @@ -27,15 +27,15 @@ Returns information about a cluster's nodes. [[cat-nodes-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bytes] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=bytes] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=http-format] `full_id`:: (Optional, Boolean) If `true`, return the full node ID. If `false`, return the shortened node ID. Defaults to `false`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-h] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-h] + -- If you do not specify which columns to include, the API returns the default columns in the order listed below. If you explicitly specify one or more columns, it only returns the specified columns. @@ -328,17 +328,17 @@ Number of mappings, including <> and <> fields. Estimated heap overhead, in bytes, of mappings on this node, which allows for 1KiB of heap for every mapped field. -- -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=help] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-s] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=time] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=time] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-v] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=include-unloaded-segments] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=include-unloaded-segments] [[cat-nodes-api-example]] ==== {api-examples-title} diff --git a/docs/reference/cat/pending_tasks.asciidoc b/docs/reference/cat/pending_tasks.asciidoc index c576df17ced2..5dd6cb068814 100644 --- a/docs/reference/cat/pending_tasks.asciidoc +++ b/docs/reference/cat/pending_tasks.asciidoc @@ -28,21 +28,21 @@ Returns cluster-level changes that have not yet been executed, similar to the [[cat-pending-tasks-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=http-format] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-h] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-h] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=help] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=local] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=local] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-s] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=time] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=time] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-v] [[cat-pending-tasks-api-example]] diff --git a/docs/reference/cat/plugins.asciidoc b/docs/reference/cat/plugins.asciidoc index 9a83887c484a..a812556887b7 100644 --- a/docs/reference/cat/plugins.asciidoc +++ b/docs/reference/cat/plugins.asciidoc @@ -29,19 +29,19 @@ Returns a list of plugins running on each node of a cluster. [[cat-plugins-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=http-format] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-h] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-h] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=help] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=local] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=local] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-s] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-v] [[cat-plugins-api-example]] diff --git a/docs/reference/cat/recovery.asciidoc b/docs/reference/cat/recovery.asciidoc index 76fb66c6703d..058f4e69ae8e 100644 --- a/docs/reference/cat/recovery.asciidoc +++ b/docs/reference/cat/recovery.asciidoc @@ -39,7 +39,7 @@ The cat recovery API returns information about shard recoveries, both ongoing and completed. It is a more compact view of the JSON <> API. -include::{es-repo-dir}/indices/recovery.asciidoc[tag=shard-recovery-desc] +include::{es-ref-dir}/indices/recovery.asciidoc[tag=shard-recovery-desc] [[cat-recovery-path-params]] @@ -53,25 +53,25 @@ and indices, omit this parameter or use `*` or `_all`. [[cat-recovery-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=active-only] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=active-only] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bytes] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=bytes] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=detailed] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=detailed] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=http-format] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-h] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-h] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=help] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-query-parm] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=index-query-parm] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-s] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=time] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=time] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-v] [[cat-recovery-api-example]] diff --git a/docs/reference/cat/repositories.asciidoc b/docs/reference/cat/repositories.asciidoc index edeb66b95423..ec2f243c27be 100644 --- a/docs/reference/cat/repositories.asciidoc +++ b/docs/reference/cat/repositories.asciidoc @@ -29,19 +29,19 @@ Returns the <> for a cluste [[cat-repositories-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=http-format] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-h] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-h] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=help] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=local] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=local] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-s] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-v] [[cat-repositories-api-example]] diff --git a/docs/reference/cat/segments.asciidoc b/docs/reference/cat/segments.asciidoc index 900bebdb8168..872af679642d 100644 --- a/docs/reference/cat/segments.asciidoc +++ b/docs/reference/cat/segments.asciidoc @@ -44,11 +44,11 @@ and indices, omit this parameter or use `*` or `_all`. [[cat-segments-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bytes] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=bytes] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=http-format] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-h] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-h] + -- If you do not specify which columns to include, the API returns the default @@ -71,39 +71,39 @@ Valid columns are: `segment`:: (Default) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=segment] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=segment] `generation`:: (Default) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=generation] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=generation] `docs.count`:: (Default) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=docs-count] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=docs-count] `docs.deleted`:: (Default) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=docs-deleted] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=docs-deleted] `size`:: (Default) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=segment-size] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=segment-size] `size.memory`:: (Default) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=memory] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=memory] `committed`:: (Default) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=committed] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=committed] `searchable`:: (Default) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=segment-search] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=segment-search] `version`:: (Default) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=segment-version] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=segment-version] `compound`:: (Default) If `true`, the segment is stored in a compound file. This means Lucene @@ -113,11 +113,11 @@ merged all files from the segment in a single file to save file descriptors. ID of the node, such as `k0zy`. -- -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=help] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-s] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-v] [[cat-segments-api-example]] diff --git a/docs/reference/cat/shards.asciidoc b/docs/reference/cat/shards.asciidoc index c3d21f29bfaf..74c017d86d8e 100644 --- a/docs/reference/cat/shards.asciidoc +++ b/docs/reference/cat/shards.asciidoc @@ -44,11 +44,11 @@ and indices, omit this parameter or use `*` or `_all`. [[cat-shards-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bytes] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=bytes] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=http-format] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-h] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-h] + -- If you do not specify which columns to include, the API returns the default @@ -297,15 +297,15 @@ values include: -- -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=help] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-s] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=time] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=time] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-v] [[cat-shards-api-example]] diff --git a/docs/reference/cat/snapshots.asciidoc b/docs/reference/cat/snapshots.asciidoc index 059fd58630bc..820c4b56c783 100644 --- a/docs/reference/cat/snapshots.asciidoc +++ b/docs/reference/cat/snapshots.asciidoc @@ -46,9 +46,9 @@ If any repository fails during the request, {es} returns an error. [[cat-snapshots-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=http-format] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-h] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-h] + -- If you do not specify which columns to include, the API returns the default @@ -107,19 +107,19 @@ units>>. Reason for any snapshot failures. -- -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=help] `ignore_unavailable`:: (Optional, Boolean) If `true`, the response does not include information from unavailable snapshots. Defaults to `false`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-s] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=time] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=time] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-v] [[cat-snapshots-api-example]] diff --git a/docs/reference/cat/tasks.asciidoc b/docs/reference/cat/tasks.asciidoc index 1258c746bfb1..91d67baa72d7 100644 --- a/docs/reference/cat/tasks.asciidoc +++ b/docs/reference/cat/tasks.asciidoc @@ -41,13 +41,13 @@ of the JSON <> API. [[cat-tasks-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=detailed] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=detailed] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=http-format] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-h] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-h] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=help] `nodes`:: (Optional, string) @@ -58,17 +58,17 @@ wildcard (`*`) expressions. (Optional, string) Parent task ID used to limit the response. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-s] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=time] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=time] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-v] [[cat-tasks-api-response-codes]] ==== {api-response-codes-title} -include::{es-repo-dir}/cluster/tasks.asciidoc[tag=tasks-api-404] +include::{es-ref-dir}/cluster/tasks.asciidoc[tag=tasks-api-404] [[cat-tasks-api-examples]] diff --git a/docs/reference/cat/templates.asciidoc b/docs/reference/cat/templates.asciidoc index 61dce67615e1..bcc8e9e4f5dc 100644 --- a/docs/reference/cat/templates.asciidoc +++ b/docs/reference/cat/templates.asciidoc @@ -39,19 +39,19 @@ expressions. If omitted, all templates are returned. [[cat-templates-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=http-format] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-h] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-h] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=help] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=local] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=local] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-s] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-v] [[cat-templates-api-example]] diff --git a/docs/reference/cat/thread_pool.asciidoc b/docs/reference/cat/thread_pool.asciidoc index 244cf643798a..948ed9a1a7a3 100644 --- a/docs/reference/cat/thread_pool.asciidoc +++ b/docs/reference/cat/thread_pool.asciidoc @@ -40,9 +40,9 @@ request. Accepts wildcard expressions. [[cat-thread-pool-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=http-format] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-h] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-h] + -- If you do not specify which columns to include, the API returns the default @@ -113,17 +113,17 @@ Type of thread pool. Returned values are `fixed`, `fixed_auto_queue_size`, `dire -- -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=help] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=local] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=local] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-s] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=time] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=time] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-v] [[cat-thread-pool-api-example]] diff --git a/docs/reference/cat/trainedmodel.asciidoc b/docs/reference/cat/trainedmodel.asciidoc index 6f305be845fc..74e83525ddfe 100644 --- a/docs/reference/cat/trainedmodel.asciidoc +++ b/docs/reference/cat/trainedmodel.asciidoc @@ -41,11 +41,11 @@ For more information, see <> and {ml-docs-setup-privileges} [[cat-trained-model-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bytes] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=bytes] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=http-format] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-h] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-h] + If you do not specify which columns to include, the API returns the default columns. If you explicitly specify one or more columns, it returns only the @@ -102,13 +102,13 @@ measuring the computational complexity of the model. `version`, `v`::: The {es} version number in which the trained model was created. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=help] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-s] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=time] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=time] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-v] [[cat-trained-model-example]] diff --git a/docs/reference/cat/transforms.asciidoc b/docs/reference/cat/transforms.asciidoc index 1723d4ab73b0..0d4e9b691ac5 100644 --- a/docs/reference/cat/transforms.asciidoc +++ b/docs/reference/cat/transforms.asciidoc @@ -41,22 +41,22 @@ privileges. For more information, see <> and ``:: (Optional, string) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-id-wildcard] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-id-wildcard] [[cat-transforms-api-query-params]] ==== {api-query-parms-title} `allow_no_match`:: (Optional, Boolean) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-match-transforms1] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=allow-no-match-transforms1] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=http-format] `from`:: (Optional, integer) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=from-transforms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=from-transforms] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-h] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-h] + If you do not specify which columns to include, the API returns the default columns. If you explicitly specify one or more columns, it returns only the @@ -66,14 +66,14 @@ Valid columns are: `changes_last_detection_time`, `cldt`::: (Default) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=checkpointing-changes-last-detected-at] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=checkpointing-changes-last-detected-at] `checkpoint`, `cp`::: (Default) The sequence number for the checkpoint. `checkpoint_duration_time_exp_avg`, `cdtea`, `checkpointTimeExpAvg`::: -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=exponential-avg-checkpoint-duration-ms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=exponential-avg-checkpoint-duration-ms] `checkpoint_progress`, `c`, `checkpointProgress`::: (Default) @@ -83,106 +83,106 @@ The progress of the next checkpoint that is currently in progress. The time the {transform} was created. `delete_time`, `dtime`::: -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=delete-time-ms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=delete-time-ms] `description`, `d`::: The description of the {transform}. `dest_index`, `di`, `destIndex`::: -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=dest-index] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=dest-index] `documents_deleted`, `docd`::: -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=docs-deleted-transform] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=docs-deleted-transform] `documents_indexed`, `doci`::: -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=docs-indexed] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=docs-indexed] `docs_per_second`, `dps`::: -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-docs-per-second] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-docs-per-second] `documents_processed`, `docp`::: (Default) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=docs-processed] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=docs-processed] `frequency`, `f`::: -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=frequency] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=frequency] `id`::: (Default) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-id] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-id] `index_failure`, `if`::: -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-failures] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=index-failures] `index_time`, `itime`::: -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-time-ms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=index-time-ms] `index_total`, `it`::: -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-total] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=index-total] `indexed_documents_exp_avg`, `idea`::: -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=exponential-avg-documents-indexed] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=exponential-avg-documents-indexed] `last_search_time`, `lst`, `lastSearchTime`::: (Default) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=checkpointing-last-search-time] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=checkpointing-last-search-time] `max_page_search_size`, `mpsz`::: -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-max-page-search-size] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-max-page-search-size] `pages_processed`, `pp`::: -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=pages-processed] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=pages-processed] `pipeline`, `p`::: -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=dest-pipeline] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=dest-pipeline] `processed_documents_exp_avg`, `pdea`::: -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=exponential-avg-documents-processed] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=exponential-avg-documents-processed] `processing_time`, `pt`::: -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=processing-time-ms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=processing-time-ms] `reason`, `r`::: -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=state-transform-reason] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=state-transform-reason] `search_failure`, `sf`::: -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=search-failures] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=search-failures] `search_time`, `stime`::: -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=search-time-ms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=search-time-ms] `search_total`, `st`::: -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=search-total] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=search-total] `source_index`, `si`, `sourceIndex`::: (Default) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=source-index-transforms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=source-index-transforms] `state`, `s`::: (Default) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=state-transform] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=state-transform] `transform_type`, `tt`::: Indicates the type of {transform}: `batch` or `continuous`. `trigger_count`, `tc`::: -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=trigger-count] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=trigger-count] `version`, `v`::: The version of {es} that existed on the node when the {transform} was created. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=help] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-s] `size`:: (Optional, integer) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=size-transforms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=size-transforms] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=time] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=time] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-v] [[cat-transforms-api-examples]] ==== {api-examples-title} diff --git a/docs/reference/ccr/apis/auto-follow/delete-auto-follow-pattern.asciidoc b/docs/reference/ccr/apis/auto-follow/delete-auto-follow-pattern.asciidoc index a78148388a93..1c72fb8742b9 100644 --- a/docs/reference/ccr/apis/auto-follow/delete-auto-follow-pattern.asciidoc +++ b/docs/reference/ccr/apis/auto-follow/delete-auto-follow-pattern.asciidoc @@ -57,7 +57,7 @@ This API deletes a configured collection of [[ccr-delete-auto-follow-pattern-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] [[ccr-delete-auto-follow-pattern-examples]] ==== {api-examples-title} diff --git a/docs/reference/ccr/apis/auto-follow/get-auto-follow-pattern.asciidoc b/docs/reference/ccr/apis/auto-follow/get-auto-follow-pattern.asciidoc index 4fa85d6ee638..46ef288b0508 100644 --- a/docs/reference/ccr/apis/auto-follow/get-auto-follow-pattern.asciidoc +++ b/docs/reference/ccr/apis/auto-follow/get-auto-follow-pattern.asciidoc @@ -75,7 +75,7 @@ This API will return the specified auto-follow pattern collection. [[ccr-get-auto-follow-pattern-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] [[ccr-get-auto-follow-pattern-examples]] ==== {api-examples-title} diff --git a/docs/reference/ccr/apis/auto-follow/pause-auto-follow-pattern.asciidoc b/docs/reference/ccr/apis/auto-follow/pause-auto-follow-pattern.asciidoc index ed0f24264069..1e64ab813e2a 100644 --- a/docs/reference/ccr/apis/auto-follow/pause-auto-follow-pattern.asciidoc +++ b/docs/reference/ccr/apis/auto-follow/pause-auto-follow-pattern.asciidoc @@ -43,7 +43,7 @@ meantime. [[ccr-pause-auto-follow-pattern-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] [[ccr-pause-auto-follow-pattern-examples]] ==== {api-examples-title} diff --git a/docs/reference/ccr/apis/auto-follow/put-auto-follow-pattern.asciidoc b/docs/reference/ccr/apis/auto-follow/put-auto-follow-pattern.asciidoc index 4b5ff5a5eb93..d08997068f70 100644 --- a/docs/reference/ccr/apis/auto-follow/put-auto-follow-pattern.asciidoc +++ b/docs/reference/ccr/apis/auto-follow/put-auto-follow-pattern.asciidoc @@ -74,7 +74,7 @@ the new patterns. [[ccr-put-auto-follow-pattern-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] [[ccr-put-auto-follow-pattern-request-body]] ==== {api-request-body-title} diff --git a/docs/reference/ccr/apis/auto-follow/resume-auto-follow-pattern.asciidoc b/docs/reference/ccr/apis/auto-follow/resume-auto-follow-pattern.asciidoc index 5028b0f3d477..04da9b4a35ba 100644 --- a/docs/reference/ccr/apis/auto-follow/resume-auto-follow-pattern.asciidoc +++ b/docs/reference/ccr/apis/auto-follow/resume-auto-follow-pattern.asciidoc @@ -38,7 +38,7 @@ have been deleted or closed in the meantime. [[ccr-resume-auto-follow-pattern-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] [[ccr-resume-auto-follow-pattern-examples]] ==== {api-examples-title} diff --git a/docs/reference/ccr/apis/follow/get-follow-info.asciidoc b/docs/reference/ccr/apis/follow/get-follow-info.asciidoc index fd3d24e41be5..68fd6e210f88 100644 --- a/docs/reference/ccr/apis/follow/get-follow-info.asciidoc +++ b/docs/reference/ccr/apis/follow/get-follow-info.asciidoc @@ -52,7 +52,7 @@ replication options and whether the follower indices are active or paused. [[ccr-get-follow-info-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] [role="child_attributes"] [[ccr-get-follow-info-response-body]] diff --git a/docs/reference/ccr/apis/follow/post-pause-follow.asciidoc b/docs/reference/ccr/apis/follow/post-pause-follow.asciidoc index 58d5fbb03fa0..a4ab69aba8d8 100644 --- a/docs/reference/ccr/apis/follow/post-pause-follow.asciidoc +++ b/docs/reference/ccr/apis/follow/post-pause-follow.asciidoc @@ -56,7 +56,7 @@ following task. [[ccr-post-pause-follow-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] [[ccr-post-pause-follow-examples]] ==== {api-examples-title} diff --git a/docs/reference/ccr/apis/follow/post-resume-follow.asciidoc b/docs/reference/ccr/apis/follow/post-resume-follow.asciidoc index b762f049bde6..47ba51a3fb8a 100644 --- a/docs/reference/ccr/apis/follow/post-resume-follow.asciidoc +++ b/docs/reference/ccr/apis/follow/post-resume-follow.asciidoc @@ -69,7 +69,7 @@ returns, the follower index will resume fetching operations from the leader inde [[ccr-post-resume-follow-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] [[ccr-post-resume-follow-request-body]] ==== {api-request-body-title} diff --git a/docs/reference/ccr/apis/follow/post-unfollow.asciidoc b/docs/reference/ccr/apis/follow/post-unfollow.asciidoc index e8ca3526bbc8..b96777b455d3 100644 --- a/docs/reference/ccr/apis/follow/post-unfollow.asciidoc +++ b/docs/reference/ccr/apis/follow/post-unfollow.asciidoc @@ -63,7 +63,7 @@ irreversible operation. [[ccr-post-unfollow-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] [[ccr-post-unfollow-examples]] ==== {api-examples-title} diff --git a/docs/reference/ccr/apis/follow/put-follow.asciidoc b/docs/reference/ccr/apis/follow/put-follow.asciidoc index 11711432437e..eb83e2a13dcf 100644 --- a/docs/reference/ccr/apis/follow/put-follow.asciidoc +++ b/docs/reference/ccr/apis/follow/put-follow.asciidoc @@ -65,7 +65,7 @@ referenced leader index. When this API returns, the follower index exists, and follower shard requires transferring all the remote Lucene segment files to the follower index. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] [[ccr-put-follow-request-body]] ==== {api-request-body-title} diff --git a/docs/reference/ccr/apis/get-ccr-stats.asciidoc b/docs/reference/ccr/apis/get-ccr-stats.asciidoc index 2917e3f86372..128df5e47c77 100644 --- a/docs/reference/ccr/apis/get-ccr-stats.asciidoc +++ b/docs/reference/ccr/apis/get-ccr-stats.asciidoc @@ -56,7 +56,7 @@ shard-level stats as in the <>. `timeout`:: (Optional, time) Controls the amount of time to wait for results. Defaults to unlimited. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] [role="child_attributes"] [[ccr-get-stats-response-body]] diff --git a/docs/reference/ccr/getting-started.asciidoc b/docs/reference/ccr/getting-started.asciidoc index d6c455b510da..d30cd43a4db5 100644 --- a/docs/reference/ccr/getting-started.asciidoc +++ b/docs/reference/ccr/getting-started.asciidoc @@ -159,7 +159,7 @@ cluster with cluster alias `leader`. connected to. ==== -include::{es-repo-dir}/security/authentication/remote-clusters-privileges-cert.asciidoc[tag=configure-ccr-privileges] +include::{es-ref-dir}/security/authentication/remote-clusters-privileges-cert.asciidoc[tag=configure-ccr-privileges] [[ccr-getting-started-follower-index]] ==== Create a follower index to replicate a specific index diff --git a/docs/reference/cluster/get-settings.asciidoc b/docs/reference/cluster/get-settings.asciidoc index 931ebc9759a8..5a9fe81df61c 100644 --- a/docs/reference/cluster/get-settings.asciidoc +++ b/docs/reference/cluster/get-settings.asciidoc @@ -34,10 +34,10 @@ defined, but can also include the default settings by calling the ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=flat-settings] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=flat-settings] `include_defaults`:: (Optional, Boolean) If `true`, returns default cluster settings from the local node. Defaults to `false`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] diff --git a/docs/reference/cluster/health.asciidoc b/docs/reference/cluster/health.asciidoc index 561c092f66a6..3a4058a55ce1 100644 --- a/docs/reference/cluster/health.asciidoc +++ b/docs/reference/cluster/health.asciidoc @@ -61,9 +61,9 @@ To target all data streams and indices in a cluster, omit this parameter or use (Optional, string) Can be one of `cluster`, `indices` or `shards`. Controls the details level of the health information returned. Defaults to `cluster`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=local] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=local] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] `wait_for_active_shards`:: (Optional, string) A number controlling to how many active shards to wait @@ -104,7 +104,7 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] (string) The name of the cluster. `status`:: -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cluster-health-status] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cluster-health-status] `timed_out`:: (Boolean) If `false` the response returned within the period of diff --git a/docs/reference/cluster/nodes-hot-threads.asciidoc b/docs/reference/cluster/nodes-hot-threads.asciidoc index 552d41629e1e..a7ee9604250d 100644 --- a/docs/reference/cluster/nodes-hot-threads.asciidoc +++ b/docs/reference/cluster/nodes-hot-threads.asciidoc @@ -30,7 +30,7 @@ threads. [[cluster-nodes-hot-threads-api-path-params]] ==== {api-path-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=node-id] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=node-id] [[cluster-nodes-hot-threads-api-query-params]] @@ -56,7 +56,7 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=node-id] troubleshooting, set this parameter to a large number (e.g. `9999`) to get information about all the threads in the system. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] `type`:: (Optional, string) The type to sample. Available options are `block`, `cpu`, and diff --git a/docs/reference/cluster/nodes-info.asciidoc b/docs/reference/cluster/nodes-info.asciidoc index 16da5a25d1fb..8ff7da3a16ad 100644 --- a/docs/reference/cluster/nodes-info.asciidoc +++ b/docs/reference/cluster/nodes-info.asciidoc @@ -101,7 +101,7 @@ can also request the metric `_all` to retrieve all metrics, or you can request the metric `_none` to suppress all metrics and retrieve only the identity of the node. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=node-id] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=node-id] [[cluster-nodes-info-api-response-body]] ==== {api-response-body-title} @@ -182,9 +182,9 @@ running process: [[cluster-nodes-info-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=flat-settings] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=flat-settings] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] [[cluster-nodes-info-api-example]] diff --git a/docs/reference/cluster/nodes-stats.asciidoc b/docs/reference/cluster/nodes-stats.asciidoc index 07328ba98bce..a40d1f98cbd5 100644 --- a/docs/reference/cluster/nodes-stats.asciidoc +++ b/docs/reference/cluster/nodes-stats.asciidoc @@ -127,31 +127,31 @@ using metrics. * `dense_vector` -- -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=node-id] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=node-id] [[cluster-nodes-stats-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=completion-fields] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=completion-fields] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=fielddata-fields] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=fielddata-fields] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=fields] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=fields] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=groups] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=groups] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=level] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=level] `types`:: (Optional, string) A comma-separated list of document types for the `indexing` index metric. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=include-segment-file-sizes] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=include-segment-file-sizes] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=include-unloaded-segments] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=include-unloaded-segments] [role="child_attributes"] [[cluster-nodes-stats-api-response-body]] @@ -244,11 +244,11 @@ node. ======= `count`:: (integer) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=docs-count] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=docs-count] `deleted`:: (integer) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=docs-deleted] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=docs-deleted] ======= `store`:: diff --git a/docs/reference/cluster/nodes-usage.asciidoc b/docs/reference/cluster/nodes-usage.asciidoc index c62c42a57228..6c53919bcfbb 100644 --- a/docs/reference/cluster/nodes-usage.asciidoc +++ b/docs/reference/cluster/nodes-usage.asciidoc @@ -48,13 +48,13 @@ of features for each node. All the nodes selective options are explained that action has been called on the node. -- -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=node-id] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=node-id] [[cluster-nodes-usage-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] [[cluster-nodes-usage-api-example]] diff --git a/docs/reference/cluster/pending.asciidoc b/docs/reference/cluster/pending.asciidoc index b82bdd8e022f..3e87234c7d26 100644 --- a/docs/reference/cluster/pending.asciidoc +++ b/docs/reference/cluster/pending.asciidoc @@ -34,9 +34,9 @@ might be reported by both task api and pending cluster tasks API. [[cluster-pending-api-path-params]] ==== {api-path-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=local] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=local] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] [[cluster-pending-api-response-body]] diff --git a/docs/reference/cluster/prevalidate-node-removal.asciidoc b/docs/reference/cluster/prevalidate-node-removal.asciidoc index d7f0ed64d6c0..16bf28c58668 100644 --- a/docs/reference/cluster/prevalidate-node-removal.asciidoc +++ b/docs/reference/cluster/prevalidate-node-removal.asciidoc @@ -34,7 +34,7 @@ Note that if the prevalidation result for a set of nodes returns `true` (i.e. it [[prevalidate-node-removal-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] `names`:: (Optional, string) Comma-separated list of node names. diff --git a/docs/reference/cluster/reroute.asciidoc b/docs/reference/cluster/reroute.asciidoc index d88df96b5000..b4e4809ae73b 100644 --- a/docs/reference/cluster/reroute.asciidoc +++ b/docs/reference/cluster/reroute.asciidoc @@ -112,7 +112,7 @@ query parameter, which will attempt a single retry round for these shards. (Optional, Boolean) If `true`, then retries allocation of shards that are blocked due to too many subsequent allocation failures. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] [role="child_attributes"] [[cluster-reroute-api-request-body]] diff --git a/docs/reference/cluster/state.asciidoc b/docs/reference/cluster/state.asciidoc index 2836757a94fb..fcb2f5f2f5dc 100644 --- a/docs/reference/cluster/state.asciidoc +++ b/docs/reference/cluster/state.asciidoc @@ -115,15 +115,15 @@ Defaults to `true`. that are open, closed or both. Available options: `open`, `closed`, `none`, `all`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=flat-settings] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=flat-settings] `ignore_unavailable`:: (Optional, Boolean) If `true`, unavailable indices (missing or closed) will be ignored. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=local] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=local] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] `wait_for_metadata_version`:: (Optional, integer) Waits for the metadata version to be equal or greater diff --git a/docs/reference/cluster/stats.asciidoc b/docs/reference/cluster/stats.asciidoc index bdd3e166c22d..26b3553c3c17 100644 --- a/docs/reference/cluster/stats.asciidoc +++ b/docs/reference/cluster/stats.asciidoc @@ -33,7 +33,7 @@ memory usage) and information about the current nodes that form the cluster ==== {api-path-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=node-filter] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=node-filter] [[cluster-stats-api-query-params]] @@ -86,7 +86,7 @@ Unique identifier for the cluster. the last time the cluster statistics were refreshed. `status`:: -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cluster-health-status] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cluster-health-status] + See <>. diff --git a/docs/reference/cluster/tasks.asciidoc b/docs/reference/cluster/tasks.asciidoc index 75a6352196b2..0ffd70095750 100644 --- a/docs/reference/cluster/tasks.asciidoc +++ b/docs/reference/cluster/tasks.asciidoc @@ -32,23 +32,23 @@ on one or more nodes in the cluster. [[tasks-api-path-params]] ==== {api-path-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=task-id] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=task-id] [[tasks-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=actions] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=actions] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=detailed] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=detailed] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=group-by] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=group-by] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=nodes] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=nodes] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=parent-task-id] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=parent-task-id] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] `wait_for_completion`:: (Optional, Boolean) If `true`, the request blocks until all found tasks are complete. diff --git a/docs/reference/cluster/update-desired-nodes.asciidoc b/docs/reference/cluster/update-desired-nodes.asciidoc index b7bbb8b3b7f4..c72a2b53208e 100644 --- a/docs/reference/cluster/update-desired-nodes.asciidoc +++ b/docs/reference/cluster/update-desired-nodes.asciidoc @@ -47,7 +47,7 @@ DELETE /_internal/desired_nodes [[update-desired-nodes-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] `dry_run`:: (Optional, Boolean) If `true`, then the request simulates the update and diff --git a/docs/reference/cluster/update-settings.asciidoc b/docs/reference/cluster/update-settings.asciidoc index c1a4397ee369..ca3d100e31e0 100644 --- a/docs/reference/cluster/update-settings.asciidoc +++ b/docs/reference/cluster/update-settings.asciidoc @@ -22,18 +22,18 @@ Configures <>. ==== {api-description-title} :strip-api-link: true -include::{es-repo-dir}/setup/configuration.asciidoc[tag=cluster-setting-precedence] +include::{es-ref-dir}/setup/configuration.asciidoc[tag=cluster-setting-precedence] [[cluster-update-settings-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=flat-settings] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=flat-settings] `include_defaults`:: (Optional, Boolean) If `true`, returns all default cluster settings. Defaults to `false`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] [[cluster-update-settings-api-example]] diff --git a/docs/reference/data-streams/data-stream-apis.asciidoc b/docs/reference/data-streams/data-stream-apis.asciidoc index d5a81a485af0..d525f0d8a788 100644 --- a/docs/reference/data-streams/data-stream-apis.asciidoc +++ b/docs/reference/data-streams/data-stream-apis.asciidoc @@ -41,34 +41,34 @@ The following API is available for <>: For concepts and tutorials, see <>. -include::{es-repo-dir}/indices/create-data-stream.asciidoc[] +include::{es-ref-dir}/indices/create-data-stream.asciidoc[] -include::{es-repo-dir}/indices/delete-data-stream.asciidoc[] +include::{es-ref-dir}/indices/delete-data-stream.asciidoc[] -include::{es-repo-dir}/indices/get-data-stream.asciidoc[] +include::{es-ref-dir}/indices/get-data-stream.asciidoc[] -include::{es-repo-dir}/indices/migrate-to-data-stream.asciidoc[] +include::{es-ref-dir}/indices/migrate-to-data-stream.asciidoc[] -include::{es-repo-dir}/indices/data-stream-stats.asciidoc[] +include::{es-ref-dir}/indices/data-stream-stats.asciidoc[] -include::{es-repo-dir}/data-streams/promote-data-stream-api.asciidoc[] +include::{es-ref-dir}/data-streams/promote-data-stream-api.asciidoc[] -include::{es-repo-dir}/data-streams/modify-data-streams-api.asciidoc[] +include::{es-ref-dir}/data-streams/modify-data-streams-api.asciidoc[] -include::{es-repo-dir}/data-streams/lifecycle/apis/put-lifecycle.asciidoc[] +include::{es-ref-dir}/data-streams/lifecycle/apis/put-lifecycle.asciidoc[] -include::{es-repo-dir}/data-streams/lifecycle/apis/get-lifecycle.asciidoc[] +include::{es-ref-dir}/data-streams/lifecycle/apis/get-lifecycle.asciidoc[] -include::{es-repo-dir}/data-streams/lifecycle/apis/delete-lifecycle.asciidoc[] +include::{es-ref-dir}/data-streams/lifecycle/apis/delete-lifecycle.asciidoc[] -include::{es-repo-dir}/data-streams/lifecycle/apis/explain-lifecycle.asciidoc[] +include::{es-ref-dir}/data-streams/lifecycle/apis/explain-lifecycle.asciidoc[] -include::{es-repo-dir}/data-streams/lifecycle/apis/get-lifecycle-stats.asciidoc[] +include::{es-ref-dir}/data-streams/lifecycle/apis/get-lifecycle-stats.asciidoc[] -include::{es-repo-dir}/data-streams/lifecycle/apis/put-global-retention.asciidoc[] +include::{es-ref-dir}/data-streams/lifecycle/apis/put-global-retention.asciidoc[] -include::{es-repo-dir}/data-streams/lifecycle/apis/get-global-retention.asciidoc[] +include::{es-ref-dir}/data-streams/lifecycle/apis/get-global-retention.asciidoc[] -include::{es-repo-dir}/data-streams/lifecycle/apis/delete-global-retention.asciidoc[] +include::{es-ref-dir}/data-streams/lifecycle/apis/delete-global-retention.asciidoc[] -include::{es-repo-dir}/indices/downsample-data-stream.asciidoc[] +include::{es-ref-dir}/indices/downsample-data-stream.asciidoc[] diff --git a/docs/reference/data-streams/lifecycle/apis/delete-lifecycle.asciidoc b/docs/reference/data-streams/lifecycle/apis/delete-lifecycle.asciidoc index fd481d7ca481..0cf6ad395fb4 100644 --- a/docs/reference/data-streams/lifecycle/apis/delete-lifecycle.asciidoc +++ b/docs/reference/data-streams/lifecycle/apis/delete-lifecycle.asciidoc @@ -37,7 +37,7 @@ To target all data streams use `*` or `_all`. [[delete-data-lifecycle-api-query-parms]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=ds-expand-wildcards] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=ds-expand-wildcards] + Defaults to `open`. diff --git a/docs/reference/data-streams/lifecycle/apis/explain-lifecycle.asciidoc b/docs/reference/data-streams/lifecycle/apis/explain-lifecycle.asciidoc index a2609dcb78ec..e0e2df217335 100644 --- a/docs/reference/data-streams/lifecycle/apis/explain-lifecycle.asciidoc +++ b/docs/reference/data-streams/lifecycle/apis/explain-lifecycle.asciidoc @@ -40,7 +40,7 @@ execution. (Optional, Boolean) Includes default configurations related to the lifecycle of the target. Defaults to `false`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] [[data-streams-explain-lifecycle-example]] ==== {api-examples-title} diff --git a/docs/reference/data-streams/lifecycle/apis/get-global-retention.asciidoc b/docs/reference/data-streams/lifecycle/apis/get-global-retention.asciidoc index 03e485f3e7eb..0997c2d84ece 100644 --- a/docs/reference/data-streams/lifecycle/apis/get-global-retention.asciidoc +++ b/docs/reference/data-streams/lifecycle/apis/get-global-retention.asciidoc @@ -28,9 +28,9 @@ Gets the global retention configuration that is applied on data streams managed [[get-global-retention-api-query-parms]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=local] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=local] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] [[get-global-retention-api-response-body]] ==== {api-response-body-title} diff --git a/docs/reference/data-streams/lifecycle/apis/get-lifecycle.asciidoc b/docs/reference/data-streams/lifecycle/apis/get-lifecycle.asciidoc index 1bda7d8959be..83955417abd0 100644 --- a/docs/reference/data-streams/lifecycle/apis/get-lifecycle.asciidoc +++ b/docs/reference/data-streams/lifecycle/apis/get-lifecycle.asciidoc @@ -39,7 +39,7 @@ To target all data streams use `*` or `_all`. [[get-data-lifecycle-api-query-parms]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=ds-expand-wildcards] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=ds-expand-wildcards] + Defaults to `open`. diff --git a/docs/reference/data-streams/lifecycle/apis/put-lifecycle.asciidoc b/docs/reference/data-streams/lifecycle/apis/put-lifecycle.asciidoc index 53bd3c2b96f0..e68dc24f11a5 100644 --- a/docs/reference/data-streams/lifecycle/apis/put-lifecycle.asciidoc +++ b/docs/reference/data-streams/lifecycle/apis/put-lifecycle.asciidoc @@ -36,7 +36,7 @@ To target all data streams use `*` or `_all`. [[put-data-lifecycle-api-query-parms]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=ds-expand-wildcards] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=ds-expand-wildcards] + Defaults to `open`. diff --git a/docs/reference/data-streams/set-up-a-data-stream.asciidoc b/docs/reference/data-streams/set-up-a-data-stream.asciidoc index 144146b897ef..57388a1199f5 100644 --- a/docs/reference/data-streams/set-up-a-data-stream.asciidoc +++ b/docs/reference/data-streams/set-up-a-data-stream.asciidoc @@ -261,7 +261,7 @@ PUT _data_stream/my-data-stream [[secure-data-stream]] === Secure the data stream -include::{es-repo-dir}/security/authorization/alias-privileges.asciidoc[tag=data-stream-security] +include::{es-ref-dir}/security/authorization/alias-privileges.asciidoc[tag=data-stream-security] For an example, see <>. diff --git a/docs/reference/docs/bulk.asciidoc b/docs/reference/docs/bulk.asciidoc index 1a32e64cedb1..02f7d7e941fe 100644 --- a/docs/reference/docs/bulk.asciidoc +++ b/docs/reference/docs/bulk.asciidoc @@ -249,21 +249,21 @@ on. were executed for each `index` or `create`. Defaults to `false`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=pipeline] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=pipeline] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=refresh] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=refresh] `require_alias`:: (Optional, Boolean) If `true`, the request's actions must target an index alias. Defaults to `false`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=routing] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=routing] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=source] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=source] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=source_excludes] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=source_excludes] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=source_includes] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=source_includes] `timeout`:: + @@ -280,7 +280,7 @@ timeout before failing. The actual wait time could be longer, particularly when multiple waits occur. -- -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards] [[bulk-api-request-body]] ==== {api-request-body-title} @@ -293,15 +293,15 @@ Indexes the specified document if it does not already exist. The following line must contain the source data to be indexed. + -- -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bulk-index-ds] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=bulk-index-ds] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bulk-id] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=bulk-id] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bulk-list-executed-pipelines] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=bulk-list-executed-pipelines] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bulk-require-alias] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=bulk-require-alias] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bulk-dynamic-templates] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=bulk-dynamic-templates] -- `delete`:: @@ -309,12 +309,12 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bulk-dynamic-templates Removes the specified document from the index. + -- -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bulk-index] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=bulk-index] `_id`:: (Required, string) The document ID. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bulk-require-alias] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=bulk-require-alias] -- `index`:: @@ -324,15 +324,15 @@ If the document exists, replaces the document and increments the version. The following line must contain the source data to be indexed. + -- -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bulk-index] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=bulk-index] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bulk-id] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=bulk-id] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bulk-list-executed-pipelines] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=bulk-list-executed-pipelines] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bulk-require-alias] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=bulk-require-alias] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bulk-dynamic-templates] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=bulk-dynamic-templates] -- `update`:: @@ -341,12 +341,12 @@ Performs a partial document update. The following line must contain the partial document and update options. + -- -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bulk-index] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=bulk-index] `_id`:: (Required, string) The document ID. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bulk-require-alias] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=bulk-require-alias] -- `doc`:: diff --git a/docs/reference/docs/delete-by-query.asciidoc b/docs/reference/docs/delete-by-query.asciidoc index d671cb9b5a63..8cde1da91121 100644 --- a/docs/reference/docs/delete-by-query.asciidoc +++ b/docs/reference/docs/delete-by-query.asciidoc @@ -175,76 +175,76 @@ this parameter or use `* or `_all`. [[docs-delete-by-query-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] + Defaults to `true`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=analyzer] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=analyzer] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=analyze_wildcard] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=analyze_wildcard] `conflicts`:: (Optional, string) What to do if delete by query hits version conflicts: `abort` or `proceed`. Defaults to `abort`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=default_operator] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=default_operator] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=df] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=df] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + Defaults to `open`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=lenient] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=lenient] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=max_docs] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=max_docs] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=preference] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=preference] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=search-q] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=search-q] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=request_cache] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=request_cache] `refresh`:: (Optional, Boolean) If `true`, {es} refreshes all shards involved in the delete by query after the request completes. Defaults to `false`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=requests_per_second] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=requests_per_second] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=routing] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=routing] `scroll`:: (Optional, <>) Period to retain the <> for scrolling. See <>. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=scroll_size] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=scroll_size] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=search_type] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=search_type] `search_timeout`:: (Optional, <>) Explicit timeout for each search request. Defaults to no timeout. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=slices] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=slices] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=sort] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=sort] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=stats] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=stats] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=terminate_after] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=terminate_after] `timeout`:: (Optional, <>) Period each deletion request <>. Defaults to `1m` (one minute). -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=version] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=version] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards] [[docs-delete-by-query-api-request-body]] ==== {api-request-body-title} diff --git a/docs/reference/docs/delete.asciidoc b/docs/reference/docs/delete.asciidoc index 1d8ff699271b..452d7f7758bf 100644 --- a/docs/reference/docs/delete.asciidoc +++ b/docs/reference/docs/delete.asciidoc @@ -152,24 +152,24 @@ DELETE /my-index-000001/_doc/1?timeout=5m [[docs-delete-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=if_seq_no] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=if_seq_no] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=if_primary_term] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=if_primary_term] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=refresh] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=refresh] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=routing] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=routing] `timeout`:: (Optional, <>) Period to <>. Defaults to `1m` (one minute). -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=doc-version] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=doc-version] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=version_type] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=version_type] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards] [[docs-delete-api-example]] ==== {api-examples-title} diff --git a/docs/reference/docs/get.asciidoc b/docs/reference/docs/get.asciidoc index d0d0db332eee..c71215fff8d7 100644 --- a/docs/reference/docs/get.asciidoc +++ b/docs/reference/docs/get.asciidoc @@ -162,27 +162,27 @@ deleted documents in the background as you continue to index more data. [[docs-get-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=preference] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=preference] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=realtime] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=realtime] `refresh`:: (Optional, Boolean) If `true`, the request refreshes the relevant shard before retrieving the document. Defaults to `false`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=routing] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=routing] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=stored_fields] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=stored_fields] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=source] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=source] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=source_excludes] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=source_excludes] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=source_includes] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=source_includes] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=doc-version] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=doc-version] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=version_type] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=version_type] [[docs-get-api-response-body]] ==== {api-response-body-title} diff --git a/docs/reference/docs/index_.asciidoc b/docs/reference/docs/index_.asciidoc index 4577e0202480..9d359fd7d7f0 100644 --- a/docs/reference/docs/index_.asciidoc +++ b/docs/reference/docs/index_.asciidoc @@ -86,9 +86,9 @@ format and omit this parameter. [[docs-index-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=if_seq_no] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=if_seq_no] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=if_primary_term] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=if_primary_term] [[docs-index-api-op_type]] `op_type`:: @@ -101,11 +101,11 @@ If document id is specified, it defaults to `index`. Otherwise, it defaults to ` NOTE: If the request targets a data stream, an `op_type` of `create` is required. See <>. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=pipeline] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=pipeline] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=refresh] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=refresh] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=routing] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=routing] `timeout`:: + @@ -122,13 +122,13 @@ timeout before failing. The actual wait time could be longer, particularly when multiple waits occur. -- -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=doc-version] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=doc-version] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=version_type] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=version_type] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=require-alias] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=require-alias] [[docs-index-api-request-body]] ==== {api-request-body-title} diff --git a/docs/reference/docs/multi-get.asciidoc b/docs/reference/docs/multi-get.asciidoc index 065e22469611..7c3eafa9c79f 100644 --- a/docs/reference/docs/multi-get.asciidoc +++ b/docs/reference/docs/multi-get.asciidoc @@ -64,23 +64,23 @@ or when a document in the `docs` array does not specify an index. [[docs-multi-get-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=preference] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=preference] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=realtime] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=realtime] `refresh`:: (Optional, Boolean) If `true`, the request refreshes relevant shards before retrieving documents. Defaults to `false`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=routing] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=routing] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=stored_fields] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=stored_fields] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=source] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=source] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=source_excludes] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=source_excludes] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=source_includes] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=source_includes] [[docs-multi-get-api-request-body]] ==== {api-request-body-title} diff --git a/docs/reference/docs/multi-termvectors.asciidoc b/docs/reference/docs/multi-termvectors.asciidoc index 90b31238a5c6..5a27e0b9b3a3 100644 --- a/docs/reference/docs/multi-termvectors.asciidoc +++ b/docs/reference/docs/multi-termvectors.asciidoc @@ -64,27 +64,27 @@ that can be included in the response. [[docs-multi-termvectors-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=fields] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=fields] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=field_statistics] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=field_statistics] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=offsets] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=offsets] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=payloads] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=payloads] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=positions] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=positions] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=preference] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=preference] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=routing] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=routing] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=realtime] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=realtime] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=term_statistics] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=term_statistics] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=version] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=version] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=version_type] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=version_type] [discrete] [[docs-multi-termvectors-api-example]] diff --git a/docs/reference/docs/reindex.asciidoc b/docs/reference/docs/reindex.asciidoc index 7c3cd8716dfe..146b519b05e8 100644 --- a/docs/reference/docs/reindex.asciidoc +++ b/docs/reference/docs/reindex.asciidoc @@ -483,21 +483,21 @@ timeout before failing. The actual wait time could be longer, particularly when multiple waits occur. -- -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards] `wait_for_completion`:: (Optional, Boolean) If `true`, the request blocks until the operation is complete. Defaults to `true`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=requests_per_second] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=requests_per_second] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=require-alias] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=require-alias] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=scroll] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=scroll] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=slices] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=slices] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=max_docs] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=max_docs] [[docs-reindex-api-request-body]] ==== {api-request-body-title} diff --git a/docs/reference/docs/termvectors.asciidoc b/docs/reference/docs/termvectors.asciidoc index 8fa6392e08d5..31dfba1ac266 100644 --- a/docs/reference/docs/termvectors.asciidoc +++ b/docs/reference/docs/termvectors.asciidoc @@ -143,27 +143,27 @@ from is randomly selected. Use `routing` only to hit a particular shard. [[docs-termvectors-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=fields] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=fields] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=field_statistics] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=field_statistics] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=offsets] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=offsets] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=payloads] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=payloads] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=positions] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=positions] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=preference] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=preference] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=routing] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=routing] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=realtime] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=realtime] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=term_statistics] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=term_statistics] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=version] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=version] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=version_type] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=version_type] [[docs-termvectors-api-example]] ==== {api-examples-title} diff --git a/docs/reference/docs/update-by-query.asciidoc b/docs/reference/docs/update-by-query.asciidoc index 5ef9d288623c..bc63fa4e33d0 100644 --- a/docs/reference/docs/update-by-query.asciidoc +++ b/docs/reference/docs/update-by-query.asciidoc @@ -167,70 +167,70 @@ this parameter or use `*` or `_all`. [[docs-update-by-query-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] + Defaults to `true`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=analyzer] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=analyzer] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=analyze_wildcard] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=analyze_wildcard] `conflicts`:: (Optional, string) What to do if update by query hits version conflicts: `abort` or `proceed`. Defaults to `abort`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=default_operator] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=default_operator] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=df] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=df] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + Defaults to `open`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=lenient] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=lenient] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=max_docs] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=max_docs] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=pipeline] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=pipeline] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=preference] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=preference] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=search-q] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=search-q] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=request_cache] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=request_cache] `refresh`:: (Optional, Boolean) If `true`, {es} refreshes affected shards to make the operation visible to search. Defaults to `false`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=requests_per_second] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=requests_per_second] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=routing] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=routing] `scroll`:: (Optional, <>) Period to retain the <> for scrolling. See <>. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=scroll_size] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=scroll_size] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=search_type] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=search_type] `search_timeout`:: (Optional, <>) Explicit timeout for each search request. Defaults to no timeout. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=slices] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=slices] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=sort] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=sort] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=stats] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=stats] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=terminate_after] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=terminate_after] `timeout`:: + @@ -246,9 +246,9 @@ timeout before failing. The actual wait time could be longer, particularly when multiple waits occur. -- -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=version] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=version] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards] [[docs-update-by-query-api-request-body]] ==== {api-request-body-title} diff --git a/docs/reference/docs/update.asciidoc b/docs/reference/docs/update.asciidoc index 989335eb702f..ca6a7e489449 100644 --- a/docs/reference/docs/update.asciidoc +++ b/docs/reference/docs/update.asciidoc @@ -53,22 +53,22 @@ automatically if it doesn't exist. For more information, see <>. [[docs-update-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=if_seq_no] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=if_seq_no] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=if_primary_term] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=if_primary_term] `lang`:: (Optional, string) The script language. Default: `painless`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=require-alias] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=require-alias] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=refresh] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=refresh] `retry_on_conflict`:: (Optional, integer) Specify how many times should the operation be retried when a conflict occurs. Default: 0. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=routing] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=routing] `_source`:: (Optional, list) Set to `false` to disable source retrieval (default: `true`). @@ -94,7 +94,7 @@ timeout before failing. The actual wait time could be longer, particularly when multiple waits occur. -- -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards] [[update-api-example]] ==== {api-examples-title} diff --git a/docs/reference/eql/eql-search-api.asciidoc b/docs/reference/eql/eql-search-api.asciidoc index d4ea3f3c7499..d7f10f4627f6 100644 --- a/docs/reference/eql/eql-search-api.asciidoc +++ b/docs/reference/eql/eql-search-api.asciidoc @@ -99,7 +99,7 @@ ignored. Defaults to `true`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + Defaults to `open`. @@ -206,7 +206,7 @@ returned. + A greater `fetch_size` value often increases search speed but uses more memory. -include::{es-repo-dir}/search/search.asciidoc[tag=fields-param-def] +include::{es-ref-dir}/search/search.asciidoc[tag=fields-param-def] `filter`:: (Optional, <>) @@ -280,7 +280,7 @@ command]. NOTE: This parameter may change the set of returned hits. However, it does not change the sort order of hits in the response. -include::{es-repo-dir}/search/search.asciidoc[tag=runtime-mappings-def] +include::{es-ref-dir}/search/search.asciidoc[tag=runtime-mappings-def] [[eql-search-api-params-size]] `size`:: diff --git a/docs/reference/eql/eql.asciidoc b/docs/reference/eql/eql.asciidoc index 2ede5e0fc737..8f3b5b893ea5 100644 --- a/docs/reference/eql/eql.asciidoc +++ b/docs/reference/eql/eql.asciidoc @@ -1013,7 +1013,7 @@ You can also use the `fields` parameter to retrieve and format specific fields in the response. This field is identical to the search API's <>. -include::{es-repo-dir}/search/search-your-data/retrieve-selected-fields.asciidoc[tag=fields-param-desc] +include::{es-ref-dir}/search/search-your-data/retrieve-selected-fields.asciidoc[tag=fields-param-desc] The following search request uses the `fields` parameter to retrieve values for the `event.type` field, all fields starting with `process.`, and the @@ -1039,7 +1039,7 @@ GET /my-data-stream/_eql/search?filter_path=-hits.events._source ---- // TEST[setup:sec_logs] -include::{es-repo-dir}/search/search-your-data/retrieve-selected-fields.asciidoc[tag=fields-param-callouts] +include::{es-ref-dir}/search/search-your-data/retrieve-selected-fields.asciidoc[tag=fields-param-callouts] The response includes values as a flat list in the `fields` section for each hit. diff --git a/docs/reference/esql/esql-across-clusters.asciidoc b/docs/reference/esql/esql-across-clusters.asciidoc index f35a62c49aca..95278314b025 100644 --- a/docs/reference/esql/esql-across-clusters.asciidoc +++ b/docs/reference/esql/esql-across-clusters.asciidoc @@ -13,16 +13,16 @@ With {esql}, you can execute a single query across multiple clusters. ==== Prerequisites -include::{es-repo-dir}/search/search-your-data/search-across-clusters.asciidoc[tag=ccs-prereqs] +include::{es-ref-dir}/search/search-your-data/search-across-clusters.asciidoc[tag=ccs-prereqs] -include::{es-repo-dir}/search/search-your-data/search-across-clusters.asciidoc[tag=ccs-gateway-seed-nodes] +include::{es-ref-dir}/search/search-your-data/search-across-clusters.asciidoc[tag=ccs-gateway-seed-nodes] -include::{es-repo-dir}/search/search-your-data/search-across-clusters.asciidoc[tag=ccs-proxy-mode] +include::{es-ref-dir}/search/search-your-data/search-across-clusters.asciidoc[tag=ccs-proxy-mode] [discrete] [[ccq-remote-cluster-setup]] ==== Remote cluster setup -include::{es-repo-dir}/search/search-your-data/search-across-clusters.asciidoc[tag=ccs-remote-cluster-setup] +include::{es-ref-dir}/search/search-your-data/search-across-clusters.asciidoc[tag=ccs-remote-cluster-setup] <1> Since `skip_unavailable` was not set on `cluster_three`, it uses the default of `false`. See the <> @@ -221,4 +221,4 @@ in the response, such as execution time, selected target indices, and shards. [[ccq-during-upgrade]] ==== Query across clusters during an upgrade -include::{es-repo-dir}/search/search-your-data/search-across-clusters.asciidoc[tag=ccs-during-upgrade] +include::{es-ref-dir}/search/search-your-data/search-across-clusters.asciidoc[tag=ccs-during-upgrade] diff --git a/docs/reference/esql/esql-enrich-data.asciidoc b/docs/reference/esql/esql-enrich-data.asciidoc index e465d7daae12..c48118d1c367 100644 --- a/docs/reference/esql/esql-enrich-data.asciidoc +++ b/docs/reference/esql/esql-enrich-data.asciidoc @@ -91,7 +91,7 @@ your query. [[esql-enrich-prereqs]] ==== Prerequisites -include::{es-repo-dir}/ingest/apis/enrich/put-enrich-policy.asciidoc[tag=enrich-policy-api-prereqs] +include::{es-ref-dir}/ingest/apis/enrich/put-enrich-policy.asciidoc[tag=enrich-policy-api-prereqs] [discrete] [[esql-create-enrich-source-index]] @@ -130,7 +130,7 @@ include::processing-commands/enrich.asciidoc[tag=examples] [[esql-update-enrich-data]] ==== Update an enrich index -include::{es-repo-dir}/ingest/apis/enrich/execute-enrich-policy.asciidoc[tag=update-enrich-index] +include::{es-ref-dir}/ingest/apis/enrich/execute-enrich-policy.asciidoc[tag=update-enrich-index] [discrete] [[esql-update-enrich-policies]] diff --git a/docs/reference/esql/esql-get-started.asciidoc b/docs/reference/esql/esql-get-started.asciidoc index 351a8efdc8ae..0e23c0d97e61 100644 --- a/docs/reference/esql/esql-get-started.asciidoc +++ b/docs/reference/esql/esql-get-started.asciidoc @@ -21,7 +21,7 @@ This getting started is also available as an https://github.com/elastic/elastics To follow along with the queries in this guide, you can either set up your own deployment, or use Elastic's public {esql} demo environment. -include::{es-repo-dir}/tab-widgets/esql/esql-getting-started-widget-sample-data.asciidoc[] +include::{es-ref-dir}/tab-widgets/esql/esql-getting-started-widget-sample-data.asciidoc[] [discrete] [[esql-getting-started-running-queries]] @@ -29,7 +29,7 @@ include::{es-repo-dir}/tab-widgets/esql/esql-getting-started-widget-sample-data. In {kib}, you can use Console or Discover to run {esql} queries: -include::{es-repo-dir}/tab-widgets/esql/esql-getting-started-widget-discover-console.asciidoc[] +include::{es-ref-dir}/tab-widgets/esql/esql-getting-started-widget-discover-console.asciidoc[] [discrete] [[esql-getting-started-first-query]] @@ -279,7 +279,7 @@ Before you can use `ENRICH`, you first need to <> and <> an <>. -include::{es-repo-dir}/tab-widgets/esql/esql-getting-started-widget-enrich-policy.asciidoc[] +include::{es-ref-dir}/tab-widgets/esql/esql-getting-started-widget-enrich-policy.asciidoc[] After creating and executing a policy, you can use it with the `ENRICH` command: diff --git a/docs/reference/esql/esql-index-options.asciidoc b/docs/reference/esql/esql-index-options.asciidoc index ba2307f611d4..721461bd9671 100644 --- a/docs/reference/esql/esql-index-options.asciidoc +++ b/docs/reference/esql/esql-index-options.asciidoc @@ -24,7 +24,7 @@ values may differ. The currently supported options are: -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] + Defaults to `true`. @@ -37,7 +37,7 @@ missing or closed index. + Defaults to `true`. -include::{es-repo-dir}/search/search.asciidoc[tag=search-preference] +include::{es-ref-dir}/search/search.asciidoc[tag=search-preference] *Examples* diff --git a/docs/reference/esql/index.asciidoc b/docs/reference/esql/index.asciidoc index 531336277ba6..5cb02064dc79 100644 --- a/docs/reference/esql/index.asciidoc +++ b/docs/reference/esql/index.asciidoc @@ -1,7 +1,7 @@ [[esql]] = {esql} -:esql-tests: {xes-repo-dir}/../../plugin/esql/qa +:esql-tests: {elasticsearch-root}/x-pack/docs/{lang}/../../plugin/esql/qa :esql-specs: {esql-tests}/testFixtures/src/main/resources [partintro] diff --git a/docs/reference/getting-started.asciidoc b/docs/reference/getting-started.asciidoc index 3e474953a72f..2a5dbc2f0d03 100644 --- a/docs/reference/getting-started.asciidoc +++ b/docs/reference/getting-started.asciidoc @@ -24,8 +24,8 @@ The simplest way to set up {es} is to create a managed deployment with {ess} on {ecloud}. If you prefer to manage your own test environment, install and run {es} using Docker. -include::{es-repo-dir}/tab-widgets/code.asciidoc[] -include::{es-repo-dir}/tab-widgets/quick-start-install-widget.asciidoc[] +include::{es-ref-dir}/tab-widgets/code.asciidoc[] +include::{es-ref-dir}/tab-widgets/quick-start-install-widget.asciidoc[] [discrete] [[send-requests-to-elasticsearch]] @@ -36,7 +36,7 @@ with {es} using any client that sends HTTP requests, such as https://curl.se[curl]. You can also use {kib}'s Console to send requests to {es}. -include::{es-repo-dir}/tab-widgets/api-call-widget.asciidoc[] +include::{es-ref-dir}/tab-widgets/api-call-widget.asciidoc[] [discrete] [[add-data]] diff --git a/docs/reference/how-to/disk-usage.asciidoc b/docs/reference/how-to/disk-usage.asciidoc index 55a7b33f53cb..975067fd576b 100644 --- a/docs/reference/how-to/disk-usage.asciidoc +++ b/docs/reference/how-to/disk-usage.asciidoc @@ -94,7 +94,7 @@ Indices in Elasticsearch are stored in one or more shards. Each shard is a Lucen The <> can be used to reduce the number of segments per shard. In many cases, the number of segments can be reduced to one per shard by setting `max_num_segments=1`. -include::{es-repo-dir}/indices/forcemerge.asciidoc[tag=force-merge-read-only-warn] +include::{es-ref-dir}/indices/forcemerge.asciidoc[tag=force-merge-read-only-warn] [discrete] === Shrink index diff --git a/docs/reference/how-to/indexing-speed.asciidoc b/docs/reference/how-to/indexing-speed.asciidoc index 924207bca470..2bff5f82bf73 100644 --- a/docs/reference/how-to/indexing-speed.asciidoc +++ b/docs/reference/how-to/indexing-speed.asciidoc @@ -43,7 +43,7 @@ The operation that consists of making changes visible to search - called a <> - is costly, and calling it often while there is ongoing indexing activity can hurt indexing speed. -include::{es-repo-dir}/indices/refresh.asciidoc[tag=refresh-interval-default] +include::{es-ref-dir}/indices/refresh.asciidoc[tag=refresh-interval-default] This is the optimal configuration if you have no or very little search traffic (e.g. less than one search request every 5 minutes) and want to optimize for indexing speed. This behavior aims to automatically optimize bulk indexing in diff --git a/docs/reference/how-to/knn-search.asciidoc b/docs/reference/how-to/knn-search.asciidoc index bfe99ad615c4..194d122cef15 100644 --- a/docs/reference/how-to/knn-search.asciidoc +++ b/docs/reference/how-to/knn-search.asciidoc @@ -109,7 +109,7 @@ force merge to one segment, the kNN search only need to check a single, all-inclusive HNSW graph. Force merging `dense_vector` fields is an expensive operation that can take significant time to complete. -include::{es-repo-dir}/indices/forcemerge.asciidoc[tag=force-merge-read-only-warn] +include::{es-ref-dir}/indices/forcemerge.asciidoc[tag=force-merge-read-only-warn] [discrete] ==== Create large segments during bulk indexing diff --git a/docs/reference/how-to/use-elasticsearch-for-time-series-data.asciidoc b/docs/reference/how-to/use-elasticsearch-for-time-series-data.asciidoc index 18de2497760c..21a516aeb53f 100644 --- a/docs/reference/how-to/use-elasticsearch-for-time-series-data.asciidoc +++ b/docs/reference/how-to/use-elasticsearch-for-time-series-data.asciidoc @@ -26,7 +26,7 @@ stream. The steps for setting up data tiers vary based on your deployment type: -include::{es-repo-dir}/tab-widgets/data-tiers-widget.asciidoc[] +include::{es-ref-dir}/tab-widgets/data-tiers-widget.asciidoc[] [discrete] [[register-snapshot-repository]] @@ -39,7 +39,7 @@ To use {search-snaps}, you must register a supported snapshot repository. The steps for registering this repository vary based on your deployment type and storage provider: -include::{es-repo-dir}/tab-widgets/snapshot-repo-widget.asciidoc[] +include::{es-ref-dir}/tab-widgets/snapshot-repo-widget.asciidoc[] [discrete] [[create-edit-index-lifecycle-policy]] @@ -58,7 +58,7 @@ ensure your policy: * Uses {search-snaps} in the cold and frozen phases, if wanted. * Includes a delete phase, if needed. -include::{es-repo-dir}/tab-widgets/ilm-widget.asciidoc[] +include::{es-ref-dir}/tab-widgets/ilm-widget.asciidoc[] [discrete] [[create-ts-component-templates]] @@ -68,19 +68,19 @@ TIP: If you use {fleet} or {agent}, skip to <>. {fleet} and {agent} use built-in templates to create data streams for you. If you use a custom application, you need to set up your own data stream. -include::{es-repo-dir}/data-streams/set-up-a-data-stream.asciidoc[tag=ds-create-component-templates] +include::{es-ref-dir}/data-streams/set-up-a-data-stream.asciidoc[tag=ds-create-component-templates] [discrete] [[create-ts-index-template]] === Create an index template -include::{es-repo-dir}/data-streams/set-up-a-data-stream.asciidoc[tag=ds-create-index-template] +include::{es-ref-dir}/data-streams/set-up-a-data-stream.asciidoc[tag=ds-create-index-template] [discrete] [[add-data-to-data-stream]] === Add data to a data stream -include::{es-repo-dir}/data-streams/set-up-a-data-stream.asciidoc[tag=ds-create-data-stream] +include::{es-ref-dir}/data-streams/set-up-a-data-stream.asciidoc[tag=ds-create-data-stream] [discrete] [[search-visualize-your-data]] diff --git a/docs/reference/ilm/apis/delete-lifecycle.asciidoc b/docs/reference/ilm/apis/delete-lifecycle.asciidoc index b8e4c7a0bd21..632cb982b396 100644 --- a/docs/reference/ilm/apis/delete-lifecycle.asciidoc +++ b/docs/reference/ilm/apis/delete-lifecycle.asciidoc @@ -35,7 +35,7 @@ the request fails and returns an error. [[ilm-delete-lifecycle-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] [[ilm-delete-lifecycle-example]] ==== {api-examples-title} diff --git a/docs/reference/ilm/apis/explain.asciidoc b/docs/reference/ilm/apis/explain.asciidoc index 64e9ec9d5241..fbe017619048 100644 --- a/docs/reference/ilm/apis/explain.asciidoc +++ b/docs/reference/ilm/apis/explain.asciidoc @@ -49,7 +49,7 @@ or `_all`. {ilm-init} and are in an error state, either due to an encountering an error while executing the policy, or attempting to use a policy that does not exist. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] [[ilm-explain-lifecycle-example]] ==== {api-examples-title} diff --git a/docs/reference/ilm/apis/get-lifecycle.asciidoc b/docs/reference/ilm/apis/get-lifecycle.asciidoc index f736de20ed43..744361006548 100644 --- a/docs/reference/ilm/apis/get-lifecycle.asciidoc +++ b/docs/reference/ilm/apis/get-lifecycle.asciidoc @@ -36,7 +36,7 @@ modified date. If no policy is specified, returns all defined policies. [[ilm-get-lifecycle-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] [[ilm-get-lifecycle-example]] ==== {api-examples-title} diff --git a/docs/reference/ilm/apis/get-status.asciidoc b/docs/reference/ilm/apis/get-status.asciidoc index 384f6e9e55ef..7e9e963f6f36 100644 --- a/docs/reference/ilm/apis/get-status.asciidoc +++ b/docs/reference/ilm/apis/get-status.asciidoc @@ -27,7 +27,7 @@ You can start or stop {ilm-init} with the <> and [[ilm-get-status-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] [role="child_attributes"] [[ilm-get-status-response-body]] diff --git a/docs/reference/ilm/apis/move-to-step.asciidoc b/docs/reference/ilm/apis/move-to-step.asciidoc index f901b2402440..19cc9f708886 100644 --- a/docs/reference/ilm/apis/move-to-step.asciidoc +++ b/docs/reference/ilm/apis/move-to-step.asciidoc @@ -50,7 +50,7 @@ policy are considered valid, an index cannot move to a step that is not part of [[ilm-move-to-step-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] [role="child_attributes"] [[ilm-move-to-step-request-body]] diff --git a/docs/reference/ilm/apis/put-lifecycle.asciidoc b/docs/reference/ilm/apis/put-lifecycle.asciidoc index 6d7c8ea5e297..ffd59a14d8c2 100644 --- a/docs/reference/ilm/apis/put-lifecycle.asciidoc +++ b/docs/reference/ilm/apis/put-lifecycle.asciidoc @@ -46,7 +46,7 @@ To avoid naming collisions with built-in and Fleet-managed ILM policies, avoid u [[ilm-put-lifecycle-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] [[ilm-put-lifecycle-example]] ==== {api-examples-title} diff --git a/docs/reference/ilm/apis/remove-policy-from-index.asciidoc b/docs/reference/ilm/apis/remove-policy-from-index.asciidoc index 0bc501093697..20e0df9f3cb9 100644 --- a/docs/reference/ilm/apis/remove-policy-from-index.asciidoc +++ b/docs/reference/ilm/apis/remove-policy-from-index.asciidoc @@ -40,7 +40,7 @@ target. Supports wildcards (`*`). To target all data streams and indices, use [[ilm-remove-policy-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] [[ilm-remove-policy-example]] ==== {api-examples-title} diff --git a/docs/reference/ilm/apis/retry-policy.asciidoc b/docs/reference/ilm/apis/retry-policy.asciidoc index c1c78bdb8824..cb2587fbb151 100644 --- a/docs/reference/ilm/apis/retry-policy.asciidoc +++ b/docs/reference/ilm/apis/retry-policy.asciidoc @@ -35,7 +35,7 @@ step. [[ilm-retry-policy-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] [[ilm-retry-policy-example]] ==== {api-examples-title} diff --git a/docs/reference/ilm/apis/start.asciidoc b/docs/reference/ilm/apis/start.asciidoc index 1b5a4b9b2561..32db585c6b14 100644 --- a/docs/reference/ilm/apis/start.asciidoc +++ b/docs/reference/ilm/apis/start.asciidoc @@ -31,7 +31,7 @@ necessary if it has been stopped using the <>. [[ilm-start-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] [[ilm-start-example]] ==== {api-examples-title} diff --git a/docs/reference/ilm/apis/stop.asciidoc b/docs/reference/ilm/apis/stop.asciidoc index 0fa7875b0efd..1e9cfb94d0b1 100644 --- a/docs/reference/ilm/apis/stop.asciidoc +++ b/docs/reference/ilm/apis/stop.asciidoc @@ -36,7 +36,7 @@ if {ilm-init} is running. [[ilm-stop-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] [[ilm-stop-example]] ==== {api-examples-title} diff --git a/docs/reference/index-modules/blocks.asciidoc b/docs/reference/index-modules/blocks.asciidoc index 2d89676a8af2..5fc89dedf024 100644 --- a/docs/reference/index-modules/blocks.asciidoc +++ b/docs/reference/index-modules/blocks.asciidoc @@ -86,7 +86,7 @@ PUT /my-index-000001/_block/write [[add-index-block-api-path-params]] ==== {api-path-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=index] + By default, you must explicitly name the indices you are adding blocks to. To allow the adding of blocks to indices with `_all`, `*`, or other wildcard @@ -116,17 +116,17 @@ Disable write operations. However, metadata changes are still allowed. [[add-index-block-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] + Defaults to `true`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + Defaults to `open`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] [discrete] [[add-index-block-api-example]] diff --git a/docs/reference/index.asciidoc b/docs/reference/index.asciidoc index b09d67e99063..e47304f1e133 100644 --- a/docs/reference/index.asciidoc +++ b/docs/reference/index.asciidoc @@ -1,13 +1,6 @@ [[elasticsearch-reference]] = Elasticsearch Guide -:include-xpack: true -:es-test-dir: {elasticsearch-root}/docs/src/test -:plugins-examples-dir: {elasticsearch-root}/plugins/examples -:dependencies-dir: {elasticsearch-root}/build-tools-internal -:xes-repo-dir: {elasticsearch-root}/x-pack/docs/{lang} -:es-repo-dir: {elasticsearch-root}/docs/reference - include::../Versions.asciidoc[] include::links.asciidoc[] diff --git a/docs/reference/indices/add-alias.asciidoc b/docs/reference/indices/add-alias.asciidoc index 860e9ca46f79..e14af6a64a2e 100644 --- a/docs/reference/indices/add-alias.asciidoc +++ b/docs/reference/indices/add-alias.asciidoc @@ -46,7 +46,7 @@ indices return an error. [[add-alias-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] [[add-alias-api-request-body]] ==== {api-request-body-title} diff --git a/docs/reference/indices/alias-exists.asciidoc b/docs/reference/indices/alias-exists.asciidoc index 997dbad5bd6c..f820a95028a0 100644 --- a/docs/reference/indices/alias-exists.asciidoc +++ b/docs/reference/indices/alias-exists.asciidoc @@ -44,7 +44,7 @@ omit this parameter or use `*` or `_all`. [[alias-exists-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + Defaults to `all`. @@ -52,7 +52,7 @@ Defaults to `all`. (Optional, Boolean) If `false`, requests that include a missing data stream or index in the `` return an error. Defaults to `false`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=local] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=local] [[alias-exists-api-response-codes]] ==== {api-response-codes-title} diff --git a/docs/reference/indices/aliases.asciidoc b/docs/reference/indices/aliases.asciidoc index 34248cc5f98d..1df9e0a4883b 100644 --- a/docs/reference/indices/aliases.asciidoc +++ b/docs/reference/indices/aliases.asciidoc @@ -43,7 +43,7 @@ for the index. [[indices-aliases-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] [role="child_attributes"] [[indices-aliases-api-request-body]] diff --git a/docs/reference/indices/apis/reload-analyzers.asciidoc b/docs/reference/indices/apis/reload-analyzers.asciidoc index dc6ed7d916a1..ca5f540564f8 100644 --- a/docs/reference/indices/apis/reload-analyzers.asciidoc +++ b/docs/reference/indices/apis/reload-analyzers.asciidoc @@ -85,15 +85,15 @@ and indices, use `*` or `_all`. [[indices-reload-analyzers-api-query-params]] === {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] + Defaults to `true`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + Defaults to `open`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] [discrete] diff --git a/docs/reference/indices/clearcache.asciidoc b/docs/reference/indices/clearcache.asciidoc index 10b590fce097..a3150ec6f72e 100644 --- a/docs/reference/indices/clearcache.asciidoc +++ b/docs/reference/indices/clearcache.asciidoc @@ -39,11 +39,11 @@ and indices, omit this parameter or use `*` or `_all`. [[clear-cache-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] + Defaults to `true`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + Defaults to `open`. @@ -77,7 +77,7 @@ or field aliases. Comma-separated list of index names used to limit the request. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] `query`:: (Optional, Boolean) diff --git a/docs/reference/indices/clone-index.asciidoc b/docs/reference/indices/clone-index.asciidoc index ef8ed28c6ac0..c8e5d2e200f2 100644 --- a/docs/reference/indices/clone-index.asciidoc +++ b/docs/reference/indices/clone-index.asciidoc @@ -168,15 +168,15 @@ on index creation applies to the clone index action as well. (Required, string) Name of the source index to clone. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=target-index] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=target-index] [[clone-index-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] [role="child_attributes"] [[clone-index-api-request-body]] @@ -185,6 +185,6 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] `aliases`:: (Optional, object of objects) Aliases for the resulting index. + -include::{es-repo-dir}/indices/create-index.asciidoc[tag=aliases-props] +include::{es-ref-dir}/indices/create-index.asciidoc[tag=aliases-props] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=target-index-settings] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=target-index-settings] diff --git a/docs/reference/indices/close.asciidoc b/docs/reference/indices/close.asciidoc index 5caa6e892289..a4bf1742fdea 100644 --- a/docs/reference/indices/close.asciidoc +++ b/docs/reference/indices/close.asciidoc @@ -29,13 +29,13 @@ POST /my-index-000001/_close You use the close index API to close open indices. -include::{es-repo-dir}/indices/open-close.asciidoc[tag=closed-index] +include::{es-ref-dir}/indices/open-close.asciidoc[tag=closed-index] [[close-index-api-path-params]] ==== {api-path-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=index] + To close all indices, use `_all` or `*`. By default, you must explicitly name the indices you are closing. @@ -48,19 +48,19 @@ or using the <> API. [[close-index-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] + Defaults to `true`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + Defaults to `open`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] [[close-index-api-example]] diff --git a/docs/reference/indices/create-index.asciidoc b/docs/reference/indices/create-index.asciidoc index d39591a37df5..2e66f3d6030c 100644 --- a/docs/reference/indices/create-index.asciidoc +++ b/docs/reference/indices/create-index.asciidoc @@ -60,9 +60,9 @@ Index names must meet the following criteria: [[indices-create-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] [role="child_attributes"] [[indices-create-api-request-body]] @@ -113,9 +113,9 @@ specified, this overwrites the `routing` value for search operations. // end::aliases-props[] -- -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=mappings] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=mappings] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=settings] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=settings] [[indices-create-api-example]] ==== {api-examples-title} diff --git a/docs/reference/indices/dangling-index-delete.asciidoc b/docs/reference/indices/dangling-index-delete.asciidoc index 53be30ef7628..6af35031e9e6 100644 --- a/docs/reference/indices/dangling-index-delete.asciidoc +++ b/docs/reference/indices/dangling-index-delete.asciidoc @@ -24,7 +24,7 @@ DELETE /_dangling/?accept_data_loss=true [[dangling-index-delete-api-desc]] ==== {api-description-title} -include::{es-repo-dir}/indices/dangling-indices-list.asciidoc[tag=dangling-index-description] +include::{es-ref-dir}/indices/dangling-indices-list.asciidoc[tag=dangling-index-description] Deletes a dangling index by referencing its UUID. Use the @@ -47,4 +47,4 @@ UUID of the index to delete. You can find this using the This field must be set to `true` in order to carry out the import, since it will no longer be possible to recover the data from the dangling index. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] diff --git a/docs/reference/indices/dangling-index-import.asciidoc b/docs/reference/indices/dangling-index-import.asciidoc index c022c51d4091..44cde56de8c9 100644 --- a/docs/reference/indices/dangling-index-import.asciidoc +++ b/docs/reference/indices/dangling-index-import.asciidoc @@ -24,7 +24,7 @@ POST /_dangling/?accept_data_loss=true [[dangling-index-import-api-desc]] ==== {api-description-title} -include::{es-repo-dir}/indices/dangling-indices-list.asciidoc[tag=dangling-index-description] +include::{es-ref-dir}/indices/dangling-indices-list.asciidoc[tag=dangling-index-description] Import a single index into the cluster by referencing its UUID. Use the <> to locate the UUID of an index. @@ -48,7 +48,7 @@ cannot know where the dangling index data came from or determine which shard copies are fresh and which are stale, it cannot guarantee that the imported data represents the latest state of the index when it was last in the cluster. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] [[dangling-index-import-api-example]] ==== {api-examples-title} diff --git a/docs/reference/indices/data-stream-stats.asciidoc b/docs/reference/indices/data-stream-stats.asciidoc index a1f83701bb52..3ed285abc035 100644 --- a/docs/reference/indices/data-stream-stats.asciidoc +++ b/docs/reference/indices/data-stream-stats.asciidoc @@ -78,7 +78,7 @@ To target all data streams in a cluster, omit this parameter or use `*`. [[data-stream-stats-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=ds-expand-wildcards] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=ds-expand-wildcards] + Defaults to `open`. diff --git a/docs/reference/indices/delete-alias.asciidoc b/docs/reference/indices/delete-alias.asciidoc index 680e255a9728..748862df0610 100644 --- a/docs/reference/indices/delete-alias.asciidoc +++ b/docs/reference/indices/delete-alias.asciidoc @@ -42,4 +42,4 @@ the request. Supports wildcards (`*`). [[delete-alias-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] diff --git a/docs/reference/indices/delete-component-template.asciidoc b/docs/reference/indices/delete-component-template.asciidoc index 21693c44aadc..0ca6560f17cc 100644 --- a/docs/reference/indices/delete-component-template.asciidoc +++ b/docs/reference/indices/delete-component-template.asciidoc @@ -52,10 +52,10 @@ that specify index mappings, settings, and aliases. [[delete-component-template-api-path-params]] ==== {api-path-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=component-template] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=component-template] [[delete-component-template-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] diff --git a/docs/reference/indices/delete-data-stream.asciidoc b/docs/reference/indices/delete-data-stream.asciidoc index eb970f0f29d4..38e7a00d451d 100644 --- a/docs/reference/indices/delete-data-stream.asciidoc +++ b/docs/reference/indices/delete-data-stream.asciidoc @@ -59,6 +59,6 @@ Wildcard (`*`) expressions are supported. [[delete-data-stream-api-query-parms]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=ds-expand-wildcards] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=ds-expand-wildcards] + Defaults to `open`. diff --git a/docs/reference/indices/delete-index-template-v1.asciidoc b/docs/reference/indices/delete-index-template-v1.asciidoc index 9caf6935fe4f..ca0b5a0e726b 100644 --- a/docs/reference/indices/delete-index-template-v1.asciidoc +++ b/docs/reference/indices/delete-index-template-v1.asciidoc @@ -55,4 +55,4 @@ expressions are supported. [[delete-template-api-v1-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] diff --git a/docs/reference/indices/delete-index-template.asciidoc b/docs/reference/indices/delete-index-template.asciidoc index f410f091f686..02396310daff 100644 --- a/docs/reference/indices/delete-index-template.asciidoc +++ b/docs/reference/indices/delete-index-template.asciidoc @@ -55,10 +55,10 @@ and <> that can be applied automatically to new indices. [[delete-template-api-path-params]] ==== {api-path-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-template] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=index-template] [[delete-template-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] diff --git a/docs/reference/indices/delete-index.asciidoc b/docs/reference/indices/delete-index.asciidoc index 92f403c22ae3..d5d168154e44 100644 --- a/docs/reference/indices/delete-index.asciidoc +++ b/docs/reference/indices/delete-index.asciidoc @@ -50,14 +50,14 @@ setting to `false`. [[delete-index-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] + Defaults to `true`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + Defaults to `open,closed`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] diff --git a/docs/reference/indices/diskusage.asciidoc b/docs/reference/indices/diskusage.asciidoc index 98c2c799cf05..3510ba346e5a 100644 --- a/docs/reference/indices/diskusage.asciidoc +++ b/docs/reference/indices/diskusage.asciidoc @@ -41,11 +41,11 @@ resources significantly. [[analyze-index-disk-usage-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] + Defaults to `true`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + Defaults to `open`. @@ -53,13 +53,13 @@ Defaults to `open`. (Optional, Boolean) If `true`, the API performs a flush before analysis. If `false`, the response may not include uncommitted data. Defaults to `true`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] `run_expensive_tasks`:: (Required, Boolean) Analyzing field disk usage is resource-intensive. To use the API, this parameter must be set to `true`. Defaults to `false`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards] [[analyze-index-disk-usage-api-example]] diff --git a/docs/reference/indices/downsample-data-stream.asciidoc b/docs/reference/indices/downsample-data-stream.asciidoc index 8226c365dd50..5ace4e03dfb6 100644 --- a/docs/reference/indices/downsample-data-stream.asciidoc +++ b/docs/reference/indices/downsample-data-stream.asciidoc @@ -103,7 +103,7 @@ or `manage` <> for the data stream. -- (Required, string) Name of the index to create. -include::{es-repo-dir}/indices/create-index.asciidoc[tag=index-name-reqs] +include::{es-ref-dir}/indices/create-index.asciidoc[tag=index-name-reqs] -- [role="child_attributes"] diff --git a/docs/reference/indices/field-usage-stats.asciidoc b/docs/reference/indices/field-usage-stats.asciidoc index 9ff3143cc389..9fd1d9e59eb3 100644 --- a/docs/reference/indices/field-usage-stats.asciidoc +++ b/docs/reference/indices/field-usage-stats.asciidoc @@ -33,20 +33,20 @@ GET /my-index-000001/_field_usage_stats [[field-usage-stats-api-path-params]] ==== {api-path-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=index] [[field-usage-stats-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] `fields`:: + diff --git a/docs/reference/indices/flush.asciidoc b/docs/reference/indices/flush.asciidoc index 25d39a17af30..61c44f157da9 100644 --- a/docs/reference/indices/flush.asciidoc +++ b/docs/reference/indices/flush.asciidoc @@ -66,11 +66,11 @@ this parameter or use `*` or `_all`. [[flush-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] + Defaults to `true`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + Defaults to `open`. @@ -90,7 +90,7 @@ This parameter is considered internal. -- -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] `wait_if_ongoing`:: + diff --git a/docs/reference/indices/forcemerge.asciidoc b/docs/reference/indices/forcemerge.asciidoc index e316e0c5e1ae..1d473acbd5d4 100644 --- a/docs/reference/indices/forcemerge.asciidoc +++ b/docs/reference/indices/forcemerge.asciidoc @@ -103,11 +103,11 @@ and indices, omit this parameter or use `*` or `_all`. [[forcemerge-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] + Defaults to `true`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + Defaults to `open`. @@ -118,7 +118,7 @@ If `true`, after the force merge. Defaults to `true`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] `max_num_segments`:: + diff --git a/docs/reference/indices/get-alias.asciidoc b/docs/reference/indices/get-alias.asciidoc index 7c2f414ce5f4..743aaf7aee17 100644 --- a/docs/reference/indices/get-alias.asciidoc +++ b/docs/reference/indices/get-alias.asciidoc @@ -47,11 +47,11 @@ omit this parameter or use `*` or `_all`. [[get-alias-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] + Defaults to `true`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + Defaults to `all`. @@ -59,4 +59,4 @@ Defaults to `all`. (Optional, Boolean) If `false`, requests that include a missing data stream or index in the `` return an error. Defaults to `false`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=local] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=local] diff --git a/docs/reference/indices/get-data-stream.asciidoc b/docs/reference/indices/get-data-stream.asciidoc index d35e7a3d5e2e..240a33164b37 100644 --- a/docs/reference/indices/get-data-stream.asciidoc +++ b/docs/reference/indices/get-data-stream.asciidoc @@ -97,7 +97,7 @@ returned. [[get-data-stream-api-query-parms]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=ds-expand-wildcards] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=ds-expand-wildcards] + Defaults to `open`. diff --git a/docs/reference/indices/get-field-mapping.asciidoc b/docs/reference/indices/get-field-mapping.asciidoc index f72210b58e8f..ac5895872fbb 100644 --- a/docs/reference/indices/get-field-mapping.asciidoc +++ b/docs/reference/indices/get-field-mapping.asciidoc @@ -47,13 +47,13 @@ limit returned information. [[get-field-mapping-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] + Defaults to `true`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] `include_defaults`:: (Optional, Boolean) If `true`, the response includes default mapping values. diff --git a/docs/reference/indices/get-index-template-v1.asciidoc b/docs/reference/indices/get-index-template-v1.asciidoc index aa29786033d1..602ca2fe454a 100644 --- a/docs/reference/indices/get-index-template-v1.asciidoc +++ b/docs/reference/indices/get-index-template-v1.asciidoc @@ -52,7 +52,7 @@ privilege>> to use this API. [[get-template-v1-api-path-params]] ==== {api-path-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-template] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=index-template] + To return all index templates, omit this parameter or use a value of `_all` or `*`. @@ -61,11 +61,11 @@ or use a value of `_all` or `*`. [[get-template-v1-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=flat-settings] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=flat-settings] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=local] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=local] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] [[get-template-v1-api-example]] diff --git a/docs/reference/indices/get-index.asciidoc b/docs/reference/indices/get-index.asciidoc index 3e08cfc02c28..2551d25801d7 100644 --- a/docs/reference/indices/get-index.asciidoc +++ b/docs/reference/indices/get-index.asciidoc @@ -36,11 +36,11 @@ and indices, omit this parameter or use `*` or `_all`. [[get-index-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] + Defaults to `true`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + Defaults to `open`. @@ -50,15 +50,15 @@ Return information about specific index features. Supports comma- separated values. Valid values are `aliases`, `mappings`, and `settings`. Defaults to `aliases,mappings,settings`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=flat-settings] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=flat-settings] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=include-defaults] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=include-defaults] `ignore_unavailable`:: (Optional, Boolean) If `false`, requests that target a missing index return an error. Defaults to `false`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=local] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=local] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] diff --git a/docs/reference/indices/get-mapping.asciidoc b/docs/reference/indices/get-mapping.asciidoc index 90368126b57b..16dc8c66d071 100644 --- a/docs/reference/indices/get-mapping.asciidoc +++ b/docs/reference/indices/get-mapping.asciidoc @@ -38,19 +38,19 @@ and indices, omit this parameter or use `*` or `_all`. [[get-mapping-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] + Defaults to `true`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + Defaults to `open`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=local] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=local] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] [[get-mapping-api-example]] diff --git a/docs/reference/indices/get-settings.asciidoc b/docs/reference/indices/get-settings.asciidoc index f7ba885b55cb..b6cb6d292638 100644 --- a/docs/reference/indices/get-settings.asciidoc +++ b/docs/reference/indices/get-settings.asciidoc @@ -44,23 +44,23 @@ used to limit the request. [[get-index-settings-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] + Defaults to `true`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + Defaults to `open`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=flat-settings] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=flat-settings] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=include-defaults] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=include-defaults] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=local] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=local] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] [[get-index-settings-api-example]] diff --git a/docs/reference/indices/index-template-exists-v1.asciidoc b/docs/reference/indices/index-template-exists-v1.asciidoc index 888a967056ee..2358f0b1a376 100644 --- a/docs/reference/indices/index-template-exists-v1.asciidoc +++ b/docs/reference/indices/index-template-exists-v1.asciidoc @@ -43,17 +43,17 @@ and <> that can be applied automatically to new indices. [[template-exists-api-path-params]] ==== {api-path-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-template] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=index-template] [[template-exists-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=flat-settings] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=flat-settings] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=local] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=local] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] [[template-exists-api-response-codes]] diff --git a/docs/reference/indices/indices-exists.asciidoc b/docs/reference/indices/indices-exists.asciidoc index 934b224b8e79..d699d36add03 100644 --- a/docs/reference/indices/indices-exists.asciidoc +++ b/docs/reference/indices/indices-exists.asciidoc @@ -35,21 +35,21 @@ Supports wildcards (`*`). [[indices-exists-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] + Defaults to `true`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + Defaults to `open`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=flat-settings] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=flat-settings] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=include-defaults] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=include-defaults] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=local] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=local] [[indices-exists-api-response-codes]] ==== {api-response-codes-title} diff --git a/docs/reference/indices/open-close.asciidoc b/docs/reference/indices/open-close.asciidoc index bac5c07a0195..a077c4d19fd5 100644 --- a/docs/reference/indices/open-close.asciidoc +++ b/docs/reference/indices/open-close.asciidoc @@ -96,19 +96,19 @@ or using the <> API. [[open-index-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] + Defaults to `true`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + Defaults to `closed`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] [[open-index-api-example]] diff --git a/docs/reference/indices/put-component-template.asciidoc b/docs/reference/indices/put-component-template.asciidoc index faf7e67039de..0a0e36b63e6c 100644 --- a/docs/reference/indices/put-component-template.asciidoc +++ b/docs/reference/indices/put-component-template.asciidoc @@ -123,7 +123,7 @@ The exception of that rule are the `*@custom` component templates that let you s If `true`, this request cannot replace or update existing component templates. Defaults to `false`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] [role="child_attributes"] [[put-component-template-api-request-body]] @@ -140,13 +140,13 @@ This is the template to be applied, may optionally include a `mappings`, `aliases`:: (Optional, object of objects) Aliases to add. + -include::{es-repo-dir}/indices/put-index-template.asciidoc[tag=template-ds-alias] +include::{es-ref-dir}/indices/put-index-template.asciidoc[tag=template-ds-alias] + -include::{es-repo-dir}/indices/create-index.asciidoc[tag=aliases-props] +include::{es-ref-dir}/indices/create-index.asciidoc[tag=aliases-props] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=mappings] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=mappings] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=settings] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=settings] ==== `version`:: diff --git a/docs/reference/indices/put-index-template-v1.asciidoc b/docs/reference/indices/put-index-template-v1.asciidoc index 5b7713656c4d..86a8a54edd97 100644 --- a/docs/reference/indices/put-index-template-v1.asciidoc +++ b/docs/reference/indices/put-index-template-v1.asciidoc @@ -112,7 +112,7 @@ Templates with lower `order` values are merged first. Templates with higher `order` values are merged later, overriding templates with lower values. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] [role="child_attributes"] [[put-index-template-v1-api-request-body]] @@ -126,11 +126,11 @@ used to match the names of indices during creation. `aliases`:: (Optional, object of objects) Aliases for the index. + -include::{es-repo-dir}/indices/create-index.asciidoc[tag=aliases-props] +include::{es-ref-dir}/indices/create-index.asciidoc[tag=aliases-props] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=mappings] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=mappings] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=settings] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=settings] `version`:: (Optional, integer) diff --git a/docs/reference/indices/put-index-template.asciidoc b/docs/reference/indices/put-index-template.asciidoc index b9460bda86a0..bcc7fa9caa81 100644 --- a/docs/reference/indices/put-index-template.asciidoc +++ b/docs/reference/indices/put-index-template.asciidoc @@ -156,7 +156,7 @@ aliases. Otherwise, these are index aliases. Data stream aliases ignore the `index_routing`, `routing`, and `search_routing` options. // end::template-ds-alias[] + -include::{es-repo-dir}/indices/create-index.asciidoc[tag=aliases-props] +include::{es-ref-dir}/indices/create-index.asciidoc[tag=aliases-props] include::{docdir}/rest-api/common-parms.asciidoc[tag=mappings] diff --git a/docs/reference/indices/put-mapping.asciidoc b/docs/reference/indices/put-mapping.asciidoc index bd2382c38910..dc6dbff1df42 100644 --- a/docs/reference/indices/put-mapping.asciidoc +++ b/docs/reference/indices/put-mapping.asciidoc @@ -50,17 +50,17 @@ and indices, omit this parameter or use `*` or `_all`. [[put-mapping-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] + Defaults to `false`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + Defaults to `open`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] `write_index_only`:: (Optional, Boolean) diff --git a/docs/reference/indices/recovery.asciidoc b/docs/reference/indices/recovery.asciidoc index 81b3aa13580c..b4e4bd33f819 100644 --- a/docs/reference/indices/recovery.asciidoc +++ b/docs/reference/indices/recovery.asciidoc @@ -70,11 +70,11 @@ and indices, omit this parameter or use `*` or `_all`. [[index-recovery-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=active-only] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=active-only] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=detailed] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=detailed] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-query-parm] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=index-query-parm] [[index-recovery-api-response-body]] diff --git a/docs/reference/indices/refresh.asciidoc b/docs/reference/indices/refresh.asciidoc index f0f9d06d6fc4..bd8e821ff56b 100644 --- a/docs/reference/indices/refresh.asciidoc +++ b/docs/reference/indices/refresh.asciidoc @@ -81,15 +81,15 @@ omit this parameter or use `*` or `_all`. [[refresh-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] + Defaults to `true`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + Defaults to `open`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] [[refresh-api-example]] diff --git a/docs/reference/indices/resolve-cluster.asciidoc b/docs/reference/indices/resolve-cluster.asciidoc index 8fa53bfc2705..48e6bfac4af1 100644 --- a/docs/reference/indices/resolve-cluster.asciidoc +++ b/docs/reference/indices/resolve-cluster.asciidoc @@ -91,15 +91,15 @@ Resources on <> can be specified using the [[resolve-cluster-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + Defaults to `open`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] + Defaults to `false`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] + Defaults to `true`. diff --git a/docs/reference/indices/resolve.asciidoc b/docs/reference/indices/resolve.asciidoc index c919bba5c765..856546b037fe 100644 --- a/docs/reference/indices/resolve.asciidoc +++ b/docs/reference/indices/resolve.asciidoc @@ -76,15 +76,15 @@ Resources on <> can be specified using the [[resolve-index-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + Defaults to `open`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] + Defaults to `false`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] + Defaults to `true`. diff --git a/docs/reference/indices/rollover-index.asciidoc b/docs/reference/indices/rollover-index.asciidoc index aa6f978b237d..2a47d28e5358 100644 --- a/docs/reference/indices/rollover-index.asciidoc +++ b/docs/reference/indices/rollover-index.asciidoc @@ -46,7 +46,7 @@ rollover also increments the data stream's generation. See [TIP] ==== -include::{es-repo-dir}/data-streams/set-up-a-data-stream.asciidoc[tag=time-series-alias-tip] +include::{es-ref-dir}/data-streams/set-up-a-data-stream.asciidoc[tag=time-series-alias-tip] See <>. ==== @@ -104,7 +104,7 @@ streams do not support this parameter. If the name of the alias's current write index does not end with `-` and a number, such as `my-index-000001` or `my-index-3`, this parameter is required. + -include::{es-repo-dir}/indices/create-index.asciidoc[tag=index-name-reqs] +include::{es-ref-dir}/indices/create-index.asciidoc[tag=index-name-reqs] [[rollover-index-api-query-params]] ==== {api-query-parms-title} @@ -119,9 +119,9 @@ If `true`, checks whether the current index satisfies the specified If `true`, signals that the data stream will be rolled over when the next indexing operation occurs. Applies only to data streams. Defaults to `false`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] [role="child_attributes"] [[rollover-index-api-request-body]] @@ -131,7 +131,7 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] (Optional, object of objects) Aliases for the target index. Data streams do not support this parameter. + -include::{es-repo-dir}/indices/create-index.asciidoc[tag=aliases-props] +include::{es-ref-dir}/indices/create-index.asciidoc[tag=aliases-props] [[rollover-conditions]] `conditions`:: @@ -152,14 +152,14 @@ instead. .Properties of `conditions` [%collapsible%open] ==== -include::{es-repo-dir}/ilm/actions/ilm-rollover.asciidoc[tag=rollover-conditions] +include::{es-ref-dir}/ilm/actions/ilm-rollover.asciidoc[tag=rollover-conditions] ==== -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=mappings] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=mappings] + Data streams do not support this parameter. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=settings] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=settings] + Data streams do not support this parameter. diff --git a/docs/reference/indices/segments.asciidoc b/docs/reference/indices/segments.asciidoc index db13243c62d2..8621bc7ae1de 100644 --- a/docs/reference/indices/segments.asciidoc +++ b/docs/reference/indices/segments.asciidoc @@ -40,50 +40,50 @@ and indices, omit this parameter or use `*` or `_all`. [[index-segments-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] + Defaults to `true`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + Defaults to `open`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] [[index-segments-api-response-body]] ==== {api-response-body-title} ``:: (String) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=segment] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=segment] `generation`:: (Integer) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=generation] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=generation] `num_docs`:: (Integer) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=docs-count] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=docs-count] `deleted_docs`:: (Integer) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=docs-deleted] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=docs-deleted] `size_in_bytes`:: (Integer) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=segment-size] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=segment-size] `committed`:: (Boolean) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=committed] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=committed] `search`:: (Boolean) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=segment-search] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=segment-search] `version`:: (String) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=segment-version] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=segment-version] `compound`:: (Boolean) diff --git a/docs/reference/indices/shard-stores.asciidoc b/docs/reference/indices/shard-stores.asciidoc index 562c14694971..1b001a3175b8 100644 --- a/docs/reference/indices/shard-stores.asciidoc +++ b/docs/reference/indices/shard-stores.asciidoc @@ -58,15 +58,15 @@ and indices, omit this parameter or use `*` or `_all`. [[index-shard-stores-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] + Defaults to `true`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + Defaults to `open`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] `status`:: + diff --git a/docs/reference/indices/shrink-index.asciidoc b/docs/reference/indices/shrink-index.asciidoc index 5d5e6c24d9e8..244733282d46 100644 --- a/docs/reference/indices/shrink-index.asciidoc +++ b/docs/reference/indices/shrink-index.asciidoc @@ -219,14 +219,14 @@ on index creation applies to the shrink index action as well. (Required, string) Name of the source index to shrink. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=target-index] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=target-index] [[shrink-index-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] [role="child_attributes"] [[shrink-index-api-request-body]] @@ -235,9 +235,9 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] `aliases`:: (Optional, object of objects) Aliases for the resulting index. + -include::{es-repo-dir}/indices/create-index.asciidoc[tag=aliases-props] +include::{es-ref-dir}/indices/create-index.asciidoc[tag=aliases-props] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=target-index-settings] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=target-index-settings] `max_primary_shard_size`:: (Optional, <>) diff --git a/docs/reference/indices/simulate-template.asciidoc b/docs/reference/indices/simulate-template.asciidoc index 404aa70d72e7..c7397ace9788 100644 --- a/docs/reference/indices/simulate-template.asciidoc +++ b/docs/reference/indices/simulate-template.asciidoc @@ -132,7 +132,7 @@ The settings, mappings, and aliases that would be applied to matching indices. (Optional, object of objects) Aliases for the index. If the index template includes `data_stream`, this parameter is not supported. + -include::{es-repo-dir}/indices/create-index.asciidoc[tag=aliases-props] +include::{es-ref-dir}/indices/create-index.asciidoc[tag=aliases-props] include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=mappings] diff --git a/docs/reference/indices/split-index.asciidoc b/docs/reference/indices/split-index.asciidoc index 26ae0f19b177..0c93b572639d 100644 --- a/docs/reference/indices/split-index.asciidoc +++ b/docs/reference/indices/split-index.asciidoc @@ -255,15 +255,15 @@ on index creation applies to the split index action as well. (Required, string) Name of the source index to split. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=target-index] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=target-index] [[split-index-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] [role="child_attributes"] [[split-index-api-request-body]] @@ -272,6 +272,6 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] `aliases`:: (Optional, object of objects) Aliases for the resulting index. + -include::{es-repo-dir}/indices/create-index.asciidoc[tag=aliases-props] +include::{es-ref-dir}/indices/create-index.asciidoc[tag=aliases-props] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=target-index-settings] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=target-index-settings] diff --git a/docs/reference/indices/stats.asciidoc b/docs/reference/indices/stats.asciidoc index 41b213b7a5b2..088d65c37ec6 100644 --- a/docs/reference/indices/stats.asciidoc +++ b/docs/reference/indices/stats.asciidoc @@ -64,34 +64,34 @@ to which the shard contributed. used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-metric] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=index-metric] [[index-stats-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + Defaults to `open`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=fields] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=fields] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=completion-fields] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=completion-fields] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=fielddata-fields] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=fielddata-fields] `forbid_closed_indices`:: (Optional, Boolean) If `true`, statistics are *not* collected from closed indices. Defaults to `true`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=groups] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=groups] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=level] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=level] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=include-segment-file-sizes] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=include-segment-file-sizes] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=include-unloaded-segments] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=include-unloaded-segments] [[index-stats-api-example]] diff --git a/docs/reference/indices/update-settings.asciidoc b/docs/reference/indices/update-settings.asciidoc index 1ac9ecbb6a6a..3b29946d5ed7 100644 --- a/docs/reference/indices/update-settings.asciidoc +++ b/docs/reference/indices/update-settings.asciidoc @@ -44,17 +44,17 @@ and indices, omit this parameter or use `*` or `_all`. [[update-index-settings-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] + Defaults to `false`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + Defaults to `open`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=flat-settings] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=flat-settings] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] `preserve_existing`:: (Optional, Boolean) If `true`, existing index settings remain unchanged. @@ -70,7 +70,7 @@ NOTE: Changing index settings on an automatically closed index using the `reopen parameter will result in the index becoming unavailable momentarily while the index is in the process of reopening. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] [[update-index-settings-api-request-body]] diff --git a/docs/reference/ingest/apis/delete-pipeline.asciidoc b/docs/reference/ingest/apis/delete-pipeline.asciidoc index 368f9f2b0262..6f50251dbf1c 100644 --- a/docs/reference/ingest/apis/delete-pipeline.asciidoc +++ b/docs/reference/ingest/apis/delete-pipeline.asciidoc @@ -59,7 +59,7 @@ use a value of `*`. [[delete-pipeline-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] [[delete-pipeline-api-api-example]] diff --git a/docs/reference/ingest/apis/get-pipeline.asciidoc b/docs/reference/ingest/apis/get-pipeline.asciidoc index 9208f0507876..71a261d97bde 100644 --- a/docs/reference/ingest/apis/get-pipeline.asciidoc +++ b/docs/reference/ingest/apis/get-pipeline.asciidoc @@ -62,7 +62,7 @@ To get all ingest pipelines, omit this parameter or use `*`. [[get-pipeline-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] [[get-pipeline-api-api-example]] diff --git a/docs/reference/ingest/apis/put-pipeline.asciidoc b/docs/reference/ingest/apis/put-pipeline.asciidoc index ab1139b99995..5b532dedf8e8 100644 --- a/docs/reference/ingest/apis/put-pipeline.asciidoc +++ b/docs/reference/ingest/apis/put-pipeline.asciidoc @@ -59,7 +59,7 @@ See also <>. version. If specified and the update is successful, the pipeline's version is incremented. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] [[put-pipeline-api-request-body]] ==== {api-request-body-title} diff --git a/docs/reference/ingest/enrich.asciidoc b/docs/reference/ingest/enrich.asciidoc index 4688b21d37e7..6642cdc2a74c 100644 --- a/docs/reference/ingest/enrich.asciidoc +++ b/docs/reference/ingest/enrich.asciidoc @@ -112,7 +112,7 @@ that doesn't change frequently. [[enrich-prereqs]] ==== Prerequisites -include::{es-repo-dir}/ingest/apis/enrich/put-enrich-policy.asciidoc[tag=enrich-policy-api-prereqs] +include::{es-ref-dir}/ingest/apis/enrich/put-enrich-policy.asciidoc[tag=enrich-policy-api-prereqs] [[create-enrich-source-index]] ==== Add enrich data @@ -203,7 +203,7 @@ documents first and verifying enrich data was added correctly using the [[update-enrich-data]] ==== Update an enrich index -include::{es-repo-dir}/ingest/apis/enrich/execute-enrich-policy.asciidoc[tag=update-enrich-index] +include::{es-ref-dir}/ingest/apis/enrich/execute-enrich-policy.asciidoc[tag=update-enrich-index] If wanted, you can <> or <> any already ingested documents diff --git a/docs/reference/ingest/processors/inference.asciidoc b/docs/reference/ingest/processors/inference.asciidoc index 0995e3f64381..88d97d9422d5 100644 --- a/docs/reference/ingest/processors/inference.asciidoc +++ b/docs/reference/ingest/processors/inference.asciidoc @@ -113,23 +113,23 @@ Classification configuration for inference. `num_top_classes`:: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-classification-num-top-classes] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-classification-num-top-classes] `num_top_feature_importance_values`:: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-classification-num-top-feature-importance-values] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-classification-num-top-feature-importance-values] `results_field`:: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-results-field-processor] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-results-field-processor] `top_classes_results_field`:: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-classification-top-classes-results-field] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-classification-top-classes-results-field] `prediction_field_type`:: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-classification-prediction-field-type] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-classification-prediction-field-type] [discrete] [[inference-processor-fill-mask-opt]] @@ -137,22 +137,22 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-classification `num_top_classes`:: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-classification-num-top-classes] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-classification-num-top-classes] `results_field`:: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-results-field-processor] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-results-field-processor] `tokenization`:: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization] + .Properties of tokenization [%collapsible%open] ===== `bert`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert] + .Properties of bert [%collapsible%open] @@ -160,12 +160,12 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenizati `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] ======= `roberta`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta] + .Properties of roberta [%collapsible%open] @@ -173,12 +173,12 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenizati `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] ======= `mpnet`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-mpnet] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-mpnet] + .Properties of mpnet [%collapsible%open] @@ -186,7 +186,7 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenizati `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] ======= ===== @@ -196,18 +196,18 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenizati `results_field`:: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-results-field-processor] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-results-field-processor] `tokenization`:: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization] + .Properties of tokenization [%collapsible%open] ===== `bert`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert] + .Properties of bert [%collapsible%open] @@ -215,12 +215,12 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenizati `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] ======= `roberta`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta] + .Properties of roberta [%collapsible%open] @@ -228,12 +228,12 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenizati `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] ======= `mpnet`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-mpnet] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-mpnet] + .Properties of mpnet [%collapsible%open] @@ -241,7 +241,7 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenizati `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] ======= ===== @@ -253,11 +253,11 @@ Regression configuration for inference. `results_field`:: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-results-field-processor] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-results-field-processor] `num_top_feature_importance_values`:: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-regression-num-top-feature-importance-values] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-regression-num-top-feature-importance-values] [discrete] [[inference-processor-text-classification-opt]] @@ -268,22 +268,22 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-regression-num `num_top_classes`:: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-classification-num-top-classes] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-classification-num-top-classes] `results_field`:: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-results-field-processor] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-results-field-processor] `tokenization`:: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization] + .Properties of tokenization [%collapsible%open] ===== `bert`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert] + .Properties of bert [%collapsible%open] @@ -291,16 +291,16 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenizati `span`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-span] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-span] `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] ======= `roberta`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta] + .Properties of roberta [%collapsible%open] @@ -308,16 +308,16 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenizati `span`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-span] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-span] `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] ======= `mpnet`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-mpnet] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-mpnet] + .Properties of mpnet [%collapsible%open] @@ -325,7 +325,7 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenizati `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] ======= ===== @@ -335,18 +335,18 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenizati `results_field`:: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-results-field-processor] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-results-field-processor] `tokenization`:: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization] + .Properties of tokenization [%collapsible%open] ===== `bert`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert] + .Properties of bert [%collapsible%open] @@ -354,12 +354,12 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenizati `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] ======= `roberta`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta] + .Properties of roberta [%collapsible%open] @@ -367,12 +367,12 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenizati `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] ======= `mpnet`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-mpnet] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-mpnet] + .Properties of mpnet [%collapsible%open] @@ -380,7 +380,7 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenizati `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] ======= ===== @@ -391,19 +391,19 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenizati `results_field`:: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-results-field-processor] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-results-field-processor] `tokenization`:: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization] + .Properties of tokenization [%collapsible%open] ===== `bert`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert] + .Properties of bert [%collapsible%open] @@ -411,16 +411,16 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenizati `span`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-span] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-span] `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] ======= `roberta`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta] + .Properties of roberta [%collapsible%open] @@ -428,16 +428,16 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenizati `span`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-span] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-span] `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] ======= `mpnet`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-mpnet] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-mpnet] + .Properties of mpnet [%collapsible%open] @@ -445,7 +445,7 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenizati `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] ======= ===== @@ -456,26 +456,26 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenizati `labels`:: (Optional, array) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-zero-shot-classification-labels] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-zero-shot-classification-labels] `multi_label`:: (Optional, boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-zero-shot-classification-multi-label] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-zero-shot-classification-multi-label] `results_field`:: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-results-field-processor] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-results-field-processor] `tokenization`:: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization] + .Properties of tokenization [%collapsible%open] ===== `bert`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert] + .Properties of bert [%collapsible%open] @@ -483,12 +483,12 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenizati `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] ======= `roberta`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta] + .Properties of roberta [%collapsible%open] @@ -496,12 +496,12 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenizati `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] ======= `mpnet`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-mpnet] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-mpnet] + .Properties of mpnet [%collapsible%open] @@ -509,7 +509,7 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenizati `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] ======= ===== diff --git a/docs/reference/mapping/explicit-mapping.asciidoc b/docs/reference/mapping/explicit-mapping.asciidoc index ba2d9ec16676..3b0de5fad051 100644 --- a/docs/reference/mapping/explicit-mapping.asciidoc +++ b/docs/reference/mapping/explicit-mapping.asciidoc @@ -63,9 +63,9 @@ PUT /my-index-000001/_mapping [[update-mapping]] === Update the mapping of a field -include::{es-repo-dir}/indices/put-mapping.asciidoc[tag=change-field-mapping] +include::{es-ref-dir}/indices/put-mapping.asciidoc[tag=change-field-mapping] -include::{es-repo-dir}/indices/put-mapping.asciidoc[tag=rename-field] +include::{es-ref-dir}/indices/put-mapping.asciidoc[tag=rename-field] [discrete] [[view-mapping]] diff --git a/docs/reference/mapping/mapping-settings-limit.asciidoc b/docs/reference/mapping/mapping-settings-limit.asciidoc index 6e05e6ea6085..197642216499 100644 --- a/docs/reference/mapping/mapping-settings-limit.asciidoc +++ b/docs/reference/mapping/mapping-settings-limit.asciidoc @@ -58,4 +58,4 @@ or setting the index setting `index.mapping.total_fields.ignore_dynamic_beyond_l unless a user starts to add a huge number of fields with really long names. Default is `Long.MAX_VALUE` (no limit). -include::{es-repo-dir}/data-streams/tsds-index-settings.asciidoc[tag=dimensions-limit] +include::{es-ref-dir}/data-streams/tsds-index-settings.asciidoc[tag=dimensions-limit] diff --git a/docs/reference/mapping/types/aggregate-metric-double.asciidoc b/docs/reference/mapping/types/aggregate-metric-double.asciidoc index cf9377dec005..e702d34f07d4 100644 --- a/docs/reference/mapping/types/aggregate-metric-double.asciidoc +++ b/docs/reference/mapping/types/aggregate-metric-double.asciidoc @@ -65,9 +65,9 @@ include::numeric.asciidoc[tag=time_series_metric] [%collapsible%open] ==== -include::{es-repo-dir}/data-streams/tsds.asciidoc[tag=time-series-metric-gauge] +include::{es-ref-dir}/data-streams/tsds.asciidoc[tag=time-series-metric-gauge] -include::{es-repo-dir}/data-streams/tsds.asciidoc[tag=time-series-metric-null] +include::{es-ref-dir}/data-streams/tsds.asciidoc[tag=time-series-metric-null] ==== [[aggregate-metric-double-uses]] diff --git a/docs/reference/mapping/types/dense-vector.asciidoc b/docs/reference/mapping/types/dense-vector.asciidoc index 14fe9d496397..6294423985ec 100644 --- a/docs/reference/mapping/types/dense-vector.asciidoc +++ b/docs/reference/mapping/types/dense-vector.asciidoc @@ -51,7 +51,7 @@ It is not possible to store multiple values in one `dense_vector` field. [[index-vectors-knn-search]] ==== Index vectors for kNN search -include::{es-repo-dir}/search/search-your-data/knn-search.asciidoc[tag=knn-def] +include::{es-ref-dir}/search/search-your-data/knn-search.asciidoc[tag=knn-def] Dense vector fields can be used to rank documents in <>. This lets you perform diff --git a/docs/reference/mapping/types/nested.asciidoc b/docs/reference/mapping/types/nested.asciidoc index 8611205cb749..5d6ede6acd5a 100644 --- a/docs/reference/mapping/types/nested.asciidoc +++ b/docs/reference/mapping/types/nested.asciidoc @@ -220,11 +220,11 @@ then 101 Lucene documents would be created: one for the parent document, and one nested object. Because of the expense associated with `nested` mappings, Elasticsearch puts settings in place to guard against performance problems: -include::{es-repo-dir}/mapping/mapping-settings-limit.asciidoc[tag=nested-fields-limit] +include::{es-ref-dir}/mapping/mapping-settings-limit.asciidoc[tag=nested-fields-limit] In the previous example, the `user` mapping would count as only 1 towards this limit. -include::{es-repo-dir}/mapping/mapping-settings-limit.asciidoc[tag=nested-objects-limit] +include::{es-ref-dir}/mapping/mapping-settings-limit.asciidoc[tag=nested-objects-limit] To illustrate how this setting works, consider adding another `nested` type called `comments` to the previous example mapping. For each document, the combined number of `user` and `comment` diff --git a/docs/reference/mapping/types/numeric.asciidoc b/docs/reference/mapping/types/numeric.asciidoc index a78611c4d8d3..32f4964e8ca4 100644 --- a/docs/reference/mapping/types/numeric.asciidoc +++ b/docs/reference/mapping/types/numeric.asciidoc @@ -200,11 +200,11 @@ metric type. You can't update this parameter for existing fields. .Valid `time_series_metric` values for numeric fields [%collapsible%open] ==== -include::{es-repo-dir}/data-streams/tsds.asciidoc[tag=time-series-metric-counter] +include::{es-ref-dir}/data-streams/tsds.asciidoc[tag=time-series-metric-counter] -include::{es-repo-dir}/data-streams/tsds.asciidoc[tag=time-series-metric-gauge] +include::{es-ref-dir}/data-streams/tsds.asciidoc[tag=time-series-metric-gauge] -include::{es-repo-dir}/data-streams/tsds.asciidoc[tag=time-series-metric-null] +include::{es-ref-dir}/data-streams/tsds.asciidoc[tag=time-series-metric-null] ==== + For a numeric time series metric, the `doc_values` parameter must be `true`. A diff --git a/docs/reference/migration/apis/deprecation.asciidoc b/docs/reference/migration/apis/deprecation.asciidoc index fd82bb3e0e6d..67b4c113af2b 100644 --- a/docs/reference/migration/apis/deprecation.asciidoc +++ b/docs/reference/migration/apis/deprecation.asciidoc @@ -5,7 +5,7 @@ Deprecation info ++++ -include::{es-repo-dir}/migration/apis/shared-migration-apis-tip.asciidoc[] +include::{es-ref-dir}/migration/apis/shared-migration-apis-tip.asciidoc[] The deprecation API is to be used to retrieve information about different cluster, node, and index level settings that use deprecated features that will diff --git a/docs/reference/migration/apis/feature-migration.asciidoc b/docs/reference/migration/apis/feature-migration.asciidoc index 9a6306dc2f59..e38639ac4453 100644 --- a/docs/reference/migration/apis/feature-migration.asciidoc +++ b/docs/reference/migration/apis/feature-migration.asciidoc @@ -5,7 +5,7 @@ Feature migration ++++ -include::{es-repo-dir}/migration/apis/shared-migration-apis-tip.asciidoc[] +include::{es-ref-dir}/migration/apis/shared-migration-apis-tip.asciidoc[] Version upgrades sometimes require changes to how features store configuration information and data in system indices. The feature migration APIs enable you to diff --git a/docs/reference/migration/migrate_8_0/rest-api-changes.asciidoc b/docs/reference/migration/migrate_8_0/rest-api-changes.asciidoc index 87e704110971..99c09b9b0538 100644 --- a/docs/reference/migration/migrate_8_0/rest-api-changes.asciidoc +++ b/docs/reference/migration/migrate_8_0/rest-api-changes.asciidoc @@ -190,7 +190,7 @@ version of a major version to a remote cluster running any minor version in the following major version. For example, a local 7.17 cluster can search any remote 8.x cluster. -include::{es-repo-dir}/search/search-your-data/ccs-version-compat-matrix.asciidoc[] +include::{es-ref-dir}/search/search-your-data/ccs-version-compat-matrix.asciidoc[] IMPORTANT: For the {ref}/eql-search-api.html[EQL search API], the local and remote clusters must use the same {es} version if they have versions prior to 7.17.7 (included) or prior to 8.5.1 (included). diff --git a/docs/reference/ml/anomaly-detection/apis/close-job.asciidoc b/docs/reference/ml/anomaly-detection/apis/close-job.asciidoc index 988dff2d9232..f0cb968e082c 100644 --- a/docs/reference/ml/anomaly-detection/apis/close-job.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/close-job.asciidoc @@ -59,7 +59,7 @@ results the job might have recently produced or might produce in the future. ``:: (Required, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection-wildcard] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection-wildcard] + You can close all jobs by using `_all` or by specifying `*` as the job identifier. @@ -69,7 +69,7 @@ identifier. `allow_no_match`:: (Optional, Boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-no-match-jobs] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=allow-no-match-jobs] `force`:: (Optional, Boolean) Use to close a failed job, or to forcefully close a job diff --git a/docs/reference/ml/anomaly-detection/apis/delete-calendar-event.asciidoc b/docs/reference/ml/anomaly-detection/apis/delete-calendar-event.asciidoc index 4e2501aa5a17..b80a248038ae 100644 --- a/docs/reference/ml/anomaly-detection/apis/delete-calendar-event.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/delete-calendar-event.asciidoc @@ -30,7 +30,7 @@ events and delete the calendar, see the ``:: (Required, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=calendar-id] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=calendar-id] ``:: (Required, string) Identifier for the scheduled event. You can obtain this diff --git a/docs/reference/ml/anomaly-detection/apis/delete-calendar-job.asciidoc b/docs/reference/ml/anomaly-detection/apis/delete-calendar-job.asciidoc index 8b01fa1066f4..6720e236fd63 100644 --- a/docs/reference/ml/anomaly-detection/apis/delete-calendar-job.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/delete-calendar-job.asciidoc @@ -23,11 +23,11 @@ Requires the `manage_ml` cluster privilege. This privilege is included in the ``:: (Required, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=calendar-id] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=calendar-id] ``:: (Required, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection-list] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection-list] [[ml-delete-calendar-job-example]] == {api-examples-title} diff --git a/docs/reference/ml/anomaly-detection/apis/delete-calendar.asciidoc b/docs/reference/ml/anomaly-detection/apis/delete-calendar.asciidoc index 5f710ca50c55..6684366c6f33 100644 --- a/docs/reference/ml/anomaly-detection/apis/delete-calendar.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/delete-calendar.asciidoc @@ -29,7 +29,7 @@ calendar. ``:: (Required, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=calendar-id] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=calendar-id] [[ml-delete-calendar-example]] == {api-examples-title} diff --git a/docs/reference/ml/anomaly-detection/apis/delete-datafeed.asciidoc b/docs/reference/ml/anomaly-detection/apis/delete-datafeed.asciidoc index bf4b69b5d8bc..64a1e4c336fe 100644 --- a/docs/reference/ml/anomaly-detection/apis/delete-datafeed.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/delete-datafeed.asciidoc @@ -27,7 +27,7 @@ can delete it. ``:: (Required, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=datafeed-id] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=datafeed-id] [[ml-delete-datafeed-query-parms]] == {api-query-parms-title} diff --git a/docs/reference/ml/anomaly-detection/apis/delete-filter.asciidoc b/docs/reference/ml/anomaly-detection/apis/delete-filter.asciidoc index e59e04fe60c1..4b41347543e8 100644 --- a/docs/reference/ml/anomaly-detection/apis/delete-filter.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/delete-filter.asciidoc @@ -31,7 +31,7 @@ filter. For more information, see ``:: (Required, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=filter-id] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=filter-id] [[ml-delete-filter-example]] == {api-examples-title} diff --git a/docs/reference/ml/anomaly-detection/apis/delete-forecast.asciidoc b/docs/reference/ml/anomaly-detection/apis/delete-forecast.asciidoc index b2866ee834a2..74e6ce27084a 100644 --- a/docs/reference/ml/anomaly-detection/apis/delete-forecast.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/delete-forecast.asciidoc @@ -45,7 +45,7 @@ forecasts from the job. ``:: (Required, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] [[ml-delete-forecast-query-parms]] diff --git a/docs/reference/ml/anomaly-detection/apis/delete-job.asciidoc b/docs/reference/ml/anomaly-detection/apis/delete-job.asciidoc index 7520a45f9211..1bbe07fd44f4 100644 --- a/docs/reference/ml/anomaly-detection/apis/delete-job.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/delete-job.asciidoc @@ -43,7 +43,7 @@ parameters as the delete job request. ``:: (Required, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] [[ml-delete-job-query-parms]] == {api-query-parms-title} diff --git a/docs/reference/ml/anomaly-detection/apis/delete-snapshot.asciidoc b/docs/reference/ml/anomaly-detection/apis/delete-snapshot.asciidoc index 6f39cdbb372e..ad10de7a2ba0 100644 --- a/docs/reference/ml/anomaly-detection/apis/delete-snapshot.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/delete-snapshot.asciidoc @@ -30,11 +30,11 @@ the `model_snapshot_id` in the results from the get jobs API. ``:: (Required, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] ``:: (Required, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=snapshot-id] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=snapshot-id] [[ml-delete-snapshot-example]] == {api-examples-title} diff --git a/docs/reference/ml/anomaly-detection/apis/flush-job.asciidoc b/docs/reference/ml/anomaly-detection/apis/flush-job.asciidoc index ea449c82efec..68ff601749b4 100644 --- a/docs/reference/ml/anomaly-detection/apis/flush-job.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/flush-job.asciidoc @@ -36,7 +36,7 @@ opened again before analyzing further data. ``:: (Required, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] [[ml-flush-job-query-parms]] == {api-query-parms-title} diff --git a/docs/reference/ml/anomaly-detection/apis/forecast.asciidoc b/docs/reference/ml/anomaly-detection/apis/forecast.asciidoc index 80ee7c96b22a..3e6067ab0585 100644 --- a/docs/reference/ml/anomaly-detection/apis/forecast.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/forecast.asciidoc @@ -45,7 +45,7 @@ error occurs if you try to create a forecast for a job that has an ``:: (Required, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] [[ml-forecast-query-parms]] == {api-query-parms-title} diff --git a/docs/reference/ml/anomaly-detection/apis/get-bucket.asciidoc b/docs/reference/ml/anomaly-detection/apis/get-bucket.asciidoc index a234901be1c4..bca839d1db31 100644 --- a/docs/reference/ml/anomaly-detection/apis/get-bucket.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/get-bucket.asciidoc @@ -32,7 +32,7 @@ bucket. ``:: (Required, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] ``:: (Optional, string) The timestamp of a single bucket result. If you do not @@ -57,7 +57,7 @@ specific timestamps. `exclude_interim`:: (Optional, Boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=exclude-interim-results] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=exclude-interim-results] `expand`:: (Optional, Boolean) If true, the output includes anomaly records. Defaults to `false`. @@ -137,11 +137,11 @@ initial value that was calculated at the time the bucket was processed. `is_interim`::: (Boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=is-interim] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=is-interim] `job_id`::: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] `probability`::: (number) The probability that the bucket has this behavior, in the range 0 to 1. @@ -161,7 +161,7 @@ this. `bucket_span`:: (number) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=bucket-span-results] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=bucket-span-results] `event_count`:: (number) The number of input data records processed in this bucket. @@ -172,11 +172,11 @@ the initial value that was calculated at the time the bucket was processed. `is_interim`:: (Boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=is-interim] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=is-interim] `job_id`:: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] `processing_time_ms`:: (number) The amount of time, in milliseconds, that it took to analyze the diff --git a/docs/reference/ml/anomaly-detection/apis/get-calendar-event.asciidoc b/docs/reference/ml/anomaly-detection/apis/get-calendar-event.asciidoc index 803871ddea34..fc06e286bf46 100644 --- a/docs/reference/ml/anomaly-detection/apis/get-calendar-event.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/get-calendar-event.asciidoc @@ -31,7 +31,7 @@ For more information, see ``:: (Required, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=calendar-id] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=calendar-id] + You can get scheduled event information for multiple calendars in a single API request by using a comma-separated list of ids or a wildcard expression. @@ -89,7 +89,7 @@ following properties: `calendar_id`:: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=calendar-id] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=calendar-id] `description`:: (string) A description of the scheduled event. diff --git a/docs/reference/ml/anomaly-detection/apis/get-calendar.asciidoc b/docs/reference/ml/anomaly-detection/apis/get-calendar.asciidoc index ffa19b3b1093..b2c46bbe16c0 100644 --- a/docs/reference/ml/anomaly-detection/apis/get-calendar.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/get-calendar.asciidoc @@ -31,7 +31,7 @@ For more information, see ``:: (Required, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=calendar-id] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=calendar-id] + You can get information for multiple calendars in a single API request by using a comma-separated list of ids or a wildcard expression. You can get information @@ -76,7 +76,7 @@ properties: `calendar_id`:: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=calendar-id] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=calendar-id] `job_ids`:: (array) An array of {anomaly-job} identifiers. For example: diff --git a/docs/reference/ml/anomaly-detection/apis/get-category.asciidoc b/docs/reference/ml/anomaly-detection/apis/get-category.asciidoc index 034a598b7337..33de5e0f71a0 100644 --- a/docs/reference/ml/anomaly-detection/apis/get-category.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/get-category.asciidoc @@ -39,7 +39,7 @@ examine the description and examples of that category. For more information, see ``:: (Required, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] ``:: (Optional, long) Identifier for the category, which is unique in the job. If you @@ -104,7 +104,7 @@ manual tweaking. `job_id`:: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] `max_matching_length`:: (unsigned integer) The maximum length of the fields that matched the category. diff --git a/docs/reference/ml/anomaly-detection/apis/get-datafeed-stats.asciidoc b/docs/reference/ml/anomaly-detection/apis/get-datafeed-stats.asciidoc index bb4ead5a6fd4..a224f3880a1a 100644 --- a/docs/reference/ml/anomaly-detection/apis/get-datafeed-stats.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/get-datafeed-stats.asciidoc @@ -39,7 +39,7 @@ IMPORTANT: This API returns a maximum of 10,000 {dfeeds}. ``:: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=datafeed-id-wildcard] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=datafeed-id-wildcard] + You can get statistics for multiple {dfeeds} in a single API request by using a comma-separated list of {dfeeds} or a wildcard expression. You can get @@ -51,7 +51,7 @@ identifier, or by omitting the identifier. `allow_no_match`:: (Optional, Boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-no-match-datafeeds] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=allow-no-match-datafeeds] [role="child_attributes"] [[ml-get-datafeed-stats-results]] @@ -62,30 +62,30 @@ informational; you cannot update their values. `assignment_explanation`:: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=assignment-explanation-datafeeds] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=assignment-explanation-datafeeds] `datafeed_id`:: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=datafeed-id] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=datafeed-id] `node`:: (object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=node-datafeeds] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=node-datafeeds] + -- [%collapsible%open] ==== `attributes`::: (object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=node-attributes] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=node-attributes] `ephemeral_id`::: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=node-ephemeral-id] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=node-ephemeral-id] `id`::: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=node-id] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=node-id] `name`::: (string) @@ -93,7 +93,7 @@ The node name. For example, `0-o0tOo`. `transport_address`::: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=node-transport-address] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=node-transport-address] ==== -- @@ -130,7 +130,7 @@ The start time as an epoch in milliseconds. `state`:: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=state-datafeed] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=state-datafeed] `timing_stats`:: (object) An object that provides statistical information about timing aspect of @@ -141,24 +141,24 @@ this {dfeed}. ==== `average_search_time_per_bucket_ms`::: (double) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=search-bucket-avg] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=search-bucket-avg] `bucket_count`::: (long) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=bucket-count] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=bucket-count] `exponential_average_search_time_per_hour_ms`::: (double) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=search-exp-avg-hour] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=search-exp-avg-hour] `job_id`::: -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] `search_count`::: -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=search-count] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=search-count] `total_search_time_ms`::: -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=search-time] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=search-time] ==== -- diff --git a/docs/reference/ml/anomaly-detection/apis/get-datafeed.asciidoc b/docs/reference/ml/anomaly-detection/apis/get-datafeed.asciidoc index f3dd3b5f4da7..a986e2220f92 100644 --- a/docs/reference/ml/anomaly-detection/apis/get-datafeed.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/get-datafeed.asciidoc @@ -36,7 +36,7 @@ IMPORTANT: This API returns a maximum of 10,000 {dfeeds}. ``:: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=datafeed-id-wildcard] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=datafeed-id-wildcard] + You can get information for multiple {dfeeds} in a single API request by using a comma-separated list of {dfeeds} or a wildcard expression. You can get @@ -48,11 +48,11 @@ information for all {dfeeds} by using `_all`, by specifying `*` as the `allow_no_match`:: (Optional, Boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-no-match-datafeeds] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=allow-no-match-datafeeds] `exclude_generated`:: (Optional, Boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=exclude-generated] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=exclude-generated] [[ml-get-datafeed-results]] == {api-response-body-title} diff --git a/docs/reference/ml/anomaly-detection/apis/get-filter.asciidoc b/docs/reference/ml/anomaly-detection/apis/get-filter.asciidoc index 29e11172b9e0..f73dcd236f1a 100644 --- a/docs/reference/ml/anomaly-detection/apis/get-filter.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/get-filter.asciidoc @@ -31,7 +31,7 @@ You can get a single filter or all filters. For more information, see ``:: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=filter-id] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=filter-id] [[ml-get-filter-query-parms]] == {api-query-parms-title} @@ -54,7 +54,7 @@ properties: `filter_id`:: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=filter-id] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=filter-id] `items`:: (array of strings) An array of strings which is the filter item list. diff --git a/docs/reference/ml/anomaly-detection/apis/get-influencer.asciidoc b/docs/reference/ml/anomaly-detection/apis/get-influencer.asciidoc index 76ead2921df6..31489e361a84 100644 --- a/docs/reference/ml/anomaly-detection/apis/get-influencer.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/get-influencer.asciidoc @@ -30,7 +30,7 @@ the anomalies. Influencer results are available only if an ``:: (Required, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] [[ml-get-influencer-query-parms]] @@ -38,7 +38,7 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] `desc`:: (Optional, Boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=desc-results] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=desc-results] `end`:: (Optional, string) Returns influencers with timestamps earlier than this time. @@ -47,7 +47,7 @@ specific timestamps. `exclude_interim`:: (Optional, Boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=exclude-interim-results] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=exclude-interim-results] `from`:: (Optional, integer) @@ -99,7 +99,7 @@ properties: `bucket_span`:: (number) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=bucket-span-results] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=bucket-span-results] `influencer_score`:: (number) A normalized score between 0-100, which is based on the probability of @@ -121,11 +121,11 @@ calculated at the time the bucket was processed. `is_interim`:: (Boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=is-interim] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=is-interim] `job_id`:: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] `probability`:: (number) The probability that the influencer has this behavior, in the range 0 @@ -138,7 +138,7 @@ human-readable and friendly interpretation of this. `timestamp`:: (date) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=timestamp-results] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=timestamp-results] NOTE: Additional influencer properties are added, depending on the fields being analyzed. For example, if it's analyzing `user_name` as an influencer, then a diff --git a/docs/reference/ml/anomaly-detection/apis/get-job-model-snapshot-upgrade-stats.asciidoc b/docs/reference/ml/anomaly-detection/apis/get-job-model-snapshot-upgrade-stats.asciidoc index e1354648e385..0939282a7591 100644 --- a/docs/reference/ml/anomaly-detection/apis/get-job-model-snapshot-upgrade-stats.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/get-job-model-snapshot-upgrade-stats.asciidoc @@ -36,7 +36,7 @@ returned. ``:: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection-wildcard] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection-wildcard] ``:: (string) @@ -51,7 +51,7 @@ use wildcard expressions or `_all`. `allow_no_match`:: (Optional, Boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-no-match-jobs] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=allow-no-match-jobs] [role="child_attributes"] [[ml-get-job-model-snapshot-upgrade-stats-results]] @@ -62,11 +62,11 @@ All of these properties are informational; you cannot update their values. `assignment_explanation`:: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=assignment-explanation-datafeeds] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=assignment-explanation-datafeeds] `job_id`:: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] `node`:: (object) @@ -78,15 +78,15 @@ available only for upgrade tasks that are assigned to a node. ==== `attributes`::: (object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=node-attributes] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=node-attributes] `ephemeral_id`::: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=node-ephemeral-id] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=node-ephemeral-id] `id`::: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=node-id] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=node-id] `name`::: (string) @@ -94,13 +94,13 @@ The node name. For example, `0-o0tOo`. `transport_address`::: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=node-transport-address] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=node-transport-address] ==== -- `snapshot_id`:: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=model-snapshot-id] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=model-snapshot-id] `state`:: (string) diff --git a/docs/reference/ml/anomaly-detection/apis/get-job-stats.asciidoc b/docs/reference/ml/anomaly-detection/apis/get-job-stats.asciidoc index 4c1fbfe2da3d..a5bd188397bb 100644 --- a/docs/reference/ml/anomaly-detection/apis/get-job-stats.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/get-job-stats.asciidoc @@ -46,7 +46,7 @@ omitting the identifier. `allow_no_match`:: (Optional, Boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-no-match-jobs] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=allow-no-match-jobs] [role="child_attributes"] [[ml-get-job-stats-results]] @@ -57,7 +57,7 @@ job: `assignment_explanation`:: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=assignment-explanation-anomaly-jobs] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=assignment-explanation-anomaly-jobs] //Begin data_counts [[datacounts]]`data_counts`:: @@ -71,75 +71,75 @@ counts are not reset. ==== `bucket_count`::: (long) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=bucket-count-anomaly-jobs] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=bucket-count-anomaly-jobs] `earliest_record_timestamp`::: (date) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=earliest-record-timestamp] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=earliest-record-timestamp] `empty_bucket_count`::: (long) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=empty-bucket-count] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=empty-bucket-count] `input_bytes`::: (long) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=input-bytes] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=input-bytes] `input_field_count`::: (long) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=input-field-count] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=input-field-count] `input_record_count`::: (long) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=input-record-count] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=input-record-count] `invalid_date_count`::: (long) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=invalid-date-count] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=invalid-date-count] `job_id`::: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] `last_data_time`::: (date) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=last-data-time] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=last-data-time] `latest_empty_bucket_timestamp`::: (date) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=latest-empty-bucket-timestamp] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=latest-empty-bucket-timestamp] `latest_record_timestamp`::: (date) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=latest-record-timestamp] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=latest-record-timestamp] `latest_sparse_bucket_timestamp`::: (date) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=latest-sparse-record-timestamp] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=latest-sparse-record-timestamp] `log_time`::: (date) The timestamp of the `data_counts` according to server time. `missing_field_count`::: (long) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=missing-field-count] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=missing-field-count] + The value of `processed_record_count` includes this count. `out_of_order_timestamp_count`::: (long) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=out-of-order-timestamp-count] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=out-of-order-timestamp-count] `processed_field_count`::: -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=processed-field-count] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=processed-field-count] `processed_record_count`::: (long) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=processed-record-count] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=processed-record-count] `sparse_bucket_count`::: (long) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=sparse-bucket-count] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=sparse-bucket-count] ==== //End data_counts @@ -183,13 +183,13 @@ forecasts related to this job. If there are no forecasts, this property is omitt `total`::: (long) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=forecast-total] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=forecast-total] ==== //End forecasts_stats `job_id`:: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] //Begin model_size_stats [[modelsizestats]]`model_size_stats`:: @@ -201,85 +201,85 @@ model. ==== `assignment_memory_basis`::: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=assignment-memory-basis] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=assignment-memory-basis] `bucket_allocation_failures_count`::: (long) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=bucket-allocation-failures-count] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=bucket-allocation-failures-count] `categorized_doc_count`::: (long) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=categorized-doc-count] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=categorized-doc-count] `categorization_status`::: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=categorization-status] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=categorization-status] `dead_category_count`::: (long) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=dead-category-count] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=dead-category-count] `failed_category_count`::: (long) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=failed-category-count] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=failed-category-count] `frequent_category_count`::: (long) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=frequent-category-count] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=frequent-category-count] `job_id`::: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] `log_time`::: (date) The timestamp of the `model_size_stats` according to server time. `memory_status`::: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=model-memory-status] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=model-memory-status] `model_bytes`::: (long) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=model-bytes] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=model-bytes] `model_bytes_exceeded`::: (long) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=model-bytes-exceeded] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=model-bytes-exceeded] `model_bytes_memory_limit`::: (long) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=model-memory-limit-anomaly-jobs] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=model-memory-limit-anomaly-jobs] `peak_model_bytes`::: (long) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=peak-model-bytes] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=peak-model-bytes] `rare_category_count`::: (long) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=rare-category-count] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=rare-category-count] `result_type`::: (string) For internal use. The type of result. `total_by_field_count`::: (long) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=total-by-field-count] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=total-by-field-count] `total_category_count`::: (long) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=total-category-count] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=total-category-count] `total_over_field_count`::: (long) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=total-over-field-count] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=total-over-field-count] `total_partition_field_count`::: (long) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=total-partition-field-count] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=total-partition-field-count] `timestamp`::: (date) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=model-timestamp] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=model-timestamp] ==== //End model_size_stats @@ -293,32 +293,32 @@ available only for open jobs. ==== `attributes`::: (object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=node-attributes] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=node-attributes] `ephemeral_id`::: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=node-ephemeral-id] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=node-ephemeral-id] `id`::: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=node-id] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=node-id] `name`::: (string) The node name. `transport_address`::: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=node-transport-address] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=node-transport-address] ==== //End node `open_time`:: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=open-time] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=open-time] `state`:: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=state-anomaly-job] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=state-anomaly-job] //Begin timing_stats [[timingstats]]`timing_stats`:: @@ -333,31 +333,31 @@ this job. `bucket_count`::: (long) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=bucket-count] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=bucket-count] `exponential_average_bucket_processing_time_ms`::: (double) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=bucket-time-exponential-average] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=bucket-time-exponential-average] `exponential_average_bucket_processing_time_per_hour_ms`::: (double) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=bucket-time-exponential-average-hour] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=bucket-time-exponential-average-hour] `job_id`::: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] `maximum_bucket_processing_time_ms`::: (double) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=bucket-time-maximum] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=bucket-time-maximum] `minimum_bucket_processing_time_ms`::: (double) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=bucket-time-minimum] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=bucket-time-minimum] `total_bucket_processing_time_ms`::: (double) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=bucket-time-total] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=bucket-time-total] ==== //End timing_stats diff --git a/docs/reference/ml/anomaly-detection/apis/get-job.asciidoc b/docs/reference/ml/anomaly-detection/apis/get-job.asciidoc index ac8746d761e0..4ee6c429ce73 100644 --- a/docs/reference/ml/anomaly-detection/apis/get-job.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/get-job.asciidoc @@ -46,11 +46,11 @@ omitting the identifier. `allow_no_match`:: (Optional, Boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-no-match-jobs] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=allow-no-match-jobs] `exclude_generated`:: (Optional, Boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=exclude-generated] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=exclude-generated] [role="child_attributes"] [[ml-get-job-results]] @@ -121,83 +121,83 @@ the account name is listed in the response. `datafeed_id`::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=datafeed-id] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=datafeed-id] `aggregations`::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=aggregations] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=aggregations] `chunking_config`::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=chunking-config] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=chunking-config] + .Properties of `chunking_config` [%collapsible%open] ===== `mode`::: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=mode] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=mode] `time_span`::: (<>) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=time-span] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=time-span] ===== `delayed_data_check_config`::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=delayed-data-check-config] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=delayed-data-check-config] + .Properties of `delayed_data_check_config` [%collapsible%open] ===== `check_window`:: (<>) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=delayed-data-check-config-check-window] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=delayed-data-check-config-check-window] `enabled`:: (Boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=delayed-data-check-config-enabled] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=delayed-data-check-config-enabled] ===== `frequency`::: (Optional, <>) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=frequency] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=frequency] `indices`::: (Required, array) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=indices] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=indices] `indices_options`::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=indices-options] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=indices-options] `job_id`::: (Required, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] `max_empty_searches`::: (Optional,integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=max-empty-searches] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=max-empty-searches] `query`::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=query] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=query] `query_delay`::: (Optional, <>) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=query-delay] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=query-delay] `runtime_mappings`::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=runtime-mappings] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=runtime-mappings] `script_fields`::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=script-fields] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=script-fields] `scroll_size`::: (Optional, unsigned integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=scroll-size] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=scroll-size] ==== `finished_time`:: @@ -218,7 +218,7 @@ independently. The `job_version` value represents the new version number. `model_snapshot_id`:: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=model-snapshot-id] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=model-snapshot-id] [[ml-get-job-response-codes]] == {api-response-codes-title} diff --git a/docs/reference/ml/anomaly-detection/apis/get-overall-buckets.asciidoc b/docs/reference/ml/anomaly-detection/apis/get-overall-buckets.asciidoc index cf8546d78fe6..b581b5c3a2eb 100644 --- a/docs/reference/ml/anomaly-detection/apis/get-overall-buckets.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/get-overall-buckets.asciidoc @@ -49,7 +49,7 @@ a span equal to the jobs' largest bucket span. ``:: (Required, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection-wildcard-list] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection-wildcard-list] + You can summarize the bucket results for all {anomaly-jobs} by using `_all` or by specifying `*` as the job identifier. @@ -59,7 +59,7 @@ by specifying `*` as the job identifier. `allow_no_match`:: (Optional, Boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-no-match-jobs] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=allow-no-match-jobs] `bucket_span`:: (Optional, string) The span of the overall buckets. Must be greater or equal to @@ -108,7 +108,7 @@ of the job with the longest one. `is_interim`:: (Boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=is-interim] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=is-interim] `jobs`:: (array) An array of objects that contain the `max_anomaly_score` per `job_id`. @@ -121,7 +121,7 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=is-interim] `timestamp`:: (date) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=timestamp-results] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=timestamp-results] [[ml-get-overall-buckets-example]] == {api-examples-title} diff --git a/docs/reference/ml/anomaly-detection/apis/get-record.asciidoc b/docs/reference/ml/anomaly-detection/apis/get-record.asciidoc index 686632366315..e74ab3ecb4b1 100644 --- a/docs/reference/ml/anomaly-detection/apis/get-record.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/get-record.asciidoc @@ -39,14 +39,14 @@ of detectors. ``:: (Required, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] [[ml-get-record-query-parms]] == {api-query-parms-title} `desc`:: (Optional, Boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=desc-results] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=desc-results] `end`:: (Optional, string) Returns records with timestamps earlier than this time. @@ -55,7 +55,7 @@ specific timestamps. `exclude_interim`:: (Optional, Boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=exclude-interim-results] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=exclude-interim-results] `from`:: (Optional, integer) Skips the specified number of records. Defaults to `0`. @@ -158,11 +158,11 @@ current bucket. `bucket_span`:: (number) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=bucket-span-results] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=bucket-span-results] `by_field_name`:: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=by-field-name] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=by-field-name] `by_field_value`:: (string) The value of `by_field_name`. @@ -220,11 +220,11 @@ at the time the bucket was processed. `is_interim`:: (Boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=is-interim] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=is-interim] `job_id`:: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] `multi_bucket_impact`:: (number) An indication of how strongly an anomaly is multi bucket or single @@ -234,14 +234,14 @@ bucket. `over_field_name`:: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=over-field-name] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=over-field-name] `over_field_value`:: (string) The value of `over_field_name`. `partition_field_name`:: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=partition-field-name] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=partition-field-name] `partition_field_value`:: (string) The value of `partition_field_name`. @@ -262,7 +262,7 @@ be updated by a re-normalization process as new data is analyzed. `timestamp`:: (date) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=timestamp-results] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=timestamp-results] `typical`:: (array) The typical value for the bucket, according to analytical modeling. diff --git a/docs/reference/ml/anomaly-detection/apis/get-snapshot.asciidoc b/docs/reference/ml/anomaly-detection/apis/get-snapshot.asciidoc index 0132f57d412e..d94bd4060854 100644 --- a/docs/reference/ml/anomaly-detection/apis/get-snapshot.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/get-snapshot.asciidoc @@ -26,11 +26,11 @@ Requires the `monitor_ml` cluster privilege. This privilege is included in the ``:: (Required, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] ``:: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=snapshot-id] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=snapshot-id] + -- You can get information for multiple snapshots by using a comma-separated list @@ -122,7 +122,7 @@ independently. The `min_version` value represents the new version number. ==== `assignment_memory_basis`::: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=assignment-memory-basis] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=assignment-memory-basis] `bucket_allocation_failures_count`::: (long) The number of buckets for which entities were not processed due to memory @@ -155,7 +155,7 @@ side effect of the way categorization has no prior training.) `failed_category_count`::: (long) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=failed-category-count] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=failed-category-count] `frequent_category_count`::: (long) The number of categories that match more than 1% of categorized @@ -163,7 +163,7 @@ documents. `job_id`::: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] `log_time`::: (date) The timestamp that the `model_size_stats` were recorded, according to @@ -223,7 +223,7 @@ separately for each detector and partition. `retain`:: (Boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=retain] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=retain] `snapshot_id`:: (string) A numerical character string that uniquely identifies the model diff --git a/docs/reference/ml/anomaly-detection/apis/open-job.asciidoc b/docs/reference/ml/anomaly-detection/apis/open-job.asciidoc index 92d8908baab4..385f672f467f 100644 --- a/docs/reference/ml/anomaly-detection/apis/open-job.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/open-job.asciidoc @@ -36,7 +36,7 @@ data is received. ``:: (Required, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] [[ml-open-job-query-parms]] == {api-query-parms-title} diff --git a/docs/reference/ml/anomaly-detection/apis/post-data.asciidoc b/docs/reference/ml/anomaly-detection/apis/post-data.asciidoc index e5b8a30055f9..931efcf8c2a5 100644 --- a/docs/reference/ml/anomaly-detection/apis/post-data.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/post-data.asciidoc @@ -52,7 +52,7 @@ or a comma-separated list. ``:: (Required, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] [[ml-post-data-query-parms]] == {api-query-parms-title} diff --git a/docs/reference/ml/anomaly-detection/apis/preview-datafeed.asciidoc b/docs/reference/ml/anomaly-detection/apis/preview-datafeed.asciidoc index c838af78871d..243cd2a5f32a 100644 --- a/docs/reference/ml/anomaly-detection/apis/preview-datafeed.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/preview-datafeed.asciidoc @@ -52,7 +52,7 @@ supply the credentials. ``:: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=datafeed-id] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=datafeed-id] + NOTE: If you provide the `` as a path parameter, you cannot provide {dfeed} or {anomaly-job} configuration details in the request body. diff --git a/docs/reference/ml/anomaly-detection/apis/put-calendar-job.asciidoc b/docs/reference/ml/anomaly-detection/apis/put-calendar-job.asciidoc index 2483f24f6afd..0c19a08cbd74 100644 --- a/docs/reference/ml/anomaly-detection/apis/put-calendar-job.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/put-calendar-job.asciidoc @@ -23,11 +23,11 @@ Requires the `manage_ml` cluster privilege. This privilege is included in the ``:: (Required, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=calendar-id] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=calendar-id] ``:: (Required, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection-list] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection-list] [[ml-put-calendar-job-example]] == {api-examples-title} diff --git a/docs/reference/ml/anomaly-detection/apis/put-calendar.asciidoc b/docs/reference/ml/anomaly-detection/apis/put-calendar.asciidoc index 8ddaea995c71..fd2b58a31737 100644 --- a/docs/reference/ml/anomaly-detection/apis/put-calendar.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/put-calendar.asciidoc @@ -29,7 +29,7 @@ For more information, see ``:: (Required, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=calendar-id] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=calendar-id] [[ml-put-calendar-request-body]] == {api-request-body-title} diff --git a/docs/reference/ml/anomaly-detection/apis/put-datafeed.asciidoc b/docs/reference/ml/anomaly-detection/apis/put-datafeed.asciidoc index 478a70e23b93..47e3059666d7 100644 --- a/docs/reference/ml/anomaly-detection/apis/put-datafeed.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/put-datafeed.asciidoc @@ -52,7 +52,7 @@ credentials are used instead. ``:: (Required, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=datafeed-id] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=datafeed-id] [[ml-put-datafeed-query-params]] == {api-query-parms-title} @@ -62,11 +62,11 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=datafeed-id] concrete indices are ignored. This includes the `_all` string or when no indices are specified. Defaults to `true`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + Defaults to `open`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=ignore_throttled] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=ignore_throttled] `ignore_unavailable`:: (Optional, Boolean) If `true`, unavailable indices (missing or closed) are @@ -79,79 +79,79 @@ ignored. Defaults to `false`. `aggregations`:: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=aggregations] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=aggregations] `chunking_config`:: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=chunking-config] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=chunking-config] + .Properties of `chunking_config` [%collapsible%open] ==== `mode`::: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=mode] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=mode] `time_span`::: (<>) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=time-span] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=time-span] ==== `delayed_data_check_config`:: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=delayed-data-check-config] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=delayed-data-check-config] + .Properties of `delayed_data_check_config` [%collapsible%open] ==== `check_window`:: (<>) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=delayed-data-check-config-check-window] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=delayed-data-check-config-check-window] `enabled`:: (Boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=delayed-data-check-config-enabled] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=delayed-data-check-config-enabled] ==== `frequency`:: (Optional, <>) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=frequency] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=frequency] `indices`:: (Required, array) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=indices] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=indices] `indices_options`:: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=indices-options] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=indices-options] `job_id`:: (Required, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] `max_empty_searches`:: (Optional,integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=max-empty-searches] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=max-empty-searches] `query`:: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=query] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=query] `query_delay`:: (Optional, <>) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=query-delay] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=query-delay] `runtime_mappings`:: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=runtime-mappings] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=runtime-mappings] `script_fields`:: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=script-fields] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=script-fields] `scroll_size`:: (Optional, unsigned integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=scroll-size] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=scroll-size] [[ml-put-datafeed-example]] == {api-examples-title} diff --git a/docs/reference/ml/anomaly-detection/apis/put-filter.asciidoc b/docs/reference/ml/anomaly-detection/apis/put-filter.asciidoc index 4e0d2ed1fabc..b50ba8cb1e23 100644 --- a/docs/reference/ml/anomaly-detection/apis/put-filter.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/put-filter.asciidoc @@ -31,7 +31,7 @@ configuration objects. For more information, see ``:: (Required, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=filter-id] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=filter-id] [[ml-put-filter-request-body]] == {api-request-body-title} diff --git a/docs/reference/ml/anomaly-detection/apis/put-job.asciidoc b/docs/reference/ml/anomaly-detection/apis/put-job.asciidoc index e4e10e2ae2fc..012904a9affa 100644 --- a/docs/reference/ml/anomaly-detection/apis/put-job.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/put-job.asciidoc @@ -42,7 +42,7 @@ credentials are used instead. ``:: (Required, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection-define] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection-define] [role="child_attributes"] [[ml-put-job-request-body]] @@ -50,31 +50,31 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection-define `allow_lazy_open`:: (Optional, Boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-lazy-open] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=allow-lazy-open] //Begin analysis_config [[put-analysisconfig]]`analysis_config`:: (Required, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=analysis-config] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=analysis-config] + .Properties of `analysis_config` [%collapsible%open] ==== `bucket_span`::: (<>) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=bucket-span] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=bucket-span] `categorization_analyzer`::: (object or string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=categorization-analyzer] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=categorization-analyzer] `categorization_field_name`::: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=categorization-field-name] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=categorization-field-name] `categorization_filters`::: (array of strings) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=categorization-filters] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=categorization-filters] //Begin analysis_config.detectors `detectors`::: @@ -90,12 +90,12 @@ no analysis can occur and an error is returned. ===== `by_field_name`:::: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=by-field-name] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=by-field-name] //Begin analysis_config.detectors.custom_rules [[put-customrules]]`custom_rules`:::: (array) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=custom-rules] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=custom-rules] + .Properties of `custom_rules` [%collapsible%open] @@ -103,45 +103,45 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=custom-rules] `actions`::: (array) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=custom-rules-actions] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=custom-rules-actions] //Begin analysis_config.detectors.custom_rules.conditions `conditions`::: (array) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=custom-rules-conditions] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=custom-rules-conditions] + .Properties of `conditions` [%collapsible%open] ======= `applies_to`:::: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=custom-rules-conditions-applies-to] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=custom-rules-conditions-applies-to] `operator`:::: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=custom-rules-conditions-operator] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=custom-rules-conditions-operator] `value`:::: (double) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=custom-rules-conditions-value] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=custom-rules-conditions-value] ======= //End analysis_config.detectors.custom_rules.conditions //Begin analysis_config.detectors.custom_rules.scope `scope`::: (object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=custom-rules-scope] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=custom-rules-scope] + .Properties of `scope` [%collapsible%open] ======= `filter_id`:::: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=custom-rules-scope-filter-id] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=custom-rules-scope-filter-id] `filter_type`:::: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=custom-rules-scope-filter-type] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=custom-rules-scope-filter-type] ======= //End analysis_config.detectors.custom_rules.scope ====== @@ -149,114 +149,114 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=custom-rules-scope-filter-type] `detector_description`:::: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=detector-description] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=detector-description] `detector_index`:::: (integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=detector-index] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=detector-index] + If you specify a value for this property, it is ignored. `exclude_frequent`:::: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=exclude-frequent] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=exclude-frequent] `field_name`:::: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=detector-field-name] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=detector-field-name] `function`:::: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=function] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=function] `over_field_name`:::: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=over-field-name] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=over-field-name] `partition_field_name`:::: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=partition-field-name] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=partition-field-name] `use_null`:::: (Boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=use-null] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=use-null] ===== //End analysis_config.detectors `influencers`::: (array of strings) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=influencers] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=influencers] `latency`::: (time units) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=latency] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=latency] `model_prune_window`::: (Optional, <>) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=model-prune-window] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=model-prune-window] `multivariate_by_fields`::: (Boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=multivariate-by-fields] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=multivariate-by-fields] //Begin analysis_config.per_partition_categorization `per_partition_categorization`::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=per-partition-categorization] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=per-partition-categorization] + .Properties of `per_partition_categorization` [%collapsible%open] ===== `enabled`:::: (Boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=per-partition-categorization-enabled] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=per-partition-categorization-enabled] `stop_on_warn`:::: (Boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=per-partition-categorization-stop-on-warn] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=per-partition-categorization-stop-on-warn] ===== //End analysis_config.per_partition_categorization `summary_count_field_name`::: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=summary-count-field-name] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=summary-count-field-name] ==== //End analysis_config //Begin analysis_limits [[put-analysislimits]]`analysis_limits`:: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=analysis-limits] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=analysis-limits] + .Properties of `analysis_limits` [%collapsible%open] ==== `categorization_examples_limit`::: (long) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=categorization-examples-limit] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=categorization-examples-limit] `model_memory_limit`::: (long or string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=model-memory-limit-ad] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=model-memory-limit-ad] ==== //End analysis_limits `background_persist_interval`:: (Optional, <>) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=background-persist-interval] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=background-persist-interval] [[put-customsettings]]`custom_settings`:: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=custom-settings] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=custom-settings] [[put-dailymodelsnapshotretentionafterdays]]`daily_model_snapshot_retention_after_days`:: (Optional, long) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=daily-model-snapshot-retention-after-days] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=daily-model-snapshot-retention-after-days] //Begin data_description [[put-datadescription]]`data_description`:: (Required, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=data-description] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=data-description] //End data_description [[put-datafeedconfig]]`datafeed_config`:: @@ -269,81 +269,81 @@ from {es} for analysis by the job. You can associate only one {dfeed} with each ==== `aggregations`::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=aggregations] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=aggregations] `chunking_config`::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=chunking-config] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=chunking-config] + .Properties of `chunking_config` [%collapsible%open] ===== `mode`::: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=mode] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=mode] `time_span`::: (<>) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=time-span] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=time-span] ===== `datafeed_id`::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=datafeed-id] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=datafeed-id] + Defaults to the same ID as the {anomaly-job}. `delayed_data_check_config`::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=delayed-data-check-config] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=delayed-data-check-config] + .Properties of `delayed_data_check_config` [%collapsible%open] ===== `check_window`:: (<>) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=delayed-data-check-config-check-window] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=delayed-data-check-config-check-window] `enabled`:: (Boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=delayed-data-check-config-enabled] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=delayed-data-check-config-enabled] ===== `frequency`::: (Optional, <>) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=frequency] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=frequency] `indices`::: (Required, array) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=indices] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=indices] `indices_options`::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=indices-options] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=indices-options] `max_empty_searches`::: (Optional,integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=max-empty-searches] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=max-empty-searches] `query`::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=query] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=query] `query_delay`::: (Optional, <>) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=query-delay] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=query-delay] `runtime_mappings`::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=runtime-mappings] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=runtime-mappings] `script_fields`::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=script-fields] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=script-fields] `scroll_size`::: (Optional, unsigned integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=scroll-size] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=scroll-size] ==== `description`:: @@ -351,45 +351,45 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=scroll-size] `groups`:: (Optional, array of strings) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=groups] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=groups] //Begin model_plot_config `model_plot_config`:: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=model-plot-config] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=model-plot-config] + .Properties of `model_plot_config` [%collapsible%open] ==== `annotations_enabled`::: (Boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=model-plot-config-annotations-enabled] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=model-plot-config-annotations-enabled] `enabled`::: (Boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=model-plot-config-enabled] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=model-plot-config-enabled] `terms`::: experimental[] (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=model-plot-config-terms] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=model-plot-config-terms] ==== //End model_plot_config [[put-modelsnapshotretentiondays]]`model_snapshot_retention_days`:: (Optional, long) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=model-snapshot-retention-days] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=model-snapshot-retention-days] [[put-renormalizationwindowdays]]`renormalization_window_days`:: (Optional, long) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=renormalization-window-days] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=renormalization-window-days] [[put-resultsindexname]]`results_index_name`:: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=results-index-name] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=results-index-name] [[put-resultsretentiondays]]`results_retention_days`:: (Optional, long) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=results-retention-days] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=results-retention-days] [[ml-put-job-example]] == {api-examples-title} diff --git a/docs/reference/ml/anomaly-detection/apis/reset-job.asciidoc b/docs/reference/ml/anomaly-detection/apis/reset-job.asciidoc index 4076e4a8038e..9009d634a2e9 100644 --- a/docs/reference/ml/anomaly-detection/apis/reset-job.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/reset-job.asciidoc @@ -35,7 +35,7 @@ separated list. ``:: (Required, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] [[ml-reset-job-query-parms]] == {api-query-parms-title} diff --git a/docs/reference/ml/anomaly-detection/apis/revert-snapshot.asciidoc b/docs/reference/ml/anomaly-detection/apis/revert-snapshot.asciidoc index 4b3a61133dfb..c8d7a27ee204 100644 --- a/docs/reference/ml/anomaly-detection/apis/revert-snapshot.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/revert-snapshot.asciidoc @@ -39,11 +39,11 @@ NOTE: Reverting to a snapshot does not change the `data_counts` values of the ``:: (Required, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] ``:: (Required, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=snapshot-id] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=snapshot-id] + -- You can specify `empty` as the . Reverting to the `empty` snapshot diff --git a/docs/reference/ml/anomaly-detection/apis/start-datafeed.asciidoc b/docs/reference/ml/anomaly-detection/apis/start-datafeed.asciidoc index 6d958383f337..b54c80133d7d 100644 --- a/docs/reference/ml/anomaly-detection/apis/start-datafeed.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/start-datafeed.asciidoc @@ -43,7 +43,7 @@ you created or updated the {dfeed}, those credentials are used instead. ``:: (Required, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=datafeed-id] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=datafeed-id] [[ml-start-datafeed-query-parms]] == {api-query-parms-title} diff --git a/docs/reference/ml/anomaly-detection/apis/stop-datafeed.asciidoc b/docs/reference/ml/anomaly-detection/apis/stop-datafeed.asciidoc index eb50e0a154a5..bc15a1de8a05 100644 --- a/docs/reference/ml/anomaly-detection/apis/stop-datafeed.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/stop-datafeed.asciidoc @@ -45,7 +45,7 @@ identifier. `allow_no_match`:: (Optional, Boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-no-match-datafeeds] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=allow-no-match-datafeeds] `force`:: (Optional, Boolean) If true, the {dfeed} is stopped forcefully. diff --git a/docs/reference/ml/anomaly-detection/apis/update-datafeed.asciidoc b/docs/reference/ml/anomaly-detection/apis/update-datafeed.asciidoc index 5e6121cd01ac..b3920d9d4f80 100644 --- a/docs/reference/ml/anomaly-detection/apis/update-datafeed.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/update-datafeed.asciidoc @@ -40,7 +40,7 @@ credentials are used instead. ``:: (Required, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=datafeed-id] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=datafeed-id] [[ml-update-datafeed-query-params]] == {api-query-parms-title} @@ -50,11 +50,11 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=datafeed-id] concrete indices are ignored. This includes the `_all` string or when no indices are specified. Defaults to `true`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + Defaults to `open`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=ignore_throttled] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=ignore_throttled] `ignore_unavailable`:: (Optional, Boolean) If `true`, unavailable indices (missing or closed) are @@ -68,55 +68,55 @@ The following properties can be updated after the {dfeed} is created: `aggregations`:: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=aggregations] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=aggregations] `chunking_config`:: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=chunking-config] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=chunking-config] + .Properties of `chunking_config` [%collapsible%open] ==== `mode`::: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=mode] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=mode] `time_span`::: (<>) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=time-span] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=time-span] ==== `delayed_data_check_config`:: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=delayed-data-check-config] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=delayed-data-check-config] + .Properties of `delayed_data_check_config` [%collapsible%open] ==== `check_window`:: (<>) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=delayed-data-check-config-check-window] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=delayed-data-check-config-check-window] `enabled`:: (Boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=delayed-data-check-config-enabled] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=delayed-data-check-config-enabled] ==== `frequency`:: (Optional, <>) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=frequency] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=frequency] `indices`:: (Optional, array) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=indices] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=indices] `indices_options`:: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=indices-options] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=indices-options] `max_empty_searches`:: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=max-empty-searches] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=max-empty-searches] + -- The special value `-1` unsets this setting. @@ -124,7 +124,7 @@ The special value `-1` unsets this setting. `query`:: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=query] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=query] + -- WARNING: If you change the query, the analyzed data is also changed. Therefore, @@ -138,19 +138,19 @@ the results of the other job. `query_delay`:: (Optional, <>) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=query-delay] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=query-delay] `runtime_mappings`:: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=runtime-mappings] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=runtime-mappings] `script_fields`:: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=script-fields] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=script-fields] `scroll_size`:: (Optional, unsigned integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=scroll-size] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=scroll-size] [[ml-update-datafeed-example]] diff --git a/docs/reference/ml/anomaly-detection/apis/update-filter.asciidoc b/docs/reference/ml/anomaly-detection/apis/update-filter.asciidoc index 46e853e08265..a4221c37a438 100644 --- a/docs/reference/ml/anomaly-detection/apis/update-filter.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/update-filter.asciidoc @@ -23,7 +23,7 @@ Requires the `manage_ml` cluster privilege. This privilege is included in the ``:: (Required, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=filter-id] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=filter-id] [[ml-update-filter-request-body]] == {api-request-body-title} diff --git a/docs/reference/ml/anomaly-detection/apis/update-job.asciidoc b/docs/reference/ml/anomaly-detection/apis/update-job.asciidoc index fd645fe0d9bf..6953235c854c 100644 --- a/docs/reference/ml/anomaly-detection/apis/update-job.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/update-job.asciidoc @@ -23,7 +23,7 @@ Requires the `manage_ml` cluster privilege. This privilege is included in the ``:: (Required, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] [role="child_attributes"] [[ml-update-job-request-body]] @@ -33,7 +33,7 @@ The following properties can be updated after the job is created: `allow_lazy_open`:: (Boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-lazy-open] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=allow-lazy-open] + -- NOTE: If the job is open when you make the update, you must stop the {dfeed}, @@ -43,7 +43,7 @@ close the job, then reopen the job and restart the {dfeed} for the changes to ta //Begin analysis_limits [[update-analysislimits]]`analysis_limits`:: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=analysis-limits] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=analysis-limits] + You can update the `analysis_limits` only while the job is closed. + @@ -52,7 +52,7 @@ You can update the `analysis_limits` only while the job is closed. ==== `model_memory_limit`::: (long or string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=model-memory-limit-ad] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=model-memory-limit-ad] + -- [NOTE] @@ -71,7 +71,7 @@ to re-run the job with an increased `model_memory_limit`. `background_persist_interval`:: (<>) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=background-persist-interval] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=background-persist-interval] + -- NOTE: If the job is open when you make the update, you must stop the {dfeed}, @@ -81,11 +81,11 @@ close the job, then reopen the job and restart the {dfeed} for the changes to ta [[update-customsettings]]`custom_settings`:: (object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=custom-settings] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=custom-settings] `daily_model_snapshot_retention_after_days`:: (long) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=daily-model-snapshot-retention-after-days] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=daily-model-snapshot-retention-after-days] `description`:: (string) A description of the job. @@ -101,7 +101,7 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=daily-model-snapshot-retention- //Begin detectors.custom_rules `custom_rules`::: (array) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=custom-rules] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=custom-rules] + .Properties of `custom_rules` [%collapsible%open] @@ -109,12 +109,12 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=custom-rules] `actions`::: (array) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=custom-rules-actions] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=custom-rules-actions] // Begin detectors.custom_rules.conditions `conditions`::: (array) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=custom-rules-conditions] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=custom-rules-conditions] + .Properties of `conditions` [%collapsible%open] @@ -122,33 +122,33 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=custom-rules-conditions] `applies_to`:::: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=custom-rules-conditions-applies-to] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=custom-rules-conditions-applies-to] `operator`:::: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=custom-rules-conditions-operator] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=custom-rules-conditions-operator] `value`:::: (double) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=custom-rules-conditions-value] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=custom-rules-conditions-value] ====== //End detectors.custom_rules.conditions //Begin detectors.custom_rules.scope `scope`::: (object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=custom-rules-scope] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=custom-rules-scope] + .Properties of `scope` [%collapsible%open] ====== `filter_id`:::: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=custom-rules-scope-filter-id] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=custom-rules-scope-filter-id] `filter_type`:::: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=custom-rules-scope-filter-type] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=custom-rules-scope-filter-type] ====== //End detectors.custom_rules.scope ===== @@ -156,11 +156,11 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=custom-rules-scope-filter-type] `description`::: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=detector-description] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=detector-description] `detector_index`::: (integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=detector-index] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=detector-index] + -- If you want to update a specific detector, you must use this identifier. You @@ -171,59 +171,59 @@ cannot, however, change the `detector_index` value for a detector. `groups`:: (array of strings) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=groups] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=groups] //Begin model_plot_config `model_plot_config`:: (object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=model-plot-config] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=model-plot-config] + .Properties of `model_plot_config` [%collapsible%open] ==== `annotations_enabled`::: (Boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=model-plot-config-annotations-enabled] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=model-plot-config-annotations-enabled] `enabled`::: (Boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=model-plot-config-enabled] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=model-plot-config-enabled] `terms`::: experimental[] (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=model-plot-config-terms] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=model-plot-config-terms] ==== //End model_plot_config `model_prune_window`:: (<>) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=model-prune-window] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=model-prune-window] `model_snapshot_retention_days`:: (long) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=model-snapshot-retention-days] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=model-snapshot-retention-days] //Begin per_partition_categorization `per_partition_categorization`::: (object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=per-partition-categorization] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=per-partition-categorization] + .Properties of `per_partition_categorization` [%collapsible%open] ==== `enabled`::: (Boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=per-partition-categorization-enabled] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=per-partition-categorization-enabled] `stop_on_warn`::: (Boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=per-partition-categorization-stop-on-warn] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=per-partition-categorization-stop-on-warn] ==== //End per_partition_categorization `renormalization_window_days`:: (long) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=renormalization-window-days] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=renormalization-window-days] + -- NOTE: If the job is open when you make the update, you must stop the {dfeed}, @@ -233,7 +233,7 @@ close the job, then reopen the job and restart the {dfeed} for the changes to ta `results_retention_days`:: (long) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=results-retention-days] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=results-retention-days] [[ml-update-job-example]] diff --git a/docs/reference/ml/anomaly-detection/apis/update-snapshot.asciidoc b/docs/reference/ml/anomaly-detection/apis/update-snapshot.asciidoc index 2978d64f0122..f8c038486002 100644 --- a/docs/reference/ml/anomaly-detection/apis/update-snapshot.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/update-snapshot.asciidoc @@ -23,11 +23,11 @@ Requires the `manage_ml` cluster privilege. This privilege is included in the ``:: (Required, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] ``:: (Required, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=snapshot-id] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=snapshot-id] [[ml-update-snapshot-request-body]] == {api-request-body-title} @@ -39,7 +39,7 @@ The following properties can be updated after the model snapshot is created: `retain`:: (Optional, Boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=retain] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=retain] [[ml-update-snapshot-example]] diff --git a/docs/reference/ml/anomaly-detection/apis/upgrade-job-model-snapshot.asciidoc b/docs/reference/ml/anomaly-detection/apis/upgrade-job-model-snapshot.asciidoc index 3f09b292dc2d..3a74e3b2296d 100644 --- a/docs/reference/ml/anomaly-detection/apis/upgrade-job-model-snapshot.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/upgrade-job-model-snapshot.asciidoc @@ -42,11 +42,11 @@ snapshot cannot be the current snapshot of the {anomaly-job}. ``:: (Required, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] ``:: (Required, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=snapshot-id] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=snapshot-id] [[ml-upgrade-job-model-snapshot-query-parms]] diff --git a/docs/reference/ml/anomaly-detection/apis/validate-detector.asciidoc b/docs/reference/ml/anomaly-detection/apis/validate-detector.asciidoc index 5c312264cf71..c71673be7dc0 100644 --- a/docs/reference/ml/anomaly-detection/apis/validate-detector.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/validate-detector.asciidoc @@ -29,78 +29,78 @@ before you create an {anomaly-job}. `by_field_name`:: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=by-field-name] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=by-field-name] `custom_rules`:: + -- (array) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=custom-rules] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=custom-rules] `analysis_config`.`detectors`.`custom_rules`.`actions`::: (array) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=custom-rules-actions] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=custom-rules-actions] `analysis_config`.`detectors`.`custom_rules`.`scope`::: (object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=custom-rules-scope] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=custom-rules-scope] `analysis_config`.`detectors`.`custom_rules`.`scope`.`filter_id`:::: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=custom-rules-scope-filter-id] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=custom-rules-scope-filter-id] `analysis_config`.`detectors`.`custom_rules`.`scope`.`filter_type`:::: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=custom-rules-scope-filter-type] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=custom-rules-scope-filter-type] `analysis_config`.`detectors`.`custom_rules`.`conditions`::: (array) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=custom-rules-conditions] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=custom-rules-conditions] `analysis_config`.`detectors`.`custom_rules`.`conditions`.`applies_to`:::: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=custom-rules-conditions-applies-to] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=custom-rules-conditions-applies-to] `analysis_config`.`detectors`.`custom_rules`.`conditions`.`operator`:::: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=custom-rules-conditions-operator] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=custom-rules-conditions-operator] `analysis_config`.`detectors`.`custom_rules`.`conditions`.`value`:::: (double) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=custom-rules-conditions-value] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=custom-rules-conditions-value] -- `detector_description`:: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=detector-description] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=detector-description] `detector_index`:: (integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=detector-index] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=detector-index] `exclude_frequent`:: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=exclude-frequent] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=exclude-frequent] `field_name`:: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=detector-field-name] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=detector-field-name] `function`:: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=function] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=function] `over_field_name`:: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=over-field-name] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=over-field-name] `partition_field_name`:: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=partition-field-name] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=partition-field-name] `use_null`:: (Boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=use-null] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=use-null] [[ml-valid-detector-example]] == {api-examples-title} diff --git a/docs/reference/ml/common/apis/get-ml-memory.asciidoc b/docs/reference/ml/common/apis/get-ml-memory.asciidoc index 2dd79a969aca..81e0f59a97e5 100644 --- a/docs/reference/ml/common/apis/get-ml-memory.asciidoc +++ b/docs/reference/ml/common/apis/get-ml-memory.asciidoc @@ -42,7 +42,7 @@ node, both within the JVM heap, and natively, outside of the JVM. Specify this query parameter to include the fields with units in the response. Otherwise only the `_in_bytes` sizes are returned in the response. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] [role="child_attributes"] [[get-ml-memory-response-body]] @@ -89,11 +89,11 @@ Contains statistics for the node. ===== `attributes`:: (object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=node-attributes] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=node-attributes] `ephemeral_id`:: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=node-ephemeral-id] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=node-ephemeral-id] `jvm`:: (object) @@ -216,7 +216,7 @@ Roles assigned to the node. See <>. `transport_address`:: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=node-transport-address] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=node-transport-address] ===== ==== diff --git a/docs/reference/ml/df-analytics/apis/delete-dfanalytics.asciidoc b/docs/reference/ml/df-analytics/apis/delete-dfanalytics.asciidoc index 8631e1e7ae16..b505da570244 100644 --- a/docs/reference/ml/df-analytics/apis/delete-dfanalytics.asciidoc +++ b/docs/reference/ml/df-analytics/apis/delete-dfanalytics.asciidoc @@ -27,7 +27,7 @@ Requires the `manage_ml` cluster privilege. This privilege is included in the ``:: (Required, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-data-frame-analytics] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=job-id-data-frame-analytics] [[ml-delete-dfanalytics-query-params]] == {api-query-parms-title} diff --git a/docs/reference/ml/df-analytics/apis/explain-dfanalytics.asciidoc b/docs/reference/ml/df-analytics/apis/explain-dfanalytics.asciidoc index ed0a98474b5c..0ee7ec563458 100644 --- a/docs/reference/ml/df-analytics/apis/explain-dfanalytics.asciidoc +++ b/docs/reference/ml/df-analytics/apis/explain-dfanalytics.asciidoc @@ -52,7 +52,7 @@ they are not included in the explanation. ``:: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-data-frame-analytics] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=job-id-data-frame-analytics] [[ml-explain-dfanalytics-request-body]] == {api-request-body-title} diff --git a/docs/reference/ml/df-analytics/apis/get-dfanalytics-stats.asciidoc b/docs/reference/ml/df-analytics/apis/get-dfanalytics-stats.asciidoc index b18899cc8655..b193379084db 100644 --- a/docs/reference/ml/df-analytics/apis/get-dfanalytics-stats.asciidoc +++ b/docs/reference/ml/df-analytics/apis/get-dfanalytics-stats.asciidoc @@ -35,7 +35,7 @@ Requires the `monitor_ml` cluster privilege. This privilege is included in the ``:: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-data-frame-analytics-default] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=job-id-data-frame-analytics-default] [[ml-get-dfanalytics-stats-query-params]] @@ -43,19 +43,19 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-data-frame-analytics-def `allow_no_match`:: (Optional, Boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-no-match-dfa-jobs] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=allow-no-match-dfa-jobs] `from`:: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=from] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=from] `size`:: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=size] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=size] `verbose`:: (Optional, Boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=verbose] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=verbose] [role="child_attributes"] [[ml-get-dfanalytics-stats-response-body]] @@ -95,106 +95,106 @@ An object containing the parameters of the {classanalysis} job. ======= `alpha`:::: (double) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=dfas-alpha] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=dfas-alpha] `class_assignment_objective`:::: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=class-assignment-objective] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=class-assignment-objective] `downsample_factor`:::: (double) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=dfas-downsample-factor] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=dfas-downsample-factor] `eta`:::: (double) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=eta] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=eta] `eta_growth_rate_per_tree`:::: (double) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=dfas-eta-growth] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=dfas-eta-growth] `feature_bag_fraction`:::: (double) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=feature-bag-fraction] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=feature-bag-fraction] `gamma`:::: (double) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=gamma] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=gamma] `lambda`:::: (double) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=lambda] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=lambda] `max_attempts_to_add_tree`:::: (integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=dfas-max-attempts] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=dfas-max-attempts] `max_optimization_rounds_per_hyperparameter`:::: (integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=dfas-max-optimization-rounds] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=dfas-max-optimization-rounds] `max_trees`:::: (integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=max-trees] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=max-trees] `num_folds`:::: (integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=dfas-num-folds] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=dfas-num-folds] `num_splits_per_feature`:::: (integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=dfas-num-splits] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=dfas-num-splits] `soft_tree_depth_limit`:::: (double) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=dfas-soft-limit] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=dfas-soft-limit] `soft_tree_depth_tolerance`:::: (double) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=dfas-soft-tolerance] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=dfas-soft-tolerance] ======= //End class_hyperparameters `iteration`:::: (integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=dfas-iteration] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=dfas-iteration] `timestamp`:::: (date) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=dfas-timestamp] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=dfas-timestamp] //Begin class_timing_stats `timing_stats`:::: (object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=dfas-timing-stats] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=dfas-timing-stats] + .Properties of `timing_stats` [%collapsible%open] ======= `elapsed_time`:::: (integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=dfas-timing-stats-elapsed] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=dfas-timing-stats-elapsed] `iteration_time`:::: (integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=dfas-timing-stats-iteration] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=dfas-timing-stats-iteration] ======= //End class_timing_stats //Begin class_validation_loss `validation_loss`:::: (object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=dfas-validation-loss] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=dfas-validation-loss] + .Properties of `validation_loss` [%collapsible%open] ======= `fold_values`:::: -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=dfas-validation-loss-fold] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=dfas-validation-loss-fold] `loss_type`:::: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=dfas-validation-loss-type] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=dfas-validation-loss-type] ======= //End class_validation_loss ====== @@ -219,45 +219,45 @@ heuristics. ======= `compute_feature_influence`:::: (Boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=compute-feature-influence] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=compute-feature-influence] `feature_influence_threshold`:::: (double) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=feature-influence-threshold] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=feature-influence-threshold] `method`:::: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=method] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=method] `n_neighbors`:::: (integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=n-neighbors] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=n-neighbors] `outlier_fraction`:::: (double) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=outlier-fraction] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=outlier-fraction] `standardization_enabled`:::: (Boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=standardization-enabled] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=standardization-enabled] ======= //End parameters `timestamp`:::: (date) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=dfas-timestamp] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=dfas-timestamp] //Begin od_timing_stats `timing_stats`:::: (object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=dfas-timing-stats] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=dfas-timing-stats] + .Property of `timing_stats` [%collapsible%open] ======= `elapsed_time`:::: (integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=dfas-timing-stats-elapsed] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=dfas-timing-stats-elapsed] ======= //End od_timing_stats ====== @@ -281,103 +281,103 @@ An object containing the parameters of the {reganalysis} job. ======= `alpha`:::: (double) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=dfas-alpha] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=dfas-alpha] `downsample_factor`:::: (double) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=dfas-downsample-factor] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=dfas-downsample-factor] `eta`:::: (double) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=eta] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=eta] `eta_growth_rate_per_tree`:::: (double) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=dfas-eta-growth] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=dfas-eta-growth] `feature_bag_fraction`:::: (double) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=feature-bag-fraction] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=feature-bag-fraction] `gamma`:::: (double) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=gamma] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=gamma] `lambda`:::: (double) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=lambda] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=lambda] `max_attempts_to_add_tree`:::: (integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=dfas-max-attempts] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=dfas-max-attempts] `max_optimization_rounds_per_hyperparameter`:::: (integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=dfas-max-optimization-rounds] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=dfas-max-optimization-rounds] `max_trees`:::: (integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=max-trees] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=max-trees] `num_folds`:::: (integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=dfas-num-folds] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=dfas-num-folds] `num_splits_per_feature`:::: (integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=dfas-num-splits] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=dfas-num-splits] `soft_tree_depth_limit`:::: (double) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=dfas-soft-limit] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=dfas-soft-limit] `soft_tree_depth_tolerance`:::: (double) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=dfas-soft-tolerance] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=dfas-soft-tolerance] ======= //End reg_hyperparameters `iteration`:::: (integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=dfas-iteration] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=dfas-iteration] `timestamp`:::: (date) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=dfas-timestamp] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=dfas-timestamp] //Begin reg_timing_stats `timing_stats`:::: (object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=dfas-timing-stats] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=dfas-timing-stats] + .Propertis of `timing_stats` [%collapsible%open] ======= `elapsed_time`:::: (integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=dfas-timing-stats-elapsed] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=dfas-timing-stats-elapsed] `iteration_time`:::: (integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=dfas-timing-stats-iteration] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=dfas-timing-stats-iteration] ======= //End reg_timing_stats //Begin reg_validation_loss `validation_loss`:::: (object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=dfas-validation-loss] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=dfas-validation-loss] + .Properties of `validation_loss` [%collapsible%open] ======= `fold_values`:::: (array of strings) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=dfas-validation-loss-fold] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=dfas-validation-loss-fold] `loss_type`:::: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=dfas-validation-loss-type] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=dfas-validation-loss-type] ======= //End reg_validation_loss ====== @@ -463,15 +463,15 @@ available only for running jobs. ===== `attributes`:::: (object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=node-attributes] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=node-attributes] `ephemeral_id`:::: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=node-ephemeral-id] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=node-ephemeral-id] `id`:::: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=node-id] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=node-id] `name`:::: (string) @@ -479,7 +479,7 @@ The node name. `transport_address`:::: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=node-transport-address] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=node-transport-address] ===== `progress`::: diff --git a/docs/reference/ml/df-analytics/apis/get-dfanalytics.asciidoc b/docs/reference/ml/df-analytics/apis/get-dfanalytics.asciidoc index 7154dd607e77..c2a4caa981da 100644 --- a/docs/reference/ml/df-analytics/apis/get-dfanalytics.asciidoc +++ b/docs/reference/ml/df-analytics/apis/get-dfanalytics.asciidoc @@ -39,7 +39,7 @@ by using a comma-separated list of {dfanalytics-jobs} or a wildcard expression. ``:: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-data-frame-analytics-default] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=job-id-data-frame-analytics-default] + -- You can get information for all {dfanalytics-jobs} by using _all, by specifying @@ -53,19 +53,19 @@ You can get information for all {dfanalytics-jobs} by using _all, by specifying `allow_no_match`:: (Optional, Boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-no-match-dfa-jobs] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=allow-no-match-dfa-jobs] `exclude_generated`:: (Optional, Boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=exclude-generated] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=exclude-generated] `from`:: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=from] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=from] `size`:: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=size] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=size] [role="child_attributes"] [[ml-get-dfanalytics-results]] diff --git a/docs/reference/ml/df-analytics/apis/preview-dfanalytics.asciidoc b/docs/reference/ml/df-analytics/apis/preview-dfanalytics.asciidoc index 5e67a0cf7832..2c61c3263992 100644 --- a/docs/reference/ml/df-analytics/apis/preview-dfanalytics.asciidoc +++ b/docs/reference/ml/df-analytics/apis/preview-dfanalytics.asciidoc @@ -41,7 +41,7 @@ that either exists already or one that has not been created yet. ``:: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-data-frame-analytics] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=job-id-data-frame-analytics] [[ml-preview-dfanalytics-request-body]] == {api-request-body-title} diff --git a/docs/reference/ml/df-analytics/apis/put-dfanalytics.asciidoc b/docs/reference/ml/df-analytics/apis/put-dfanalytics.asciidoc index f11166f9c1a6..54cbe78b3445 100644 --- a/docs/reference/ml/df-analytics/apis/put-dfanalytics.asciidoc +++ b/docs/reference/ml/df-analytics/apis/put-dfanalytics.asciidoc @@ -51,7 +51,7 @@ determines a value for each of the undefined parameters. ``:: (Required, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-data-frame-analytics-define] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=job-id-data-frame-analytics-define] [role="child_attributes"] [[ml-put-dfanalytics-request-body]] @@ -93,16 +93,16 @@ understand the function of these parameters. ===== `alpha`:::: (Optional, double) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=dfas-alpha] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=dfas-alpha] `class_assignment_objective`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=class-assignment-objective] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=class-assignment-objective] `dependent_variable`:::: (Required, string) + -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=dependent-variable] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=dependent-variable] + The data type of the field must be numeric (`integer`, `short`, `long`, `byte`), categorical (`ip` or `keyword`), or boolean. There must be no more than 100 @@ -110,148 +110,148 @@ different values in this field. `downsample_factor`:::: (Optional, double) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=dfas-downsample-factor] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=dfas-downsample-factor] `early_stopping_enabled`:::: (Optional, Boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=dfas-early-stopping-enabled] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=dfas-early-stopping-enabled] `eta`:::: (Optional, double) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=eta] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=eta] `eta_growth_rate_per_tree`:::: (Optional, double) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=dfas-eta-growth] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=dfas-eta-growth] `feature_bag_fraction`:::: (Optional, double) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=feature-bag-fraction] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=feature-bag-fraction] `feature_processors`:::: (Optional, list) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=dfas-feature-processors] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=dfas-feature-processors] + .Properties of `feature_processors` [%collapsible%open] ====== `frequency_encoding`:::: (object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=dfas-feature-processors-frequency] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=dfas-feature-processors-frequency] + .Properties of `frequency_encoding` [%collapsible%open] ======= `feature_name`:::: (Required, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=dfas-feature-processors-feat-name] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=dfas-feature-processors-feat-name] `field`:::: (Required, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=dfas-feature-processors-field] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=dfas-feature-processors-field] `frequency_map`:::: (Required, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=dfas-feature-processors-frequency-map] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=dfas-feature-processors-frequency-map] ======= `multi_encoding`:::: (object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=dfas-feature-processors-multi] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=dfas-feature-processors-multi] + .Properties of `multi_encoding` [%collapsible%open] ======= `processors`:::: (Required, array) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=dfas-feature-processors-multi-proc] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=dfas-feature-processors-multi-proc] ======= `n_gram_encoding`:::: (object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=dfas-feature-processors-ngram] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=dfas-feature-processors-ngram] + .Properties of `n_gram_encoding` [%collapsible%open] ======= `feature_prefix`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=dfas-feature-processors-ngram-feat-pref] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=dfas-feature-processors-ngram-feat-pref] `field`:::: (Required, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=dfas-feature-processors-ngram-field] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=dfas-feature-processors-ngram-field] `length`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=dfas-feature-processors-ngram-length] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=dfas-feature-processors-ngram-length] `n_grams`:::: (Required, array) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=dfas-feature-processors-ngram-ngrams] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=dfas-feature-processors-ngram-ngrams] `start`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=dfas-feature-processors-ngram-start] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=dfas-feature-processors-ngram-start] ======= `one_hot_encoding`:::: (object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=dfas-feature-processors-one-hot] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=dfas-feature-processors-one-hot] + .Properties of `one_hot_encoding` [%collapsible%open] ======= `field`:::: (Required, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=dfas-feature-processors-field] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=dfas-feature-processors-field] `hot_map`:::: (Required, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=dfas-feature-processors-one-hot-map] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=dfas-feature-processors-one-hot-map] ======= `target_mean_encoding`:::: (object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=dfas-feature-processors-target-mean] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=dfas-feature-processors-target-mean] + .Properties of `target_mean_encoding` [%collapsible%open] ======= `default_value`:::: (Required, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=dfas-feature-processors-target-mean-default] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=dfas-feature-processors-target-mean-default] `feature_name`:::: (Required, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=dfas-feature-processors-feat-name] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=dfas-feature-processors-feat-name] `field`:::: (Required, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=dfas-feature-processors-field] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=dfas-feature-processors-field] `target_map`:::: (Required, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=dfas-feature-processors-target-mean-map] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=dfas-feature-processors-target-mean-map] ======= ====== `gamma`:::: (Optional, double) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=gamma] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=gamma] `lambda`:::: (Optional, double) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=lambda] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=lambda] `max_optimization_rounds_per_hyperparameter`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=dfas-max-optimization-rounds] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=dfas-max-optimization-rounds] `max_trees`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=max-trees] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=max-trees] `num_top_classes`:::: (Optional, integer) @@ -276,23 +276,23 @@ By default, it is zero and no {feat-imp} calculation occurs. `prediction_field_name`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=prediction-field-name] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=prediction-field-name] `randomize_seed`:::: (Optional, long) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=randomize-seed] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=randomize-seed] `soft_tree_depth_limit`:::: (Optional, double) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=dfas-soft-limit] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=dfas-soft-limit] `soft_tree_depth_tolerance`:::: (Optional, double) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=dfas-soft-tolerance] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=dfas-soft-tolerance] `training_percent`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=training-percent] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=training-percent] //End classification ===== //Begin outlier_detection @@ -306,27 +306,27 @@ The configuration information necessary to perform ===== `compute_feature_influence`:::: (Optional, Boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=compute-feature-influence] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=compute-feature-influence] `feature_influence_threshold`:::: (Optional, double) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=feature-influence-threshold] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=feature-influence-threshold] `method`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=method] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=method] `n_neighbors`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=n-neighbors] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=n-neighbors] `outlier_fraction`:::: (Optional, double) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=outlier-fraction] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=outlier-fraction] `standardization_enabled`:::: (Optional, Boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=standardization-enabled] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=standardization-enabled] //End outlier_detection ===== //Begin regression @@ -345,46 +345,46 @@ understand the function of these parameters. ===== `alpha`:::: (Optional, double) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=dfas-alpha] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=dfas-alpha] `dependent_variable`:::: (Required, string) + -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=dependent-variable] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=dependent-variable] + The data type of the field must be numeric. `downsample_factor`:::: (Optional, double) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=dfas-downsample-factor] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=dfas-downsample-factor] `early_stopping_enabled`:::: (Optional, Boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=dfas-early-stopping-enabled] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=dfas-early-stopping-enabled] `eta`:::: (Optional, double) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=eta] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=eta] `eta_growth_rate_per_tree`:::: (Optional, double) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=dfas-eta-growth] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=dfas-eta-growth] `feature_bag_fraction`:::: (Optional, double) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=feature-bag-fraction] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=feature-bag-fraction] `feature_processors`:::: (Optional, list) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=dfas-feature-processors] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=dfas-feature-processors] `gamma`:::: (Optional, double) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=gamma] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=gamma] `lambda`:::: (Optional, double) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=lambda] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=lambda] `loss_function`:::: (Optional, string) @@ -401,11 +401,11 @@ A positive number that is used as a parameter to the `loss_function`. `max_optimization_rounds_per_hyperparameter`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=dfas-max-optimization-rounds] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=dfas-max-optimization-rounds] `max_trees`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=max-trees] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=max-trees] `num_top_feature_importance_values`:::: (Optional, integer) @@ -415,23 +415,23 @@ By default, it is zero and no {feat-imp} calculation occurs. `prediction_field_name`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=prediction-field-name] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=prediction-field-name] `randomize_seed`:::: (Optional, long) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=randomize-seed] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=randomize-seed] `soft_tree_depth_limit`:::: (Optional, double) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=dfas-soft-limit] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=dfas-soft-limit] `soft_tree_depth_tolerance`:::: (Optional, double) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=dfas-soft-tolerance] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=dfas-soft-tolerance] `training_percent`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=training-percent] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=training-percent] ===== //End regression ==== @@ -493,11 +493,11 @@ analysis. `description`:: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=description-dfa] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=description-dfa] `dest`:: (Required, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=dest] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=dest] `max_num_threads`:: (Optional, integer) @@ -509,11 +509,11 @@ functionality other than the analysis itself. `_meta`:: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=meta] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=meta] `model_memory_limit`:: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=model-memory-limit-dfa] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=model-memory-limit-dfa] `source`:: (object) diff --git a/docs/reference/ml/df-analytics/apis/start-dfanalytics.asciidoc b/docs/reference/ml/df-analytics/apis/start-dfanalytics.asciidoc index 8ed1fab20206..70e996ef8dd0 100644 --- a/docs/reference/ml/df-analytics/apis/start-dfanalytics.asciidoc +++ b/docs/reference/ml/df-analytics/apis/start-dfanalytics.asciidoc @@ -53,14 +53,14 @@ when you created the job, those credentials are used. ``:: (Required, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-data-frame-analytics-define] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=job-id-data-frame-analytics-define] [[ml-start-dfanalytics-query-params]] == {api-query-parms-title} `timeout`:: (Optional, <>) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=timeout-start] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=timeout-start] [[ml-start-dfanalytics-response-body]] == {api-response-body-title} diff --git a/docs/reference/ml/df-analytics/apis/stop-dfanalytics.asciidoc b/docs/reference/ml/df-analytics/apis/stop-dfanalytics.asciidoc index 3ac7be860fd1..2fa3bc4413d7 100644 --- a/docs/reference/ml/df-analytics/apis/stop-dfanalytics.asciidoc +++ b/docs/reference/ml/df-analytics/apis/stop-dfanalytics.asciidoc @@ -42,14 +42,14 @@ stop all {dfanalytics-job} by using _all or by specifying * as the ``:: (Required, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-data-frame-analytics-define] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=job-id-data-frame-analytics-define] [[ml-stop-dfanalytics-query-params]] == {api-query-parms-title} `allow_no_match`:: (Optional, Boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-no-match-dfa-jobs] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=allow-no-match-dfa-jobs] `force`:: @@ -57,7 +57,7 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-no-match-dfa-jobs] `timeout`:: (Optional, <>) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=timeout-stop] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=timeout-stop] [[ml-stop-dfanalytics-example]] diff --git a/docs/reference/ml/df-analytics/apis/update-dfanalytics.asciidoc b/docs/reference/ml/df-analytics/apis/update-dfanalytics.asciidoc index f78b0516a621..49cca176be69 100644 --- a/docs/reference/ml/df-analytics/apis/update-dfanalytics.asciidoc +++ b/docs/reference/ml/df-analytics/apis/update-dfanalytics.asciidoc @@ -44,7 +44,7 @@ indices and stores the outcome in a destination index. ``:: (Required, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-data-frame-analytics-define] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=job-id-data-frame-analytics-define] [role="child_attributes"] [[ml-update-dfanalytics-request-body]] @@ -62,7 +62,7 @@ the `starting` state until sufficient {ml} node capacity is available. `description`:: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=description-dfa] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=description-dfa] `max_num_threads`:: (Optional, integer) @@ -74,11 +74,11 @@ functionality other than the analysis itself. `_meta`:: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=meta] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=meta] `model_memory_limit`:: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=model-memory-limit-dfa] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=model-memory-limit-dfa] [[ml-update-dfanalytics-example]] == {api-examples-title} diff --git a/docs/reference/ml/ml-shared.asciidoc b/docs/reference/ml/ml-shared.asciidoc index cc6d9037bd59..6bbc98db1c2e 100644 --- a/docs/reference/ml/ml-shared.asciidoc +++ b/docs/reference/ml/ml-shared.asciidoc @@ -234,15 +234,15 @@ is an object it has the following properties: ===== `char_filter`:::: (array of strings or objects) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=char-filter] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=char-filter] `tokenizer`:::: (string or object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=tokenizer] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=tokenizer] `filter`:::: (array of strings or objects) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=filter] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=filter] ===== end::categorization-analyzer[] @@ -448,7 +448,7 @@ it is not stored in {es}. Only the results for {anomaly-detect} are retained. `time_format`::: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=time-format] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=time-format] ==== end::data-description[] diff --git a/docs/reference/ml/trained-models/apis/clear-trained-model-deployment-cache.asciidoc b/docs/reference/ml/trained-models/apis/clear-trained-model-deployment-cache.asciidoc index 642afc520e6a..f24379705fc7 100644 --- a/docs/reference/ml/trained-models/apis/clear-trained-model-deployment-cache.asciidoc +++ b/docs/reference/ml/trained-models/apis/clear-trained-model-deployment-cache.asciidoc @@ -31,7 +31,7 @@ node. Calling this API clears the caches without restarting the deployment. `deployment_id`:: (Required, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=deployment-id] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=deployment-id] [[clear-trained-model-deployment-cache-example]] == {api-examples-title} diff --git a/docs/reference/ml/trained-models/apis/delete-trained-models.asciidoc b/docs/reference/ml/trained-models/apis/delete-trained-models.asciidoc index bba39d876ebd..1b54343d1f1c 100644 --- a/docs/reference/ml/trained-models/apis/delete-trained-models.asciidoc +++ b/docs/reference/ml/trained-models/apis/delete-trained-models.asciidoc @@ -27,7 +27,7 @@ Requires the `manage_ml` cluster privilege. This privilege is included in the ``:: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=model-id] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=model-id] [[ml-delete-trained-models-query-parms]] == {api-query-parms-title} diff --git a/docs/reference/ml/trained-models/apis/get-trained-models-stats.asciidoc b/docs/reference/ml/trained-models/apis/get-trained-models-stats.asciidoc index aec997855902..beff87e6ec6e 100644 --- a/docs/reference/ml/trained-models/apis/get-trained-models-stats.asciidoc +++ b/docs/reference/ml/trained-models/apis/get-trained-models-stats.asciidoc @@ -53,15 +53,15 @@ model. `allow_no_match`:: (Optional, Boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-no-match-models] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=allow-no-match-models] `from`:: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=from-models] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=from-models] `size`:: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=size-models] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=size-models] [role="child_attributes"] [[ml-get-trained-models-stats-results]] @@ -120,7 +120,7 @@ The desired number of nodes for model allocation. ====== `deployment_id`::: -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=deployment-id] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=deployment-id] `error_count`::: (integer) @@ -132,7 +132,7 @@ The sum of `inference_count` for all nodes in the deployment. `model_id`::: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=model-id] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=model-id] `nodes`::: (array of objects) @@ -190,22 +190,22 @@ Information pertaining to the node. ======== `attributes`::: (object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=node-attributes] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=node-attributes] `ephemeral_id`::: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=node-ephemeral-id] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=node-ephemeral-id] `id`::: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=node-id] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=node-id] `name`::: (string) The node name. `transport_address`::: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=node-transport-address] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=node-transport-address] ======== `number_of_allocations`::: @@ -365,7 +365,7 @@ section in <>. `model_id`::: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=model-id] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=model-id] `model_size_stats`::: (object) diff --git a/docs/reference/ml/trained-models/apis/get-trained-models.asciidoc b/docs/reference/ml/trained-models/apis/get-trained-models.asciidoc index 648595a83e8f..f203578c6f1c 100644 --- a/docs/reference/ml/trained-models/apis/get-trained-models.asciidoc +++ b/docs/reference/ml/trained-models/apis/get-trained-models.asciidoc @@ -38,7 +38,7 @@ Requires the `monitor_ml` cluster privilege. This privilege is included in the ``:: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=model-id-or-alias] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=model-id-or-alias] + You can get information for multiple trained models in a single API request by using a comma-separated list of model IDs or a wildcard expression. @@ -48,7 +48,7 @@ using a comma-separated list of model IDs or a wildcard expression. `allow_no_match`:: (Optional, Boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-no-match-models] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=allow-no-match-models] `decompress_definition`:: (Optional, Boolean) @@ -57,11 +57,11 @@ Specifies whether the included model definition should be returned as a JSON map `exclude_generated`:: (Optional, Boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=exclude-generated] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=exclude-generated] `from`:: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=from-models] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=from-models] `include`:: (Optional, string) @@ -83,11 +83,11 @@ in the response body. `size`:: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=size-models] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=size-models] `tags`:: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=tags] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=tags] [role="child_attributes"] [[ml-get-trained-models-results]] @@ -148,157 +148,157 @@ Classification configuration for inference. ====== `num_top_classes`::: (integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-classification-num-top-classes] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-classification-num-top-classes] `num_top_feature_importance_values`::: (integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-classification-num-top-feature-importance-values] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-classification-num-top-feature-importance-values] `prediction_field_type`::: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-classification-prediction-field-type] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-classification-prediction-field-type] `results_field`::: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-results-field] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-results-field] `top_classes_results_field`::: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-classification-top-classes-results-field] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-classification-top-classes-results-field] ====== `fill_mask`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-fill-mask] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-fill-mask] + .Properties of fill_mask inference [%collapsible%open] ====== `mask_token`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-mask-token] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-mask-token] `tokenization`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization] + .Properties of tokenization [%collapsible%open] ======= `bert`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert] + .Properties of bert [%collapsible%open] ======== `do_lower_case`:::: (Optional, boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-do-lower-case] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-do-lower-case] `max_sequence_length`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-max-sequence-length] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-max-sequence-length] `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] `with_special_tokens`:::: (Optional, boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert-with-special-tokens] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert-with-special-tokens] ======== `roberta`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta] + .Properties of roberta [%collapsible%open] ======== `add_prefix_space`:::: (Optional, boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta-add-prefix-space] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta-add-prefix-space] `max_sequence_length`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-max-sequence-length] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-max-sequence-length] `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] `with_special_tokens`:::: (Optional, boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta-with-special-tokens] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta-with-special-tokens] ======== `mpnet`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-mpnet] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-mpnet] + .Properties of mpnet [%collapsible%open] ======== `do_lower_case`:::: (Optional, boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-do-lower-case] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-do-lower-case] `max_sequence_length`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-max-sequence-length] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-max-sequence-length] `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] `with_special_tokens`:::: (Optional, boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-mpnet-with-special-tokens] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-mpnet-with-special-tokens] ======== `xlm_roberta`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-xlm-roberta] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-xlm-roberta] + .Properties of xlm_roberta [%collapsible%open] ======== `max_sequence_length`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-max-sequence-length] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-max-sequence-length] `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] `with_special_tokens`:::: (Optional, boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta-with-special-tokens] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta-with-special-tokens] ======== `bert_ja`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert-ja] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert-ja] + .Properties of bert_ja [%collapsible%open] ======== `do_lower_case`:::: (Optional, boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-do-lower-case] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-do-lower-case] `max_sequence_length`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-max-sequence-length] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-max-sequence-length] `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] `with_special_tokens`:::: (Optional, boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert-ja-with-special-tokens] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert-ja-with-special-tokens] ======== ======= `vocabulary`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-vocabulary] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-vocabulary] + .Properties of vocabulary [%collapsible%open] @@ -311,7 +311,7 @@ The index where the vocabulary is stored. `ner`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-ner] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-ner] + .Properties of ner inference [%collapsible%open] @@ -325,126 +325,126 @@ and miscellaneous. For example: `tokenization`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization] + .Properties of tokenization [%collapsible%open] ======= `bert`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert] + .Properties of bert [%collapsible%open] ======== `do_lower_case`:::: (Optional, boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-do-lower-case] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-do-lower-case] `max_sequence_length`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-max-sequence-length] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-max-sequence-length] `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] `with_special_tokens`:::: (Optional, boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert-with-special-tokens] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert-with-special-tokens] ======== `roberta`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta] + .Properties of roberta [%collapsible%open] ======== `add_prefix_space`:::: (Optional, boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta-add-prefix-space] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta-add-prefix-space] `max_sequence_length`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-max-sequence-length] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-max-sequence-length] `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] `with_special_tokens`:::: (Optional, boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta-with-special-tokens] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta-with-special-tokens] ======== `mpnet`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-mpnet] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-mpnet] + .Properties of mpnet [%collapsible%open] ======== `do_lower_case`:::: (Optional, boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-do-lower-case] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-do-lower-case] `max_sequence_length`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-max-sequence-length] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-max-sequence-length] `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] `with_special_tokens`:::: (Optional, boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-mpnet-with-special-tokens] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-mpnet-with-special-tokens] ======== `xlm_roberta`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-xlm-roberta] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-xlm-roberta] + .Properties of xlm_roberta [%collapsible%open] ======== `max_sequence_length`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-max-sequence-length] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-max-sequence-length] `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] `with_special_tokens`:::: (Optional, boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta-with-special-tokens] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta-with-special-tokens] ======== `bert_ja`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert-ja] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert-ja] + .Properties of bert_ja [%collapsible%open] ======== `do_lower_case`:::: (Optional, boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-do-lower-case] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-do-lower-case] `max_sequence_length`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-max-sequence-length] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-max-sequence-length] `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] `with_special_tokens`:::: (Optional, boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert-ja-with-special-tokens] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert-ja-with-special-tokens] ======== ======= `vocabulary`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-vocabulary] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-vocabulary] + .Properties of vocabulary [%collapsible%open] @@ -457,133 +457,133 @@ The index where the vocabulary is stored `pass_through`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-pass-through] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-pass-through] + .Properties of pass_through inference [%collapsible%open] ====== `tokenization`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization] + .Properties of tokenization [%collapsible%open] ======= `bert`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert] + .Properties of bert [%collapsible%open] ======== `do_lower_case`:::: (Optional, boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-do-lower-case] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-do-lower-case] `max_sequence_length`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-max-sequence-length] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-max-sequence-length] `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] `with_special_tokens`:::: (Optional, boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert-with-special-tokens] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert-with-special-tokens] ======== `roberta`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta] + .Properties of roberta [%collapsible%open] ======== `add_prefix_space`:::: (Optional, boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta-add-prefix-space] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta-add-prefix-space] `max_sequence_length`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-max-sequence-length] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-max-sequence-length] `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] `with_special_tokens`:::: (Optional, boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta-with-special-tokens] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta-with-special-tokens] ======== `mpnet`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-mpnet] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-mpnet] + .Properties of mpnet [%collapsible%open] ======== `do_lower_case`:::: (Optional, boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-do-lower-case] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-do-lower-case] `max_sequence_length`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-max-sequence-length] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-max-sequence-length] `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] `with_special_tokens`:::: (Optional, boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-mpnet-with-special-tokens] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-mpnet-with-special-tokens] ======== `xlm_roberta`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-xlm-roberta] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-xlm-roberta] + .Properties of xlm_roberta [%collapsible%open] ======== `max_sequence_length`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-max-sequence-length] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-max-sequence-length] `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] `with_special_tokens`:::: (Optional, boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta-with-special-tokens] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta-with-special-tokens] ======== `bert_ja`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert-ja] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert-ja] + .Properties of bert_ja [%collapsible%open] ======== `do_lower_case`:::: (Optional, boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-do-lower-case] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-do-lower-case] `max_sequence_length`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-max-sequence-length] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-max-sequence-length] `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] `with_special_tokens`:::: (Optional, boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert-ja-with-special-tokens] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert-ja-with-special-tokens] ======== ======= `vocabulary`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-vocabulary] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-vocabulary] + .Properties of vocabulary [%collapsible%open] @@ -603,15 +603,15 @@ Regression configuration for inference. ====== `num_top_feature_importance_values`::: (integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-regression-num-top-feature-importance-values] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-regression-num-top-feature-importance-values] `results_field`::: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-results-field] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-results-field] ====== `text_classification`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-text-classification] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-text-classification] + .Properties of text_classification inference [%collapsible%open] @@ -626,147 +626,147 @@ Specifies the number of top class predictions to return. Defaults to all classes `tokenization`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization] + .Properties of tokenization [%collapsible%open] ======= `bert`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert] + .Properties of bert [%collapsible%open] ======== `do_lower_case`:::: (Optional, boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-do-lower-case] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-do-lower-case] `max_sequence_length`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-max-sequence-length] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-max-sequence-length] `span`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-span] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-span] `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] `with_special_tokens`:::: (Optional, boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert-with-special-tokens] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert-with-special-tokens] ======== `roberta`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta] + .Properties of roberta [%collapsible%open] ======== `add_prefix_space`:::: (Optional, boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta-add-prefix-space] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta-add-prefix-space] `max_sequence_length`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-max-sequence-length] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-max-sequence-length] `span`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-span] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-span] `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] `with_special_tokens`:::: (Optional, boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta-with-special-tokens] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta-with-special-tokens] ======== `mpnet`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-mpnet] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-mpnet] + .Properties of mpnet [%collapsible%open] ======== `do_lower_case`:::: (Optional, boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-do-lower-case] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-do-lower-case] `max_sequence_length`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-max-sequence-length] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-max-sequence-length] `span`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-span] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-span] `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] `with_special_tokens`:::: (Optional, boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-mpnet-with-special-tokens] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-mpnet-with-special-tokens] ======== `xlm_roberta`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-xlm-roberta] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-xlm-roberta] + .Properties of xlm_roberta [%collapsible%open] ======== `max_sequence_length`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-max-sequence-length] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-max-sequence-length] `span`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-span] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-span] `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] `with_special_tokens`:::: (Optional, boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta-with-special-tokens] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta-with-special-tokens] ======== `bert_ja`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert-ja] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert-ja] + .Properties of bert_ja [%collapsible%open] ======== `do_lower_case`:::: (Optional, boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-do-lower-case] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-do-lower-case] `max_sequence_length`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-max-sequence-length] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-max-sequence-length] `span`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-span] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-span] `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] `with_special_tokens`:::: (Optional, boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert-ja-with-special-tokens] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert-ja-with-special-tokens] ======== ======= `vocabulary`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-vocabulary] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-vocabulary] + .Properties of vocabulary [%collapsible%open] @@ -778,141 +778,141 @@ The index where the vocabulary is stored. ====== `text_embedding`:::: (Object, optional) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-text-embedding] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-text-embedding] + .Properties of text_embedding inference [%collapsible%open] ====== `embedding_size`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-text-embedding-size] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-text-embedding-size] `results_field`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-results-field] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-results-field] `tokenization`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization] + .Properties of tokenization [%collapsible%open] ======= `bert`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert] + .Properties of bert [%collapsible%open] ======== `do_lower_case`:::: (Optional, boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-do-lower-case] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-do-lower-case] `max_sequence_length`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-max-sequence-length] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-max-sequence-length] `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] `with_special_tokens`:::: (Optional, boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert-with-special-tokens] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert-with-special-tokens] ======== `roberta`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta] + .Properties of roberta [%collapsible%open] ======== `add_prefix_space`:::: (Optional, boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta-add-prefix-space] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta-add-prefix-space] `max_sequence_length`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-max-sequence-length] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-max-sequence-length] `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] `with_special_tokens`:::: (Optional, boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta-with-special-tokens] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta-with-special-tokens] ======== `mpnet`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-mpnet] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-mpnet] + .Properties of mpnet [%collapsible%open] ======== `do_lower_case`:::: (Optional, boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-do-lower-case] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-do-lower-case] `max_sequence_length`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-max-sequence-length] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-max-sequence-length] `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] `with_special_tokens`:::: (Optional, boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-mpnet-with-special-tokens] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-mpnet-with-special-tokens] ======== `xlm_roberta`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-xlm-roberta] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-xlm-roberta] + .Properties of xlm_roberta [%collapsible%open] ======== `max_sequence_length`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-max-sequence-length] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-max-sequence-length] `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] `with_special_tokens`:::: (Optional, boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta-with-special-tokens] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta-with-special-tokens] ======== `bert_ja`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert-ja] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert-ja] + .Properties of bert_ja [%collapsible%open] ======== `do_lower_case`:::: (Optional, boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-do-lower-case] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-do-lower-case] `max_sequence_length`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-max-sequence-length] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-max-sequence-length] `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] `with_special_tokens`:::: (Optional, boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert-ja-with-special-tokens] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert-ja-with-special-tokens] ======== ======= `vocabulary`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-vocabulary] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-vocabulary] + .Properties of vocabulary [%collapsible%open] @@ -924,157 +924,157 @@ The index where the vocabulary is stored. ====== `text_similarity`:::: (Object, optional) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-text-similarity] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-text-similarity] + .Properties of text_similarity inference [%collapsible%open] ====== `span_score_combination_function`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-text-similarity-span-score-func] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-text-similarity-span-score-func] `tokenization`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization] + .Properties of tokenization [%collapsible%open] ======= `bert`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert] + .Properties of bert [%collapsible%open] ======== `do_lower_case`:::: (Optional, boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-do-lower-case] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-do-lower-case] `max_sequence_length`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-max-sequence-length] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-max-sequence-length] `span`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-span] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-span] `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] `with_special_tokens`:::: (Optional, boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert-with-special-tokens] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert-with-special-tokens] ======== `roberta`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta] + .Properties of roberta [%collapsible%open] ======== `add_prefix_space`:::: (Optional, boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta-add-prefix-space] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta-add-prefix-space] `max_sequence_length`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-max-sequence-length] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-max-sequence-length] `span`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-span] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-span] `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] `with_special_tokens`:::: (Optional, boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta-with-special-tokens] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta-with-special-tokens] ======== `mpnet`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-mpnet] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-mpnet] + .Properties of mpnet [%collapsible%open] ======== `do_lower_case`:::: (Optional, boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-do-lower-case] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-do-lower-case] `max_sequence_length`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-max-sequence-length] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-max-sequence-length] `span`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-span] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-span] `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] `with_special_tokens`:::: (Optional, boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-mpnet-with-special-tokens] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-mpnet-with-special-tokens] ======== `xlm_roberta`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-xlm-roberta] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-xlm-roberta] + .Properties of xlm_roberta [%collapsible%open] ======== `max_sequence_length`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-max-sequence-length] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-max-sequence-length] `span`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-span] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-span] `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] `with_special_tokens`:::: (Optional, boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta-with-special-tokens] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta-with-special-tokens] ======== `bert_ja`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert-ja] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert-ja] + .Properties of bert_ja [%collapsible%open] ======== `do_lower_case`:::: (Optional, boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-do-lower-case] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-do-lower-case] `max_sequence_length`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-max-sequence-length] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-max-sequence-length] `span`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-span] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-span] `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] `with_special_tokens`:::: (Optional, boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert-ja-with-special-tokens] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert-ja-with-special-tokens] ======== ======= `vocabulary`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-vocabulary] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-vocabulary] + .Properties of vocabulary [%collapsible%open] @@ -1086,149 +1086,149 @@ The index where the vocabulary is stored. ====== `zero_shot_classification`:::: (Object, optional) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-zero-shot-classification] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-zero-shot-classification] + .Properties of zero_shot_classification inference [%collapsible%open] ====== `classification_labels`:::: (Required, array) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-zero-shot-classification-classification-labels] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-zero-shot-classification-classification-labels] `hypothesis_template`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-zero-shot-classification-hypothesis-template] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-zero-shot-classification-hypothesis-template] `labels`:::: (Optional, array) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-zero-shot-classification-labels] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-zero-shot-classification-labels] `multi_label`:::: (Optional, boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-zero-shot-classification-multi-label] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-zero-shot-classification-multi-label] `tokenization`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization] + .Properties of tokenization [%collapsible%open] ======= `bert`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert] + .Properties of bert [%collapsible%open] ======== `do_lower_case`:::: (Optional, boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-do-lower-case] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-do-lower-case] `max_sequence_length`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-max-sequence-length] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-max-sequence-length] `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] `with_special_tokens`:::: (Optional, boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert-with-special-tokens] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert-with-special-tokens] ======== `roberta`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta] + .Properties of roberta [%collapsible%open] ======== `add_prefix_space`:::: (Optional, boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta-add-prefix-space] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta-add-prefix-space] `max_sequence_length`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-max-sequence-length] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-max-sequence-length] `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] `with_special_tokens`:::: (Optional, boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta-with-special-tokens] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta-with-special-tokens] ======== `mpnet`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-mpnet] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-mpnet] + .Properties of mpnet [%collapsible%open] ======== `do_lower_case`:::: (Optional, boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-do-lower-case] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-do-lower-case] `max_sequence_length`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-max-sequence-length] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-max-sequence-length] `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] `with_special_tokens`:::: (Optional, boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-mpnet-with-special-tokens] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-mpnet-with-special-tokens] ======== `xlm_roberta`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-xlm-roberta] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-xlm-roberta] + .Properties of xlm_roberta [%collapsible%open] ======== `max_sequence_length`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-max-sequence-length] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-max-sequence-length] `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] `with_special_tokens`:::: (Optional, boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta-with-special-tokens] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta-with-special-tokens] ======== `bert_ja`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert-ja] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert-ja] + .Properties of bert_ja [%collapsible%open] ======== `do_lower_case`:::: (Optional, boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-do-lower-case] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-do-lower-case] `max_sequence_length`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-max-sequence-length] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-max-sequence-length] `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] `with_special_tokens`:::: (Optional, boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert-ja-with-special-tokens] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert-ja-with-special-tokens] ======== ======= `vocabulary`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-vocabulary] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-vocabulary] + .Properties of vocabulary [%collapsible%open] @@ -1307,7 +1307,7 @@ hyperparameter optimization. `max_trees`:::: (integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=max-trees-trained-models] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=max-trees-trained-models] `name`:::: (string) @@ -1344,7 +1344,7 @@ request parameter. `feature_name`::: (string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-metadata-feature-importance-feature-name] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-metadata-feature-importance-feature-name] `importance`::: (object) @@ -1355,15 +1355,15 @@ A collection of {feat-imp} statistics related to the training data set for this ======= `mean_magnitude`::: (double) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-metadata-feature-importance-magnitude] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-metadata-feature-importance-magnitude] `max`::: (integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-metadata-feature-importance-max] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-metadata-feature-importance-max] `min`::: (integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-metadata-feature-importance-min] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-metadata-feature-importance-min] ======= @@ -1390,15 +1390,15 @@ A collection of {feat-imp} statistics related to the training data set for this ======== `mean_magnitude`::: (double) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-metadata-feature-importance-magnitude] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-metadata-feature-importance-magnitude] `max`::: (int) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-metadata-feature-importance-max] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-metadata-feature-importance-max] `min`::: (int) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-metadata-feature-importance-min] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-metadata-feature-importance-min] ======== diff --git a/docs/reference/ml/trained-models/apis/infer-trained-model-deployment.asciidoc b/docs/reference/ml/trained-models/apis/infer-trained-model-deployment.asciidoc index d92d74d894a3..83bc56d18df6 100644 --- a/docs/reference/ml/trained-models/apis/infer-trained-model-deployment.asciidoc +++ b/docs/reference/ml/trained-models/apis/infer-trained-model-deployment.asciidoc @@ -31,7 +31,7 @@ deprecated::[8.3.0,Replaced by <>.] ``:: (Required, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=model-id-or-alias] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=model-id-or-alias] [[infer-trained-model-deployment-query-params]] == {api-query-parms-title} diff --git a/docs/reference/ml/trained-models/apis/infer-trained-model.asciidoc b/docs/reference/ml/trained-models/apis/infer-trained-model.asciidoc index d7201fcf42c0..9aac913e7559 100644 --- a/docs/reference/ml/trained-models/apis/infer-trained-model.asciidoc +++ b/docs/reference/ml/trained-models/apis/infer-trained-model.asciidoc @@ -34,14 +34,14 @@ directly from the {infer} cache. ``:: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=model-id-or-alias] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=model-id-or-alias] If you specify the `model_id` in the API call, and the model has multiple deployments, a random deployment will be used. If the `model_id` matches the ID of one of the deployments, that deployment will be used. ``:: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=deployment-id] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=deployment-id] [[infer-trained-model-query-params]] == {api-query-parms-title} @@ -84,28 +84,28 @@ Classification configuration for inference. ===== `num_top_classes`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-classification-num-top-classes] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-classification-num-top-classes] `num_top_feature_importance_values`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-classification-num-top-feature-importance-values] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-classification-num-top-feature-importance-values] `prediction_field_type`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-classification-prediction-field-type] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-classification-prediction-field-type] `results_field`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-results-field] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-results-field] `top_classes_results_field`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-classification-top-classes-results-field] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-classification-top-classes-results-field] ===== `fill_mask`::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-fill-mask] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-fill-mask] + .Properties of fill_mask inference [%collapsible%open] @@ -117,228 +117,228 @@ to `0`. `results_field`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-results-field] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-results-field] `tokenization`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization] + .Properties of tokenization [%collapsible%open] ====== `bert`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert] + .Properties of bert [%collapsible%open] ======= `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] ======= `roberta`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta] + .Properties of roberta [%collapsible%open] ======= `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] ======= `mpnet`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-mpnet] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-mpnet] + .Properties of mpnet [%collapsible%open] ======= `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] ======= `xlm_roberta`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-xlm-roberta] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-xlm-roberta] + .Properties of xlm_roberta [%collapsible%open] ======= `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] ======= `bert_ja`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert-ja] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert-ja] + .Properties of bert_ja [%collapsible%open] ======= `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] ======= ====== ===== `ner`::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-ner] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-ner] + .Properties of ner inference [%collapsible%open] ===== `results_field`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-results-field] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-results-field] `tokenization`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization] + .Properties of tokenization [%collapsible%open] ====== `bert`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert] + .Properties of bert [%collapsible%open] ======= `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] ======= `roberta`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta] + .Properties of roberta [%collapsible%open] ======= `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] ======= `mpnet`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-mpnet] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-mpnet] + .Properties of mpnet [%collapsible%open] ======= `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] ======= `xlm_roberta`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-xlm-roberta] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-xlm-roberta] + .Properties of xlm_roberta [%collapsible%open] ======= `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] ======= `bert_ja`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert-ja] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert-ja] + .Properties of bert_ja [%collapsible%open] ======= `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] ======= ====== ===== `pass_through`::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-pass-through] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-pass-through] + .Properties of pass_through inference [%collapsible%open] ===== `results_field`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-results-field] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-results-field] `tokenization`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization] + .Properties of tokenization [%collapsible%open] ====== `bert`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert] + .Properties of bert [%collapsible%open] ======= `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] ======= `roberta`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta] + .Properties of roberta [%collapsible%open] ======= `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] ======= `mpnet`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-mpnet] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-mpnet] + .Properties of mpnet [%collapsible%open] ======= `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] ======= `xlm_roberta`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-xlm-roberta] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-xlm-roberta] + .Properties of xlm_roberta [%collapsible%open] ======= `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] ======= `bert_ja`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert-ja] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert-ja] + .Properties of bert_ja [%collapsible%open] ======= `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] ======= ====== ===== `question_answering`::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-question-answering] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-question-answering] + .Properties of question_answering inference [%collapsible%open] @@ -358,11 +358,11 @@ The question to use when extracting an answer `results_field`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-results-field] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-results-field] `tokenization`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization] + Recommended to set `max_sequence_length` to `386` with `128` of `span` and set `truncate` to `none`. @@ -372,78 +372,78 @@ Recommended to set `max_sequence_length` to `386` with `128` of `span` and set ====== `bert`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert] + .Properties of bert [%collapsible%open] ======= `span`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-span] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-span] `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] ======= `roberta`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta] + .Properties of roberta [%collapsible%open] ======= `span`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-span] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-span] `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] ======= `mpnet`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-mpnet] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-mpnet] + .Properties of mpnet [%collapsible%open] ======= `span`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-span] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-span] `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] ======= `xlm_roberta`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-xlm-roberta] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-xlm-roberta] + .Properties of xlm_roberta [%collapsible%open] ======= `span`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-span] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-span] `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] ======= `bert_ja`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert-ja] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert-ja] + .Properties of bert_ja [%collapsible%open] ======= `span`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-span] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-span] `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] ======= ====== ===== @@ -457,16 +457,16 @@ Regression configuration for inference. ===== `num_top_feature_importance_values`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-regression-num-top-feature-importance-values] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-regression-num-top-feature-importance-values] `results_field`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-results-field] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-results-field] ===== `text_classification`::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-text-classification] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-text-classification] + .Properties of text_classification inference [%collapsible%open] @@ -481,346 +481,346 @@ Specifies the number of top class predictions to return. Defaults to all classes `results_field`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-results-field] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-results-field] `tokenization`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization] + .Properties of tokenization [%collapsible%open] ====== `bert`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert] + .Properties of bert [%collapsible%open] ======= `span`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-span] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-span] `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] ======= `roberta`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta] + .Properties of roberta [%collapsible%open] ======= `span`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-span] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-span] `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] ======= `mpnet`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-mpnet] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-mpnet] + .Properties of mpnet [%collapsible%open] ======= `span`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-span] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-span] `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] ======= `xlm_roberta`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-xlm-roberta] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-xlm-roberta] + .Properties of xlm_roberta [%collapsible%open] ======= `span`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-span] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-span] `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] ======= `bert_ja`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert-ja] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert-ja] + .Properties of bert_ja [%collapsible%open] ======= `span`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-span] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-span] `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] ======= ====== ===== `text_embedding`::: (Object, optional) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-text-embedding] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-text-embedding] + .Properties of text_embedding inference [%collapsible%open] ===== `results_field`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-results-field] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-results-field] `tokenization`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization] + .Properties of tokenization [%collapsible%open] ====== `bert`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert] + .Properties of bert [%collapsible%open] ======= `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] ======= `roberta`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta] + .Properties of roberta [%collapsible%open] ======= `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] ======= `mpnet`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-mpnet] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-mpnet] + .Properties of mpnet [%collapsible%open] ======= `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] ======= `xlm_roberta`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-xlm-roberta] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-xlm-roberta] + .Properties of xlm_roberta [%collapsible%open] ======= `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] ======= `bert_ja`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert-ja] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert-ja] + .Properties of bert_ja [%collapsible%open] ======= `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] ======= ====== ===== `text_similarity`::: (Object, optional) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-text-similarity] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-text-similarity] + .Properties of text_similarity inference [%collapsible%open] ===== `span_score_combination_function`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-text-similarity-span-score-func] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-text-similarity-span-score-func] `text`:::: (Required, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-text-similarity-text] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-text-similarity-text] `tokenization`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization] + .Properties of tokenization [%collapsible%open] ====== `bert`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert] + .Properties of bert [%collapsible%open] ======= `span`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-span] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-span] `with_special_tokens`:::: (Optional, boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert-with-special-tokens] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert-with-special-tokens] ======= `roberta`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta] + .Properties of roberta [%collapsible%open] ======= `span`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-span] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-span] `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] ======= `mpnet`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-mpnet] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-mpnet] + .Properties of mpnet [%collapsible%open] ======= `span`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-span] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-span] `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] ======= `xlm_roberta`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-xlm-roberta] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-xlm-roberta] + .Properties of xlm_roberta [%collapsible%open] ======= `span`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-span] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-span] `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] ======= `bert_ja`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert-ja] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert-ja] + .Properties of bert_ja [%collapsible%open] ======= `span`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-span] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-span] `with_special_tokens`:::: (Optional, boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert-ja-with-special-tokens] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert-ja-with-special-tokens] ======= ====== ===== `zero_shot_classification`::: (Object, optional) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-zero-shot-classification] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-zero-shot-classification] + .Properties of zero_shot_classification inference [%collapsible%open] ===== `labels`:::: (Optional, array) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-zero-shot-classification-labels] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-zero-shot-classification-labels] `multi_label`:::: (Optional, boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-zero-shot-classification-multi-label] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-zero-shot-classification-multi-label] `results_field`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-results-field] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-results-field] `tokenization`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization] + .Properties of tokenization [%collapsible%open] ====== `bert`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert] + .Properties of bert [%collapsible%open] ======= `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] ======= `roberta`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta] + .Properties of roberta [%collapsible%open] ======= `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] ======= `mpnet`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-mpnet] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-mpnet] + .Properties of mpnet [%collapsible%open] ======= `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] ======= `xlm_roberta`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-xlm-roberta] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-xlm-roberta] + .Properties of xlm_roberta [%collapsible%open] ======= `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] ======= `bert_ja`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert-ja] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert-ja] + .Properties of bert_ja [%collapsible%open] ======= `truncate`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] ======= ====== ===== diff --git a/docs/reference/ml/trained-models/apis/put-trained-model-definition-part.asciidoc b/docs/reference/ml/trained-models/apis/put-trained-model-definition-part.asciidoc index 53cad5cffa37..d1da29abffcd 100644 --- a/docs/reference/ml/trained-models/apis/put-trained-model-definition-part.asciidoc +++ b/docs/reference/ml/trained-models/apis/put-trained-model-definition-part.asciidoc @@ -26,7 +26,7 @@ Requires the `manage_ml` cluster privilege. This privilege is included in the ``:: (Required, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=model-id] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=model-id] ``:: (Required, number) diff --git a/docs/reference/ml/trained-models/apis/put-trained-model-vocabulary.asciidoc b/docs/reference/ml/trained-models/apis/put-trained-model-vocabulary.asciidoc index 8541583f368f..2fdf86259388 100644 --- a/docs/reference/ml/trained-models/apis/put-trained-model-vocabulary.asciidoc +++ b/docs/reference/ml/trained-models/apis/put-trained-model-vocabulary.asciidoc @@ -34,7 +34,7 @@ The vocabulary is stored in the index as described in ``:: (Required, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=model-id] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=model-id] [[ml-put-trained-model-vocabulary-request-body]] == {api-request-body-title} diff --git a/docs/reference/ml/trained-models/apis/put-trained-models.asciidoc b/docs/reference/ml/trained-models/apis/put-trained-models.asciidoc index 433286a8e0c2..eef90630eb35 100644 --- a/docs/reference/ml/trained-models/apis/put-trained-models.asciidoc +++ b/docs/reference/ml/trained-models/apis/put-trained-models.asciidoc @@ -40,7 +40,7 @@ created by {dfanalytics}. ``:: (Required, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=model-id] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=model-id] [[ml-put-trained-models-query-params]] == {api-query-parms-title} @@ -104,7 +104,7 @@ The field name to encode. Object that maps the field value to the frequency encoded value. `custom`:: -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=custom-preprocessor] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=custom-preprocessor] ====== //End frequency encoding @@ -126,7 +126,7 @@ The field name to encode. String map of "field_value: one_hot_column_name". `custom`:: -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=custom-preprocessor] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=custom-preprocessor] ====== //End one hot encoding @@ -156,7 +156,7 @@ The field name to encode. Object that maps the field value to the target mean value. `custom`:: -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=custom-preprocessor] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=custom-preprocessor] ====== //End target mean encoding @@ -409,28 +409,28 @@ Classification configuration for inference. ===== `num_top_classes`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-classification-num-top-classes] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-classification-num-top-classes] `num_top_feature_importance_values`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-classification-num-top-feature-importance-values] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-classification-num-top-feature-importance-values] `prediction_field_type`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-classification-prediction-field-type] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-classification-prediction-field-type] `results_field`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-results-field] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-results-field] `top_classes_results_field`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-classification-top-classes-results-field] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-classification-top-classes-results-field] ===== `fill_mask`::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-fill-mask] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-fill-mask] + .Properties of fill_mask inference [%collapsible%open] @@ -441,11 +441,11 @@ Number of top predicted tokens to return for replacing the mask token. Defaults `results_field`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-results-field] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-results-field] `tokenization`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization] + Refer to <> to review the properties of the `tokenization` object. @@ -453,7 +453,7 @@ Refer to <> to review the properties of the `ner`::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-ner] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-ner] + .Properties of ner inference [%collapsible%open] @@ -467,11 +467,11 @@ Example: ["O", "B-PER", "I-PER", "B-ORG", "I-ORG", "B-LOC", "I-LOC", "B-MISC", `results_field`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-results-field] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-results-field] `tokenization`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization] + Refer to <> to review the properties of the `tokenization` object. @@ -479,18 +479,18 @@ properties of the `tokenization` object. `pass_through`::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-pass-through] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-pass-through] + .Properties of pass_through inference [%collapsible%open] ===== `results_field`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-results-field] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-results-field] `tokenization`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization] + Refer to <> to review the properties of the `tokenization` object. @@ -498,7 +498,7 @@ Refer to <> to review the properties of the `question_answering`::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-question-answering] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-question-answering] + .Properties of question_answering inference [%collapsible%open] @@ -509,11 +509,11 @@ The maximum amount of words in the answer. Defaults to `15`. `results_field`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-results-field] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-results-field] `tokenization`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization] + Recommended to set `max_sentence_length` to `386` with `128` of `span` and set `truncate` to `none`. @@ -531,16 +531,16 @@ Regression configuration for inference. ===== `num_top_feature_importance_values`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-regression-num-top-feature-importance-values] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-regression-num-top-feature-importance-values] `results_field`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-results-field] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-results-field] ===== `text_classification`::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-text-classification] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-text-classification] + .Properties of text_classification inference [%collapsible%open] @@ -555,11 +555,11 @@ Specifies the number of top class predictions to return. Defaults to all classes `results_field`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-results-field] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-results-field] `tokenization`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization] + Refer to <> to review the properties of the `tokenization` object. @@ -567,22 +567,22 @@ Refer to <> to review the properties of the `text_embedding`::: (Object, optional) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-text-embedding] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-text-embedding] + .Properties of text_embedding inference [%collapsible%open] ===== `embedding_size`:::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-text-embedding-size] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-text-embedding-size] `results_field`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-results-field] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-results-field] `tokenization`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization] + Refer to <> to review the properties of the `tokenization` object. @@ -590,18 +590,18 @@ Refer to <> to review the properties of the `text_similarity`:::: (Object, optional) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-text-similarity] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-text-similarity] + .Properties of text_similarity inference [%collapsible%open] ===== `span_score_combination_function`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-text-similarity-span-score-func] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-text-similarity-span-score-func] `tokenization`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization] + Refer to <> to review the properties of the `tokenization` object. @@ -609,34 +609,34 @@ Refer to <> to review the properties of the `zero_shot_classification`::: (Object, optional) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-zero-shot-classification] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-zero-shot-classification] + .Properties of zero_shot_classification inference [%collapsible%open] ===== `classification_labels`:::: (Required, array) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-zero-shot-classification-classification-labels] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-zero-shot-classification-classification-labels] `hypothesis_template`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-zero-shot-classification-hypothesis-template] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-zero-shot-classification-hypothesis-template] `labels`:::: (Optional, array) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-zero-shot-classification-labels] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-zero-shot-classification-labels] `multi_label`:::: (Optional, boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-zero-shot-classification-multi-label] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-zero-shot-classification-multi-label] `results_field`:::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-results-field] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-results-field] `tokenization`:::: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization] + Refer to <> to review the properties of the `tokenization` object. @@ -748,134 +748,134 @@ The `tokenization` object has the following properties. `bert`:: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert] + .Properties of bert [%collapsible%open] ==== `do_lower_case`::: (Optional, boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-do-lower-case] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-do-lower-case] `max_sequence_length`::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-max-sequence-length] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-max-sequence-length] `span`::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-span] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-span] `truncate`::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] `with_special_tokens`::: (Optional, boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert-with-special-tokens] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert-with-special-tokens] ==== `roberta`:: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta] + .Properties of roberta [%collapsible%open] ==== `add_prefix_space`::: (Optional, boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta-add-prefix-space] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta-add-prefix-space] `max_sequence_length`::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-max-sequence-length] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-max-sequence-length] `span`::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-span] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-span] `truncate`::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] `with_special_tokens`::: (Optional, boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta-with-special-tokens] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta-with-special-tokens] ==== `mpnet`:: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-mpnet] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-mpnet] + .Properties of mpnet [%collapsible%open] ==== `do_lower_case`::: (Optional, boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-do-lower-case] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-do-lower-case] `max_sequence_length`::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-max-sequence-length] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-max-sequence-length] `span`::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-span] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-span] `truncate`::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] `with_special_tokens`::: (Optional, boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-mpnet-with-special-tokens] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-mpnet-with-special-tokens] ==== `xlm_roberta`:: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-xlm-roberta] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-xlm-roberta] + .Properties of xlm_roberta [%collapsible%open] ==== `max_sequence_length`::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-max-sequence-length] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-max-sequence-length] `span`::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-span] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-span] `truncate`::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] `with_special_tokens`::: (Optional, boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta-with-special-tokens] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-roberta-with-special-tokens] ==== `bert_ja`:: (Optional, object) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert-ja] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert-ja] + .Properties of bert_ja [%collapsible%open] ==== `do_lower_case`::: (Optional, boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-do-lower-case] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-do-lower-case] `max_sequence_length`::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-max-sequence-length] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-max-sequence-length] `span`::: (Optional, integer) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-span] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-span] `truncate`::: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-truncate] `with_special_tokens`::: (Optional, boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert-ja-with-special-tokens] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert-ja-with-special-tokens] ==== diff --git a/docs/reference/ml/trained-models/apis/start-trained-model-deployment.asciidoc b/docs/reference/ml/trained-models/apis/start-trained-model-deployment.asciidoc index 5771579cfaf3..50754ac55443 100644 --- a/docs/reference/ml/trained-models/apis/start-trained-model-deployment.asciidoc +++ b/docs/reference/ml/trained-models/apis/start-trained-model-deployment.asciidoc @@ -53,7 +53,7 @@ the node's allocated processors. ``:: (Required, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=model-id] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=model-id] [[start-trained-model-deployment-query-params]] == {api-query-parms-title} @@ -67,7 +67,7 @@ cache, `0b` can be provided. `deployment_id`:: (Optional, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=deployment-id] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=deployment-id] Defaults to `model_id`. `number_of_allocations`:: diff --git a/docs/reference/ml/trained-models/apis/stop-trained-model-deployment.asciidoc b/docs/reference/ml/trained-models/apis/stop-trained-model-deployment.asciidoc index 335d76ffcd56..622b440622cd 100644 --- a/docs/reference/ml/trained-models/apis/stop-trained-model-deployment.asciidoc +++ b/docs/reference/ml/trained-models/apis/stop-trained-model-deployment.asciidoc @@ -29,7 +29,7 @@ Deployment is required only for trained models that have a PyTorch `model_type`. ``:: (Required, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=deployment-id] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=deployment-id] [[stop-trained-model-deployment-query-params]] @@ -37,7 +37,7 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=deployment-id] `allow_no_match`:: (Optional, Boolean) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-no-match-deployments] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=allow-no-match-deployments] `force`:: (Optional, Boolean) If true, the deployment is stopped even if it or one of its diff --git a/docs/reference/ml/trained-models/apis/update-trained-model-deployment.asciidoc b/docs/reference/ml/trained-models/apis/update-trained-model-deployment.asciidoc index 1b5f94cceeaf..93547c1d3e9b 100644 --- a/docs/reference/ml/trained-models/apis/update-trained-model-deployment.asciidoc +++ b/docs/reference/ml/trained-models/apis/update-trained-model-deployment.asciidoc @@ -34,7 +34,7 @@ You can either increase or decrease the number of allocations of such a deployme ``:: (Required, string) -include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=deployment-id] +include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=deployment-id] [[update-trained-model-deployment-request-body]] == {api-request-body-title} diff --git a/docs/reference/modules/cluster/misc.asciidoc b/docs/reference/modules/cluster/misc.asciidoc index 7eb1cf357498..3da5df4f1641 100644 --- a/docs/reference/modules/cluster/misc.asciidoc +++ b/docs/reference/modules/cluster/misc.asciidoc @@ -163,7 +163,7 @@ increase it if you expect nodes to be absent from the cluster and miss more than 500 deletes. We think that is rare, thus the default. Tombstones don't take up much space, but we also think that a number like 50,000 is probably too big. -include::{es-repo-dir}/indices/dangling-indices-list.asciidoc[tag=dangling-index-description] +include::{es-ref-dir}/indices/dangling-indices-list.asciidoc[tag=dangling-index-description] You can use the <> to manage this situation. diff --git a/docs/reference/modules/cluster/remote-clusters-api-key.asciidoc b/docs/reference/modules/cluster/remote-clusters-api-key.asciidoc index 0cac52deaae4..506e834e0b1c 100644 --- a/docs/reference/modules/cluster/remote-clusters-api-key.asciidoc +++ b/docs/reference/modules/cluster/remote-clusters-api-key.asciidoc @@ -198,4 +198,4 @@ Configuring the `remote_cluster_client` settings in `elasticsearch.yml` still re include::remote-clusters-connect.asciidoc[] :!trust-mechanism: -include::{es-repo-dir}/security/authentication/remote-clusters-privileges-api-key.asciidoc[leveloffset=+1] +include::{es-ref-dir}/security/authentication/remote-clusters-privileges-api-key.asciidoc[leveloffset=+1] diff --git a/docs/reference/modules/cluster/remote-clusters-cert.asciidoc b/docs/reference/modules/cluster/remote-clusters-cert.asciidoc index 11d71955cfe6..6602c807f5b6 100644 --- a/docs/reference/modules/cluster/remote-clusters-cert.asciidoc +++ b/docs/reference/modules/cluster/remote-clusters-cert.asciidoc @@ -80,4 +80,4 @@ generate certificates for all nodes simplifies this task. include::remote-clusters-connect.asciidoc[] :!trust-mechanism: -include::{es-repo-dir}/security/authentication/remote-clusters-privileges-cert.asciidoc[leveloffset=+1] \ No newline at end of file +include::{es-ref-dir}/security/authentication/remote-clusters-privileges-cert.asciidoc[leveloffset=+1] \ No newline at end of file diff --git a/docs/reference/modules/indices/index_management.asciidoc b/docs/reference/modules/indices/index_management.asciidoc index cdb8af570c6d..5f7274b2271d 100644 --- a/docs/reference/modules/indices/index_management.asciidoc +++ b/docs/reference/modules/indices/index_management.asciidoc @@ -46,9 +46,9 @@ to `true`. This setting affects the following built-in index templates: -include::{es-repo-dir}/indices/index-templates.asciidoc[tag=built-in-index-template-patterns] +include::{es-ref-dir}/indices/index-templates.asciidoc[tag=built-in-index-template-patterns] This setting also affects the following built-in component templates: -include::{es-repo-dir}/indices/put-component-template.asciidoc[tag=built-in-component-templates] +include::{es-ref-dir}/indices/put-component-template.asciidoc[tag=built-in-component-templates] -- diff --git a/docs/reference/modules/node.asciidoc b/docs/reference/modules/node.asciidoc index 8a42d11f6367..81df2cf4a2a6 100644 --- a/docs/reference/modules/node.asciidoc +++ b/docs/reference/modules/node.asciidoc @@ -253,7 +253,7 @@ node.roles: [ data ] ===== Content data node Content data nodes are part of the content tier. -include::{es-repo-dir}/datatiers.asciidoc[tag=content-tier] +include::{es-ref-dir}/datatiers.asciidoc[tag=content-tier] To create a dedicated content node, set: [source,yaml] @@ -265,7 +265,7 @@ node.roles: [ data_content ] ===== Hot data node Hot data nodes are part of the hot tier. -include::{es-repo-dir}/datatiers.asciidoc[tag=hot-tier] +include::{es-ref-dir}/datatiers.asciidoc[tag=hot-tier] To create a dedicated hot node, set: [source,yaml] @@ -277,7 +277,7 @@ node.roles: [ data_hot ] ===== Warm data node Warm data nodes are part of the warm tier. -include::{es-repo-dir}/datatiers.asciidoc[tag=warm-tier] +include::{es-ref-dir}/datatiers.asciidoc[tag=warm-tier] To create a dedicated warm node, set: [source,yaml] @@ -289,7 +289,7 @@ node.roles: [ data_warm ] ===== Cold data node Cold data nodes are part of the cold tier. -include::{es-repo-dir}/datatiers.asciidoc[tag=cold-tier] +include::{es-ref-dir}/datatiers.asciidoc[tag=cold-tier] To create a dedicated cold node, set: [source,yaml] @@ -301,7 +301,7 @@ node.roles: [ data_cold ] ===== Frozen data node Frozen data nodes are part of the frozen tier. -include::{es-repo-dir}/datatiers.asciidoc[tag=frozen-tier] +include::{es-ref-dir}/datatiers.asciidoc[tag=frozen-tier] To create a dedicated frozen node, set: [source,yaml] diff --git a/docs/reference/query-dsl/knn-query.asciidoc b/docs/reference/query-dsl/knn-query.asciidoc index 56f90c7d5da0..b7ded6929ed2 100644 --- a/docs/reference/query-dsl/knn-query.asciidoc +++ b/docs/reference/query-dsl/knn-query.asciidoc @@ -96,7 +96,7 @@ Either this or `query_vector_builder` must be provided. + -- (Optional, object) Query vector builder. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=knn-query-vector-builder] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=knn-query-vector-builder] -- diff --git a/docs/reference/query-dsl/script-score-query.asciidoc b/docs/reference/query-dsl/script-score-query.asciidoc index 08522708554f..9291b8c15f0d 100644 --- a/docs/reference/query-dsl/script-score-query.asciidoc +++ b/docs/reference/query-dsl/script-score-query.asciidoc @@ -335,7 +335,7 @@ through a script: The `script_score` query has equivalent <> that can be used in scripts. -include::{es-repo-dir}/vectors/vector-functions.asciidoc[] +include::{es-ref-dir}/vectors/vector-functions.asciidoc[] [[score-explanation]] ===== Explain request diff --git a/docs/reference/repositories-metering-api/apis/clear-repositories-metering-archive.asciidoc b/docs/reference/repositories-metering-api/apis/clear-repositories-metering-archive.asciidoc index 991b015f6356..addcd65f0e84 100644 --- a/docs/reference/repositories-metering-api/apis/clear-repositories-metering-archive.asciidoc +++ b/docs/reference/repositories-metering-api/apis/clear-repositories-metering-archive.asciidoc @@ -26,7 +26,7 @@ You can use this API to clear the archived repositories metering information in [[clear-repositories-metering-archive-api-path-params]] ==== {api-path-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=node-id] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=node-id] ``:: (long) Specifies the maximum <> to be cleared from the archive. @@ -37,4 +37,4 @@ All the nodes selective options are explained <>. ==== {api-response-body-title} Returns the deleted archived repositories metering information. -include::{es-repo-dir}/repositories-metering-api/apis/repositories-meterings-body.asciidoc[tag=repositories-metering-body] +include::{es-ref-dir}/repositories-metering-api/apis/repositories-meterings-body.asciidoc[tag=repositories-metering-body] diff --git a/docs/reference/repositories-metering-api/apis/get-repositories-metering.asciidoc b/docs/reference/repositories-metering-api/apis/get-repositories-metering.asciidoc index 4e7eb876ad72..314f85a7dba5 100644 --- a/docs/reference/repositories-metering-api/apis/get-repositories-metering.asciidoc +++ b/docs/reference/repositories-metering-api/apis/get-repositories-metering.asciidoc @@ -30,11 +30,11 @@ exposed by this API is volatile, meaning that it won't be present after node res [[get-repositories-metering-api-path-params]] ==== {api-path-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=node-id] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=node-id] All the nodes selective options are explained <>. [role="child_attributes"] [[get-repositories-metering-api-response-body]] ==== {api-response-body-title} -include::{es-repo-dir}/repositories-metering-api/apis/repositories-meterings-body.asciidoc[tag=repositories-metering-body] +include::{es-ref-dir}/repositories-metering-api/apis/repositories-meterings-body.asciidoc[tag=repositories-metering-body] diff --git a/docs/reference/rest-api/common-parms.asciidoc b/docs/reference/rest-api/common-parms.asciidoc index 39d9e90079bf..e63f66217d8d 100644 --- a/docs/reference/rest-api/common-parms.asciidoc +++ b/docs/reference/rest-api/common-parms.asciidoc @@ -1180,7 +1180,7 @@ tag::target-index[] (Required, string) Name of the target index to create. -include::{es-repo-dir}/indices/create-index.asciidoc[tag=index-name-reqs] +include::{es-ref-dir}/indices/create-index.asciidoc[tag=index-name-reqs] -- end::target-index[] diff --git a/docs/reference/rest-api/defs.asciidoc b/docs/reference/rest-api/defs.asciidoc index a80d4a42eb30..52b05daaefd5 100644 --- a/docs/reference/rest-api/defs.asciidoc +++ b/docs/reference/rest-api/defs.asciidoc @@ -8,4 +8,4 @@ to {security-features}. * <> -include::{es-repo-dir}/rest-api/security/role-mapping-resources.asciidoc[] +include::{es-ref-dir}/rest-api/security/role-mapping-resources.asciidoc[] diff --git a/docs/reference/rest-api/index.asciidoc b/docs/reference/rest-api/index.asciidoc index fa0d3babb3a0..50c9f96ad81b 100644 --- a/docs/reference/rest-api/index.asciidoc +++ b/docs/reference/rest-api/index.asciidoc @@ -60,52 +60,52 @@ not be included yet. * <> -- -include::{es-repo-dir}/api-conventions.asciidoc[] -include::{es-repo-dir}/rest-api/common-options.asciidoc[] -include::{es-repo-dir}/rest-api/rest-api-compatibility.asciidoc[] -include::{es-repo-dir}/autoscaling/apis/autoscaling-apis.asciidoc[] -include::{es-repo-dir}/behavioral-analytics/apis/index.asciidoc[] -include::{es-repo-dir}/cat.asciidoc[] -include::{es-repo-dir}/cluster.asciidoc[] -include::{es-repo-dir}/ccr/apis/ccr-apis.asciidoc[] -include::{es-repo-dir}/connector/apis/connector-apis.asciidoc[] -include::{es-repo-dir}/data-streams/data-stream-apis.asciidoc[] -include::{es-repo-dir}/docs.asciidoc[] -include::{es-repo-dir}/ingest/apis/enrich/index.asciidoc[] -include::{es-repo-dir}/eql/eql-apis.asciidoc[] -include::{es-repo-dir}/esql/esql-apis.asciidoc[] -include::{es-repo-dir}/features/apis/features-apis.asciidoc[] -include::{es-repo-dir}/fleet/index.asciidoc[] -include::{es-repo-dir}/graph/explore.asciidoc[] -include::{es-repo-dir}/indices.asciidoc[] -include::{es-repo-dir}/ilm/apis/ilm-api.asciidoc[] -include::{es-repo-dir}/inference/inference-apis.asciidoc[] +include::{es-ref-dir}/api-conventions.asciidoc[] +include::{es-ref-dir}/rest-api/common-options.asciidoc[] +include::{es-ref-dir}/rest-api/rest-api-compatibility.asciidoc[] +include::{es-ref-dir}/autoscaling/apis/autoscaling-apis.asciidoc[] +include::{es-ref-dir}/behavioral-analytics/apis/index.asciidoc[] +include::{es-ref-dir}/cat.asciidoc[] +include::{es-ref-dir}/cluster.asciidoc[] +include::{es-ref-dir}/ccr/apis/ccr-apis.asciidoc[] +include::{es-ref-dir}/connector/apis/connector-apis.asciidoc[] +include::{es-ref-dir}/data-streams/data-stream-apis.asciidoc[] +include::{es-ref-dir}/docs.asciidoc[] +include::{es-ref-dir}/ingest/apis/enrich/index.asciidoc[] +include::{es-ref-dir}/eql/eql-apis.asciidoc[] +include::{es-ref-dir}/esql/esql-apis.asciidoc[] +include::{es-ref-dir}/features/apis/features-apis.asciidoc[] +include::{es-ref-dir}/fleet/index.asciidoc[] +include::{es-ref-dir}/graph/explore.asciidoc[] +include::{es-ref-dir}/indices.asciidoc[] +include::{es-ref-dir}/ilm/apis/ilm-api.asciidoc[] +include::{es-ref-dir}/inference/inference-apis.asciidoc[] include::info.asciidoc[] -include::{es-repo-dir}/ingest/apis/index.asciidoc[] -include::{es-repo-dir}/licensing/index.asciidoc[] -include::{es-repo-dir}/rest-api/logstash/index.asciidoc[] -include::{es-repo-dir}/ml/common/apis/index.asciidoc[] -include::{es-repo-dir}/ml/anomaly-detection/apis/index.asciidoc[] -include::{es-repo-dir}/ml/df-analytics/apis/index.asciidoc[] -include::{es-repo-dir}/ml/trained-models/apis/index.asciidoc[] -include::{es-repo-dir}/migration/migration.asciidoc[] -include::{es-repo-dir}/shutdown/apis/shutdown-api.asciidoc[] -include::{es-repo-dir}/query-rules/apis/index.asciidoc[] -include::{es-repo-dir}/indices/apis/reload-analyzers.asciidoc[] -include::{es-repo-dir}/repositories-metering-api/repositories-metering-apis.asciidoc[] -include::{es-repo-dir}/rollup/rollup-apis.asciidoc[] -include::{es-repo-dir}/rest-api/root.asciidoc[] -include::{es-repo-dir}/scripting/apis/script-apis.asciidoc[] -include::{es-repo-dir}/search.asciidoc[] -include::{es-repo-dir}/search-application/apis/index.asciidoc[] -include::{es-repo-dir}/searchable-snapshots/apis/searchable-snapshots-apis.asciidoc[] -include::{es-repo-dir}/rest-api/security.asciidoc[] -include::{es-repo-dir}/snapshot-restore/apis/snapshot-restore-apis.asciidoc[] -include::{es-repo-dir}/slm/apis/slm-api.asciidoc[] -include::{es-repo-dir}/sql/apis/sql-apis.asciidoc[] -include::{es-repo-dir}/synonyms/apis/synonyms-apis.asciidoc[] -include::{es-repo-dir}/text-structure/apis/index.asciidoc[] -include::{es-repo-dir}/transform/apis/index.asciidoc[] +include::{es-ref-dir}/ingest/apis/index.asciidoc[] +include::{es-ref-dir}/licensing/index.asciidoc[] +include::{es-ref-dir}/rest-api/logstash/index.asciidoc[] +include::{es-ref-dir}/ml/common/apis/index.asciidoc[] +include::{es-ref-dir}/ml/anomaly-detection/apis/index.asciidoc[] +include::{es-ref-dir}/ml/df-analytics/apis/index.asciidoc[] +include::{es-ref-dir}/ml/trained-models/apis/index.asciidoc[] +include::{es-ref-dir}/migration/migration.asciidoc[] +include::{es-ref-dir}/shutdown/apis/shutdown-api.asciidoc[] +include::{es-ref-dir}/query-rules/apis/index.asciidoc[] +include::{es-ref-dir}/indices/apis/reload-analyzers.asciidoc[] +include::{es-ref-dir}/repositories-metering-api/repositories-metering-apis.asciidoc[] +include::{es-ref-dir}/rollup/rollup-apis.asciidoc[] +include::{es-ref-dir}/rest-api/root.asciidoc[] +include::{es-ref-dir}/scripting/apis/script-apis.asciidoc[] +include::{es-ref-dir}/search.asciidoc[] +include::{es-ref-dir}/search-application/apis/index.asciidoc[] +include::{es-ref-dir}/searchable-snapshots/apis/searchable-snapshots-apis.asciidoc[] +include::{es-ref-dir}/rest-api/security.asciidoc[] +include::{es-ref-dir}/snapshot-restore/apis/snapshot-restore-apis.asciidoc[] +include::{es-ref-dir}/slm/apis/slm-api.asciidoc[] +include::{es-ref-dir}/sql/apis/sql-apis.asciidoc[] +include::{es-ref-dir}/synonyms/apis/synonyms-apis.asciidoc[] +include::{es-ref-dir}/text-structure/apis/index.asciidoc[] +include::{es-ref-dir}/transform/apis/index.asciidoc[] include::usage.asciidoc[] -include::{es-repo-dir}/rest-api/watcher.asciidoc[] +include::{es-ref-dir}/rest-api/watcher.asciidoc[] include::defs.asciidoc[] diff --git a/docs/reference/rest-api/security/disable-user-profile.asciidoc b/docs/reference/rest-api/security/disable-user-profile.asciidoc index a25b4a311aa8..35658f071679 100644 --- a/docs/reference/rest-api/security/disable-user-profile.asciidoc +++ b/docs/reference/rest-api/security/disable-user-profile.asciidoc @@ -45,7 +45,7 @@ To re-enable a disabled user profile, use the [[security-api-disable-user-profile-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=refresh] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=refresh] diff --git a/docs/reference/rest-api/security/enable-user-profile.asciidoc b/docs/reference/rest-api/security/enable-user-profile.asciidoc index c61e847cfd1f..e27673b07f59 100644 --- a/docs/reference/rest-api/security/enable-user-profile.asciidoc +++ b/docs/reference/rest-api/security/enable-user-profile.asciidoc @@ -42,7 +42,7 @@ enable user profile API to make the profile visible in these searches again. [[security-api-enable-user-profile-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=refresh] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=refresh] [[security-api-enable-user-profile-example]] ==== {api-examples-title} diff --git a/docs/reference/rest-api/security/query-api-key.asciidoc b/docs/reference/rest-api/security/query-api-key.asciidoc index ad4184ec34a2..5760968cc7e9 100644 --- a/docs/reference/rest-api/security/query-api-key.asciidoc +++ b/docs/reference/rest-api/security/query-api-key.asciidoc @@ -242,7 +242,7 @@ This supports only a subset of aggregation types, namely: <>, and <>. Additionally, aggregations only run over the same subset of fields that `query` works with. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=from] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=from] + By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters. To page through more hits, use the diff --git a/docs/reference/rest-api/security/query-user.asciidoc b/docs/reference/rest-api/security/query-user.asciidoc index 92c293d1fe59..d0c7b44faf3b 100644 --- a/docs/reference/rest-api/security/query-user.asciidoc +++ b/docs/reference/rest-api/security/query-user.asciidoc @@ -70,7 +70,7 @@ Specifies whether the user is enabled. (Optional, boolean) Determines whether to retrieve the <> `uid`, if exists, for the users. Defaults to `false`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=from] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=from] + By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters. To page through more hits, use the diff --git a/docs/reference/rest-api/security/update-user-profile-data.asciidoc b/docs/reference/rest-api/security/update-user-profile-data.asciidoc index d4c89558c3fc..01fa5e11d10e 100644 --- a/docs/reference/rest-api/security/update-user-profile-data.asciidoc +++ b/docs/reference/rest-api/security/update-user-profile-data.asciidoc @@ -48,11 +48,11 @@ the allowed namespaces. [[security-api-update-user-profile-data-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=if_seq_no] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=if_seq_no] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=if_primary_term] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=if_primary_term] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=refresh] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=refresh] `uid`:: (Required, string) A unique identifier for the user profile. diff --git a/docs/reference/rest-api/usage.asciidoc b/docs/reference/rest-api/usage.asciidoc index bbbd73a0523f..6bdfaab17a4d 100644 --- a/docs/reference/rest-api/usage.asciidoc +++ b/docs/reference/rest-api/usage.asciidoc @@ -28,7 +28,7 @@ available under the current license and some usage statistics. [[usage-api-query-parms]] === {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] [discrete] [[usage-api-example]] diff --git a/docs/reference/rest-api/watcher/start.asciidoc b/docs/reference/rest-api/watcher/start.asciidoc index 10811ac0b861..565ef60160a9 100644 --- a/docs/reference/rest-api/watcher/start.asciidoc +++ b/docs/reference/rest-api/watcher/start.asciidoc @@ -27,7 +27,7 @@ information, see <>. [[watcher-api-start-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] //[[watcher-api-start-request-body]] //==== {api-request-body-title} diff --git a/docs/reference/rest-api/watcher/stop.asciidoc b/docs/reference/rest-api/watcher/stop.asciidoc index c06090a3cd99..50acd6e9eb2d 100644 --- a/docs/reference/rest-api/watcher/stop.asciidoc +++ b/docs/reference/rest-api/watcher/stop.asciidoc @@ -27,7 +27,7 @@ information, see <>. [[watcher-api-stop-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] //[[watcher-api-stop-request-body]] //==== {api-request-body-title} diff --git a/docs/reference/scripting/apis/create-stored-script-api.asciidoc b/docs/reference/scripting/apis/create-stored-script-api.asciidoc index 6108831a836b..dab1314e65dc 100644 --- a/docs/reference/scripting/apis/create-stored-script-api.asciidoc +++ b/docs/reference/scripting/apis/create-stored-script-api.asciidoc @@ -67,7 +67,7 @@ the API immediately compiles the script or template in this context. If you specify both this and the `` request path parameter, the API uses the request path parameter. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] [role="child_attributes"] [[create-stored-script-api-request-body]] diff --git a/docs/reference/scripting/apis/delete-stored-script-api.asciidoc b/docs/reference/scripting/apis/delete-stored-script-api.asciidoc index 038d1916f76f..e233922c9a7d 100644 --- a/docs/reference/scripting/apis/delete-stored-script-api.asciidoc +++ b/docs/reference/scripting/apis/delete-stored-script-api.asciidoc @@ -47,4 +47,4 @@ Identifier for the stored script or search template. [[delete-stored-script-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] diff --git a/docs/reference/scripting/apis/get-stored-script-api.asciidoc b/docs/reference/scripting/apis/get-stored-script-api.asciidoc index 6b6f6648a7ed..fffeb24e0331 100644 --- a/docs/reference/scripting/apis/get-stored-script-api.asciidoc +++ b/docs/reference/scripting/apis/get-stored-script-api.asciidoc @@ -55,4 +55,4 @@ Identifier for the stored script or search template. [[get-stored-script-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] diff --git a/docs/reference/scripting/engine.asciidoc b/docs/reference/scripting/engine.asciidoc index 54d85e6e8236..ef062e8afab1 100644 --- a/docs/reference/scripting/engine.asciidoc +++ b/docs/reference/scripting/engine.asciidoc @@ -17,7 +17,7 @@ the document frequency of a provided term. ["source","java",subs="attributes,callouts,macros"] -------------------------------------------------- -include-tagged::{plugins-examples-dir}/script-expert-scoring/src/main/java/org/elasticsearch/example/expertscript/ExpertScriptPlugin.java[expert_engine] +include-tagged::{elasticsearch-root}/plugins/examples/script-expert-scoring/src/main/java/org/elasticsearch/example/expertscript/ExpertScriptPlugin.java[expert_engine] -------------------------------------------------- You can execute the script by specifying its `lang` as `expert_scripts`, and the name diff --git a/docs/reference/search/count.asciidoc b/docs/reference/search/count.asciidoc index 152571a25ec1..399545adf8d1 100644 --- a/docs/reference/search/count.asciidoc +++ b/docs/reference/search/count.asciidoc @@ -56,46 +56,46 @@ this parameter or use `*` or `_all`. [[search-count-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] + Defaults to `true`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=analyzer] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=analyzer] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=analyze_wildcard] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=analyze_wildcard] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=default_operator] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=default_operator] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=df] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=df] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + Defaults to `open`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=ignore_throttled] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=ignore_throttled] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=lenient] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=lenient] `min_score`:: (Optional, float) Sets the minimum `_score` value that documents must have to be included in the result. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=preference] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=preference] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=search-q] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=search-q] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=routing] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=routing] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=terminate_after] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=terminate_after] [[search-count-request-body]] ==== {api-request-body-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=query] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=query] [[search-count-api-example]] diff --git a/docs/reference/search/explain.asciidoc b/docs/reference/search/explain.asciidoc index c9e297c93413..77e2d5bd63ef 100644 --- a/docs/reference/search/explain.asciidoc +++ b/docs/reference/search/explain.asciidoc @@ -59,37 +59,37 @@ Only a single index name can be provided to this parameter. [[search-explain-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=analyzer] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=analyzer] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=analyze_wildcard] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=analyze_wildcard] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=default_operator] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=default_operator] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=df] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=df] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=lenient] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=lenient] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=preference] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=preference] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=search-q] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=search-q] `stored_fields`:: (Optional, string) A comma-separated list of stored fields to return in the response. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=routing] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=routing] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=source] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=source] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=source_excludes] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=source_excludes] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=source_includes] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=source_includes] [[search-explain-api-request-body]] ==== {api-request-body-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=query] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=query] [[search-explain-api-example]] diff --git a/docs/reference/search/field-caps.asciidoc b/docs/reference/search/field-caps.asciidoc index 5fe924d38e02..2ff2b8d18604 100644 --- a/docs/reference/search/field-caps.asciidoc +++ b/docs/reference/search/field-caps.asciidoc @@ -61,17 +61,17 @@ and indices, omit this parameter or use `*` or `_all`. Comma-separated list of fields to retrieve capabilities for. Wildcard (`*`) expressions are supported. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] + Defaults to `true`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + -- Defaults to `open`. -- -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] `include_unmapped`:: (Optional, Boolean) If `true`, unmapped fields that are mapped in one index but not in another are included in the response. Fields that don't have any mapping are never included. diff --git a/docs/reference/search/knn-search.asciidoc b/docs/reference/search/knn-search.asciidoc index 7947c688a807..78e3e13b09fe 100644 --- a/docs/reference/search/knn-search.asciidoc +++ b/docs/reference/search/knn-search.asciidoc @@ -91,7 +91,7 @@ use `*` or `_all`. [[knn-search-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=routing] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=routing] [role="child_attributes"] [[knn-search-api-request-body]] @@ -99,36 +99,36 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=routing] `filter`:: (Optional, <>) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=knn-filter] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=knn-filter] `knn`:: (Required, object) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=knn] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=knn] + .Properties of `knn` object [%collapsible%open] ==== `field`:: (Required, string) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=knn-field] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=knn-field] `k`:: (Optional, integer) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=knn-k] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=knn-k] `num_candidates`:: (Optional, integer) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=knn-num-candidates] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=knn-num-candidates] `query_vector`:: (Required, array of floats or string) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=knn-query-vector] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=knn-query-vector] ==== -include::{es-repo-dir}/search/search.asciidoc[tag=docvalue-fields-def] -include::{es-repo-dir}/search/search.asciidoc[tag=fields-param-def] -include::{es-repo-dir}/search/search.asciidoc[tag=source-filtering-def] -include::{es-repo-dir}/search/search.asciidoc[tag=stored-fields-def] +include::{es-ref-dir}/search/search.asciidoc[tag=docvalue-fields-def] +include::{es-ref-dir}/search/search.asciidoc[tag=fields-param-def] +include::{es-ref-dir}/search/search.asciidoc[tag=source-filtering-def] +include::{es-ref-dir}/search/search.asciidoc[tag=stored-fields-def] [role="child_attributes"] [[knn-search-api-response-body]] diff --git a/docs/reference/search/multi-search-template-api.asciidoc b/docs/reference/search/multi-search-template-api.asciidoc index a680795737ff..c8eea52a6fd9 100644 --- a/docs/reference/search/multi-search-template-api.asciidoc +++ b/docs/reference/search/multi-search-template-api.asciidoc @@ -89,7 +89,7 @@ min(<>, 10)))+. (Optional, Boolean) If `true`, the response returns `hits.total` as an integer. If false, it returns `hits.total` as an object. Defaults to `false`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=search_type] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=search_type] `typed_keys`:: (Optional, Boolean) If `true`, the response prefixes aggregation and suggester diff --git a/docs/reference/search/multi-search.asciidoc b/docs/reference/search/multi-search.asciidoc index 90056d503655..9cafa756f035 100644 --- a/docs/reference/search/multi-search.asciidoc +++ b/docs/reference/search/multi-search.asciidoc @@ -72,7 +72,7 @@ in a cluster, omit this parameter or use `_all` or `*`. [[search-multi-search-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] `ccs_minimize_roundtrips`:: (Optional, Boolean) @@ -80,13 +80,13 @@ If `true`, network roundtrips between the coordinating node and remote clusters are minimized for {ccs} requests. Defaults to `true`. See <>. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + Defaults to `open`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=ignore_throttled] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=ignore_throttled] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] `max_concurrent_searches`:: (Optional, integer) @@ -184,7 +184,7 @@ If `true`, the request does *not* return an error if a wildcard expression or This parameter also applies to <> that point to a missing or index. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + Defaults to `open`. diff --git a/docs/reference/search/rank-eval.asciidoc b/docs/reference/search/rank-eval.asciidoc index e008b9a8aef8..05862ebbbcca 100644 --- a/docs/reference/search/rank-eval.asciidoc +++ b/docs/reference/search/rank-eval.asciidoc @@ -78,17 +78,17 @@ and indices, omit this parameter or use `*` or `_all`. [[search-rank-eval-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] + Defaults to `true`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + -- Defaults to `open`. -- -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] [[search-rank-eval-api-example]] diff --git a/docs/reference/search/retriever.asciidoc b/docs/reference/search/retriever.asciidoc index a872f1866f42..42d2129f0fde 100644 --- a/docs/reference/search/retriever.asciidoc +++ b/docs/reference/search/retriever.asciidoc @@ -46,7 +46,7 @@ where all documents must match this query but do not contribute to the score. + Defines a search after object parameter used for pagination. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=terminate_after] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=terminate_after] `sort`:: + @@ -97,12 +97,12 @@ A kNN retriever returns top documents from a <>) + -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=knn-filter] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=knn-filter] `similarity`:: (Optional, float) + -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=knn-similarity] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=knn-similarity] ===== Restrictions @@ -160,11 +160,11 @@ equally weighting two or more child retrievers. ===== Parameters -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=rrf-retrievers] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=rrf-retrievers] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=rrf-rank-constant] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=rrf-rank-constant] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=rrf-window-size] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=rrf-window-size] ===== Restrictions diff --git a/docs/reference/search/rrf.asciidoc b/docs/reference/search/rrf.asciidoc index 813d1f6557be..96477cdee45f 100644 --- a/docs/reference/search/rrf.asciidoc +++ b/docs/reference/search/rrf.asciidoc @@ -41,11 +41,11 @@ An RRF retriever is an optional object defined as part of a search request's <>. The RRF retriever object contains the following parameters: -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=rrf-retrievers] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=rrf-retrievers] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=rrf-rank-constant] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=rrf-rank-constant] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=rrf-window-size] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=rrf-window-size] An example request using RRF: diff --git a/docs/reference/search/search-shards.asciidoc b/docs/reference/search/search-shards.asciidoc index d0a518865baf..b9646f4d3730 100644 --- a/docs/reference/search/search-shards.asciidoc +++ b/docs/reference/search/search-shards.asciidoc @@ -45,23 +45,23 @@ this parameter or use `*` or `_all`. [[search-shards-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] + Defaults to `true`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + -- Defaults to `open`. -- -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=local] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=local] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=preference] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=preference] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=routing] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=routing] [[search-shards-api-example]] diff --git a/docs/reference/search/search-template-api.asciidoc b/docs/reference/search/search-template-api.asciidoc index 539048a32474..038396e55860 100644 --- a/docs/reference/search/search-template-api.asciidoc +++ b/docs/reference/search/search-template-api.asciidoc @@ -78,7 +78,7 @@ this parameter or use `*`. [[search-template-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] + Defaults to `true`. @@ -86,27 +86,27 @@ Defaults to `true`. (Optional, Boolean) If `true`, network round-trips are minimized for cross-cluster search requests. Defaults to `true`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] `explain`:: (Optional, Boolean) If `true`, the response includes additional details about score computation as part of a hit. Defaults to `false`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=ignore_throttled] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=ignore_throttled] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=preference] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=preference] `rest_total_hits_as_int`:: (Optional, Boolean) If `true`, the response returns `hits.total` as an integer. If false, it returns `hits.total` as an object. Defaults to `false`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=routing] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=routing] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=scroll] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=scroll] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=search_type] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=search_type] `typed_keys`:: (Optional, Boolean) If `true`, the response prefixes aggregation and suggester diff --git a/docs/reference/search/search-vector-tile-api.asciidoc b/docs/reference/search/search-vector-tile-api.asciidoc index 97d2e76e7fcd..2cdc29918a69 100644 --- a/docs/reference/search/search-vector-tile-api.asciidoc +++ b/docs/reference/search/search-vector-tile-api.asciidoc @@ -429,7 +429,7 @@ include::search-vector-tile-api.asciidoc[tag=grid-type] (Optional, object) <> used to filter documents for the search. -include::{es-repo-dir}/search/search.asciidoc[tag=runtime-mappings-def] +include::{es-ref-dir}/search/search.asciidoc[tag=runtime-mappings-def] include::search-vector-tile-api.asciidoc[tag=size] diff --git a/docs/reference/search/search-your-data/knn-search.asciidoc b/docs/reference/search/search-your-data/knn-search.asciidoc index ffac84c11a77..db4b0febb07b 100644 --- a/docs/reference/search/search-your-data/knn-search.asciidoc +++ b/docs/reference/search/search-your-data/knn-search.asciidoc @@ -1041,7 +1041,7 @@ PUT image-index option is not supported. * {blank} -include::{es-repo-dir}/search/knn-search.asciidoc[tag=hnsw-algorithm] +include::{es-ref-dir}/search/knn-search.asciidoc[tag=hnsw-algorithm] NOTE: Approximate kNN search always uses the <> search type in order to gather diff --git a/docs/reference/search/search-your-data/search-across-clusters.asciidoc b/docs/reference/search/search-your-data/search-across-clusters.asciidoc index ee1d9fcae18e..2573722b6d2e 100644 --- a/docs/reference/search/search-your-data/search-across-clusters.asciidoc +++ b/docs/reference/search/search-your-data/search-across-clusters.asciidoc @@ -1366,7 +1366,7 @@ following major version. For example, a local 7.17 cluster can search any remote 8.x cluster. [[ccs-version-compatibility]] -include::{es-repo-dir}/search/search-your-data/ccs-version-compat-matrix.asciidoc[] +include::{es-ref-dir}/search/search-your-data/ccs-version-compat-matrix.asciidoc[] IMPORTANT: For the <>, the local and remote clusters must use the same {es} version if they have versions prior to 7.17.7 (included) or prior to 8.5.1 (included). diff --git a/docs/reference/search/search-your-data/search-with-synonyms.asciidoc b/docs/reference/search/search-your-data/search-with-synonyms.asciidoc index 16952f94890c..596af695b791 100644 --- a/docs/reference/search/search-your-data/search-with-synonyms.asciidoc +++ b/docs/reference/search/search-your-data/search-with-synonyms.asciidoc @@ -47,7 +47,7 @@ An example synonyms file: [source,synonyms] -------------------------------------------------- -include::{es-test-dir}/cluster/config/analysis/synonym.txt[] +include::{elasticsearch-root}/docs/src/test/cluster/config/analysis/synonym.txt[] -------------------------------------------------- To update an existing synonyms set, upload new files to your cluster. diff --git a/docs/reference/search/search-your-data/semantic-search-inference.asciidoc b/docs/reference/search/search-your-data/semantic-search-inference.asciidoc index 53abf0f0458a..e7e16d74764f 100644 --- a/docs/reference/search/search-your-data/semantic-search-inference.asciidoc +++ b/docs/reference/search/search-your-data/semantic-search-inference.asciidoc @@ -20,7 +20,7 @@ review the corresponding instructions. [[infer-service-requirements]] ==== Requirements -include::{es-repo-dir}/tab-widgets/inference-api/infer-api-requirements-widget.asciidoc[] +include::{es-ref-dir}/tab-widgets/inference-api/infer-api-requirements-widget.asciidoc[] [discrete] @@ -29,7 +29,7 @@ include::{es-repo-dir}/tab-widgets/inference-api/infer-api-requirements-widget.a Create an {infer} endpoint by using the <>: -include::{es-repo-dir}/tab-widgets/inference-api/infer-api-task-widget.asciidoc[] +include::{es-ref-dir}/tab-widgets/inference-api/infer-api-task-widget.asciidoc[] [discrete] @@ -41,7 +41,7 @@ that the model will create based on your input text - must be created. The destination index must have a field with the <> field type to index the output of the used model. -include::{es-repo-dir}/tab-widgets/inference-api/infer-api-mapping-widget.asciidoc[] +include::{es-ref-dir}/tab-widgets/inference-api/infer-api-mapping-widget.asciidoc[] [discrete] @@ -52,7 +52,7 @@ Create an <> with an <> and use the model you created above to infer against the data that is being ingested in the pipeline. -include::{es-repo-dir}/tab-widgets/inference-api/infer-api-ingest-pipeline-widget.asciidoc[] +include::{es-ref-dir}/tab-widgets/inference-api/infer-api-ingest-pipeline-widget.asciidoc[] [discrete] @@ -82,7 +82,7 @@ you can see an index named `test-data` with 182469 documents. Create the embeddings from the text by reindexing the data through the {infer} pipeline that uses the chosen model as the inference model. -include::{es-repo-dir}/tab-widgets/inference-api/infer-api-reindex-widget.asciidoc[] +include::{es-ref-dir}/tab-widgets/inference-api/infer-api-reindex-widget.asciidoc[] The call returns a task ID to monitor the progress: @@ -114,4 +114,4 @@ provide the query text and the model you have used to create the embeddings. NOTE: If you cancelled the reindexing process, you run the query only a part of the data which affects the quality of your results. -include::{es-repo-dir}/tab-widgets/inference-api/infer-api-search-widget.asciidoc[] \ No newline at end of file +include::{es-ref-dir}/tab-widgets/inference-api/infer-api-search-widget.asciidoc[] \ No newline at end of file diff --git a/docs/reference/search/search-your-data/semantic-search.asciidoc b/docs/reference/search/search-your-data/semantic-search.asciidoc index f4768e5c3a23..a4d892c98645 100644 --- a/docs/reference/search/search-your-data/semantic-search.asciidoc +++ b/docs/reference/search/search-your-data/semantic-search.asciidoc @@ -64,7 +64,7 @@ important each is. After you decide which model you want to use for implementing semantic search, you need to deploy the model in {es}. -include::{es-repo-dir}/tab-widgets/semantic-search/deploy-nlp-model-widget.asciidoc[] +include::{es-ref-dir}/tab-widgets/semantic-search/deploy-nlp-model-widget.asciidoc[] [discrete] [[semantic-search-field-mappings]] @@ -74,7 +74,7 @@ Before you start using the deployed model to generate embeddings based on your input text, you need to prepare your index mapping first. The mapping of the index depends on the type of model. -include::{es-repo-dir}/tab-widgets/semantic-search/field-mappings-widget.asciidoc[] +include::{es-ref-dir}/tab-widgets/semantic-search/field-mappings-widget.asciidoc[] [discrete] [[semantic-search-generate-embeddings]] @@ -89,7 +89,7 @@ infer against the data ingested through the pipeline. After you created the ingest pipeline with the inference processor, you can ingest your data through it to generate the model output. -include::{es-repo-dir}/tab-widgets/semantic-search/generate-embeddings-widget.asciidoc[] +include::{es-ref-dir}/tab-widgets/semantic-search/generate-embeddings-widget.asciidoc[] Now it is time to perform semantic search! @@ -100,7 +100,7 @@ Now it is time to perform semantic search! Depending on the type of model you have deployed, you can query rank features with a text expansion query, or dense vectors with a kNN search. -include::{es-repo-dir}/tab-widgets/semantic-search/search-widget.asciidoc[] +include::{es-ref-dir}/tab-widgets/semantic-search/search-widget.asciidoc[] [discrete] [[semantic-search-hybrid-search]] @@ -114,7 +114,7 @@ Combining semantic and lexical search into one hybrid search request using but hybrid search using reciprocal rank fusion {blog-ref}improving-information-retrieval-elastic-stack-hybrid[has been shown to perform better in general]. -include::{es-repo-dir}/tab-widgets/semantic-search/hybrid-search-widget.asciidoc[] +include::{es-ref-dir}/tab-widgets/semantic-search/hybrid-search-widget.asciidoc[] [discrete] [[semantic-search-read-more]] diff --git a/docs/reference/search/search.asciidoc b/docs/reference/search/search.asciidoc index 3be30c98261d..15985088a6ff 100644 --- a/docs/reference/search/search.asciidoc +++ b/docs/reference/search/search.asciidoc @@ -56,7 +56,7 @@ IMPORTANT: Several options for this API can be specified using a query parameter or a request body parameter. If both parameters are specified, only the query parameter is used. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] + Defaults to `true`. @@ -70,9 +70,9 @@ no partial results. Defaults to `true`. To override the default for this field, set the `search.default_allow_partial_results` cluster setting to `false`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=analyzer] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=analyzer] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=analyze_wildcard] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=analyze_wildcard] `batched_reduce_size`:: (Optional, integer) The number of shard results that should be reduced at once @@ -86,15 +86,15 @@ shards in the request can be large. Defaults to `512`. coordinating node and the remote clusters are minimized when executing {ccs} (CCS) requests. See <>. Defaults to `true`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=default_operator] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=default_operator] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=df] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=df] `docvalue_fields`:: (Optional, string) A comma-separated list of fields to return as the docvalue representation of a field for each hit. See <>. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + Defaults to `open`. @@ -103,13 +103,13 @@ Defaults to `open`. computation as part of a hit. Defaults to `false`. [[search-from-param]] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=from] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=from] + By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters. To page through more hits, use the <> parameter. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=ignore_throttled] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=ignore_throttled] `include_named_queries_score`:: (Optional, Boolean) If `true`, includes the score contribution from any named queries. @@ -118,9 +118,9 @@ response. Typically, this adds a small overhead to a request. However, using computationally expensive named queries on a large number of hits may add significant overhead. Defaults to `false`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=lenient] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=lenient] `max_concurrent_shard_requests`:: (Optional, integer) Defines the number of concurrent shard requests per node @@ -182,7 +182,7 @@ end::search-preference[] [[search-api-query-params-q]] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=search-q] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=search-q] + You can use the `q` parameter to run a query parameter search. Query parameter searches do not support the full {es} <> but are handy for @@ -201,7 +201,7 @@ level settings. (Optional, Boolean) Indicates whether hits.total should be rendered as an integer or an object in the rest search response. Defaults to `false`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=routing] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=routing] [[search-api-scroll-query-param]] `scroll`:: @@ -275,9 +275,9 @@ Comma-separated list of source fields to return. Wildcard (`*`) patterns are supported. ==== -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=source_excludes] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=source_excludes] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=source_includes] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=source_includes] `stats`:: (Optional, string) Specific `tag` of the request for logging and statistical @@ -322,7 +322,7 @@ returned. This parameter can only be used when the `suggest_field` query string parameter is specified. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=terminate_after] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=terminate_after] + Defaults to `0`, which does not terminate query execution early. @@ -466,7 +466,7 @@ search response. (Optional, Boolean) If `true`, returns detailed information about score computation as part of a hit. Defaults to `false`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=from] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=from] + By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters. To page through more hits, use the @@ -493,30 +493,30 @@ A boost value greater than `1.0` increases the score. A boost value between [[search-api-knn]] `knn`:: (Optional, object or array of objects) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=knn] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=knn] + .Properties of `knn` object [%collapsible%open] ==== `field`:: (Required, string) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=knn-field] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=knn-field] `filter`:: (Optional, <>) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=knn-filter] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=knn-filter] `k`:: (Optional, integer) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=knn-k] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=knn-k] `num_candidates`:: (Optional, integer) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=knn-num-candidates] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=knn-num-candidates] `query_vector`:: (Optional, array of floats) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=knn-query-vector] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=knn-query-vector] `query_vector_builder`:: (Optional, object) @@ -526,7 +526,7 @@ not both. Refer to <> to learn more. `similarity`:: (Optional, float) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=knn-similarity] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=knn-similarity] ==== @@ -714,7 +714,7 @@ aggregation for its associated searches. You can retrieve these stats using the <>. [[request-body-search-terminate-after]] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=terminate_after] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=terminate_after] + Defaults to `0`, which does not terminate query execution early. diff --git a/docs/reference/search/validate.asciidoc b/docs/reference/search/validate.asciidoc index 528e24151c47..ce682e485cd2 100644 --- a/docs/reference/search/validate.asciidoc +++ b/docs/reference/search/validate.asciidoc @@ -41,7 +41,7 @@ request body. search. Supports wildcards (`*`). To search all data streams or indices, omit this parameter or use `*` or `_all`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=query] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=query] [[search-validate-api-query-params]] @@ -51,33 +51,33 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=query] (Optional, Boolean) If `true`, the validation is executed on all shards instead of one random shard per index. Defaults to `false`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] + Defaults to `false`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=analyzer] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=analyzer] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=analyze_wildcard] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=analyze_wildcard] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=default_operator] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=default_operator] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=df] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=df] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] `explain`:: (Optional, Boolean) If `true`, the response returns detailed information if an error has occurred. Defaults to `false`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=lenient] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=lenient] `rewrite`:: (Optional, Boolean) If `true`, returns a more detailed explanation showing the actual Lucene query that will be executed. Defaults to `false`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=search-q] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=search-q] [[search-validate-api-example]] diff --git a/docs/reference/searchable-snapshots/apis/mount-snapshot.asciidoc b/docs/reference/searchable-snapshots/apis/mount-snapshot.asciidoc index 255b78993e1c..ba25cebcd1e1 100644 --- a/docs/reference/searchable-snapshots/apis/mount-snapshot.asciidoc +++ b/docs/reference/searchable-snapshots/apis/mount-snapshot.asciidoc @@ -40,7 +40,7 @@ to mount. [[searchable-snapshots-api-mount-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] `wait_for_completion`:: (Optional, Boolean) If `true`, the request blocks until the operation is complete. diff --git a/docs/reference/searchable-snapshots/apis/node-cache-stats.asciidoc b/docs/reference/searchable-snapshots/apis/node-cache-stats.asciidoc index ce97a912d875..50314b6d36f2 100644 --- a/docs/reference/searchable-snapshots/apis/node-cache-stats.asciidoc +++ b/docs/reference/searchable-snapshots/apis/node-cache-stats.asciidoc @@ -33,7 +33,7 @@ For more information, see <>. [[searchable-snapshots-api-cache-stats-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] [role="child_attributes"] [[searchable-snapshots-api-cache-stats-response-body]] diff --git a/docs/reference/settings/monitoring-settings.asciidoc b/docs/reference/settings/monitoring-settings.asciidoc index a10116005a6b..8fdad409ee98 100644 --- a/docs/reference/settings/monitoring-settings.asciidoc +++ b/docs/reference/settings/monitoring-settings.asciidoc @@ -286,18 +286,18 @@ You can configure the following TLS/SSL settings. +{ssl-prefix}.ssl.supported_protocols+:: (<>) deprecated:[7.16.0] -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-supported-protocols] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-supported-protocols] ifdef::verifies[] +{ssl-prefix}.ssl.verification_mode+:: (<>) deprecated:[7.16.0] Controls the verification of certificates. -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-verification-mode-values] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-verification-mode-values] endif::verifies[] +{ssl-prefix}.ssl.cipher_suites+:: (<>) deprecated:[7.16.0] -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-cipher-suites-values] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-cipher-suites-values] [#{ssl-context}-tls-ssl-key-trusted-certificate-settings] ===== {component} TLS/SSL key and trusted certificate settings @@ -315,23 +315,23 @@ When using PEM encoded files, use the following settings: +{ssl-prefix}.ssl.key+:: (<>) deprecated:[7.16.0] -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-key-pem] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-key-pem] +{ssl-prefix}.ssl.key_passphrase+:: (<>) deprecated:[7.16.0] -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-key-passphrase] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-key-passphrase] +{ssl-prefix}.ssl.secure_key_passphrase+:: (<>) deprecated:[7.16.0] -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-secure-key-passphrase] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-secure-key-passphrase] +{ssl-prefix}.ssl.certificate+:: (<>) deprecated:[7.16.0] -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-certificate] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-certificate] +{ssl-prefix}.ssl.certificate_authorities+:: (<>) deprecated:[7.16.0] -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-certificate-authorities] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-certificate-authorities] ===== Java keystore files @@ -340,35 +340,35 @@ and certificates that should be trusted, use the following settings: +{ssl-prefix}.ssl.keystore.path+:: (<>) deprecated:[7.16.0] -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-path] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-path] +{ssl-prefix}.ssl.keystore.password+:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-password] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-password] +{ssl-prefix}.ssl.keystore.secure_password+:: (<>) deprecated:[7.16.0] -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-secure-password] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-secure-password] +{ssl-prefix}.ssl.keystore.key_password+:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-key-password] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-key-password] +{ssl-prefix}.ssl.keystore.secure_key_password+:: (<>) deprecated:[7.16.0] -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-secure-key-password] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-secure-key-password] +{ssl-prefix}.ssl.truststore.path+:: (<>) deprecated:[7.16.0] -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-path] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-path] +{ssl-prefix}.ssl.truststore.password+:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-password] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-password] +{ssl-prefix}.ssl.truststore.secure_password+:: (<>) deprecated:[7.16.0] -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-secure-password] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-secure-password] [#{ssl-context}-pkcs12-files] ===== PKCS#12 files @@ -380,31 +380,31 @@ PKCS#12 files are configured in the same way as Java keystore files: +{ssl-prefix}.ssl.keystore.path+:: (<>) deprecated:[7.16.0] -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-path] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-path] +{ssl-prefix}.ssl.keystore.type+:: (<>) deprecated:[7.16.0] -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-type-pkcs12] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-type-pkcs12] +{ssl-prefix}.ssl.keystore.password+:: (<>) deprecated:[7.16.0] -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-password] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-password] +{ssl-prefix}.ssl.keystore.secure_password+:: (<>) deprecated:[7.16.0] -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-secure-password] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-secure-password] +{ssl-prefix}.ssl.keystore.key_password+:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-key-password] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-key-password] +{ssl-prefix}.ssl.keystore.secure_key_password+:: (<>) deprecated:[7.16.0] -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-secure-key-password] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-secure-key-password] +{ssl-prefix}.ssl.truststore.path+:: (<>) deprecated:[7.16.0] -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-path] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-path] +{ssl-prefix}.ssl.truststore.type+:: (<>) deprecated:[7.16.0] @@ -413,9 +413,9 @@ Set this to `PKCS12` to indicate that the truststore is a PKCS#12 file. +{ssl-prefix}.ssl.truststore.password+:: (<>) deprecated:[7.16.0] -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-password] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-password] +{ssl-prefix}.ssl.truststore.secure_password+:: (<>) deprecated:[7.16.0] -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-secure-password] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-secure-password] diff --git a/docs/reference/settings/security-settings.asciidoc b/docs/reference/settings/security-settings.asciidoc index ae8bf5d4e900..c620d97fda42 100644 --- a/docs/reference/settings/security-settings.asciidoc +++ b/docs/reference/settings/security-settings.asciidoc @@ -613,90 +613,90 @@ Defaults to `5s` (5 seconds ). `ssl.key`:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-key-pem] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-key-pem] + If the LDAP server requires client authentication, it uses this file. You cannot use this setting and `ssl.keystore.path` at the same time. `ssl.key_passphrase`:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-key-passphrase] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-key-passphrase] `ssl.secure_key_passphrase`:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-secure-key-passphrase] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-secure-key-passphrase] `ssl.certificate`:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-certificate] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-certificate] + This certificate is presented to clients when they connect. `ssl.certificate_authorities`:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-certificate-authorities] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-certificate-authorities] + You cannot use this setting and `ssl.truststore.path` at the same time. `ssl.keystore.path`:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-path] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-path] + You cannot use this setting and `ssl.key` at the same time. `ssl.keystore.type`:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-type-pkcs12] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-type-pkcs12] `ssl.keystore.password`:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-password] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-password] `ssl.keystore.secure_password`:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-secure-password] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-secure-password] `ssl.keystore.key_password`:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-key-password] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-key-password] `ssl.keystore.secure_key_password`:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-secure-key-password] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-secure-key-password] `ssl.truststore.path`:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-path] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-path] + You cannot use this setting and `ssl.certificate_authorities` at the same time. `ssl.truststore.password`:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-password] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-password] `ssl.truststore.secure_password`:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-secure-password] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-secure-password] `ssl.truststore.type`:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-type] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-type] `ssl.verification_mode`:: (<>) Indicates the type of verification when using `ldaps` to protect against man in the middle attacks and certificate forgery. -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-verification-mode-values] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-verification-mode-values] `ssl.supported_protocols`:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-supported-protocols] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-supported-protocols] `ssl.cipher_suites`:: (<>) Specifies the cipher suites that should be supported when communicating with the LDAP server. -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-cipher-suites-values] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-cipher-suites-values] //TBD: Can this be updated to using the Java 11 URL instead or does it have to stay java8? `cache.ttl`:: @@ -915,91 +915,91 @@ Defaults to `5s` (5 seconds ). `ssl.certificate`:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-certificate] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-certificate] + This certificate is presented to clients when they connect. `ssl.certificate_authorities`:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-certificate-authorities] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-certificate-authorities] + You cannot use this setting and `ssl.truststore.path` at the same time. `ssl.key`:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-key-pem] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-key-pem] + If the Active Directory server requires client authentication, it uses this file. You cannot use this setting and `ssl.keystore.path` at the same time. `ssl.key_passphrase`:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-key-passphrase] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-key-passphrase] `ssl.secure_key_passphrase`:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-secure-key-passphrase] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-secure-key-passphrase] `ssl.keystore.key_password`:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-key-password] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-key-password] `ssl.keystore.secure_key_password`:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-secure-key-password] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-secure-key-password] `ssl.keystore.password`:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-password] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-password] `ssl.secure_keystore.password`:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-secure-password] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-secure-password] //TBD: Why/how is this different than `ssl.keystore.secure_password`? `ssl.keystore.path`:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-path] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-path] + You cannot use this setting and `ssl.key` at the same time. `ssl.keystore.type`:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-type-pkcs12] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-type-pkcs12] `ssl.truststore.password`:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-password] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-password] `ssl.truststore.secure_password`:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-secure-password] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-secure-password] `ssl.truststore.path`:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-path] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-path] + You cannot use this setting and `ssl.certificate_authorities` at the same time. `ssl.truststore.type`:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-type] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-type] `ssl.verification_mode`:: (<>) Indicates the type of verification when using `ldaps` to protect against man in the middle attacks and certificate forgery. -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-verification-mode-values] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-verification-mode-values] `ssl.supported_protocols`:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-supported-protocols] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-supported-protocols] `ssl.cipher_suites`:: (<>) Specifies the cipher suites that should be supported when communicating with the Active Directory server. -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-cipher-suites-values] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-cipher-suites-values] //TBD: Can this be updated to using the Java 11 URL instead or does it have to stay java8? `cache.ttl`:: @@ -1060,12 +1060,12 @@ Algorithm for the truststore. Defaults to `SunX509`. `truststore.password`:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-password] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-password] If `truststore.path` is set, this setting is required. `truststore.secure_password`:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-secure-password] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-secure-password] `truststore.path`:: (<>) @@ -1522,91 +1522,91 @@ over https. // tag::saml-ssl-key-tag[] `ssl.key` {ess-icon}:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-key-pem] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-key-pem] // end::saml-ssl-key-tag[] // tag::saml-ssl-key-passphrase-tag[] `ssl.key_passphrase` {ess-icon}:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-key-passphrase] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-key-passphrase] // end::saml-ssl-key-passphrase-tag[] `ssl.secure_key_passphrase`:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-secure-key-passphrase] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-secure-key-passphrase] + You cannot use this setting and `ssl.key_passphrase` at the same time. // tag::saml-ssl-certificate-tag[] `ssl.certificate` {ess-icon}:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-certificate] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-certificate] // end::saml-ssl-certificate-tag[] // tag::saml-ssl-certificate-authorities-tag[] `ssl.certificate_authorities` {ess-icon}:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-certificate-authorities] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-certificate-authorities] // end::saml-ssl-certificate-authorities-tag[] // tag::saml-ssl-keystore-path-tag[] `ssl.keystore.path` {ess-icon}:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-path] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-path] // end::saml-ssl-keystore-path-tag[] // tag::saml-ssl-keystore-type[] `ssl.keystore.type` {ess-icon}:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-type-pkcs12] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-type-pkcs12] // end::saml-ssl-keystore-type[] // tag::saml-ssl-keystore-password-tag[] `ssl.keystore.password` {ess-icon}:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-password] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-password] // end::saml-ssl-keystore-password-tag[] `ssl.keystore.secure_password`:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-secure-password] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-secure-password] + You cannot use this setting and `ssl.keystore.password` at the same time. //TBD: Why is this different name than `ssl.secure_keystore.password` elsewhere in this file? `ssl.keystore.key_password`:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-key-password] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-key-password] + You cannot use this setting and `ssl.keystore.secure_key_password` at the same time. `ssl.keystore.secure_key_password`:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-secure-key-password] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-secure-key-password] You cannot use this setting and `ssl.keystore.key_password` at the same time. // tag::saml-ssl-truststore-path-tag[] `ssl.truststore.path` {ess-icon}:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-path] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-path] // end::saml-ssl-truststore-path-tag[] // tag::saml-ssl-truststore-type-tag[] `ssl.truststore.type` {ess-icon}:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-type] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-type] // end::saml-ssl-truststore-type-tag[] // tag::saml-ssl-truststore-password-tag[] `ssl.truststore.password` {ess-icon}:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-password] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-password] // end::saml-ssl-truststore-password-tag[] `ssl.truststore.secure_password`:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-secure-password] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-secure-password] + This setting cannot be used with `ssl.truststore.password`. @@ -1614,19 +1614,19 @@ This setting cannot be used with `ssl.truststore.password`. `ssl.verification_mode` {ess-icon}:: (<>) Controls the verification of certificates. -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-verification-mode-values] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-verification-mode-values] // end::saml-ssl-verification-mode-tag[] // tag::saml-ssl-supported-prototols-tag[] `ssl.supported_protocols` {ess-icon}:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-supported-protocols] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-supported-protocols] // end::saml-ssl-supported-prototols-tag[] // tag::saml-ssl-cipher-suites-tag[] `ssl.cipher_suites` {ess-icon}:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-cipher-suites-values] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-cipher-suites-values] // end::saml-ssl-cipher-suites-tag[] [discrete] @@ -2008,91 +2008,91 @@ NOTE: These settings are _only_ used for the back-channel communication between // tag::oidc-ssl-key-tag[] `ssl.key` {ess-icon}:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-key-pem] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-key-pem] // end::oidc-ssl-key-tag[] // tag::oidc-ssl-key-passphrase-tag[] `ssl.key_passphrase` {ess-icon}:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-key-passphrase] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-key-passphrase] // end::oidc-ssl-key-passphrase-tag[] `ssl.secure_key_passphrase`:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-secure-key-passphrase] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-secure-key-passphrase] + You cannot use this setting and `ssl.key_passphrase` at the same time. // tag::oidc-ssl-certificate-tag[] `ssl.certificate` {ess-icon}:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-certificate] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-certificate] // end::oidc-ssl-certificate-tag[] // tag::oidc-ssl-certificate-authorities-tag[] `ssl.certificate_authorities` {ess-icon}:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-certificate-authorities] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-certificate-authorities] // end::oidc-ssl-certificate-authorities-tag[] // tag::oidc-ssl-keystore-path-tag[] `ssl.keystore.path` {ess-icon}:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-path] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-path] // end::oidc-ssl-keystore-path-tag[] // tag::oidc-ssl-keystore-type-tag[] `ssl.keystore.type` {ess-icon}:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-type-pkcs12] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-type-pkcs12] // end::oidc-ssl-keystore-type-tag[] // tag::oidc-ssl-keystore-password-tag[] `ssl.keystore.password` {ess-icon}:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-password] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-password] // end::oidc-ssl-keystore-password-tag[] `ssl.keystore.secure_password`:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-secure-password] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-secure-password] + You cannot use this setting and `ssl.keystore.password` at the same time. `ssl.keystore.key_password`:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-key-password] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-key-password] + You cannot use this setting and `ssl.keystore.secure_key_password` at the same time. `ssl.keystore.secure_key_password`:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-secure-key-password] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-secure-key-password] + You cannot use this setting and `ssl.keystore.key_password` at the same time. // tag::oidc-ssl-truststore-path-tag[] `ssl.truststore.path` {ess-icon}:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-path] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-path] // end::oidc-ssl-truststore-path-tag[] // tag::oidc-ssl-truststore-type-tag[] `ssl.truststore.type` {ess-icon}:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-type] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-type] // end::oidc-ssl-truststore-type-tag[] // tag::oidc-ssl-truststore-password-tag[] `ssl.truststore.password` {ess-icon}:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-password] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-password] // end::oidc-ssl-truststore-password-tag[] `ssl.truststore.secure_password`:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-secure-password] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-secure-password] + You cannot use this setting and `ssl.truststore.password` at the same time. @@ -2100,19 +2100,19 @@ You cannot use this setting and `ssl.truststore.password` at the same time. `ssl.verification_mode` {ess-icon}:: (<>) Controls the verification of certificates. -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-verification-mode-values] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-verification-mode-values] // end::oidc-ssl-verification-mode-tag[] // tag::oidc-ssl-supported-protocols-tag[] `ssl.supported_protocols` {ess-icon}:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-supported-protocols] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-supported-protocols] // end::oidc-ssl-supported-protocols-tag[] // tag::oidc-ssl-cipher-suites-tag[] `ssl.cipher_suites` {ess-icon}:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-cipher-suites-values] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-cipher-suites-values] // end::oidc-ssl-cipher-suites-tag[] [[ref-jwt-settings]] @@ -2443,91 +2443,91 @@ NOTE: These settings are _only_ used for the back-channel communication between // tag::jwt-ssl-key-tag[] `ssl.key` {ess-icon}:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-key-pem] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-key-pem] // end::jwt-ssl-key-tag[] // tag::jwt-ssl-key-passphrase-tag[] `ssl.key_passphrase` {ess-icon}:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-key-passphrase] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-key-passphrase] // end::jwt-ssl-key-passphrase-tag[] `ssl.secure_key_passphrase`:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-secure-key-passphrase] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-secure-key-passphrase] + You cannot use this setting and `ssl.key_passphrase` at the same time. // tag::jwt-ssl-certificate-tag[] `ssl.certificate` {ess-icon}:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-certificate] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-certificate] // end::jwt-ssl-certificate-tag[] // tag::jwt-ssl-certificate-authorities-tag[] `ssl.certificate_authorities` {ess-icon}:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-certificate-authorities] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-certificate-authorities] // end::jwt-ssl-certificate-authorities-tag[] // tag::jwt-ssl-keystore-path-tag[] `ssl.keystore.path` {ess-icon}:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-path] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-path] // end::jwt-ssl-keystore-path-tag[] // tag::jwt-ssl-keystore-type-tag[] `ssl.keystore.type` {ess-icon}:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-type-pkcs12] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-type-pkcs12] // end::jwt-ssl-keystore-type-tag[] // tag::jwt-ssl-keystore-password-tag[] `ssl.keystore.password` {ess-icon}:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-password] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-password] // end::jwt-ssl-keystore-password-tag[] `ssl.keystore.secure_password`:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-secure-password] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-secure-password] + You cannot use this setting and `ssl.keystore.password` at the same time. `ssl.keystore.key_password`:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-key-password] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-key-password] + You cannot use this setting and `ssl.keystore.secure_key_password` at the same time. `ssl.keystore.secure_key_password`:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-secure-key-password] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-secure-key-password] + You cannot use this setting and `ssl.keystore.key_password` at the same time. // tag::jwt-ssl-truststore-path-tag[] `ssl.truststore.path` {ess-icon}:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-path] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-path] // end::jwt-ssl-truststore-path-tag[] // tag::jwt-ssl-truststore-type-tag[] `ssl.truststore.type` {ess-icon}:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-type] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-type] // end::jwt-ssl-truststore-type-tag[] // tag::jwt-ssl-truststore-password-tag[] `ssl.truststore.password` {ess-icon}:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-password] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-password] // end::jwt-ssl-truststore-password-tag[] `ssl.truststore.secure_password`:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-secure-password] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-secure-password] + You cannot use this setting and `ssl.truststore.password` at the same time. @@ -2535,19 +2535,19 @@ You cannot use this setting and `ssl.truststore.password` at the same time. `ssl.verification_mode` {ess-icon}:: (<>) Controls the verification of certificates. -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-verification-mode-values] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-verification-mode-values] // end::jwt-ssl-verification-mode-tag[] // tag::jwt-ssl-supported-protocols-tag[] `ssl.supported_protocols` {ess-icon}:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-supported-protocols] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-supported-protocols] // end::jwt-ssl-supported-protocols-tag[] // tag::jwt-ssl-cipher-suites-tag[] `ssl.cipher_suites` {ess-icon}:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-cipher-suites-values] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-cipher-suites-values] // end::jwt-ssl-cipher-suites-tag[] [discrete] diff --git a/docs/reference/settings/ssl-settings.asciidoc b/docs/reference/settings/ssl-settings.asciidoc index 2ab32c1a65c2..1c484a444743 100644 --- a/docs/reference/settings/ssl-settings.asciidoc +++ b/docs/reference/settings/ssl-settings.asciidoc @@ -15,7 +15,7 @@ endif::no-enabled-setting[] +{ssl-prefix}.ssl.supported_protocols+:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-supported-protocols] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-supported-protocols] ifdef::server[] +{ssl-prefix}.ssl.client_authentication+:: @@ -41,11 +41,11 @@ a TLS _server_ is discouraged. endif::verifies[] Defines how to verify the certificates presented by another party in the TLS connection: -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-verification-mode-values] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-verification-mode-values] +{ssl-prefix}.ssl.cipher_suites+:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-cipher-suites-values] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-cipher-suites-values] [#{ssl-context}-tls-ssl-key-trusted-certificate-settings] ===== {component} TLS/SSL key and trusted certificate settings @@ -66,25 +66,25 @@ When using PEM encoded files, use the following settings: +{ssl-prefix}.ssl.key+:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-key-pem] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-key-pem] ifndef::secure-pass[] +{ssl-prefix}.ssl.key_passphrase+:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-key-passphrase] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-key-passphrase] endif::secure-pass[] +{ssl-prefix}.ssl.secure_key_passphrase+:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-secure-key-passphrase] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-secure-key-passphrase] +{ssl-prefix}.ssl.certificate+:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-certificate] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-certificate] +{ssl-prefix}.ssl.certificate_authorities+:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-certificate-authorities] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-certificate-authorities] ===== Java keystore files @@ -93,41 +93,41 @@ and certificates that should be trusted, use the following settings: +{ssl-prefix}.ssl.keystore.path+:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-path] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-path] ifndef::secure-pass[] +{ssl-prefix}.ssl.keystore.password+:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-password] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-password] endif::secure-pass[] +{ssl-prefix}.ssl.keystore.secure_password+:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-secure-password] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-secure-password] ifndef::secure-pass[] +{ssl-prefix}.ssl.keystore.key_password+:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-key-password] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-key-password] endif::secure-pass[] +{ssl-prefix}.ssl.keystore.secure_key_password+:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-secure-key-password] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-secure-key-password] +{ssl-prefix}.ssl.truststore.path+:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-path] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-path] ifndef::secure-pass[] +{ssl-prefix}.ssl.truststore.password+:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-password] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-password] endif::secure-pass[] +{ssl-prefix}.ssl.truststore.secure_password+:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-secure-password] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-secure-password] [#{ssl-context}-pkcs12-files] ===== PKCS#12 files @@ -139,35 +139,35 @@ PKCS#12 files are configured in the same way as Java keystore files: +{ssl-prefix}.ssl.keystore.path+:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-path] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-path] +{ssl-prefix}.ssl.keystore.type+:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-type-pkcs12] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-type-pkcs12] ifndef::secure-pass[] +{ssl-prefix}.ssl.keystore.password+:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-password] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-password] endif::secure-pass[] +{ssl-prefix}.ssl.keystore.secure_password+:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-secure-password] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-secure-password] ifndef::secure-pass[] +{ssl-prefix}.ssl.keystore.key_password+:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-key-password] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-key-password] endif::secure-pass[] +{ssl-prefix}.ssl.keystore.secure_key_password+:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-secure-key-password] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-secure-key-password] +{ssl-prefix}.ssl.truststore.path+:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-path] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-path] +{ssl-prefix}.ssl.truststore.type+:: (<>) @@ -177,10 +177,10 @@ Set this to `PKCS12` to indicate that the truststore is a PKCS#12 file. ifndef::secure-pass[] +{ssl-prefix}.ssl.truststore.password+:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-password] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-password] endif::secure-pass[] +{ssl-prefix}.ssl.truststore.secure_password+:: (<>) -include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-secure-password] +include::{es-ref-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-secure-password] diff --git a/docs/reference/setup/add-nodes.asciidoc b/docs/reference/setup/add-nodes.asciidoc index e65dd0ba7af1..ba749782c092 100644 --- a/docs/reference/setup/add-nodes.asciidoc +++ b/docs/reference/setup/add-nodes.asciidoc @@ -37,7 +37,7 @@ To add a node to a cluster running on multiple machines, you must also set the rest of its cluster. ==== -include::{es-repo-dir}/security/enroll-nodes.asciidoc[] +include::{es-ref-dir}/security/enroll-nodes.asciidoc[] For more information about discovery and shard allocation, refer to <> and <>. diff --git a/docs/reference/setup/configuration.asciidoc b/docs/reference/setup/configuration.asciidoc index 1d111a07f9c2..eea0541b898c 100644 --- a/docs/reference/setup/configuration.asciidoc +++ b/docs/reference/setup/configuration.asciidoc @@ -159,7 +159,7 @@ cluster settings and node settings. The API doesn't require a restart and ensures a setting's value is the same on all nodes. ==== -include::{es-repo-dir}/cluster/update-settings.asciidoc[tag=transient-settings-warning] +include::{es-ref-dir}/cluster/update-settings.asciidoc[tag=transient-settings-warning] // end::cluster-setting-precedence[] -- diff --git a/docs/reference/setup/important-settings/path-settings.asciidoc b/docs/reference/setup/important-settings/path-settings.asciidoc index 3e87d504963a..a0a444ca5090 100644 --- a/docs/reference/setup/important-settings/path-settings.asciidoc +++ b/docs/reference/setup/important-settings/path-settings.asciidoc @@ -18,9 +18,9 @@ data and log to locations outside of `$ES_HOME` by default. Supported `path.data` and `path.logs` values vary by platform: -include::{es-repo-dir}/tab-widgets/customize-data-log-path-widget.asciidoc[] +include::{es-ref-dir}/tab-widgets/customize-data-log-path-widget.asciidoc[] -include::{es-repo-dir}/modules/node.asciidoc[tag=modules-node-data-path-warning-tag] +include::{es-ref-dir}/modules/node.asciidoc[tag=modules-node-data-path-warning-tag] [discrete] ==== Multiple data paths @@ -36,7 +36,7 @@ the node, even if the node’s other paths have available disk space. If you nee additional disk space, we recommend you add a new node rather than additional data paths. -include::{es-repo-dir}/tab-widgets/multi-data-path-widget.asciidoc[] +include::{es-ref-dir}/tab-widgets/multi-data-path-widget.asciidoc[] [discrete] [[mdp-migrate]] diff --git a/docs/reference/setup/install/deb.asciidoc b/docs/reference/setup/install/deb.asciidoc index edaed7c78548..c7e146a5442c 100644 --- a/docs/reference/setup/install/deb.asciidoc +++ b/docs/reference/setup/install/deb.asciidoc @@ -1,6 +1,8 @@ [[deb]] === Install Elasticsearch with Debian Package +:include-xpack: true + The Debian package for Elasticsearch can be <> or from our <>. It can be used to install Elasticsearch on any Debian-based system such as Debian and Ubuntu. diff --git a/docs/reference/setup/install/rpm.asciidoc b/docs/reference/setup/install/rpm.asciidoc index a30c8c313b26..60815d570ab3 100644 --- a/docs/reference/setup/install/rpm.asciidoc +++ b/docs/reference/setup/install/rpm.asciidoc @@ -1,6 +1,8 @@ [[rpm]] === Install Elasticsearch with RPM +:include-xpack: true + The RPM for Elasticsearch can be <> or from our <>. It can be used to install Elasticsearch on any RPM-based system such as OpenSuSE, SLES, Centos, Red Hat, @@ -131,6 +133,8 @@ include::xpack-indices.asciidoc[] endif::include-xpack[] +:include-xpack!: true + [id="{distro}-running-systemd"] include::systemd.asciidoc[] diff --git a/docs/reference/setup/install/targz-start.asciidoc b/docs/reference/setup/install/targz-start.asciidoc index 79c4131a5703..0539c74469e0 100644 --- a/docs/reference/setup/install/targz-start.asciidoc +++ b/docs/reference/setup/install/targz-start.asciidoc @@ -53,4 +53,4 @@ symbolic link. :slash: / -include::{es-repo-dir}/security/enroll-nodes.asciidoc[] \ No newline at end of file +include::{es-ref-dir}/security/enroll-nodes.asciidoc[] \ No newline at end of file diff --git a/docs/reference/setup/install/targz.asciidoc b/docs/reference/setup/install/targz.asciidoc index c3dd6ad354d9..470299abe9ac 100644 --- a/docs/reference/setup/install/targz.asciidoc +++ b/docs/reference/setup/install/targz.asciidoc @@ -1,6 +1,8 @@ [[targz]] === Install {es} from archive on Linux or MacOS +:include-xpack: true + {es} is available as a `.tar.gz` archive for Linux and MacOS. include::license.asciidoc[] diff --git a/docs/reference/setup/install/zip-windows-start.asciidoc b/docs/reference/setup/install/zip-windows-start.asciidoc index 60edbb9ec704..8eb4bfb9afeb 100644 --- a/docs/reference/setup/install/zip-windows-start.asciidoc +++ b/docs/reference/setup/install/zip-windows-start.asciidoc @@ -47,4 +47,4 @@ To stop {es}, press `Ctrl-C`. :slash: \ -include::{es-repo-dir}/security/enroll-nodes.asciidoc[] \ No newline at end of file +include::{es-ref-dir}/security/enroll-nodes.asciidoc[] \ No newline at end of file diff --git a/docs/reference/setup/install/zip-windows.asciidoc b/docs/reference/setup/install/zip-windows.asciidoc index 214feaab16ac..eb84ff149f8b 100644 --- a/docs/reference/setup/install/zip-windows.asciidoc +++ b/docs/reference/setup/install/zip-windows.asciidoc @@ -1,6 +1,8 @@ [[zip-windows]] === Install {es} with `.zip` on Windows +:include-xpack: true + {es} can be installed on Windows using the Windows `.zip` archive. This comes with a `elasticsearch-service.bat` command which will setup {es} to run as a service. diff --git a/docs/reference/setup/logging-config.asciidoc b/docs/reference/setup/logging-config.asciidoc index f6b0ceb2d6ae..7b36b6382c9b 100644 --- a/docs/reference/setup/logging-config.asciidoc +++ b/docs/reference/setup/logging-config.asciidoc @@ -5,7 +5,7 @@ You can use {es}'s application logs to monitor your cluster and diagnose issues. If you run {es} as a service, the default location of the logs varies based on your platform and installation method: -include::{es-repo-dir}/tab-widgets/logging-widget.asciidoc[] +include::{es-ref-dir}/tab-widgets/logging-widget.asciidoc[] If you run {es} from the command line, {es} prints logs to the standard output (`stdout`). diff --git a/docs/reference/setup/restart-cluster.asciidoc b/docs/reference/setup/restart-cluster.asciidoc index 899cc9f46545..9488c6632836 100644 --- a/docs/reference/setup/restart-cluster.asciidoc +++ b/docs/reference/setup/restart-cluster.asciidoc @@ -22,7 +22,7 @@ usage below the <> before to restar . *Disable shard allocation.* + -- -include::{es-repo-dir}/upgrade/disable-shard-alloc.asciidoc[] +include::{es-ref-dir}/upgrade/disable-shard-alloc.asciidoc[] -- // end::disable_shard_alloc[] @@ -72,7 +72,7 @@ or jobs with large model states. . *Shut down all nodes.* + -- -include::{es-repo-dir}/upgrade/shut-down-node.asciidoc[] +include::{es-ref-dir}/upgrade/shut-down-node.asciidoc[] -- . *Perform any needed changes.* @@ -176,7 +176,7 @@ the datafeeds from {kib} or with the <> and === Rolling restart -include::{es-repo-dir}/setup/restart-cluster.asciidoc[tag=disable_shard_alloc] +include::{es-ref-dir}/setup/restart-cluster.asciidoc[tag=disable_shard_alloc] . *Stop non-essential indexing and perform a flush.* (Optional) + @@ -191,7 +191,7 @@ POST /_flush -------------------------------------------------- -- -include::{es-repo-dir}/setup/restart-cluster.asciidoc[tag=stop_ml] +include::{es-ref-dir}/setup/restart-cluster.asciidoc[tag=stop_ml] + -- * If you perform a rolling restart, you can also leave your machine learning @@ -204,7 +204,7 @@ cluster. . *Shut down a single node in case of rolling restart.* + -- -include::{es-repo-dir}/upgrade/shut-down-node.asciidoc[] +include::{es-ref-dir}/upgrade/shut-down-node.asciidoc[] -- . *Perform any needed changes.* @@ -248,4 +248,4 @@ When the node has recovered and the cluster is stable, repeat these steps for each node that needs to be changed. -- -include::{es-repo-dir}/setup/restart-cluster.asciidoc[tag=restart_ml] +include::{es-ref-dir}/setup/restart-cluster.asciidoc[tag=restart_ml] diff --git a/docs/reference/shutdown/apis/shutdown-delete.asciidoc b/docs/reference/shutdown/apis/shutdown-delete.asciidoc index 5129b2f587be..133539adfaa3 100644 --- a/docs/reference/shutdown/apis/shutdown-delete.asciidoc +++ b/docs/reference/shutdown/apis/shutdown-delete.asciidoc @@ -40,7 +40,7 @@ The ID of a node that you prepared for shut down. [[delete-shutdown-api-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] [[delete-shutdown-api-example]] ==== {api-examples-title} diff --git a/docs/reference/shutdown/apis/shutdown-get.asciidoc b/docs/reference/shutdown/apis/shutdown-get.asciidoc index 50fcb45b2f81..264a8dd7be18 100644 --- a/docs/reference/shutdown/apis/shutdown-get.asciidoc +++ b/docs/reference/shutdown/apis/shutdown-get.asciidoc @@ -40,7 +40,7 @@ If no ID is specified, returns the status of all nodes being prepared for shutdo [[get-shutdown-api-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] [[get-shutdown-api-example]] ==== {api-examples-title} diff --git a/docs/reference/shutdown/apis/shutdown-put.asciidoc b/docs/reference/shutdown/apis/shutdown-put.asciidoc index b8af8fb8741d..236367f886ef 100644 --- a/docs/reference/shutdown/apis/shutdown-put.asciidoc +++ b/docs/reference/shutdown/apis/shutdown-put.asciidoc @@ -50,7 +50,7 @@ No error is thrown if you specify an invalid node ID. [[put-shutdown-api-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] [role="child_attributes"] [[put-shutdown-api-request-body]] diff --git a/docs/reference/slm/apis/slm-get-status.asciidoc b/docs/reference/slm/apis/slm-get-status.asciidoc index fa9e2225f26e..d4afbaddb1be 100644 --- a/docs/reference/slm/apis/slm-get-status.asciidoc +++ b/docs/reference/slm/apis/slm-get-status.asciidoc @@ -25,7 +25,7 @@ You halt and restart the {slm-init} plugin with the ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] [[slm-api-get-status-prereqs]] ==== {api-prereq-title} diff --git a/docs/reference/slm/apis/slm-put.asciidoc b/docs/reference/slm/apis/slm-put.asciidoc index 69dfc4af4e84..be265554deef 100644 --- a/docs/reference/slm/apis/slm-put.asciidoc +++ b/docs/reference/slm/apis/slm-put.asciidoc @@ -41,7 +41,7 @@ you want to create or update. [[slm-api-put-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] [role="child_attributes"] [[slm-api-put-request-body]] @@ -55,7 +55,7 @@ Configuration for each snapshot created by the policy. [%collapsible%open] ==== :page-id: put-slm-api -include::{es-repo-dir}/snapshot-restore/apis/create-snapshot-api.asciidoc[tag=snapshot-config] +include::{es-ref-dir}/snapshot-restore/apis/create-snapshot-api.asciidoc[tag=snapshot-config] :!page-id: ==== diff --git a/docs/reference/slm/apis/slm-start.asciidoc b/docs/reference/slm/apis/slm-start.asciidoc index c17132908e41..9d9b8108cb57 100644 --- a/docs/reference/slm/apis/slm-start.asciidoc +++ b/docs/reference/slm/apis/slm-start.asciidoc @@ -30,7 +30,7 @@ Manually starting {slm-init} is only necessary if it has been stopped using the ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] [[slm-api-start-example]] ==== {api-examples-title} diff --git a/docs/reference/slm/apis/slm-stop.asciidoc b/docs/reference/slm/apis/slm-stop.asciidoc index 82b3e1b849ee..253abec7b4d1 100644 --- a/docs/reference/slm/apis/slm-stop.asciidoc +++ b/docs/reference/slm/apis/slm-stop.asciidoc @@ -37,7 +37,7 @@ Use the <> to see if {slm-init} is running. ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] [[slm-api-stop-example]] ==== {api-examples-title} diff --git a/docs/reference/snapshot-restore/apis/clean-up-repo-api.asciidoc b/docs/reference/snapshot-restore/apis/clean-up-repo-api.asciidoc index 2360698e0be8..249e192c0c58 100644 --- a/docs/reference/snapshot-restore/apis/clean-up-repo-api.asciidoc +++ b/docs/reference/snapshot-restore/apis/clean-up-repo-api.asciidoc @@ -48,7 +48,7 @@ Name of the snapshot repository to review and clean up. [[clean-up-snapshot-repo-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] [role="child_attributes"] [[clean-up-snapshot-repo-api-response-body]] diff --git a/docs/reference/snapshot-restore/apis/clone-snapshot-api.asciidoc b/docs/reference/snapshot-restore/apis/clone-snapshot-api.asciidoc index fab734e8413c..590bc7e7410f 100644 --- a/docs/reference/snapshot-restore/apis/clone-snapshot-api.asciidoc +++ b/docs/reference/snapshot-restore/apis/clone-snapshot-api.asciidoc @@ -42,7 +42,7 @@ Name of the snapshot repository that both source and target snapshot belong to. [[clone-snapshot-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] `timeout`:: (Optional, <>) Specifies the period of time to wait for diff --git a/docs/reference/snapshot-restore/apis/create-snapshot-api.asciidoc b/docs/reference/snapshot-restore/apis/create-snapshot-api.asciidoc index 06693dadd387..baa28bb7b0a5 100644 --- a/docs/reference/snapshot-restore/apis/create-snapshot-api.asciidoc +++ b/docs/reference/snapshot-restore/apis/create-snapshot-api.asciidoc @@ -56,7 +56,7 @@ unique within the snapshot repository. [[create-snapshot-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] `wait_for_completion`:: (Optional, Boolean) If `true`, the request returns a response when the snapshot diff --git a/docs/reference/snapshot-restore/apis/delete-repo-api.asciidoc b/docs/reference/snapshot-restore/apis/delete-repo-api.asciidoc index d3ebeeac3c03..2931faf49841 100644 --- a/docs/reference/snapshot-restore/apis/delete-repo-api.asciidoc +++ b/docs/reference/snapshot-restore/apis/delete-repo-api.asciidoc @@ -51,7 +51,7 @@ supported. [[delete-snapshot-repo-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] `timeout`:: (Optional, <>) Specifies the period of time to wait for diff --git a/docs/reference/snapshot-restore/apis/delete-snapshot-api.asciidoc b/docs/reference/snapshot-restore/apis/delete-snapshot-api.asciidoc index 5bc46f54ec13..d1431b8cb670 100644 --- a/docs/reference/snapshot-restore/apis/delete-snapshot-api.asciidoc +++ b/docs/reference/snapshot-restore/apis/delete-snapshot-api.asciidoc @@ -56,7 +56,7 @@ Comma-separated list of snapshot names to delete. Also accepts wildcards (`*`). [[delete-snapshot-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] [[delete-snapshot-api-example]] ==== {api-example-title} diff --git a/docs/reference/snapshot-restore/apis/get-repo-api.asciidoc b/docs/reference/snapshot-restore/apis/get-repo-api.asciidoc index 1f03a44c5e49..cf1b9813c519 100644 --- a/docs/reference/snapshot-restore/apis/get-repo-api.asciidoc +++ b/docs/reference/snapshot-restore/apis/get-repo-api.asciidoc @@ -59,7 +59,7 @@ cluster, omit this parameter or use `*` or `_all`. only. If `false`, the request gets information from the master node. Defaults to `false`. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] [role="child_attributes"] [[get-snapshot-repo-api-response-body]] diff --git a/docs/reference/snapshot-restore/apis/get-snapshot-api.asciidoc b/docs/reference/snapshot-restore/apis/get-snapshot-api.asciidoc index e685badc31d4..622e1ade024b 100644 --- a/docs/reference/snapshot-restore/apis/get-snapshot-api.asciidoc +++ b/docs/reference/snapshot-restore/apis/get-snapshot-api.asciidoc @@ -83,7 +83,7 @@ Set <> to `true` to re [[get-snapshot-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] [[get-snapshot-api-ignore-unavailable]] `ignore_unavailable`:: diff --git a/docs/reference/snapshot-restore/apis/get-snapshot-status-api.asciidoc b/docs/reference/snapshot-restore/apis/get-snapshot-status-api.asciidoc index 150f4dfff48a..d8b03cbc0e88 100644 --- a/docs/reference/snapshot-restore/apis/get-snapshot-status-api.asciidoc +++ b/docs/reference/snapshot-restore/apis/get-snapshot-status-api.asciidoc @@ -134,7 +134,7 @@ currently running snapshots. Wildcards (`*`) are not supported. [[get-snapshot-status-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] `ignore_unavailable`:: (Optional, Boolean) diff --git a/docs/reference/snapshot-restore/apis/put-repo-api.asciidoc b/docs/reference/snapshot-restore/apis/put-repo-api.asciidoc index 1154b970b907..c3e9c0a0904b 100644 --- a/docs/reference/snapshot-restore/apis/put-repo-api.asciidoc +++ b/docs/reference/snapshot-restore/apis/put-repo-api.asciidoc @@ -52,7 +52,7 @@ IMPORTANT: Several options for this API can be specified using a query parameter or a request body parameter. If both parameters are specified, only the query parameter is used. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] `timeout`:: (Optional, <>) Specifies the period of time to wait for diff --git a/docs/reference/snapshot-restore/apis/restore-snapshot-api.asciidoc b/docs/reference/snapshot-restore/apis/restore-snapshot-api.asciidoc index db8923505973..9fe06d73f1a6 100644 --- a/docs/reference/snapshot-restore/apis/restore-snapshot-api.asciidoc +++ b/docs/reference/snapshot-restore/apis/restore-snapshot-api.asciidoc @@ -113,7 +113,7 @@ Name of the snapshot to restore. [[restore-snapshot-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] `wait_for_completion`:: (Optional, Boolean) If `true`, the request returns a response when the restore diff --git a/docs/reference/snapshot-restore/apis/verify-repo-api.asciidoc b/docs/reference/snapshot-restore/apis/verify-repo-api.asciidoc index f0fc659df1a4..9d14e8a426e3 100644 --- a/docs/reference/snapshot-restore/apis/verify-repo-api.asciidoc +++ b/docs/reference/snapshot-restore/apis/verify-repo-api.asciidoc @@ -47,7 +47,7 @@ Name of the snapshot repository to verify. [[verify-snapshot-repo-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] `timeout`:: (Optional, <>) Specifies the period of time to wait for diff --git a/docs/reference/snapshot-restore/repository-read-only-url.asciidoc b/docs/reference/snapshot-restore/repository-read-only-url.asciidoc index 8f9cb7e198f8..53d0c340fcdc 100644 --- a/docs/reference/snapshot-restore/repository-read-only-url.asciidoc +++ b/docs/reference/snapshot-restore/repository-read-only-url.asciidoc @@ -1,7 +1,7 @@ [[snapshots-read-only-repository]] === Read-only URL repository -include::{es-repo-dir}/snapshot-restore/on-prem-repo-type.asciidoc[] +include::{es-ref-dir}/snapshot-restore/on-prem-repo-type.asciidoc[] You can use a URL repository to give a cluster read-only access to a shared file system. Since URL repositories are always read-only, they're a safer and more diff --git a/docs/reference/snapshot-restore/repository-shared-file-system.asciidoc b/docs/reference/snapshot-restore/repository-shared-file-system.asciidoc index 6be49d9d4422..be5347845a2f 100644 --- a/docs/reference/snapshot-restore/repository-shared-file-system.asciidoc +++ b/docs/reference/snapshot-restore/repository-shared-file-system.asciidoc @@ -1,7 +1,7 @@ [[snapshots-filesystem-repository]] === Shared file system repository -include::{es-repo-dir}/snapshot-restore/on-prem-repo-type.asciidoc[] +include::{es-ref-dir}/snapshot-restore/on-prem-repo-type.asciidoc[] Use a shared file system repository to store snapshots on a shared file system. @@ -13,7 +13,7 @@ master and data node. For running clusters, this requires a Supported `path.repo` values vary by platform: -include::{es-repo-dir}/tab-widgets/register-fs-repo-widget.asciidoc[] +include::{es-ref-dir}/tab-widgets/register-fs-repo-widget.asciidoc[] [[filesystem-repository-settings]] ==== Repository settings diff --git a/docs/reference/sql/apis/sql-search-api.asciidoc b/docs/reference/sql/apis/sql-search-api.asciidoc index 596378c5e439..118d7975aefd 100644 --- a/docs/reference/sql/apis/sql-search-api.asciidoc +++ b/docs/reference/sql/apis/sql-search-api.asciidoc @@ -123,7 +123,7 @@ the scroll request. Defaults to `45s` (45 seconds). (Optional, <>) Timeout before the request fails. Defaults to `90s` (90 seconds). -include::{es-repo-dir}/search/search.asciidoc[tag=runtime-mappings-def] +include::{es-ref-dir}/search/search.asciidoc[tag=runtime-mappings-def] [[sql-search-api-time-zone]] `time_zone`:: diff --git a/docs/reference/sql/index.asciidoc b/docs/reference/sql/index.asciidoc index 1d2b2e7fd3ec..2ae7ea78a803 100644 --- a/docs/reference/sql/index.asciidoc +++ b/docs/reference/sql/index.asciidoc @@ -2,7 +2,7 @@ [[xpack-sql]] = SQL -:sql-tests: {xes-repo-dir}/../../plugin/sql/qa/ +:sql-tests: {elasticsearch-root}/x-pack/docs/{lang}/../../plugin/sql/qa/ :sql-specs: {sql-tests}server/src/main/resources/ :jdbc-tests: {sql-tests}jdbc/src/main/java/org/elasticsearch/xpack/sql/qa/jdbc :security-tests: {sql-tests}server/security/src/test/java/org/elasticsearch/xpack/sql/qa/security diff --git a/docs/reference/sql/security.asciidoc b/docs/reference/sql/security.asciidoc index b57179742700..a440ae69d8da 100644 --- a/docs/reference/sql/security.asciidoc +++ b/docs/reference/sql/security.asciidoc @@ -44,7 +44,7 @@ APIs to view or edit a role defined in `roles.yml`. This example configures a role that can run SQL in JDBC querying the `test` index: -include::{es-repo-dir}/rest-api/security/create-roles.asciidoc[tag=sql-queries-permission] +include::{es-ref-dir}/rest-api/security/create-roles.asciidoc[tag=sql-queries-permission] [discrete] [[sql-role-file-example]] diff --git a/docs/reference/tab-widgets/ilm.asciidoc b/docs/reference/tab-widgets/ilm.asciidoc index 60a92135d773..3682377d754e 100644 --- a/docs/reference/tab-widgets/ilm.asciidoc +++ b/docs/reference/tab-widgets/ilm.asciidoc @@ -85,5 +85,5 @@ Index Lifecycle Policies**. Click **Create policy**. You can also use the <>. -include::{es-repo-dir}/data-streams/set-up-a-data-stream.asciidoc[tag=ilm-policy-api-ex] +include::{es-ref-dir}/data-streams/set-up-a-data-stream.asciidoc[tag=ilm-policy-api-ex] // end::custom[] diff --git a/docs/reference/tab-widgets/register-fs-repo.asciidoc b/docs/reference/tab-widgets/register-fs-repo.asciidoc index 6ff0bf23ca9e..f222f87f5a3e 100644 --- a/docs/reference/tab-widgets/register-fs-repo.asciidoc +++ b/docs/reference/tab-widgets/register-fs-repo.asciidoc @@ -48,7 +48,7 @@ PUT _snapshot/my_fs_backup relative path, `my_fs_backup_location`, resolves to `/mount/backups/my_fs_backup_location`. -include::{es-repo-dir}/snapshot-restore/register-repository.asciidoc[tag=multi-cluster-repo] +include::{es-ref-dir}/snapshot-restore/register-repository.asciidoc[tag=multi-cluster-repo] // tag::fs-repo-read-only[] To register a file system repository as read-only using the create snapshot @@ -119,7 +119,7 @@ PUT _snapshot/my_fs_backup relative path, `My_fs_backup_location`, resolves to `E:\Mount\Backups\My_fs_backup_location`. -include::{es-repo-dir}/snapshot-restore/register-repository.asciidoc[tag=multi-cluster-repo] +include::{es-ref-dir}/snapshot-restore/register-repository.asciidoc[tag=multi-cluster-repo] include::register-fs-repo.asciidoc[tag=fs-repo-read-only] diff --git a/docs/reference/tab-widgets/snapshot-repo.asciidoc b/docs/reference/tab-widgets/snapshot-repo.asciidoc index e3871d84e483..b41ddbf128a3 100644 --- a/docs/reference/tab-widgets/snapshot-repo.asciidoc +++ b/docs/reference/tab-widgets/snapshot-repo.asciidoc @@ -15,5 +15,5 @@ You can also use any of the following custom repository types with {search-snaps // end::cloud[] // tag::self-managed[] -include::{es-repo-dir}/searchable-snapshots/index.asciidoc[tag=searchable-snapshot-repo-types] +include::{es-ref-dir}/searchable-snapshots/index.asciidoc[tag=searchable-snapshot-repo-types] // end::self-managed[] diff --git a/docs/reference/text-structure/apis/find-field-structure.asciidoc b/docs/reference/text-structure/apis/find-field-structure.asciidoc index 6788ddf7f42b..4fa108e92d4c 100644 --- a/docs/reference/text-structure/apis/find-field-structure.asciidoc +++ b/docs/reference/text-structure/apis/find-field-structure.asciidoc @@ -57,22 +57,22 @@ chosen. `field`:: (Required, string) The name of the field that's analyzed. -include::{es-repo-dir}/text-structure/apis/find-structure-shared.asciidoc[tag=param-column-names] -include::{es-repo-dir}/text-structure/apis/find-structure-shared.asciidoc[tag=param-delimiter] +include::{es-ref-dir}/text-structure/apis/find-structure-shared.asciidoc[tag=param-column-names] +include::{es-ref-dir}/text-structure/apis/find-structure-shared.asciidoc[tag=param-delimiter] `documents_to_sample`:: (Optional, unsigned integer) The number of documents to include in the structural analysis. The minimum is 2; the default is 1000. -include::{es-repo-dir}/text-structure/apis/find-structure-shared.asciidoc[tag=param-explain] -include::{es-repo-dir}/text-structure/apis/find-structure-shared.asciidoc[tag=param-format] -include::{es-repo-dir}/text-structure/apis/find-structure-shared.asciidoc[tag=param-grok-pattern] -include::{es-repo-dir}/text-structure/apis/find-structure-shared.asciidoc[tag=param-ecs-compatibility] -include::{es-repo-dir}/text-structure/apis/find-structure-shared.asciidoc[tag=param-quote] -include::{es-repo-dir}/text-structure/apis/find-structure-shared.asciidoc[tag=param-should-trim-fields] -include::{es-repo-dir}/text-structure/apis/find-structure-shared.asciidoc[tag=param-timeout] -include::{es-repo-dir}/text-structure/apis/find-structure-shared.asciidoc[tag=param-timestamp-field] -include::{es-repo-dir}/text-structure/apis/find-structure-shared.asciidoc[tag=param-timestamp-format] +include::{es-ref-dir}/text-structure/apis/find-structure-shared.asciidoc[tag=param-explain] +include::{es-ref-dir}/text-structure/apis/find-structure-shared.asciidoc[tag=param-format] +include::{es-ref-dir}/text-structure/apis/find-structure-shared.asciidoc[tag=param-grok-pattern] +include::{es-ref-dir}/text-structure/apis/find-structure-shared.asciidoc[tag=param-ecs-compatibility] +include::{es-ref-dir}/text-structure/apis/find-structure-shared.asciidoc[tag=param-quote] +include::{es-ref-dir}/text-structure/apis/find-structure-shared.asciidoc[tag=param-should-trim-fields] +include::{es-ref-dir}/text-structure/apis/find-structure-shared.asciidoc[tag=param-timeout] +include::{es-ref-dir}/text-structure/apis/find-structure-shared.asciidoc[tag=param-timestamp-field] +include::{es-ref-dir}/text-structure/apis/find-structure-shared.asciidoc[tag=param-timestamp-format] [discrete] [[find-field-structure-examples]] diff --git a/docs/reference/text-structure/apis/find-message-structure.asciidoc b/docs/reference/text-structure/apis/find-message-structure.asciidoc index 085f65b85212..6c1bf5089bed 100644 --- a/docs/reference/text-structure/apis/find-message-structure.asciidoc +++ b/docs/reference/text-structure/apis/find-message-structure.asciidoc @@ -52,17 +52,17 @@ chosen. [[find-message-structure-query-parms]] == {api-query-parms-title} -include::{es-repo-dir}/text-structure/apis/find-structure-shared.asciidoc[tag=param-column-names] -include::{es-repo-dir}/text-structure/apis/find-structure-shared.asciidoc[tag=param-delimiter] -include::{es-repo-dir}/text-structure/apis/find-structure-shared.asciidoc[tag=param-explain] -include::{es-repo-dir}/text-structure/apis/find-structure-shared.asciidoc[tag=param-format] -include::{es-repo-dir}/text-structure/apis/find-structure-shared.asciidoc[tag=param-grok-pattern] -include::{es-repo-dir}/text-structure/apis/find-structure-shared.asciidoc[tag=param-ecs-compatibility] -include::{es-repo-dir}/text-structure/apis/find-structure-shared.asciidoc[tag=param-quote] -include::{es-repo-dir}/text-structure/apis/find-structure-shared.asciidoc[tag=param-should-trim-fields] -include::{es-repo-dir}/text-structure/apis/find-structure-shared.asciidoc[tag=param-timeout] -include::{es-repo-dir}/text-structure/apis/find-structure-shared.asciidoc[tag=param-timestamp-field] -include::{es-repo-dir}/text-structure/apis/find-structure-shared.asciidoc[tag=param-timestamp-format] +include::{es-ref-dir}/text-structure/apis/find-structure-shared.asciidoc[tag=param-column-names] +include::{es-ref-dir}/text-structure/apis/find-structure-shared.asciidoc[tag=param-delimiter] +include::{es-ref-dir}/text-structure/apis/find-structure-shared.asciidoc[tag=param-explain] +include::{es-ref-dir}/text-structure/apis/find-structure-shared.asciidoc[tag=param-format] +include::{es-ref-dir}/text-structure/apis/find-structure-shared.asciidoc[tag=param-grok-pattern] +include::{es-ref-dir}/text-structure/apis/find-structure-shared.asciidoc[tag=param-ecs-compatibility] +include::{es-ref-dir}/text-structure/apis/find-structure-shared.asciidoc[tag=param-quote] +include::{es-ref-dir}/text-structure/apis/find-structure-shared.asciidoc[tag=param-should-trim-fields] +include::{es-ref-dir}/text-structure/apis/find-structure-shared.asciidoc[tag=param-timeout] +include::{es-ref-dir}/text-structure/apis/find-structure-shared.asciidoc[tag=param-timestamp-field] +include::{es-ref-dir}/text-structure/apis/find-structure-shared.asciidoc[tag=param-timestamp-format] [discrete] [[find-message-structure-request-body]] diff --git a/docs/reference/text-structure/apis/find-structure.asciidoc b/docs/reference/text-structure/apis/find-structure.asciidoc index b49b0f352668..361560bace4e 100644 --- a/docs/reference/text-structure/apis/find-structure.asciidoc +++ b/docs/reference/text-structure/apis/find-structure.asciidoc @@ -55,21 +55,21 @@ chosen. [[find-structure-query-parms]] == {api-query-parms-title} -include::{es-repo-dir}/text-structure/apis/find-structure-shared.asciidoc[tag=param-charset] -include::{es-repo-dir}/text-structure/apis/find-structure-shared.asciidoc[tag=param-column-names] -include::{es-repo-dir}/text-structure/apis/find-structure-shared.asciidoc[tag=param-delimiter] -include::{es-repo-dir}/text-structure/apis/find-structure-shared.asciidoc[tag=param-explain] -include::{es-repo-dir}/text-structure/apis/find-structure-shared.asciidoc[tag=param-format] -include::{es-repo-dir}/text-structure/apis/find-structure-shared.asciidoc[tag=param-grok-pattern] -include::{es-repo-dir}/text-structure/apis/find-structure-shared.asciidoc[tag=param-ecs-compatibility] -include::{es-repo-dir}/text-structure/apis/find-structure-shared.asciidoc[tag=param-has-header-row] -include::{es-repo-dir}/text-structure/apis/find-structure-shared.asciidoc[tag=param-line-merge-size-limit] -include::{es-repo-dir}/text-structure/apis/find-structure-shared.asciidoc[tag=param-lines-to-sample] -include::{es-repo-dir}/text-structure/apis/find-structure-shared.asciidoc[tag=param-quote] -include::{es-repo-dir}/text-structure/apis/find-structure-shared.asciidoc[tag=param-should-trim-fields] -include::{es-repo-dir}/text-structure/apis/find-structure-shared.asciidoc[tag=param-timeout] -include::{es-repo-dir}/text-structure/apis/find-structure-shared.asciidoc[tag=param-timestamp-field] -include::{es-repo-dir}/text-structure/apis/find-structure-shared.asciidoc[tag=param-timestamp-format] +include::{es-ref-dir}/text-structure/apis/find-structure-shared.asciidoc[tag=param-charset] +include::{es-ref-dir}/text-structure/apis/find-structure-shared.asciidoc[tag=param-column-names] +include::{es-ref-dir}/text-structure/apis/find-structure-shared.asciidoc[tag=param-delimiter] +include::{es-ref-dir}/text-structure/apis/find-structure-shared.asciidoc[tag=param-explain] +include::{es-ref-dir}/text-structure/apis/find-structure-shared.asciidoc[tag=param-format] +include::{es-ref-dir}/text-structure/apis/find-structure-shared.asciidoc[tag=param-grok-pattern] +include::{es-ref-dir}/text-structure/apis/find-structure-shared.asciidoc[tag=param-ecs-compatibility] +include::{es-ref-dir}/text-structure/apis/find-structure-shared.asciidoc[tag=param-has-header-row] +include::{es-ref-dir}/text-structure/apis/find-structure-shared.asciidoc[tag=param-line-merge-size-limit] +include::{es-ref-dir}/text-structure/apis/find-structure-shared.asciidoc[tag=param-lines-to-sample] +include::{es-ref-dir}/text-structure/apis/find-structure-shared.asciidoc[tag=param-quote] +include::{es-ref-dir}/text-structure/apis/find-structure-shared.asciidoc[tag=param-should-trim-fields] +include::{es-ref-dir}/text-structure/apis/find-structure-shared.asciidoc[tag=param-timeout] +include::{es-ref-dir}/text-structure/apis/find-structure-shared.asciidoc[tag=param-timestamp-field] +include::{es-ref-dir}/text-structure/apis/find-structure-shared.asciidoc[tag=param-timestamp-format] [discrete] [[find-structure-request-body]] diff --git a/docs/reference/transform/apis/delete-transform.asciidoc b/docs/reference/transform/apis/delete-transform.asciidoc index 9a097407749a..111dda23690b 100644 --- a/docs/reference/transform/apis/delete-transform.asciidoc +++ b/docs/reference/transform/apis/delete-transform.asciidoc @@ -26,7 +26,7 @@ in the `transform_admin` built-in role. ``:: (Required, string) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-id] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-id] [[delete-transform-query-parms]] == {api-query-parms-title} diff --git a/docs/reference/transform/apis/get-transform-stats.asciidoc b/docs/reference/transform/apis/get-transform-stats.asciidoc index 2a7ed1913546..273b1d094979 100644 --- a/docs/reference/transform/apis/get-transform-stats.asciidoc +++ b/docs/reference/transform/apis/get-transform-stats.asciidoc @@ -49,7 +49,7 @@ specifying `*` as the ``, or by omitting the ``:: (Optional, string) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-id-wildcard] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-id-wildcard] [[get-transform-stats-query-parms]] @@ -57,15 +57,15 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-id-wildcard] `allow_no_match`:: (Optional, Boolean) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-match-transforms1] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=allow-no-match-transforms1] `from`:: (Optional, integer) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=from-transforms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=from-transforms] `size`:: (Optional, integer) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=size-transforms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=size-transforms] [role="child_attributes"] [[get-transform-stats-response]] @@ -84,7 +84,7 @@ informational; you cannot update their values. ==== `changes_last_detected_at`::: (date) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=checkpointing-changes-last-detected-at] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=checkpointing-changes-last-detected-at] //Begin checkpointing.last `last`::: @@ -106,7 +106,7 @@ was created. `last_search_time`::: (date) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=checkpointing-last-search-time] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=checkpointing-last-search-time] //Begin checkpointing.next `next`::: @@ -191,7 +191,7 @@ that the {transform} is failing to keep up. `id`:: (string) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-id] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-id] //Begin node `node`:: @@ -221,11 +221,11 @@ example, `127.0.0.1:9300`. `reason`:: (string) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=state-transform-reason] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=state-transform-reason] `state`:: (string) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=state-transform] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=state-transform] //Begin stats `stats`:: @@ -237,71 +237,71 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=state-transform] `delete_time_in_ms`::: (long) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=delete-time-ms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=delete-time-ms] `documents_deleted`::: (long) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=docs-deleted-transform] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=docs-deleted-transform] `documents_indexed`::: (long) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=docs-indexed] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=docs-indexed] `documents_processed`::: (long) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=docs-processed] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=docs-processed] `exponential_avg_checkpoint_duration_ms`::: (double) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=exponential-avg-checkpoint-duration-ms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=exponential-avg-checkpoint-duration-ms] `exponential_avg_documents_indexed`::: (double) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=exponential-avg-documents-indexed] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=exponential-avg-documents-indexed] `exponential_avg_documents_processed`::: (double) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=exponential-avg-documents-processed] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=exponential-avg-documents-processed] `index_failures`::: (long) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-failures] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=index-failures] `index_time_in_ms`::: (long) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-time-ms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=index-time-ms] `index_total`::: (long) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-total] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=index-total] `pages_processed`::: (long) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=pages-processed] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=pages-processed] `processing_time_in_ms`::: (long) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=processing-time-ms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=processing-time-ms] `processing_total`::: (long) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=processing-total] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=processing-total] `search_failures`::: (long) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=search-failures] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=search-failures] `search_time_in_ms`::: (long) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=search-time-ms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=search-time-ms] `search_total`::: (long) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=search-total] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=search-total] `trigger_count`::: (long) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=trigger-count] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=trigger-count] ==== //End stats diff --git a/docs/reference/transform/apis/get-transform.asciidoc b/docs/reference/transform/apis/get-transform.asciidoc index c008e34e74fd..ece59138e289 100644 --- a/docs/reference/transform/apis/get-transform.asciidoc +++ b/docs/reference/transform/apis/get-transform.asciidoc @@ -40,14 +40,14 @@ specifying `*` as the ``, or by omitting the ``. ``:: (Optional, string) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-id-wildcard] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-id-wildcard] [[get-transform-query-parms]] == {api-query-parms-title} `allow_no_match`:: (Optional, Boolean) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-match-transforms1] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=allow-no-match-transforms1] `exclude_generated`:: (Optional, Boolean) @@ -57,11 +57,11 @@ and then added to another cluster. Default is false. `from`:: (Optional, integer) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=from-transforms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=from-transforms] `size`:: (Optional, integer) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=size-transforms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=size-transforms] diff --git a/docs/reference/transform/apis/preview-transform.asciidoc b/docs/reference/transform/apis/preview-transform.asciidoc index 86ca91b32fdf..fa9ad0c0fc8f 100644 --- a/docs/reference/transform/apis/preview-transform.asciidoc +++ b/docs/reference/transform/apis/preview-transform.asciidoc @@ -91,29 +91,29 @@ expires, the request fails and returns an error. Defaults to `30s`. //Begin dest `dest`:: (Optional, object) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=dest] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=dest] + .Properties of `dest` [%collapsible%open] ==== `index`::: (Optional, string) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=dest-index] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=dest-index] `pipeline`::: (Optional, string) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=dest-pipeline] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=dest-pipeline] ==== //End dest `frequency`:: (Optional, <>) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=frequency] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=frequency] //Begin latest `latest`:: (Required^*^, object) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-latest] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-latest] + .Properties of `latest` [%collapsible%open] @@ -121,11 +121,11 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-latest] `sort`::: (Required, string) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-sort] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-sort] `unique_key`::: (Required, array of strings) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-unique-key] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-unique-key] ==== //End latest @@ -133,43 +133,43 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-unique-key] //Begin pivot `pivot`:: (Required, object) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=pivot] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=pivot] + .Properties of `pivot` [%collapsible%open] ==== `aggregations` or `aggs`::: (Required, object) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=pivot-aggs] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=pivot-aggs] `group_by`::: (Required, object) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=pivot-group-by] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=pivot-group-by] ==== //End pivot //Begin retention policy `retention_policy`:: (Optional, object) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-retention] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-retention] + .Properties of `retention_policy` [%collapsible%open] ==== `time`::: (Required, object) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-retention-time] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-retention-time] + .Properties of `time` [%collapsible%open] ===== `field`::: (Required, string) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-retention-time-field] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-retention-time-field] `max_age`::: (Required, <>) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-retention-time-max-age] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-retention-time-max-age] ===== ==== //End retention policy @@ -177,29 +177,29 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-retention-ti //Begin source `source`:: (Required, object) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=source-transforms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=source-transforms] + .Properties of `source` [%collapsible%open] ==== `index`::: (Required, string or array) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=source-index-transforms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=source-index-transforms] `query`::: (Optional, object) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=source-query-transforms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=source-query-transforms] `runtime_mappings`::: (Optional, object) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=source-runtime-mappings-transforms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=source-runtime-mappings-transforms] ==== //End source //Begin sync `sync`:: (Optional, object) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=sync] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=sync] + .Properties of `sync` [%collapsible%open] @@ -208,18 +208,18 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=sync] `time`::: (Optional, object) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=sync-time] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=sync-time] + .Properties of `time` [%collapsible%open] ===== `delay`:::: (Optional, <>) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=sync-time-delay] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=sync-time-delay] `field`:::: (Optional, string) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=sync-time-field] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=sync-time-field] ===== //End sync.time ==== @@ -228,29 +228,29 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=sync-time-field] //Begin settings `settings`:: (Optional, object) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-settings] + .Properties of `settings` [%collapsible%open] ==== `align_checkpoints`::: (Optional, boolean) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-align-checkpoints] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-align-checkpoints] `dates_as_epoch_millis`::: (Optional, boolean) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-dates-as-epoch-milli] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-dates-as-epoch-milli] `deduce_mappings`::: (Optional, boolean) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-deduce-mappings] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-deduce-mappings] `docs_per_second`::: (Optional, float) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-docs-per-second] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-docs-per-second] `max_page_search_size`::: (Optional, integer) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-max-page-search-size] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-max-page-search-size] `unattended`::: (Optional, boolean) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-unattended] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-unattended] ==== //End settings diff --git a/docs/reference/transform/apis/put-transform.asciidoc b/docs/reference/transform/apis/put-transform.asciidoc index a3f885795732..ed2ceba0a7a5 100644 --- a/docs/reference/transform/apis/put-transform.asciidoc +++ b/docs/reference/transform/apis/put-transform.asciidoc @@ -101,7 +101,7 @@ expires, the request fails and returns an error. Defaults to `30s`. //Begin dest `dest`:: (Required, object) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=dest] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=dest] + .Properties of `dest` [%collapsible%open] @@ -109,12 +109,12 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=dest] `index`::: (Required, string) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=dest-index] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=dest-index] //Begin aliases `aliases`::: (Optional, array of objects) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=dest-aliases] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=dest-aliases] + .Properties of `aliases` [%collapsible%open] @@ -122,29 +122,29 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=dest-aliases] `alias`:::: (Required, string) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=dest-aliases-alias] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=dest-aliases-alias] `move_on_creation`:::: (Optional, boolean) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=dest-aliases-move-on-creation] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=dest-aliases-move-on-creation] ===== //End aliases `pipeline`::: (Optional, string) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=dest-pipeline] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=dest-pipeline] ==== //End dest `frequency`:: (Optional, <>) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=frequency] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=frequency] //Begin latest `latest`:: (Required^*^, object) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-latest] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-latest] + .Properties of `latest` [%collapsible%open] @@ -152,11 +152,11 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-latest] `sort`::: (Required, string) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-sort] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-sort] `unique_key`::: (Required, array of strings) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-unique-key] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-unique-key] ==== //End latest @@ -164,13 +164,13 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-unique-key] //Begin _meta `_meta`:: (Optional, object) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-metadata] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-metadata] //End _meta //Begin pivot `pivot`:: (Required^*^, object) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=pivot] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=pivot] + .Properties of `pivot` [%collapsible%open] @@ -178,36 +178,36 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=pivot] `aggregations` or `aggs`::: (Required, object) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=pivot-aggs] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=pivot-aggs] `group_by`::: (Required, object) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=pivot-group-by] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=pivot-group-by] ==== //End pivot //Begin retention policy `retention_policy`:: (Optional, object) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-retention] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-retention] + .Properties of `retention_policy` [%collapsible%open] ==== `time`::: (Required, object) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-retention-time] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-retention-time] + .Properties of `time` [%collapsible%open] ===== `field`::: (Required, string) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-retention-time-field] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-retention-time-field] `max_age`::: (Required, <>) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-retention-time-max-age] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-retention-time-max-age] ===== ==== //End retention policy @@ -215,39 +215,39 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-retention-ti //Begin settings `settings`:: (Optional, object) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-settings] + .Properties of `settings` [%collapsible%open] ==== `align_checkpoints`::: (Optional, boolean) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-align-checkpoints] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-align-checkpoints] `dates_as_epoch_millis`::: (Optional, boolean) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-dates-as-epoch-milli] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-dates-as-epoch-milli] `deduce_mappings`::: (Optional, boolean) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-deduce-mappings] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-deduce-mappings] `docs_per_second`::: (Optional, float) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-docs-per-second] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-docs-per-second] `max_page_search_size`::: (Optional, integer) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-max-page-search-size] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-max-page-search-size] `num_failure_retries`::: (Optional, integer) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-num-failure-retries] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-num-failure-retries] `unattended`::: (Optional, boolean) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-unattended] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-unattended] ==== //End settings //Begin source `source`:: (Required, object) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=source-transforms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=source-transforms] + .Properties of `source` [%collapsible%open] @@ -255,22 +255,22 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=source-transforms] `index`::: (Required, string or array) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=source-index-transforms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=source-index-transforms] `query`::: (Optional, object) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=source-query-transforms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=source-query-transforms] `runtime_mappings`::: (Optional, object) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=source-runtime-mappings-transforms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=source-runtime-mappings-transforms] ==== //End source //Begin sync `sync`:: (Optional, object) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=sync] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=sync] + .Properties of `sync` [%collapsible%open] @@ -279,18 +279,18 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=sync] //Begin time `time`::: (Required, object) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=sync-time] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=sync-time] + .Properties of `time` [%collapsible%open] ===== `delay`:::: (Optional, <>) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=sync-time-delay] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=sync-time-delay] `field`:::: (Required, string) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=sync-time-field] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=sync-time-field] + -- TIP: It is strongly recommended to use a field that contains the diff --git a/docs/reference/transform/apis/reset-transform.asciidoc b/docs/reference/transform/apis/reset-transform.asciidoc index badbc0f02231..1194d3589275 100644 --- a/docs/reference/transform/apis/reset-transform.asciidoc +++ b/docs/reference/transform/apis/reset-transform.asciidoc @@ -38,7 +38,7 @@ to the latest format as if the <> API was used. The ``:: (Required, string) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-id] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-id] [[reset-transform-query-parms]] == {api-query-parms-title} diff --git a/docs/reference/transform/apis/schedule-now-transform.asciidoc b/docs/reference/transform/apis/schedule-now-transform.asciidoc index 202b2d61fc73..7a276edf0881 100644 --- a/docs/reference/transform/apis/schedule-now-transform.asciidoc +++ b/docs/reference/transform/apis/schedule-now-transform.asciidoc @@ -35,7 +35,7 @@ called again in the meantime. ``:: (Required, string) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-id] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-id] [[schedule-now-transform-query-parms]] == {api-query-parms-title} diff --git a/docs/reference/transform/apis/stop-transform.asciidoc b/docs/reference/transform/apis/stop-transform.asciidoc index 670e015c3314..e99fcbd413eb 100644 --- a/docs/reference/transform/apis/stop-transform.asciidoc +++ b/docs/reference/transform/apis/stop-transform.asciidoc @@ -41,7 +41,7 @@ comma-separated list or a wildcard expression. To stop all {transforms}, use `allow_no_match`:: (Optional, Boolean) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-match-transforms2] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=allow-no-match-transforms2] `force`:: (Optional, Boolean) Set to `true` to stop a failed {transform} or to diff --git a/docs/reference/transform/apis/update-transform.asciidoc b/docs/reference/transform/apis/update-transform.asciidoc index 57a27b4efae7..1ac7d6d5410d 100644 --- a/docs/reference/transform/apis/update-transform.asciidoc +++ b/docs/reference/transform/apis/update-transform.asciidoc @@ -57,7 +57,7 @@ permanent failure. ``:: (Required, string) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-id] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-id] [[update-transform-query-parms]] == {api-query-parms-title} @@ -82,7 +82,7 @@ expires, the request fails and returns an error. Defaults to `30s`. //Begin dest `dest`:: (Optional, object) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=dest] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=dest] + .Properties of `dest` [%collapsible%open] @@ -90,12 +90,12 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=dest] `index`::: (Required, string) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=dest-index] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=dest-index] //Begin aliases `aliases`::: (Optional, array of objects) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=dest-aliases] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=dest-aliases] + .Properties of `aliases` [%collapsible%open] @@ -103,53 +103,53 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=dest-aliases] `alias`:::: (Required, string) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=dest-aliases-alias] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=dest-aliases-alias] `move_on_creation`:::: (Optional, boolean) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=dest-aliases-move-on-creation] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=dest-aliases-move-on-creation] ===== //End aliases `pipeline`::: (Optional, string) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=dest-pipeline] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=dest-pipeline] ==== //End dest `frequency`:: (Optional, <>) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=frequency] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=frequency] //Begin _meta `_meta`:: (Optional, object) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-metadata] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-metadata] //End _meta //Begin retention policy `retention_policy`:: (Optional, object) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-retention] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-retention] + .Properties of `retention_policy` [%collapsible%open] ==== `time`::: (Required, object) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-retention-time] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-retention-time] + .Properties of `time` [%collapsible%open] ===== `field`::: (Required, string) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-retention-time-field] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-retention-time-field] `max_age`::: (Required, <>) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-retention-time-max-age] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-retention-time-max-age] ===== ==== //End retention policy @@ -157,39 +157,39 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-retention-ti //Begin settings `settings`:: (Optional, object) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-settings] + .Properties of `settings` [%collapsible%open] ==== `align_checkpoints`::: (Optional, boolean) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-align-checkpoints] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-align-checkpoints] `dates_as_epoch_millis`::: (Optional, boolean) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-dates-as-epoch-milli] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-dates-as-epoch-milli] `deduce_mappings`::: (Optional, boolean) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-deduce-mappings] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-deduce-mappings] `docs_per_second`::: (Optional, float) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-docs-per-second] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-docs-per-second] `max_page_search_size`::: (Optional, integer) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-max-page-search-size] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-max-page-search-size] `num_failure_retries`::: (Optional, integer) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-num-failure-retries] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-num-failure-retries] `unattended`::: (Optional, boolean) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-unattended] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-unattended] ==== //End settings //Begin source `source`:: (Optional, object) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=source-transforms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=source-transforms] + .Properties of `source` [%collapsible%open] @@ -197,18 +197,18 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=source-transforms] `index`::: (Required, string or array) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=source-index-transforms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=source-index-transforms] `query`::: (Optional, object) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=source-query-transforms] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=source-query-transforms] ==== //End source //Begin sync `sync`:: (Optional, object) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=sync] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=sync] + -- NOTE: You can update these properties only if it is a continuous {transform}. You @@ -224,7 +224,7 @@ Instead, clone the {transform} in {kib} and add or remove the `sync` property. //Begin sync.time `time`::: (Required, object) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=sync-time] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=sync-time] + .Properties of `time` [%collapsible%open] @@ -232,11 +232,11 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=sync-time] `delay`:::: (Optional, <>) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=sync-time-delay] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=sync-time-delay] `field`:::: (Required, string) -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=sync-time-field] +include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=sync-time-field] + -- TIP: In general, it’s a good idea to use a field that contains the diff --git a/docs/reference/troubleshooting/common-issues/diagnose-unassigned-shards.asciidoc b/docs/reference/troubleshooting/common-issues/diagnose-unassigned-shards.asciidoc index 2d23763a7576..fe9422d6d4c5 100644 --- a/docs/reference/troubleshooting/common-issues/diagnose-unassigned-shards.asciidoc +++ b/docs/reference/troubleshooting/common-issues/diagnose-unassigned-shards.asciidoc @@ -6,7 +6,7 @@ allocation settings to lack of disk space. In order to diagnose the unassigned shards in your deployment use the following steps: -include::{es-repo-dir}/tab-widgets/troubleshooting/data/diagnose-unassigned-shards-widget.asciidoc[] +include::{es-ref-dir}/tab-widgets/troubleshooting/data/diagnose-unassigned-shards-widget.asciidoc[] diff --git a/docs/reference/troubleshooting/common-issues/high-cpu-usage.asciidoc b/docs/reference/troubleshooting/common-issues/high-cpu-usage.asciidoc index 536d18b65358..858683ef97a6 100644 --- a/docs/reference/troubleshooting/common-issues/high-cpu-usage.asciidoc +++ b/docs/reference/troubleshooting/common-issues/high-cpu-usage.asciidoc @@ -15,7 +15,7 @@ depleted, {es} will reject search requests until more threads are available. **Check CPU usage** -include::{es-repo-dir}/tab-widgets/cpu-usage-widget.asciidoc[] +include::{es-ref-dir}/tab-widgets/cpu-usage-widget.asciidoc[] **Check hot threads** diff --git a/docs/reference/troubleshooting/common-issues/high-jvm-memory-pressure.asciidoc b/docs/reference/troubleshooting/common-issues/high-jvm-memory-pressure.asciidoc index c71dda063dea..e88927f159f2 100644 --- a/docs/reference/troubleshooting/common-issues/high-jvm-memory-pressure.asciidoc +++ b/docs/reference/troubleshooting/common-issues/high-jvm-memory-pressure.asciidoc @@ -12,7 +12,7 @@ exceeds 85%. **Check JVM memory pressure** -include::{es-repo-dir}/tab-widgets/jvm-memory-pressure-widget.asciidoc[] +include::{es-ref-dir}/tab-widgets/jvm-memory-pressure-widget.asciidoc[] **Check garbage collection logs** diff --git a/docs/reference/troubleshooting/data/add-tier.asciidoc b/docs/reference/troubleshooting/data/add-tier.asciidoc index 830cb2bbe296..03077d7da1bb 100644 --- a/docs/reference/troubleshooting/data/add-tier.asciidoc +++ b/docs/reference/troubleshooting/data/add-tier.asciidoc @@ -6,7 +6,7 @@ The allocation of indices in an {es} deployment can be allocated on <> the indices expect to be allocated on to your deployment: -include::{es-repo-dir}/tab-widgets/troubleshooting/data/add-tier-widget.asciidoc[] +include::{es-ref-dir}/tab-widgets/troubleshooting/data/add-tier-widget.asciidoc[] diff --git a/docs/reference/troubleshooting/data/data-tiers-mixed-with-node-attr.asciidoc b/docs/reference/troubleshooting/data/data-tiers-mixed-with-node-attr.asciidoc index 7bf6ef91cce7..2f6b75b372fd 100644 --- a/docs/reference/troubleshooting/data/data-tiers-mixed-with-node-attr.asciidoc +++ b/docs/reference/troubleshooting/data/data-tiers-mixed-with-node-attr.asciidoc @@ -12,7 +12,7 @@ This could lead to unassigned shards or shards not transitioning to the desired In order to fix this follow the next steps: -include::{es-repo-dir}/tab-widgets/troubleshooting/data/migrate-to-data-tiers-routing-guide-widget.asciidoc[] +include::{es-ref-dir}/tab-widgets/troubleshooting/data/migrate-to-data-tiers-routing-guide-widget.asciidoc[] diff --git a/docs/reference/troubleshooting/data/enable-cluster-allocation.asciidoc b/docs/reference/troubleshooting/data/enable-cluster-allocation.asciidoc index 787588d2a165..e229d9016dfe 100644 --- a/docs/reference/troubleshooting/data/enable-cluster-allocation.asciidoc +++ b/docs/reference/troubleshooting/data/enable-cluster-allocation.asciidoc @@ -10,7 +10,7 @@ Forgetting to re-allow all data allocations can lead to unassigned shards. In order to (re)allow all data to be allocated follow these steps: -include::{es-repo-dir}/tab-widgets/troubleshooting/data/enable-cluster-allocation-widget.asciidoc[] +include::{es-ref-dir}/tab-widgets/troubleshooting/data/enable-cluster-allocation-widget.asciidoc[] diff --git a/docs/reference/troubleshooting/data/enable-index-allocation.asciidoc b/docs/reference/troubleshooting/data/enable-index-allocation.asciidoc index abdc3cade5c6..a4f266ad2d21 100644 --- a/docs/reference/troubleshooting/data/enable-index-allocation.asciidoc +++ b/docs/reference/troubleshooting/data/enable-index-allocation.asciidoc @@ -10,7 +10,7 @@ Forgetting to re-allow all data allocation can lead to unassigned shards. In order to (re)allow all data to be allocated follow these steps: -include::{es-repo-dir}/tab-widgets/troubleshooting/data/enable-index-allocation-widget.asciidoc[] +include::{es-ref-dir}/tab-widgets/troubleshooting/data/enable-index-allocation-widget.asciidoc[] diff --git a/docs/reference/troubleshooting/data/increase-cluster-shard-limit.asciidoc b/docs/reference/troubleshooting/data/increase-cluster-shard-limit.asciidoc index 916677329b2b..8b8703f9a9dc 100644 --- a/docs/reference/troubleshooting/data/increase-cluster-shard-limit.asciidoc +++ b/docs/reference/troubleshooting/data/increase-cluster-shard-limit.asciidoc @@ -14,7 +14,7 @@ satisfy the configuration. In order to fix this follow the next steps: -include::{es-repo-dir}/tab-widgets/troubleshooting/data/increase-cluster-shard-limit-widget.asciidoc[] +include::{es-ref-dir}/tab-widgets/troubleshooting/data/increase-cluster-shard-limit-widget.asciidoc[] diff --git a/docs/reference/troubleshooting/data/increase-shard-limit.asciidoc b/docs/reference/troubleshooting/data/increase-shard-limit.asciidoc index f97bff73bf10..121b5348ab36 100644 --- a/docs/reference/troubleshooting/data/increase-shard-limit.asciidoc +++ b/docs/reference/troubleshooting/data/increase-shard-limit.asciidoc @@ -12,7 +12,7 @@ satisfy the index configuration. In order to fix this follow the next steps: -include::{es-repo-dir}/tab-widgets/troubleshooting/data/total-shards-per-node-widget.asciidoc[] +include::{es-ref-dir}/tab-widgets/troubleshooting/data/total-shards-per-node-widget.asciidoc[] diff --git a/docs/reference/troubleshooting/data/increase-tier-capacity.asciidoc b/docs/reference/troubleshooting/data/increase-tier-capacity.asciidoc index a413918cee48..362a14c3874d 100644 --- a/docs/reference/troubleshooting/data/increase-tier-capacity.asciidoc +++ b/docs/reference/troubleshooting/data/increase-tier-capacity.asciidoc @@ -15,7 +15,7 @@ replicas, you can influence this behavior by adding more nodes to the cluster In order to fix this follow the next steps: -include::{es-repo-dir}/tab-widgets/troubleshooting/data/increase-tier-capacity-widget.asciidoc[] +include::{es-ref-dir}/tab-widgets/troubleshooting/data/increase-tier-capacity-widget.asciidoc[] diff --git a/docs/reference/troubleshooting/data/restore-from-snapshot.asciidoc b/docs/reference/troubleshooting/data/restore-from-snapshot.asciidoc index 95d8d8c4aff8..4b5de3937686 100644 --- a/docs/reference/troubleshooting/data/restore-from-snapshot.asciidoc +++ b/docs/reference/troubleshooting/data/restore-from-snapshot.asciidoc @@ -9,4 +9,4 @@ contain a copy of the data anymore. IMPORTANT: Restoring the missing data requires you to have a backup of the affected indices and data streams that is up-to-date enough for your use case. Please do not proceed without confirming this. -include::{es-repo-dir}/tab-widgets/troubleshooting/data/restore-from-snapshot-widget.asciidoc[] +include::{es-ref-dir}/tab-widgets/troubleshooting/data/restore-from-snapshot-widget.asciidoc[] diff --git a/docs/reference/troubleshooting/data/start-ilm.asciidoc b/docs/reference/troubleshooting/data/start-ilm.asciidoc index 18f1bd4f5353..1798af814e50 100644 --- a/docs/reference/troubleshooting/data/start-ilm.asciidoc +++ b/docs/reference/troubleshooting/data/start-ilm.asciidoc @@ -5,7 +5,7 @@ Automatic index lifecycle and data retention management is currently disabled. In order to start the automatic {ilm} service, follow these steps: -include::{es-repo-dir}/tab-widgets/troubleshooting/data/start-ilm-widget.asciidoc[] +include::{es-ref-dir}/tab-widgets/troubleshooting/data/start-ilm-widget.asciidoc[] diff --git a/docs/reference/troubleshooting/data/start-slm.asciidoc b/docs/reference/troubleshooting/data/start-slm.asciidoc index 7b5e57cfbf6c..66264e8ac1b2 100644 --- a/docs/reference/troubleshooting/data/start-slm.asciidoc +++ b/docs/reference/troubleshooting/data/start-slm.asciidoc @@ -6,7 +6,7 @@ snapshots will not be created automatically. In order to start the snapshot lifecycle management service, follow these steps: -include::{es-repo-dir}/tab-widgets/troubleshooting/data/start-slm-widget.asciidoc[] +include::{es-ref-dir}/tab-widgets/troubleshooting/data/start-slm-widget.asciidoc[] diff --git a/docs/reference/troubleshooting/disk/fix-data-node-out-of-disk.asciidoc b/docs/reference/troubleshooting/disk/fix-data-node-out-of-disk.asciidoc index b98b78582900..67541cb036bf 100644 --- a/docs/reference/troubleshooting/disk/fix-data-node-out-of-disk.asciidoc +++ b/docs/reference/troubleshooting/disk/fix-data-node-out-of-disk.asciidoc @@ -11,7 +11,7 @@ of two ways: [[increase-capacity-data-node]] === Increase the disk capacity of data nodes -include::{es-repo-dir}/tab-widgets/troubleshooting/disk/increase-data-node-capacity-widget.asciidoc[] +include::{es-ref-dir}/tab-widgets/troubleshooting/disk/increase-data-node-capacity-widget.asciidoc[] [[decrease-disk-usage-data-node]] === Decrease the disk usage of data nodes @@ -20,4 +20,4 @@ In order to decrease the disk usage in your cluster without losing any data, you NOTE: Reducing the replicas of an index can potentially reduce search throughput and data redundancy. However, it can quickly give the cluster breathing room until a more permanent solution is in place. -include::{es-repo-dir}/tab-widgets/troubleshooting/disk/decrease-data-node-disk-usage-widget.asciidoc[] +include::{es-ref-dir}/tab-widgets/troubleshooting/disk/decrease-data-node-disk-usage-widget.asciidoc[] diff --git a/docs/reference/troubleshooting/disk/fix-master-node-out-of-disk.asciidoc b/docs/reference/troubleshooting/disk/fix-master-node-out-of-disk.asciidoc index 6a32ab8aff37..73268a0f433e 100644 --- a/docs/reference/troubleshooting/disk/fix-master-node-out-of-disk.asciidoc +++ b/docs/reference/troubleshooting/disk/fix-master-node-out-of-disk.asciidoc @@ -5,4 +5,4 @@ out of space, you need to ensure that they have enough disk space to function. If the <> reports that your master node is out of space you need to increase the disk capacity of your master nodes. -include::{es-repo-dir}/tab-widgets/troubleshooting/disk/increase-master-node-capacity-widget.asciidoc[] +include::{es-ref-dir}/tab-widgets/troubleshooting/disk/increase-master-node-capacity-widget.asciidoc[] diff --git a/docs/reference/troubleshooting/disk/fix-other-node-out-of-disk.asciidoc b/docs/reference/troubleshooting/disk/fix-other-node-out-of-disk.asciidoc index d53e5337fad8..9334e0f17fd8 100644 --- a/docs/reference/troubleshooting/disk/fix-other-node-out-of-disk.asciidoc +++ b/docs/reference/troubleshooting/disk/fix-other-node-out-of-disk.asciidoc @@ -6,4 +6,4 @@ for example machine learning. If one or more of these nodes are running out of s enough disk space to function. If the <> reports that a node that is not a master and does not contain data is out of space you need to increase the disk capacity of this node. -include::{es-repo-dir}/tab-widgets/troubleshooting/disk/increase-other-node-capacity-widget.asciidoc[] +include::{es-ref-dir}/tab-widgets/troubleshooting/disk/increase-other-node-capacity-widget.asciidoc[] diff --git a/docs/reference/troubleshooting/snapshot/add-repository.asciidoc b/docs/reference/troubleshooting/snapshot/add-repository.asciidoc index 0de4667bd968..386c2561c03c 100644 --- a/docs/reference/troubleshooting/snapshot/add-repository.asciidoc +++ b/docs/reference/troubleshooting/snapshot/add-repository.asciidoc @@ -16,7 +16,7 @@ guide. To remedy the situation mark the repository as read-only or remove it from all the other deployments, and re-add (recreate) the repository in the current deployment: -include::{es-repo-dir}/tab-widgets/troubleshooting/snapshot/corrupt-repository-widget.asciidoc[] +include::{es-ref-dir}/tab-widgets/troubleshooting/snapshot/corrupt-repository-widget.asciidoc[] [[diagnosing-unknown-repositories]] diff --git a/docs/reference/troubleshooting/snapshot/repeated-snapshot-failures.asciidoc b/docs/reference/troubleshooting/snapshot/repeated-snapshot-failures.asciidoc index 4084fdc7ca42..2496781c0c8f 100644 --- a/docs/reference/troubleshooting/snapshot/repeated-snapshot-failures.asciidoc +++ b/docs/reference/troubleshooting/snapshot/repeated-snapshot-failures.asciidoc @@ -12,7 +12,7 @@ repeated failures before reporting a warning is controlled by the In the event that an automated {slm} policy execution is experiencing repeated failures, follow these steps to get more information about the problem: -include::{es-repo-dir}/tab-widgets/troubleshooting/snapshot/repeated-snapshot-failures-widget.asciidoc[] +include::{es-ref-dir}/tab-widgets/troubleshooting/snapshot/repeated-snapshot-failures-widget.asciidoc[] diff --git a/docs/reference/troubleshooting/troubleshooting-shards-capacity.asciidoc b/docs/reference/troubleshooting/troubleshooting-shards-capacity.asciidoc index 6a3a5bc06ce8..bc8fb7290f1e 100644 --- a/docs/reference/troubleshooting/troubleshooting-shards-capacity.asciidoc +++ b/docs/reference/troubleshooting/troubleshooting-shards-capacity.asciidoc @@ -7,4 +7,4 @@ The current shards capacity of the cluster is available in the <>. -include::{es-repo-dir}/tab-widgets/troubleshooting/troubleshooting-shards-capacity-widget.asciidoc[] +include::{es-ref-dir}/tab-widgets/troubleshooting/troubleshooting-shards-capacity-widget.asciidoc[] diff --git a/docs/reference/upgrade.asciidoc b/docs/reference/upgrade.asciidoc index 8f6d095971ff..d5057d9b87d8 100644 --- a/docs/reference/upgrade.asciidoc +++ b/docs/reference/upgrade.asciidoc @@ -52,7 +52,7 @@ the REST API. [[upgrade-fips-java17]] === FIPS Compliance and Java 17 -include::{es-repo-dir}/security/fips-java17.asciidoc[] +include::{es-ref-dir}/security/fips-java17.asciidoc[] include::upgrade/archived-settings.asciidoc[]