diff --git a/deploy-manage/deploy/elastic-cloud/elastic-cloud-hosted-planning.md b/deploy-manage/deploy/elastic-cloud/elastic-cloud-hosted-planning.md index 9db9e09cd3..3bbe685b25 100644 --- a/deploy-manage/deploy/elastic-cloud/elastic-cloud-hosted-planning.md +++ b/deploy-manage/deploy/elastic-cloud/elastic-cloud-hosted-planning.md @@ -28,7 +28,7 @@ We recommend that you use at least two availability zones for production and thr Increasing the number of zones should not be used to add more resources. The concept of zones is meant for High Availability (2 zones) and Fault Tolerance (3 zones), but neither will work if the cluster relies on the resources from those zones to be operational. ::: -With multiple {{es}} nodes in multiple availability zones you have the recommended hardware. The next step is to ensure proper index replication. Each index, with the exception of searchable snapshot indices, should have one or more replicas. Use the [index settings API](https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-indices-get-settings-1) to find any indices without replicas: +With multiple {{es}} nodes in multiple availability zones you have the recommended hardware. The next step is to ensure proper index replication. Each index, with the exception of searchable snapshot indices, should have one or more replicas. Use the [index settings API]({{es-apis}}operation/operation-indices-get-settings) to find any indices without replicas: ```sh GET _all/_settings/index.number_of_replicas diff --git a/explore-analyze/elastic-inference/eis.md b/explore-analyze/elastic-inference/eis.md index e868dc72f9..f8294b6b24 100644 --- a/explore-analyze/elastic-inference/eis.md +++ b/explore-analyze/elastic-inference/eis.md @@ -49,7 +49,7 @@ You can now use `semantic_text` with the new ELSER endpoint on EIS. To learn how #### Batch size Batches are limited to a maximum of 16 documents. -This is particularly relevant when using the [_bulk API](https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-bulk) for data ingestion. +This is particularly relevant when using the [_bulk API]({{es-apis}}operation/operation-bulk) for data ingestion. ## Pricing diff --git a/explore-analyze/elastic-inference/inference-api.md b/explore-analyze/elastic-inference/inference-api.md index bc4d9f6ca7..f8ce5450b9 100644 --- a/explore-analyze/elastic-inference/inference-api.md +++ b/explore-analyze/elastic-inference/inference-api.md @@ -11,11 +11,11 @@ products: # {{infer-cap}} integrations -{{es}} provides a machine learning [{{infer}} API](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-inference) to create and manage {{infer}} endpoints that integrate with services such as {{es}} (for built-in NLP models like [ELSER](/explore-analyze/machine-learning/nlp/ml-nlp-elser.md) and [E5](/explore-analyze/machine-learning/nlp/ml-nlp-e5.md)), as well as popular third-party services like Amazon Bedrock, Anthropic, Azure AI Studio, Cohere, Google AI, Mistral, OpenAI, Hugging Face, and more. +{{es}} provides a machine learning [{{infer}} API]({{es-apis}}group/endpoint-inference) to create and manage {{infer}} endpoints that integrate with services such as {{es}} (for built-in NLP models like [ELSER](/explore-analyze/machine-learning/nlp/ml-nlp-elser.md) and [E5](/explore-analyze/machine-learning/nlp/ml-nlp-e5.md)), as well as popular third-party services like Amazon Bedrock, Anthropic, Azure AI Studio, Cohere, Google AI, Mistral, OpenAI, Hugging Face, and more. You can use the default {{infer}} endpoints your deployment contains or create a new {{infer}} endpoint: -- using the [Create an inference endpoint API](https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put) +- using the [Create an inference endpoint API]({{es-apis}}operation/operation-inference-put) - through the [Inference endpoints UI](#add-inference-endpoints). ## Default {{infer}} endpoints [default-enpoints] diff --git a/explore-analyze/machine-learning/nlp/ml-nlp-deploy-model.md b/explore-analyze/machine-learning/nlp/ml-nlp-deploy-model.md index f9d149125c..06b1e0d317 100644 --- a/explore-analyze/machine-learning/nlp/ml-nlp-deploy-model.md +++ b/explore-analyze/machine-learning/nlp/ml-nlp-deploy-model.md @@ -24,7 +24,7 @@ You can optimize your deplyoment for typical use cases, such as search and inges Each deployment will be fine-tuned automatically based on its specific purpose you choose. ::::{note} -Since eland uses APIs to deploy the models, you cannot see the models in {{kib}} until the saved objects are synchronized. You can follow the prompts in {{kib}}, wait for automatic synchronization, or use the [sync {{ml}} saved objects API](https://www.elastic.co/docs/api/doc/kibana/v8/group/endpoint-ml). +Since eland uses APIs to deploy the models, you cannot see the models in {{kib}} until the saved objects are synchronized. You can follow the prompts in {{kib}}, wait for automatic synchronization, or use the [sync {{ml}} saved objects API]({{kib-apis}}group/endpoint-ml). :::: You can define the resource usage level of the NLP model during model deployment. The resource usage levels behave differently depending on [adaptive resources](../../../deploy-manage/autoscaling/trained-model-autoscaling.md#enabling-autoscaling-through-apis-adaptive-allocations) being enabled or disabled. When adaptive resources are disabled but {{ml}} autoscaling is enabled, vCPU usage of Cloud deployments derived from the Cloud console and functions as follows: diff --git a/explore-analyze/machine-learning/nlp/ml-nlp-ner-example.md b/explore-analyze/machine-learning/nlp/ml-nlp-ner-example.md index d4d6b092d6..2a776bf030 100644 --- a/explore-analyze/machine-learning/nlp/ml-nlp-ner-example.md +++ b/explore-analyze/machine-learning/nlp/ml-nlp-ner-example.md @@ -49,7 +49,7 @@ You need to provide an administrator username and its password and replace the ` Since the `--start` option is used at the end of the Eland import command, {{es}} deploys the model ready to use. If you have multiple models and want to select which model to deploy, you can use the **{{ml-app}} > Model Management** user interface in {{kib}} to manage the starting and stopping of models. -Go to the **{{ml-app}} > Trained Models** page and synchronize your trained models. A warning message is displayed at the top of the page that says *"ML job and trained model synchronization required"*. Follow the link to *"Synchronize your jobs and trained models."* Then click **Synchronize**. You can also wait for the automatic synchronization that occurs in every hour, or use the [sync {{ml}} objects API](https://www.elastic.co/docs/api/doc/kibana/v8/group/endpoint-ml). +Go to the **{{ml-app}} > Trained Models** page and synchronize your trained models. A warning message is displayed at the top of the page that says *"ML job and trained model synchronization required"*. Follow the link to *"Synchronize your jobs and trained models."* Then click **Synchronize**. You can also wait for the automatic synchronization that occurs in every hour, or use the [sync {{ml}} objects API]({{kib-apis}}group/endpoint-ml). ## Test the NER model [ex-ner-test] diff --git a/explore-analyze/machine-learning/nlp/ml-nlp-text-emb-vector-search-example.md b/explore-analyze/machine-learning/nlp/ml-nlp-text-emb-vector-search-example.md index fa329929cd..e907c68574 100644 --- a/explore-analyze/machine-learning/nlp/ml-nlp-text-emb-vector-search-example.md +++ b/explore-analyze/machine-learning/nlp/ml-nlp-text-emb-vector-search-example.md @@ -53,7 +53,7 @@ You need to provide an administrator username and password and replace the `$CLO Since the `--start` option is used at the end of the Eland import command, {{es}} deploys the model ready to use. If you have multiple models and want to select which model to deploy, you can use the **{{ml-app}} > Model Management** user interface in {{kib}} to manage the starting and stopping of models. -Go to the **{{ml-app}} > Trained Models** page and synchronize your trained models. A warning message is displayed at the top of the page that says *"ML job and trained model synchronization required"*. Follow the link to *"Synchronize your jobs and trained models."* Then click **Synchronize**. You can also wait for the automatic synchronization that occurs in every hour, or use the [sync {{ml}} objects API](https://www.elastic.co/docs/api/doc/kibana/v8/group/endpoint-ml). +Go to the **{{ml-app}} > Trained Models** page and synchronize your trained models. A warning message is displayed at the top of the page that says *"ML job and trained model synchronization required"*. Follow the link to *"Synchronize your jobs and trained models."* Then click **Synchronize**. You can also wait for the automatic synchronization that occurs in every hour, or use the [sync {{ml}} objects API]({{kib-apis}}group/endpoint-ml). ## Test the text embedding model [ex-text-emb-test] diff --git a/manage-data/lifecycle/index-lifecycle-management.md b/manage-data/lifecycle/index-lifecycle-management.md index ea786fa54a..d5de51b638 100644 --- a/manage-data/lifecycle/index-lifecycle-management.md +++ b/manage-data/lifecycle/index-lifecycle-management.md @@ -72,7 +72,7 @@ For example, if you are indexing metrics data from a fleet of ATMs into Elastics ## Create and manage {{ilm-init}} policies -You can create and manage index lifecycle policies through {{kib}}'s [Index Management](/manage-data/data-store/index-basics.md#index-management) UI or the [{{ilm-init}} APIs](https://www.elastic.co/docs/api/doc/elasticsearch/v8/group/endpoint-ilm). For more details on creating and managing index lifecycle policies refer to: +You can create and manage index lifecycle policies through {{kib}}'s [Index Management](/manage-data/data-store/index-basics.md#index-management) UI or the [{{ilm-init}} APIs]({{es-apis}}group/endpoint-ilm). For more details on creating and managing index lifecycle policies refer to: * [Configure a lifecycle policy](/manage-data/lifecycle/index-lifecycle-management/configure-lifecycle-policy.md) * [View the lifecycle status of an index or datastream](/manage-data/lifecycle/index-lifecycle-management/policy-view-status.md) diff --git a/solutions/search/apis-and-tools.md b/solutions/search/apis-and-tools.md index a3764e890a..41bf317179 100644 --- a/solutions/search/apis-and-tools.md +++ b/solutions/search/apis-and-tools.md @@ -19,31 +19,31 @@ This page is handy list of the most important APIs and tools you need to build, | Endpoint | Function | |----------|----------| -| [`_search`](https://www.elastic.co/docs/api/doc/elasticsearch/v8/group/endpoint-search) | Searches and aggregations written in [Query DSL](/explore-analyze/query-filter/languages/querydsl.md) and [retrievers](retrievers-overview.md) syntax | -| [`_query`](https://www.elastic.co/docs/api/doc/elasticsearch/v8/group/endpoint-esql)| Endpoint for [{{esql}}](elasticsearch://reference/query-languages/esql.md) queries | -| [`_explain`](https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-explain) | Provides detailed explanation of how a specific document matches a query with scoring breakdown | -| [`_count`](https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-count) | Returns count of documents matching a query without retrieving results | -| [`_validate/query`](https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-indices-validate-query) | Validates query syntax without executing the search | +| [`_search`]({{es-apis}}group/endpoint-search) | Searches and aggregations written in [Query DSL](/explore-analyze/query-filter/languages/querydsl.md) and [retrievers](retrievers-overview.md) syntax | +| [`_query`]({{es-apis}}group/endpoint-esql)| Endpoint for [{{esql}}](elasticsearch://reference/query-languages/esql.md) queries | +| [`_explain`]({{es-apis}}operation/operation-explain) | Provides detailed explanation of how a specific document matches a query with scoring breakdown | +| [`_count`]({{es-apis}}operation/operation-count) | Returns count of documents matching a query without retrieving results | +| [`_validate/query`]({{es-apis}}operation/operation-indices-validate-query) | Validates query syntax without executing the search | | [`_analyze`](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-analyze) | Performs analysis for [full-text search](./full-text.md) on a text string and returns the resulting tokens. | ### Ingestion & mapping APIs | Endpoint | Function | |----------|----------| -| [`_mapping`](https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-indices-get-field-mapping) | Retrieves or updates field mappings with options for specific field inspection | -| [`_reindex`](https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-reindex) | Copies documents from one index to another, useful for mapping changes | -| [`_update_by_query`](https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-update-by-query) | Updates documents matching a query without reindexing | -| [`_bulk`](https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-bulk-1) | Performs multiple index/update/delete operations in a single request | -| [`_refresh`](https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-indices-refresh-3) | Forces a refresh to make recent operations searchable | -| [`_ingest/pipeline`](https://www.elastic.co/docs/api/doc/elasticsearch/v8/group/endpoint-ingest) | Creates and manages document processing pipelines before indexing | +| [`_mapping`]({{es-apis}}operation/operation-indices-get-field-mapping) | Retrieves or updates field mappings with options for specific field inspection | +| [`_reindex`]({{es-apis}}operation/operation-reindex) | Copies documents from one index to another, useful for mapping changes | +| [`_update_by_query`]({{es-apis}}operation/operation-update-by-query) | Updates documents matching a query without reindexing | +| [`_bulk`]({{es-apis}}operation/operation-bulk) | Performs multiple index/update/delete operations in a single request | +| [`_refresh`]({{es-apis}}operation/operation-indices-refresh) | Forces a refresh to make recent operations searchable | +| [`_ingest/pipeline`]({{es-apis}}group/endpoint-ingest) | Creates and manages document processing pipelines before indexing | ### Search optimization APIs | Endpoint | Function | |----------|----------| -| [`_rank_eval`](https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-rank-eval)| Evaluates search quality against known relevant documents | -| [`_settings`](https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-indices-get-settings-1) | Configures settings including slow logs, refresh intervals, and replicas (only index-level settings available in serverless) | -| [`_scripts`](https://www.elastic.co/docs/api/doc/elasticsearch/v8/group/endpoint-script) | Creates or updates stored scripts for reuse in queries and aggregations | +| [`_rank_eval`]({{es-apis}}operation/operation-rank-eval)| Evaluates search quality against known relevant documents | +| [`_settings`]({{es-apis}}operation/operation-indices-get-settings) | Configures settings including slow logs, refresh intervals, and replicas (only index-level settings available in serverless) | +| [`_scripts`]({{es-apis}}group/endpoint-script) | Creates or updates stored scripts for reuse in queries and aggregations | ## UI tools [elasticsearch-dev-tools] diff --git a/troubleshoot/elasticsearch/diagnose-unassigned-shards.md b/troubleshoot/elasticsearch/diagnose-unassigned-shards.md index 82e42a5a87..c99bb1f0f2 100644 --- a/troubleshoot/elasticsearch/diagnose-unassigned-shards.md +++ b/troubleshoot/elasticsearch/diagnose-unassigned-shards.md @@ -258,7 +258,7 @@ View [this video](https://www.youtube.com/watch?v=5z3n2VgusLE) for a walkthrough When Elasticsearch is unable to allocate a shard, it will attempt to retry allocation up to the maximum number of retries allowed. After this, Elasticsearch will stop attempting to allocate the shard in order to prevent infinite retries which may impact cluster performance. -You can use an API to [reroute the cluster](https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-cluster-reroute), which will allocate the shard if the issue preventing allocation has been resolved. +You can use an API to [reroute the cluster]({{es-apis}}operation/operation-cluster-reroute), which will allocate the shard if the issue preventing allocation has been resolved. ### No valid shard copy [no-shard-copy] diff --git a/troubleshoot/observability/troubleshoot-service-level-objectives-slos.md b/troubleshoot/observability/troubleshoot-service-level-objectives-slos.md index 28b2793bfa..c5df0a742a 100644 --- a/troubleshoot/observability/troubleshoot-service-level-objectives-slos.md +++ b/troubleshoot/observability/troubleshoot-service-level-objectives-slos.md @@ -194,7 +194,7 @@ Where `sloId` can be obtained from the [Inspect SLO assets](#slo-troubleshoot-in ### Using API calls to retrieve SLO details [slo-api-calls] -Refer to [SLO API calls](https://www.elastic.co/docs/api/doc/kibana/v8/operation/operation-findslosop) as an alternative to [using SLO Inspect](#slo-troubleshoot-inspect). +Refer to [SLO API calls]({{kib-apis}}operation/operation-findslosop) as an alternative to [using SLO Inspect](#slo-troubleshoot-inspect). ## Upgrade from beta to GA [slo-troubleshoot-beta] @@ -209,8 +209,8 @@ To migrate your SLO definitions, open the SLO overview. A banner will display th If you have a large number of SLO definitions, it is possible to automate this process. To do this, you’ll need to use two Elastic APIs: -* [SLO Definitions Find API](https://github.com/elastic/kibana/blob/9cb830fe9a021cda1d091effbe3e0cd300220969/x-pack/plugins/observability/docs/openapi/slo/bundled.yaml#L453-L514) (`/api/observability/slos/_definitions`) -* [SLO Reset API](https://www.elastic.co/docs/api/doc/kibana/v8/operation/operation-resetsloop) +* [SLO Definitions Find API]({{kib-apis}}operation/operation-getdefinitionsop) +* [SLO Reset API]({{kib-apis}}operation/operation-resetsloop) Pass in `includeOutdatedOnly=1` as a query parameter to the Definitions Find API. This will display your outdated SLO definitions. Loop through this list, one by one, calling the Reset API on each outdated SLO definition. The Reset API loads the outdated SLO definition and resets it to the new format required for GA. Once an SLO is reset, it will start to regenerate SLIs and summary data.