Skip to content

Commit af29010

Browse files
Fix outdated v8 and v9 API URLs (#3681)
Co-authored-by: florent-leborgne <[email protected]>
1 parent 856a007 commit af29010

File tree

10 files changed

+26
-26
lines changed

10 files changed

+26
-26
lines changed

deploy-manage/deploy/elastic-cloud/elastic-cloud-hosted-planning.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ We recommend that you use at least two availability zones for production and thr
2828
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.
2929
:::
3030

31-
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:
31+
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:
3232

3333
```sh
3434
GET _all/_settings/index.number_of_replicas

explore-analyze/elastic-inference/eis.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ You can now use `semantic_text` with the new ELSER endpoint on EIS. To learn how
4949
#### Batch size
5050

5151
Batches are limited to a maximum of 16 documents.
52-
This is particularly relevant when using the [_bulk API](https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-bulk) for data ingestion.
52+
This is particularly relevant when using the [_bulk API]({{es-apis}}operation/operation-bulk) for data ingestion.
5353

5454
## Pricing
5555

explore-analyze/elastic-inference/inference-api.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@ products:
1111

1212
# {{infer-cap}} integrations
1313

14-
{{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.
14+
{{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.
1515

1616
You can use the default {{infer}} endpoints your deployment contains or create a new {{infer}} endpoint:
1717

18-
- using the [Create an inference endpoint API](https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put)
18+
- using the [Create an inference endpoint API]({{es-apis}}operation/operation-inference-put)
1919
- through the [Inference endpoints UI](#add-inference-endpoints).
2020

2121
## Default {{infer}} endpoints [default-enpoints]

explore-analyze/machine-learning/nlp/ml-nlp-deploy-model.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ You can optimize your deplyoment for typical use cases, such as search and inges
2424
Each deployment will be fine-tuned automatically based on its specific purpose you choose.
2525

2626
::::{note}
27-
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).
27+
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).
2828
::::
2929

3030
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:

explore-analyze/machine-learning/nlp/ml-nlp-ner-example.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ You need to provide an administrator username and its password and replace the `
4949

5050
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.
5151

52-
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).
52+
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).
5353

5454
## Test the NER model [ex-ner-test]
5555

explore-analyze/machine-learning/nlp/ml-nlp-text-emb-vector-search-example.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ You need to provide an administrator username and password and replace the `$CLO
5353

5454
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.
5555

56-
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).
56+
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).
5757

5858
## Test the text embedding model [ex-text-emb-test]
5959

manage-data/lifecycle/index-lifecycle-management.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ For example, if you are indexing metrics data from a fleet of ATMs into Elastics
7272

7373
## Create and manage {{ilm-init}} policies
7474

75-
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:
75+
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:
7676

7777
* [Configure a lifecycle policy](/manage-data/lifecycle/index-lifecycle-management/configure-lifecycle-policy.md)
7878
* [View the lifecycle status of an index or datastream](/manage-data/lifecycle/index-lifecycle-management/policy-view-status.md)

solutions/search/apis-and-tools.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -19,31 +19,31 @@ This page is handy list of the most important APIs and tools you need to build,
1919

2020
| Endpoint | Function |
2121
|----------|----------|
22-
| [`_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 |
23-
| [`_query`](https://www.elastic.co/docs/api/doc/elasticsearch/v8/group/endpoint-esql)| Endpoint for [{{esql}}](elasticsearch://reference/query-languages/esql.md) queries |
24-
| [`_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 |
25-
| [`_count`](https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-count) | Returns count of documents matching a query without retrieving results |
26-
| [`_validate/query`](https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-indices-validate-query) | Validates query syntax without executing the search |
22+
| [`_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 |
23+
| [`_query`]({{es-apis}}group/endpoint-esql)| Endpoint for [{{esql}}](elasticsearch://reference/query-languages/esql.md) queries |
24+
| [`_explain`]({{es-apis}}operation/operation-explain) | Provides detailed explanation of how a specific document matches a query with scoring breakdown |
25+
| [`_count`]({{es-apis}}operation/operation-count) | Returns count of documents matching a query without retrieving results |
26+
| [`_validate/query`]({{es-apis}}operation/operation-indices-validate-query) | Validates query syntax without executing the search |
2727
| [`_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. |
2828

2929
### Ingestion & mapping APIs
3030

3131
| Endpoint | Function |
3232
|----------|----------|
33-
| [`_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 |
34-
| [`_reindex`](https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-reindex) | Copies documents from one index to another, useful for mapping changes |
35-
| [`_update_by_query`](https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-update-by-query) | Updates documents matching a query without reindexing |
36-
| [`_bulk`](https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-bulk-1) | Performs multiple index/update/delete operations in a single request |
37-
| [`_refresh`](https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-indices-refresh-3) | Forces a refresh to make recent operations searchable |
38-
| [`_ingest/pipeline`](https://www.elastic.co/docs/api/doc/elasticsearch/v8/group/endpoint-ingest) | Creates and manages document processing pipelines before indexing |
33+
| [`_mapping`]({{es-apis}}operation/operation-indices-get-field-mapping) | Retrieves or updates field mappings with options for specific field inspection |
34+
| [`_reindex`]({{es-apis}}operation/operation-reindex) | Copies documents from one index to another, useful for mapping changes |
35+
| [`_update_by_query`]({{es-apis}}operation/operation-update-by-query) | Updates documents matching a query without reindexing |
36+
| [`_bulk`]({{es-apis}}operation/operation-bulk) | Performs multiple index/update/delete operations in a single request |
37+
| [`_refresh`]({{es-apis}}operation/operation-indices-refresh) | Forces a refresh to make recent operations searchable |
38+
| [`_ingest/pipeline`]({{es-apis}}group/endpoint-ingest) | Creates and manages document processing pipelines before indexing |
3939

4040
### Search optimization APIs
4141

4242
| Endpoint | Function |
4343
|----------|----------|
44-
| [`_rank_eval`](https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-rank-eval)| Evaluates search quality against known relevant documents |
45-
| [`_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) |
46-
| [`_scripts`](https://www.elastic.co/docs/api/doc/elasticsearch/v8/group/endpoint-script) | Creates or updates stored scripts for reuse in queries and aggregations |
44+
| [`_rank_eval`]({{es-apis}}operation/operation-rank-eval)| Evaluates search quality against known relevant documents |
45+
| [`_settings`]({{es-apis}}operation/operation-indices-get-settings) | Configures settings including slow logs, refresh intervals, and replicas (only index-level settings available in serverless) |
46+
| [`_scripts`]({{es-apis}}group/endpoint-script) | Creates or updates stored scripts for reuse in queries and aggregations |
4747

4848

4949
## UI tools [elasticsearch-dev-tools]

troubleshoot/elasticsearch/diagnose-unassigned-shards.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -258,7 +258,7 @@ View [this video](https://www.youtube.com/watch?v=5z3n2VgusLE) for a walkthrough
258258

259259
When Elasticsearch is unable to allocate a shard, it will attempt to retry allocation up to the maximum number of retries allowed.
260260
After this, Elasticsearch will stop attempting to allocate the shard in order to prevent infinite retries which may impact cluster performance.
261-
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.
261+
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.
262262

263263
### No valid shard copy [no-shard-copy]
264264

troubleshoot/observability/troubleshoot-service-level-objectives-slos.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -194,7 +194,7 @@ Where `sloId` can be obtained from the [Inspect SLO assets](#slo-troubleshoot-in
194194

195195
### Using API calls to retrieve SLO details [slo-api-calls]
196196

197-
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).
197+
Refer to [SLO API calls]({{kib-apis}}operation/operation-findslosop) as an alternative to [using SLO Inspect](#slo-troubleshoot-inspect).
198198

199199

200200
## 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
209209

210210
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:
211211

212-
* [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`)
213-
* [SLO Reset API](https://www.elastic.co/docs/api/doc/kibana/v8/operation/operation-resetsloop)
212+
* [SLO Definitions Find API]({{kib-apis}}operation/operation-getdefinitionsop)
213+
* [SLO Reset API]({{kib-apis}}operation/operation-resetsloop)
214214

215215
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.
216216

0 commit comments

Comments
 (0)