elasticsearch 8.18.0__py3-none-any.whl → 9.0.1__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (107) hide show
  1. elasticsearch/_async/client/__init__.py +62 -277
  2. elasticsearch/_async/client/_base.py +1 -1
  3. elasticsearch/_async/client/async_search.py +6 -10
  4. elasticsearch/_async/client/autoscaling.py +4 -4
  5. elasticsearch/_async/client/cat.py +26 -33
  6. elasticsearch/_async/client/ccr.py +13 -13
  7. elasticsearch/_async/client/cluster.py +20 -20
  8. elasticsearch/_async/client/connector.py +44 -30
  9. elasticsearch/_async/client/dangling_indices.py +3 -3
  10. elasticsearch/_async/client/enrich.py +5 -5
  11. elasticsearch/_async/client/eql.py +4 -4
  12. elasticsearch/_async/client/esql.py +7 -11
  13. elasticsearch/_async/client/features.py +2 -2
  14. elasticsearch/_async/client/fleet.py +18 -20
  15. elasticsearch/_async/client/graph.py +1 -1
  16. elasticsearch/_async/client/ilm.py +18 -11
  17. elasticsearch/_async/client/indices.py +75 -163
  18. elasticsearch/_async/client/inference.py +132 -25
  19. elasticsearch/_async/client/ingest.py +12 -12
  20. elasticsearch/_async/client/license.py +7 -7
  21. elasticsearch/_async/client/logstash.py +3 -3
  22. elasticsearch/_async/client/migration.py +3 -3
  23. elasticsearch/_async/client/ml.py +80 -85
  24. elasticsearch/_async/client/monitoring.py +1 -1
  25. elasticsearch/_async/client/nodes.py +8 -8
  26. elasticsearch/_async/client/query_rules.py +8 -8
  27. elasticsearch/_async/client/rollup.py +8 -8
  28. elasticsearch/_async/client/search_application.py +10 -10
  29. elasticsearch/_async/client/searchable_snapshots.py +4 -4
  30. elasticsearch/_async/client/security.py +71 -68
  31. elasticsearch/_async/client/shutdown.py +3 -3
  32. elasticsearch/_async/client/simulate.py +1 -1
  33. elasticsearch/_async/client/slm.py +9 -9
  34. elasticsearch/_async/client/snapshot.py +280 -130
  35. elasticsearch/_async/client/sql.py +6 -6
  36. elasticsearch/_async/client/ssl.py +1 -1
  37. elasticsearch/_async/client/synonyms.py +7 -7
  38. elasticsearch/_async/client/tasks.py +3 -3
  39. elasticsearch/_async/client/text_structure.py +4 -4
  40. elasticsearch/_async/client/transform.py +11 -11
  41. elasticsearch/_async/client/watcher.py +14 -14
  42. elasticsearch/_async/client/xpack.py +2 -2
  43. elasticsearch/_sync/client/__init__.py +62 -277
  44. elasticsearch/_sync/client/_base.py +1 -1
  45. elasticsearch/_sync/client/async_search.py +6 -10
  46. elasticsearch/_sync/client/autoscaling.py +4 -4
  47. elasticsearch/_sync/client/cat.py +26 -33
  48. elasticsearch/_sync/client/ccr.py +13 -13
  49. elasticsearch/_sync/client/cluster.py +20 -20
  50. elasticsearch/_sync/client/connector.py +44 -30
  51. elasticsearch/_sync/client/dangling_indices.py +3 -3
  52. elasticsearch/_sync/client/enrich.py +5 -5
  53. elasticsearch/_sync/client/eql.py +4 -4
  54. elasticsearch/_sync/client/esql.py +7 -11
  55. elasticsearch/_sync/client/features.py +2 -2
  56. elasticsearch/_sync/client/fleet.py +18 -20
  57. elasticsearch/_sync/client/graph.py +1 -1
  58. elasticsearch/_sync/client/ilm.py +18 -11
  59. elasticsearch/_sync/client/indices.py +75 -163
  60. elasticsearch/_sync/client/inference.py +132 -25
  61. elasticsearch/_sync/client/ingest.py +12 -12
  62. elasticsearch/_sync/client/license.py +7 -7
  63. elasticsearch/_sync/client/logstash.py +3 -3
  64. elasticsearch/_sync/client/migration.py +3 -3
  65. elasticsearch/_sync/client/ml.py +80 -85
  66. elasticsearch/_sync/client/monitoring.py +1 -1
  67. elasticsearch/_sync/client/nodes.py +8 -8
  68. elasticsearch/_sync/client/query_rules.py +8 -8
  69. elasticsearch/_sync/client/rollup.py +8 -8
  70. elasticsearch/_sync/client/search_application.py +10 -10
  71. elasticsearch/_sync/client/searchable_snapshots.py +4 -4
  72. elasticsearch/_sync/client/security.py +71 -68
  73. elasticsearch/_sync/client/shutdown.py +3 -3
  74. elasticsearch/_sync/client/simulate.py +1 -1
  75. elasticsearch/_sync/client/slm.py +9 -9
  76. elasticsearch/_sync/client/snapshot.py +280 -130
  77. elasticsearch/_sync/client/sql.py +6 -6
  78. elasticsearch/_sync/client/ssl.py +1 -1
  79. elasticsearch/_sync/client/synonyms.py +7 -7
  80. elasticsearch/_sync/client/tasks.py +3 -3
  81. elasticsearch/_sync/client/text_structure.py +4 -4
  82. elasticsearch/_sync/client/transform.py +11 -11
  83. elasticsearch/_sync/client/utils.py +0 -37
  84. elasticsearch/_sync/client/watcher.py +14 -14
  85. elasticsearch/_sync/client/xpack.py +2 -2
  86. elasticsearch/_version.py +1 -1
  87. elasticsearch/dsl/_async/search.py +7 -3
  88. elasticsearch/dsl/_sync/search.py +7 -3
  89. elasticsearch/dsl/aggs.py +11 -7
  90. elasticsearch/dsl/faceted_search_base.py +4 -4
  91. elasticsearch/dsl/field.py +139 -1
  92. elasticsearch/dsl/query.py +7 -1
  93. elasticsearch/dsl/search_base.py +16 -3
  94. elasticsearch/dsl/types.py +66 -84
  95. elasticsearch/dsl/wrappers.py +25 -0
  96. elasticsearch/exceptions.py +2 -0
  97. elasticsearch/helpers/vectorstore/_async/strategies.py +12 -12
  98. elasticsearch/helpers/vectorstore/_sync/strategies.py +12 -12
  99. {elasticsearch-8.18.0.dist-info → elasticsearch-9.0.1.dist-info}/METADATA +17 -29
  100. elasticsearch-9.0.1.dist-info/RECORD +162 -0
  101. elasticsearch-9.0.1.dist-info/licenses/LICENSE.txt +175 -0
  102. elasticsearch-9.0.1.dist-info/licenses/NOTICE.txt +559 -0
  103. elasticsearch/transport.py +0 -57
  104. elasticsearch-8.18.0.dist-info/RECORD +0 -161
  105. {elasticsearch-8.18.0.dist-info → elasticsearch-9.0.1.dist-info}/WHEEL +0 -0
  106. {elasticsearch-8.18.0.dist-info → elasticsearch-9.0.1.dist-info}/licenses/LICENSE +0 -0
  107. {elasticsearch-8.18.0.dist-info → elasticsearch-9.0.1.dist-info}/licenses/NOTICE +0 -0
@@ -47,7 +47,7 @@ class InferenceClient(NamespacedClient):
47
47
  <p>Perform completion inference on the service</p>
48
48
 
49
49
 
50
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/post-inference-api.html>`_
50
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-inference>`_
51
51
 
52
52
  :param inference_id: The inference Id
53
53
  :param input: Inference input. Either a string or an array of strings.
@@ -123,7 +123,7 @@ class InferenceClient(NamespacedClient):
123
123
  <p>Delete an inference endpoint</p>
124
124
 
125
125
 
126
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/delete-inference-api.html>`_
126
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-delete>`_
127
127
 
128
128
  :param inference_id: The inference identifier.
129
129
  :param task_type: The task type
@@ -197,7 +197,7 @@ class InferenceClient(NamespacedClient):
197
197
  <p>Get an inference endpoint</p>
198
198
 
199
199
 
200
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/get-inference-api.html>`_
200
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-get>`_
201
201
 
202
202
  :param task_type: The task type
203
203
  :param inference_id: The inference Id
@@ -234,6 +234,113 @@ class InferenceClient(NamespacedClient):
234
234
  path_parts=__path_parts,
235
235
  )
236
236
 
237
+ @_rewrite_parameters(
238
+ body_fields=("input", "query", "task_settings"),
239
+ )
240
+ def inference(
241
+ self,
242
+ *,
243
+ inference_id: str,
244
+ input: t.Optional[t.Union[str, t.Sequence[str]]] = None,
245
+ task_type: t.Optional[
246
+ t.Union[
247
+ str,
248
+ t.Literal[
249
+ "chat_completion",
250
+ "completion",
251
+ "rerank",
252
+ "sparse_embedding",
253
+ "text_embedding",
254
+ ],
255
+ ]
256
+ ] = None,
257
+ error_trace: t.Optional[bool] = None,
258
+ filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
259
+ human: t.Optional[bool] = None,
260
+ pretty: t.Optional[bool] = None,
261
+ query: t.Optional[str] = None,
262
+ task_settings: t.Optional[t.Any] = None,
263
+ timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
264
+ body: t.Optional[t.Dict[str, t.Any]] = None,
265
+ ) -> ObjectApiResponse[t.Any]:
266
+ """
267
+ .. raw:: html
268
+
269
+ <p>Perform inference on the service.</p>
270
+ <p>This API enables you to use machine learning models to perform specific tasks on data that you provide as an input.
271
+ It returns a response with the results of the tasks.
272
+ The inference endpoint you use can perform one specific task that has been defined when the endpoint was created with the create inference API.</p>
273
+ <p>For details about using this API with a service, such as Amazon Bedrock, Anthropic, or HuggingFace, refer to the service-specific documentation.</p>
274
+ <blockquote>
275
+ <p>info
276
+ The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Azure, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs.</p>
277
+ </blockquote>
278
+
279
+
280
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-inference>`_
281
+
282
+ :param inference_id: The unique identifier for the inference endpoint.
283
+ :param input: The text on which you want to perform the inference task. It can
284
+ be a single string or an array. > info > Inference endpoints for the `completion`
285
+ task type currently only support a single string as input.
286
+ :param task_type: The type of inference task that the model performs.
287
+ :param query: The query input, which is required only for the `rerank` task.
288
+ It is not required for other tasks.
289
+ :param task_settings: Task settings for the individual inference request. These
290
+ settings are specific to the task type you specified and override the task
291
+ settings specified when initializing the service.
292
+ :param timeout: The amount of time to wait for the inference request to complete.
293
+ """
294
+ if inference_id in SKIP_IN_PATH:
295
+ raise ValueError("Empty value passed for parameter 'inference_id'")
296
+ if input is None and body is None:
297
+ raise ValueError("Empty value passed for parameter 'input'")
298
+ __path_parts: t.Dict[str, str]
299
+ if task_type not in SKIP_IN_PATH and inference_id not in SKIP_IN_PATH:
300
+ __path_parts = {
301
+ "task_type": _quote(task_type),
302
+ "inference_id": _quote(inference_id),
303
+ }
304
+ __path = f'/_inference/{__path_parts["task_type"]}/{__path_parts["inference_id"]}'
305
+ elif inference_id not in SKIP_IN_PATH:
306
+ __path_parts = {"inference_id": _quote(inference_id)}
307
+ __path = f'/_inference/{__path_parts["inference_id"]}'
308
+ else:
309
+ raise ValueError("Couldn't find a path for the given parameters")
310
+ __query: t.Dict[str, t.Any] = {}
311
+ __body: t.Dict[str, t.Any] = body if body is not None else {}
312
+ if error_trace is not None:
313
+ __query["error_trace"] = error_trace
314
+ if filter_path is not None:
315
+ __query["filter_path"] = filter_path
316
+ if human is not None:
317
+ __query["human"] = human
318
+ if pretty is not None:
319
+ __query["pretty"] = pretty
320
+ if timeout is not None:
321
+ __query["timeout"] = timeout
322
+ if not __body:
323
+ if input is not None:
324
+ __body["input"] = input
325
+ if query is not None:
326
+ __body["query"] = query
327
+ if task_settings is not None:
328
+ __body["task_settings"] = task_settings
329
+ if not __body:
330
+ __body = None # type: ignore[assignment]
331
+ __headers = {"accept": "application/json"}
332
+ if __body is not None:
333
+ __headers["content-type"] = "application/json"
334
+ return self.perform_request( # type: ignore[return-value]
335
+ "POST",
336
+ __path,
337
+ params=__query,
338
+ headers=__headers,
339
+ body=__body,
340
+ endpoint_id="inference.inference",
341
+ path_parts=__path_parts,
342
+ )
343
+
237
344
  @_rewrite_parameters(
238
345
  body_name="inference_config",
239
346
  )
@@ -274,7 +381,7 @@ class InferenceClient(NamespacedClient):
274
381
  However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs.</p>
275
382
 
276
383
 
277
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/put-inference-api.html>`_
384
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put>`_
278
385
 
279
386
  :param inference_id: The inference Id
280
387
  :param inference_config:
@@ -358,7 +465,7 @@ class InferenceClient(NamespacedClient):
358
465
  Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.</p>
359
466
 
360
467
 
361
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/infer-service-alibabacloud-ai-search.html>`_
468
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-alibabacloud>`_
362
469
 
363
470
  :param task_type: The type of the inference task that the model will perform.
364
471
  :param alibabacloud_inference_id: The unique identifier of the inference endpoint.
@@ -458,7 +565,7 @@ class InferenceClient(NamespacedClient):
458
565
  Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.</p>
459
566
 
460
567
 
461
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/infer-service-amazon-bedrock.html>`_
568
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-amazonbedrock>`_
462
569
 
463
570
  :param task_type: The type of the inference task that the model will perform.
464
571
  :param amazonbedrock_inference_id: The unique identifier of the inference endpoint.
@@ -554,7 +661,7 @@ class InferenceClient(NamespacedClient):
554
661
  Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.</p>
555
662
 
556
663
 
557
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/infer-service-anthropic.html>`_
664
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-anthropic>`_
558
665
 
559
666
  :param task_type: The task type. The only valid task type for the model to perform
560
667
  is `completion`.
@@ -651,7 +758,7 @@ class InferenceClient(NamespacedClient):
651
758
  Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.</p>
652
759
 
653
760
 
654
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/infer-service-azure-ai-studio.html>`_
761
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-azureaistudio>`_
655
762
 
656
763
  :param task_type: The type of the inference task that the model will perform.
657
764
  :param azureaistudio_inference_id: The unique identifier of the inference endpoint.
@@ -753,7 +860,7 @@ class InferenceClient(NamespacedClient):
753
860
  Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.</p>
754
861
 
755
862
 
756
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/infer-service-azure-openai.html>`_
863
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-azureopenai>`_
757
864
 
758
865
  :param task_type: The type of the inference task that the model will perform.
759
866
  NOTE: The `chat_completion` task type only supports streaming and only through
@@ -851,7 +958,7 @@ class InferenceClient(NamespacedClient):
851
958
  Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.</p>
852
959
 
853
960
 
854
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/infer-service-cohere.html>`_
961
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-cohere>`_
855
962
 
856
963
  :param task_type: The type of the inference task that the model will perform.
857
964
  :param cohere_inference_id: The unique identifier of the inference endpoint.
@@ -955,7 +1062,7 @@ class InferenceClient(NamespacedClient):
955
1062
  Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.</p>
956
1063
 
957
1064
 
958
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/infer-service-elasticsearch.html>`_
1065
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-elasticsearch>`_
959
1066
 
960
1067
  :param task_type: The type of the inference task that the model will perform.
961
1068
  :param elasticsearch_inference_id: The unique identifier of the inference endpoint.
@@ -1055,7 +1162,7 @@ class InferenceClient(NamespacedClient):
1055
1162
  Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.</p>
1056
1163
 
1057
1164
 
1058
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/infer-service-elser.html>`_
1165
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-elser>`_
1059
1166
 
1060
1167
  :param task_type: The type of the inference task that the model will perform.
1061
1168
  :param elser_inference_id: The unique identifier of the inference endpoint.
@@ -1139,7 +1246,7 @@ class InferenceClient(NamespacedClient):
1139
1246
  Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.</p>
1140
1247
 
1141
1248
 
1142
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/infer-service-google-ai-studio.html>`_
1249
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-googleaistudio>`_
1143
1250
 
1144
1251
  :param task_type: The type of the inference task that the model will perform.
1145
1252
  :param googleaistudio_inference_id: The unique identifier of the inference endpoint.
@@ -1231,7 +1338,7 @@ class InferenceClient(NamespacedClient):
1231
1338
  Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.</p>
1232
1339
 
1233
1340
 
1234
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/infer-service-google-vertex-ai.html>`_
1341
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-googlevertexai>`_
1235
1342
 
1236
1343
  :param task_type: The type of the inference task that the model will perform.
1237
1344
  :param googlevertexai_inference_id: The unique identifier of the inference endpoint.
@@ -1334,7 +1441,7 @@ class InferenceClient(NamespacedClient):
1334
1441
  Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.</p>
1335
1442
 
1336
1443
 
1337
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/infer-service-hugging-face.html>`_
1444
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-hugging-face>`_
1338
1445
 
1339
1446
  :param task_type: The type of the inference task that the model will perform.
1340
1447
  :param huggingface_inference_id: The unique identifier of the inference endpoint.
@@ -1428,7 +1535,7 @@ class InferenceClient(NamespacedClient):
1428
1535
  Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.</p>
1429
1536
 
1430
1537
 
1431
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/infer-service-jinaai.html>`_
1538
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-jinaai>`_
1432
1539
 
1433
1540
  :param task_type: The type of the inference task that the model will perform.
1434
1541
  :param jinaai_inference_id: The unique identifier of the inference endpoint.
@@ -1516,7 +1623,7 @@ class InferenceClient(NamespacedClient):
1516
1623
  Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.</p>
1517
1624
 
1518
1625
 
1519
- `<https://www.elastic.co/guide/en/elasticsearch/reference/{brnach}/infer-service-mistral.html>`_
1626
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-mistral>`_
1520
1627
 
1521
1628
  :param task_type: The task type. The only valid task type for the model to perform
1522
1629
  is `text_embedding`.
@@ -1601,7 +1708,7 @@ class InferenceClient(NamespacedClient):
1601
1708
  .. raw:: html
1602
1709
 
1603
1710
  <p>Create an OpenAI inference endpoint.</p>
1604
- <p>Create an inference endpoint to perform an inference task with the <code>openai</code> service or <code>openai</code> compatible APIs.</p>
1711
+ <p>Create an inference endpoint to perform an inference task with the <code>openai</code> service.</p>
1605
1712
  <p>When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.
1606
1713
  After creating the endpoint, wait for the model deployment to complete before using it.
1607
1714
  To verify the deployment status, use the get trained model statistics API.
@@ -1609,7 +1716,7 @@ class InferenceClient(NamespacedClient):
1609
1716
  Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.</p>
1610
1717
 
1611
1718
 
1612
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/infer-service-openai.html>`_
1719
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-openai>`_
1613
1720
 
1614
1721
  :param task_type: The type of the inference task that the model will perform.
1615
1722
  NOTE: The `chat_completion` task type only supports streaming and only through
@@ -1701,7 +1808,7 @@ class InferenceClient(NamespacedClient):
1701
1808
  <p>Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.</p>
1702
1809
 
1703
1810
 
1704
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/infer-service-voyageai.html>`_
1811
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-voyageai>`_
1705
1812
 
1706
1813
  :param task_type: The type of the inference task that the model will perform.
1707
1814
  :param voyageai_inference_id: The unique identifier of the inference endpoint.
@@ -1790,7 +1897,7 @@ class InferenceClient(NamespacedClient):
1790
1897
  Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.</p>
1791
1898
 
1792
1899
 
1793
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/infer-service-watsonx-ai.html>`_
1900
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-watsonx>`_
1794
1901
 
1795
1902
  :param task_type: The task type. The only valid task type for the model to perform
1796
1903
  is `text_embedding`.
@@ -1866,7 +1973,7 @@ class InferenceClient(NamespacedClient):
1866
1973
  <p>Perform rereanking inference on the service</p>
1867
1974
 
1868
1975
 
1869
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/post-inference-api.html>`_
1976
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-inference>`_
1870
1977
 
1871
1978
  :param inference_id: The unique identifier for the inference endpoint.
1872
1979
  :param input: The text on which you want to perform the inference task. It can
@@ -1942,7 +2049,7 @@ class InferenceClient(NamespacedClient):
1942
2049
  <p>Perform sparse embedding inference on the service</p>
1943
2050
 
1944
2051
 
1945
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/post-inference-api.html>`_
2052
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-inference>`_
1946
2053
 
1947
2054
  :param inference_id: The inference Id
1948
2055
  :param input: Inference input. Either a string or an array of strings.
@@ -2010,7 +2117,7 @@ class InferenceClient(NamespacedClient):
2010
2117
  <p>Perform text embedding inference on the service</p>
2011
2118
 
2012
2119
 
2013
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/post-inference-api.html>`_
2120
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-inference>`_
2014
2121
 
2015
2122
  :param inference_id: The inference Id
2016
2123
  :param input: Inference input. Either a string or an array of strings.
@@ -2092,7 +2199,7 @@ class InferenceClient(NamespacedClient):
2092
2199
  However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs.</p>
2093
2200
 
2094
2201
 
2095
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/update-inference-api.html>`_
2202
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-update>`_
2096
2203
 
2097
2204
  :param inference_id: The unique identifier of the inference endpoint.
2098
2205
  :param inference_config:
@@ -44,7 +44,7 @@ class IngestClient(NamespacedClient):
44
44
  <p>Delete one or more IP geolocation database configurations.</p>
45
45
 
46
46
 
47
- `<https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-ingest-delete-geoip-database>`_
47
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ingest-delete-geoip-database>`_
48
48
 
49
49
  :param id: A comma-separated list of geoip database configurations to delete
50
50
  :param master_timeout: The period to wait for a connection to the master node.
@@ -98,7 +98,7 @@ class IngestClient(NamespacedClient):
98
98
  <p>Delete IP geolocation database configurations.</p>
99
99
 
100
100
 
101
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/delete-ip-location-database-api.html>`_
101
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ingest-delete-ip-location-database>`_
102
102
 
103
103
  :param id: A comma-separated list of IP location database configurations.
104
104
  :param master_timeout: The period to wait for a connection to the master node.
@@ -155,7 +155,7 @@ class IngestClient(NamespacedClient):
155
155
  Delete one or more ingest pipelines.</p>
156
156
 
157
157
 
158
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/delete-pipeline-api.html>`_
158
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ingest-delete-pipeline>`_
159
159
 
160
160
  :param id: Pipeline ID or wildcard expression of pipeline IDs used to limit the
161
161
  request. To delete all ingest pipelines in a cluster, use a value of `*`.
@@ -208,7 +208,7 @@ class IngestClient(NamespacedClient):
208
208
  Get download statistics for GeoIP2 databases that are used with the GeoIP processor.</p>
209
209
 
210
210
 
211
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/geoip-processor.html>`_
211
+ `<https://www.elastic.co/docs/reference/enrich-processor/geoip-processor>`_
212
212
  """
213
213
  __path_parts: t.Dict[str, str] = {}
214
214
  __path = "/_ingest/geoip/stats"
@@ -248,7 +248,7 @@ class IngestClient(NamespacedClient):
248
248
  <p>Get information about one or more IP geolocation database configurations.</p>
249
249
 
250
250
 
251
- `<https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-ingest-get-geoip-database>`_
251
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ingest-get-geoip-database>`_
252
252
 
253
253
  :param id: A comma-separated list of database configuration IDs to retrieve.
254
254
  Wildcard (`*`) expressions are supported. To get all database configurations,
@@ -297,7 +297,7 @@ class IngestClient(NamespacedClient):
297
297
  <p>Get IP geolocation database configurations.</p>
298
298
 
299
299
 
300
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/get-ip-location-database-api.html>`_
300
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ingest-get-ip-location-database>`_
301
301
 
302
302
  :param id: Comma-separated list of database configuration IDs to retrieve. Wildcard
303
303
  (`*`) expressions are supported. To get all database configurations, omit
@@ -355,7 +355,7 @@ class IngestClient(NamespacedClient):
355
355
  This API returns a local reference of the pipeline.</p>
356
356
 
357
357
 
358
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/get-pipeline-api.html>`_
358
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ingest-get-pipeline>`_
359
359
 
360
360
  :param id: Comma-separated list of pipeline IDs to retrieve. Wildcard (`*`) expressions
361
361
  are supported. To get all ingest pipelines, omit this parameter or use `*`.
@@ -412,7 +412,7 @@ class IngestClient(NamespacedClient):
412
412
  A grok pattern is like a regular expression that supports aliased expressions that can be reused.</p>
413
413
 
414
414
 
415
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/grok-processor.html>`_
415
+ `<https://www.elastic.co/docs/reference/enrich-processor/grok-processor>`_
416
416
  """
417
417
  __path_parts: t.Dict[str, str] = {}
418
418
  __path = "/_ingest/processor/grok"
@@ -459,7 +459,7 @@ class IngestClient(NamespacedClient):
459
459
  <p>Refer to the create or update IP geolocation database configuration API.</p>
460
460
 
461
461
 
462
- `<https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-ingest-put-geoip-database>`_
462
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ingest-put-geoip-database>`_
463
463
 
464
464
  :param id: ID of the database configuration to create or update.
465
465
  :param maxmind: The configuration necessary to identify which IP geolocation
@@ -534,7 +534,7 @@ class IngestClient(NamespacedClient):
534
534
  <p>Create or update an IP geolocation database configuration.</p>
535
535
 
536
536
 
537
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/put-ip-location-database-api.html>`_
537
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ingest-put-ip-location-database>`_
538
538
 
539
539
  :param id: The database configuration identifier.
540
540
  :param configuration:
@@ -620,7 +620,7 @@ class IngestClient(NamespacedClient):
620
620
  Changes made using this API take effect immediately.</p>
621
621
 
622
622
 
623
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/ingest.html>`_
623
+ `<https://www.elastic.co/docs/manage-data/ingest/transform-enrich/ingest-pipelines>`_
624
624
 
625
625
  :param id: ID of the ingest pipeline to create or update.
626
626
  :param deprecated: Marks this ingest pipeline as deprecated. When a deprecated
@@ -717,7 +717,7 @@ class IngestClient(NamespacedClient):
717
717
  You can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request.</p>
718
718
 
719
719
 
720
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/simulate-pipeline-api.html>`_
720
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ingest-simulate>`_
721
721
 
722
722
  :param docs: Sample documents to test in the pipeline.
723
723
  :param id: The pipeline to test. If you don't specify a `pipeline` in the request
@@ -44,7 +44,7 @@ class LicenseClient(NamespacedClient):
44
44
  <p>If the operator privileges feature is enabled, only operator users can use this API.</p>
45
45
 
46
46
 
47
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/delete-license.html>`_
47
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-license-delete>`_
48
48
 
49
49
  :param master_timeout: The period to wait for a connection to the master node.
50
50
  :param timeout: The period to wait for a response. If no response is received
@@ -98,7 +98,7 @@ class LicenseClient(NamespacedClient):
98
98
  </blockquote>
99
99
 
100
100
 
101
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/get-license.html>`_
101
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-license-get>`_
102
102
 
103
103
  :param accept_enterprise: If `true`, this parameter returns enterprise for Enterprise
104
104
  license types. If `false`, this parameter returns platinum for both platinum
@@ -147,7 +147,7 @@ class LicenseClient(NamespacedClient):
147
147
  <p>Get the basic license status.</p>
148
148
 
149
149
 
150
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/get-basic-status.html>`_
150
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-license-get-basic-status>`_
151
151
  """
152
152
  __path_parts: t.Dict[str, str] = {}
153
153
  __path = "/_license/basic_status"
@@ -185,7 +185,7 @@ class LicenseClient(NamespacedClient):
185
185
  <p>Get the trial status.</p>
186
186
 
187
187
 
188
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/get-trial-status.html>`_
188
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-license-get-trial-status>`_
189
189
  """
190
190
  __path_parts: t.Dict[str, str] = {}
191
191
  __path = "/_license/trial_status"
@@ -237,7 +237,7 @@ class LicenseClient(NamespacedClient):
237
237
  If the operator privileges feature is enabled, only operator users can use this API.</p>
238
238
 
239
239
 
240
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/update-license.html>`_
240
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-license-post>`_
241
241
 
242
242
  :param acknowledge: Specifies whether you acknowledge the license changes.
243
243
  :param license:
@@ -308,7 +308,7 @@ class LicenseClient(NamespacedClient):
308
308
  <p>To check the status of your basic license, use the get basic license API.</p>
309
309
 
310
310
 
311
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/start-basic.html>`_
311
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-license-post-start-basic>`_
312
312
 
313
313
  :param acknowledge: whether the user has acknowledged acknowledge messages (default:
314
314
  false)
@@ -365,7 +365,7 @@ class LicenseClient(NamespacedClient):
365
365
  <p>To check the status of your trial, use the get trial status API.</p>
366
366
 
367
367
 
368
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/start-trial.html>`_
368
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-license-post-start-trial>`_
369
369
 
370
370
  :param acknowledge: whether the user has acknowledged acknowledge messages (default:
371
371
  false)
@@ -43,7 +43,7 @@ class LogstashClient(NamespacedClient):
43
43
  If the request succeeds, you receive an empty response with an appropriate status code.</p>
44
44
 
45
45
 
46
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/logstash-api-delete-pipeline.html>`_
46
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-logstash-delete-pipeline>`_
47
47
 
48
48
  :param id: An identifier for the pipeline.
49
49
  """
@@ -87,7 +87,7 @@ class LogstashClient(NamespacedClient):
87
87
  Get pipelines that are used for Logstash Central Management.</p>
88
88
 
89
89
 
90
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/logstash-api-get-pipeline.html>`_
90
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-logstash-get-pipeline>`_
91
91
 
92
92
  :param id: A comma-separated list of pipeline identifiers.
93
93
  """
@@ -139,7 +139,7 @@ class LogstashClient(NamespacedClient):
139
139
  If the specified pipeline exists, it is replaced.</p>
140
140
 
141
141
 
142
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/logstash-api-put-pipeline.html>`_
142
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-logstash-put-pipeline>`_
143
143
 
144
144
  :param id: An identifier for the pipeline.
145
145
  :param pipeline:
@@ -44,7 +44,7 @@ class MigrationClient(NamespacedClient):
44
44
  You are strongly recommended to use the Upgrade Assistant.</p>
45
45
 
46
46
 
47
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/migration-api-deprecation.html>`_
47
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-migration-deprecations>`_
48
48
 
49
49
  :param index: Comma-separate list of data streams or indices to check. Wildcard
50
50
  (*) expressions are supported.
@@ -94,7 +94,7 @@ class MigrationClient(NamespacedClient):
94
94
  You are strongly recommended to use the Upgrade Assistant.</p>
95
95
 
96
96
 
97
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/feature-migration-api.html>`_
97
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-migration-get-feature-upgrade-status>`_
98
98
  """
99
99
  __path_parts: t.Dict[str, str] = {}
100
100
  __path = "/_migration/system_features"
@@ -136,7 +136,7 @@ class MigrationClient(NamespacedClient):
136
136
  <p>TIP: The API is designed for indirect use by the Upgrade Assistant. We strongly recommend you use the Upgrade Assistant.</p>
137
137
 
138
138
 
139
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/feature-migration-api.html>`_
139
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-migration-get-feature-upgrade-status>`_
140
140
  """
141
141
  __path_parts: t.Dict[str, str] = {}
142
142
  __path = "/_migration/system_features"