elasticsearch9 9.0.1__py3-none-any.whl → 9.0.2__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 (28) hide show
  1. elasticsearch9/_async/client/__init__.py +5 -5
  2. elasticsearch9/_async/client/cat.py +201 -7
  3. elasticsearch9/_async/client/indices.py +13 -4
  4. elasticsearch9/_async/client/inference.py +2 -72
  5. elasticsearch9/_sync/client/__init__.py +5 -5
  6. elasticsearch9/_sync/client/cat.py +201 -7
  7. elasticsearch9/_sync/client/indices.py +13 -4
  8. elasticsearch9/_sync/client/inference.py +2 -72
  9. elasticsearch9/_version.py +1 -1
  10. elasticsearch9/dsl/_async/document.py +1 -1
  11. elasticsearch9/dsl/_sync/_sync_check/__init__.py +16 -0
  12. elasticsearch9/dsl/_sync/_sync_check/document.py +514 -0
  13. elasticsearch9/dsl/_sync/_sync_check/faceted_search.py +50 -0
  14. elasticsearch9/dsl/_sync/_sync_check/index.py +597 -0
  15. elasticsearch9/dsl/_sync/_sync_check/mapping.py +49 -0
  16. elasticsearch9/dsl/_sync/_sync_check/search.py +230 -0
  17. elasticsearch9/dsl/_sync/_sync_check/update_by_query.py +45 -0
  18. elasticsearch9/dsl/_sync/document.py +1 -1
  19. elasticsearch9/dsl/field.py +11 -1
  20. elasticsearch9/dsl/query.py +44 -2
  21. elasticsearch9/dsl/types.py +76 -10
  22. {elasticsearch9-9.0.1.dist-info → elasticsearch9-9.0.2.dist-info}/METADATA +1 -3
  23. {elasticsearch9-9.0.1.dist-info → elasticsearch9-9.0.2.dist-info}/RECORD +26 -21
  24. elasticsearch9-9.0.1.dist-info/licenses/LICENSE.txt +0 -175
  25. elasticsearch9-9.0.1.dist-info/licenses/NOTICE.txt +0 -559
  26. {elasticsearch9-9.0.1.dist-info → elasticsearch9-9.0.2.dist-info}/WHEEL +0 -0
  27. {elasticsearch9-9.0.1.dist-info → elasticsearch9-9.0.2.dist-info}/licenses/LICENSE +0 -0
  28. {elasticsearch9-9.0.1.dist-info → elasticsearch9-9.0.2.dist-info}/licenses/NOTICE +0 -0
@@ -1767,7 +1767,200 @@ class CatClient(NamespacedClient):
1767
1767
  filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
1768
1768
  format: t.Optional[str] = None,
1769
1769
  full_id: t.Optional[t.Union[bool, str]] = None,
1770
- h: t.Optional[t.Union[str, t.Sequence[str]]] = None,
1770
+ h: t.Optional[
1771
+ t.Union[
1772
+ t.Sequence[
1773
+ t.Union[
1774
+ str,
1775
+ t.Literal[
1776
+ "build",
1777
+ "completion.size",
1778
+ "cpu",
1779
+ "disk.avail",
1780
+ "disk.total",
1781
+ "disk.used",
1782
+ "disk.used_percent",
1783
+ "fielddata.evictions",
1784
+ "fielddata.memory_size",
1785
+ "file_desc.current",
1786
+ "file_desc.max",
1787
+ "file_desc.percent",
1788
+ "flush.total",
1789
+ "flush.total_time",
1790
+ "get.current",
1791
+ "get.exists_time",
1792
+ "get.exists_total",
1793
+ "get.missing_time",
1794
+ "get.missing_total",
1795
+ "get.time",
1796
+ "get.total",
1797
+ "heap.current",
1798
+ "heap.max",
1799
+ "heap.percent",
1800
+ "http_address",
1801
+ "id",
1802
+ "indexing.delete_current",
1803
+ "indexing.delete_time",
1804
+ "indexing.delete_total",
1805
+ "indexing.index_current",
1806
+ "indexing.index_failed",
1807
+ "indexing.index_failed_due_to_version_conflict",
1808
+ "indexing.index_time",
1809
+ "indexing.index_total",
1810
+ "ip",
1811
+ "jdk",
1812
+ "load_15m",
1813
+ "load_1m",
1814
+ "load_5m",
1815
+ "mappings.total_count",
1816
+ "mappings.total_estimated_overhead_in_bytes",
1817
+ "master",
1818
+ "merges.current",
1819
+ "merges.current_docs",
1820
+ "merges.current_size",
1821
+ "merges.total",
1822
+ "merges.total_docs",
1823
+ "merges.total_size",
1824
+ "merges.total_time",
1825
+ "name",
1826
+ "node.role",
1827
+ "pid",
1828
+ "port",
1829
+ "query_cache.evictions",
1830
+ "query_cache.hit_count",
1831
+ "query_cache.memory_size",
1832
+ "query_cache.miss_count",
1833
+ "ram.current",
1834
+ "ram.max",
1835
+ "ram.percent",
1836
+ "refresh.time",
1837
+ "refresh.total",
1838
+ "request_cache.evictions",
1839
+ "request_cache.hit_count",
1840
+ "request_cache.memory_size",
1841
+ "request_cache.miss_count",
1842
+ "script.cache_evictions",
1843
+ "script.compilations",
1844
+ "search.fetch_current",
1845
+ "search.fetch_time",
1846
+ "search.fetch_total",
1847
+ "search.open_contexts",
1848
+ "search.query_current",
1849
+ "search.query_time",
1850
+ "search.query_total",
1851
+ "search.scroll_current",
1852
+ "search.scroll_time",
1853
+ "search.scroll_total",
1854
+ "segments.count",
1855
+ "segments.fixed_bitset_memory",
1856
+ "segments.index_writer_memory",
1857
+ "segments.memory",
1858
+ "segments.version_map_memory",
1859
+ "shard_stats.total_count",
1860
+ "suggest.current",
1861
+ "suggest.time",
1862
+ "suggest.total",
1863
+ "uptime",
1864
+ "version",
1865
+ ],
1866
+ ]
1867
+ ],
1868
+ t.Union[
1869
+ str,
1870
+ t.Literal[
1871
+ "build",
1872
+ "completion.size",
1873
+ "cpu",
1874
+ "disk.avail",
1875
+ "disk.total",
1876
+ "disk.used",
1877
+ "disk.used_percent",
1878
+ "fielddata.evictions",
1879
+ "fielddata.memory_size",
1880
+ "file_desc.current",
1881
+ "file_desc.max",
1882
+ "file_desc.percent",
1883
+ "flush.total",
1884
+ "flush.total_time",
1885
+ "get.current",
1886
+ "get.exists_time",
1887
+ "get.exists_total",
1888
+ "get.missing_time",
1889
+ "get.missing_total",
1890
+ "get.time",
1891
+ "get.total",
1892
+ "heap.current",
1893
+ "heap.max",
1894
+ "heap.percent",
1895
+ "http_address",
1896
+ "id",
1897
+ "indexing.delete_current",
1898
+ "indexing.delete_time",
1899
+ "indexing.delete_total",
1900
+ "indexing.index_current",
1901
+ "indexing.index_failed",
1902
+ "indexing.index_failed_due_to_version_conflict",
1903
+ "indexing.index_time",
1904
+ "indexing.index_total",
1905
+ "ip",
1906
+ "jdk",
1907
+ "load_15m",
1908
+ "load_1m",
1909
+ "load_5m",
1910
+ "mappings.total_count",
1911
+ "mappings.total_estimated_overhead_in_bytes",
1912
+ "master",
1913
+ "merges.current",
1914
+ "merges.current_docs",
1915
+ "merges.current_size",
1916
+ "merges.total",
1917
+ "merges.total_docs",
1918
+ "merges.total_size",
1919
+ "merges.total_time",
1920
+ "name",
1921
+ "node.role",
1922
+ "pid",
1923
+ "port",
1924
+ "query_cache.evictions",
1925
+ "query_cache.hit_count",
1926
+ "query_cache.memory_size",
1927
+ "query_cache.miss_count",
1928
+ "ram.current",
1929
+ "ram.max",
1930
+ "ram.percent",
1931
+ "refresh.time",
1932
+ "refresh.total",
1933
+ "request_cache.evictions",
1934
+ "request_cache.hit_count",
1935
+ "request_cache.memory_size",
1936
+ "request_cache.miss_count",
1937
+ "script.cache_evictions",
1938
+ "script.compilations",
1939
+ "search.fetch_current",
1940
+ "search.fetch_time",
1941
+ "search.fetch_total",
1942
+ "search.open_contexts",
1943
+ "search.query_current",
1944
+ "search.query_time",
1945
+ "search.query_total",
1946
+ "search.scroll_current",
1947
+ "search.scroll_time",
1948
+ "search.scroll_total",
1949
+ "segments.count",
1950
+ "segments.fixed_bitset_memory",
1951
+ "segments.index_writer_memory",
1952
+ "segments.memory",
1953
+ "segments.version_map_memory",
1954
+ "shard_stats.total_count",
1955
+ "suggest.current",
1956
+ "suggest.time",
1957
+ "suggest.total",
1958
+ "uptime",
1959
+ "version",
1960
+ ],
1961
+ ],
1962
+ ]
1963
+ ] = None,
1771
1964
  help: t.Optional[bool] = None,
1772
1965
  human: t.Optional[bool] = None,
1773
1966
  include_unloaded_segments: t.Optional[bool] = None,
@@ -1794,16 +1987,17 @@ class CatClient(NamespacedClient):
1794
1987
  to `text`, `json`, `cbor`, `yaml`, or `smile`.
1795
1988
  :param full_id: If `true`, return the full node ID. If `false`, return the shortened
1796
1989
  node ID.
1797
- :param h: List of columns to appear in the response. Supports simple wildcards.
1990
+ :param h: A comma-separated list of columns names to display. It supports simple
1991
+ wildcards.
1798
1992
  :param help: When set to `true` will output available columns. This option can't
1799
1993
  be combined with any other query string option.
1800
1994
  :param include_unloaded_segments: If true, the response includes information
1801
1995
  from segments that are not loaded into memory.
1802
- :param master_timeout: Period to wait for a connection to the master node.
1803
- :param s: List of columns that determine how the table should be sorted. Sorting
1804
- defaults to ascending and can be changed by setting `:asc` or `:desc` as
1805
- a suffix to the column name.
1806
- :param time: Unit used to display time values.
1996
+ :param master_timeout: The period to wait for a connection to the master node.
1997
+ :param s: A comma-separated list of column names or aliases that determines the
1998
+ sort order. Sorting defaults to ascending and can be changed by setting `:asc`
1999
+ or `:desc` as a suffix to the column name.
2000
+ :param time: The unit used to display time values.
1807
2001
  :param v: When set to `true` will enable verbose output.
1808
2002
  """
1809
2003
  __path_parts: t.Dict[str, str] = {}
@@ -656,7 +656,15 @@ class IndicesClient(NamespacedClient):
656
656
 
657
657
  `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-create>`_
658
658
 
659
- :param index: Name of the index you wish to create.
659
+ :param index: Name of the index you wish to create. Index names must meet the
660
+ following criteria: * Lowercase only * Cannot include `\\`, `/`, `*`, `?`,
661
+ `"`, `<`, `>`, `|`, ` ` (space character), `,`, or `#` * Indices prior to
662
+ 7.0 could contain a colon (`:`), but that has been deprecated and will not
663
+ be supported in later versions * Cannot start with `-`, `_`, or `+` * Cannot
664
+ be `.` or `..` * Cannot be longer than 255 bytes (note thtat it is bytes,
665
+ so multi-byte characters will reach the limit faster) * Names starting with
666
+ `.` are deprecated, except for hidden indices and internal indices managed
667
+ by plugins
660
668
  :param aliases: Aliases for the index.
661
669
  :param mappings: Mapping for fields in the index. If specified, this mapping
662
670
  can include: - Field names - Field data types - Mapping parameters
@@ -1246,7 +1254,8 @@ class IndicesClient(NamespacedClient):
1246
1254
  """
1247
1255
  .. raw:: html
1248
1256
 
1249
- <p>Delete a legacy index template.</p>
1257
+ <p>Delete a legacy index template.
1258
+ IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.</p>
1250
1259
 
1251
1260
 
1252
1261
  `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-delete-template>`_
@@ -2880,7 +2889,7 @@ class IndicesClient(NamespacedClient):
2880
2889
  """
2881
2890
  .. raw:: html
2882
2891
 
2883
- <p>Get index templates.
2892
+ <p>Get legacy index templates.
2884
2893
  Get information about one or more index templates.</p>
2885
2894
  <p>IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.</p>
2886
2895
 
@@ -3973,7 +3982,7 @@ class IndicesClient(NamespacedClient):
3973
3982
  """
3974
3983
  .. raw:: html
3975
3984
 
3976
- <p>Create or update an index template.
3985
+ <p>Create or update a legacy index template.
3977
3986
  Index templates define settings, mappings, and aliases that can be applied automatically to new indices.
3978
3987
  Elasticsearch applies templates to new indices based on an index pattern that matches the index name.</p>
3979
3988
  <p>IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.</p>
@@ -370,12 +370,7 @@ class InferenceClient(NamespacedClient):
370
370
  """
371
371
  .. raw:: html
372
372
 
373
- <p>Create an inference endpoint.
374
- When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.
375
- After creating the endpoint, wait for the model deployment to complete before using it.
376
- To verify the deployment status, use the get trained model statistics API.
377
- Look for <code>&quot;state&quot;: &quot;fully_allocated&quot;</code> in the response and ensure that the <code>&quot;allocation_count&quot;</code> matches the <code>&quot;target_allocation_count&quot;</code>.
378
- Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.</p>
373
+ <p>Create an inference endpoint.</p>
379
374
  <p>IMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Mistral, Azure OpenAI, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face.
380
375
  For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models.
381
376
  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>
@@ -458,11 +453,6 @@ class InferenceClient(NamespacedClient):
458
453
 
459
454
  <p>Create an AlibabaCloud AI Search inference endpoint.</p>
460
455
  <p>Create an inference endpoint to perform an inference task with the <code>alibabacloud-ai-search</code> service.</p>
461
- <p>When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.
462
- After creating the endpoint, wait for the model deployment to complete before using it.
463
- To verify the deployment status, use the get trained model statistics API.
464
- Look for <code>&quot;state&quot;: &quot;fully_allocated&quot;</code> in the response and ensure that the <code>&quot;allocation_count&quot;</code> matches the <code>&quot;target_allocation_count&quot;</code>.
465
- Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.</p>
466
456
 
467
457
 
468
458
  `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-alibabacloud>`_
@@ -558,11 +548,6 @@ class InferenceClient(NamespacedClient):
558
548
  <p>info
559
549
  You need to provide the access and secret keys only once, during the inference model creation. The get inference API does not retrieve your access or secret keys. After creating the inference model, you cannot change the associated key pairs. If you want to use a different access and secret key pair, delete the inference model and recreate it with the same name and the updated keys.</p>
560
550
  </blockquote>
561
- <p>When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.
562
- After creating the endpoint, wait for the model deployment to complete before using it.
563
- To verify the deployment status, use the get trained model statistics API.
564
- Look for <code>&quot;state&quot;: &quot;fully_allocated&quot;</code> in the response and ensure that the <code>&quot;allocation_count&quot;</code> matches the <code>&quot;target_allocation_count&quot;</code>.
565
- Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.</p>
566
551
 
567
552
 
568
553
  `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-amazonbedrock>`_
@@ -654,11 +639,6 @@ class InferenceClient(NamespacedClient):
654
639
 
655
640
  <p>Create an Anthropic inference endpoint.</p>
656
641
  <p>Create an inference endpoint to perform an inference task with the <code>anthropic</code> service.</p>
657
- <p>When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.
658
- After creating the endpoint, wait for the model deployment to complete before using it.
659
- To verify the deployment status, use the get trained model statistics API.
660
- Look for <code>&quot;state&quot;: &quot;fully_allocated&quot;</code> in the response and ensure that the <code>&quot;allocation_count&quot;</code> matches the <code>&quot;target_allocation_count&quot;</code>.
661
- Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.</p>
662
642
 
663
643
 
664
644
  `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-anthropic>`_
@@ -751,11 +731,6 @@ class InferenceClient(NamespacedClient):
751
731
 
752
732
  <p>Create an Azure AI studio inference endpoint.</p>
753
733
  <p>Create an inference endpoint to perform an inference task with the <code>azureaistudio</code> service.</p>
754
- <p>When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.
755
- After creating the endpoint, wait for the model deployment to complete before using it.
756
- To verify the deployment status, use the get trained model statistics API.
757
- Look for <code>&quot;state&quot;: &quot;fully_allocated&quot;</code> in the response and ensure that the <code>&quot;allocation_count&quot;</code> matches the <code>&quot;target_allocation_count&quot;</code>.
758
- Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.</p>
759
734
 
760
735
 
761
736
  `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-azureaistudio>`_
@@ -853,11 +828,6 @@ class InferenceClient(NamespacedClient):
853
828
  <li><a href="https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models?tabs=global-standard%2Cstandard-chat-completions#gpt-35">GPT-3.5</a></li>
854
829
  </ul>
855
830
  <p>The list of embeddings models that you can choose from in your deployment can be found in the <a href="https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models?tabs=global-standard%2Cstandard-chat-completions#embeddings">Azure models documentation</a>.</p>
856
- <p>When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.
857
- After creating the endpoint, wait for the model deployment to complete before using it.
858
- To verify the deployment status, use the get trained model statistics API.
859
- Look for <code>&quot;state&quot;: &quot;fully_allocated&quot;</code> in the response and ensure that the <code>&quot;allocation_count&quot;</code> matches the <code>&quot;target_allocation_count&quot;</code>.
860
- Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.</p>
861
831
 
862
832
 
863
833
  `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-azureopenai>`_
@@ -951,11 +921,6 @@ class InferenceClient(NamespacedClient):
951
921
 
952
922
  <p>Create a Cohere inference endpoint.</p>
953
923
  <p>Create an inference endpoint to perform an inference task with the <code>cohere</code> service.</p>
954
- <p>When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.
955
- After creating the endpoint, wait for the model deployment to complete before using it.
956
- To verify the deployment status, use the get trained model statistics API.
957
- Look for <code>&quot;state&quot;: &quot;fully_allocated&quot;</code> in the response and ensure that the <code>&quot;allocation_count&quot;</code> matches the <code>&quot;target_allocation_count&quot;</code>.
958
- Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.</p>
959
924
 
960
925
 
961
926
  `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-cohere>`_
@@ -1239,11 +1204,6 @@ class InferenceClient(NamespacedClient):
1239
1204
 
1240
1205
  <p>Create an Google AI Studio inference endpoint.</p>
1241
1206
  <p>Create an inference endpoint to perform an inference task with the <code>googleaistudio</code> service.</p>
1242
- <p>When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.
1243
- After creating the endpoint, wait for the model deployment to complete before using it.
1244
- To verify the deployment status, use the get trained model statistics API.
1245
- Look for <code>&quot;state&quot;: &quot;fully_allocated&quot;</code> in the response and ensure that the <code>&quot;allocation_count&quot;</code> matches the <code>&quot;target_allocation_count&quot;</code>.
1246
- Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.</p>
1247
1207
 
1248
1208
 
1249
1209
  `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-googleaistudio>`_
@@ -1331,11 +1291,6 @@ class InferenceClient(NamespacedClient):
1331
1291
 
1332
1292
  <p>Create a Google Vertex AI inference endpoint.</p>
1333
1293
  <p>Create an inference endpoint to perform an inference task with the <code>googlevertexai</code> service.</p>
1334
- <p>When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.
1335
- After creating the endpoint, wait for the model deployment to complete before using it.
1336
- To verify the deployment status, use the get trained model statistics API.
1337
- Look for <code>&quot;state&quot;: &quot;fully_allocated&quot;</code> in the response and ensure that the <code>&quot;allocation_count&quot;</code> matches the <code>&quot;target_allocation_count&quot;</code>.
1338
- Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.</p>
1339
1294
 
1340
1295
 
1341
1296
  `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-googlevertexai>`_
@@ -1434,11 +1389,6 @@ class InferenceClient(NamespacedClient):
1434
1389
  <li><code>multilingual-e5-base</code></li>
1435
1390
  <li><code>multilingual-e5-small</code></li>
1436
1391
  </ul>
1437
- <p>When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.
1438
- After creating the endpoint, wait for the model deployment to complete before using it.
1439
- To verify the deployment status, use the get trained model statistics API.
1440
- Look for <code>&quot;state&quot;: &quot;fully_allocated&quot;</code> in the response and ensure that the <code>&quot;allocation_count&quot;</code> matches the <code>&quot;target_allocation_count&quot;</code>.
1441
- Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.</p>
1442
1392
 
1443
1393
 
1444
1394
  `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-hugging-face>`_
@@ -1528,11 +1478,6 @@ class InferenceClient(NamespacedClient):
1528
1478
  <p>Create an inference endpoint to perform an inference task with the <code>jinaai</code> service.</p>
1529
1479
  <p>To review the available <code>rerank</code> models, refer to <a href="https://jina.ai/reranker">https://jina.ai/reranker</a>.
1530
1480
  To review the available <code>text_embedding</code> models, refer to the <a href="https://jina.ai/embeddings/">https://jina.ai/embeddings/</a>.</p>
1531
- <p>When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.
1532
- After creating the endpoint, wait for the model deployment to complete before using it.
1533
- To verify the deployment status, use the get trained model statistics API.
1534
- Look for <code>&quot;state&quot;: &quot;fully_allocated&quot;</code> in the response and ensure that the <code>&quot;allocation_count&quot;</code> matches the <code>&quot;target_allocation_count&quot;</code>.
1535
- Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.</p>
1536
1481
 
1537
1482
 
1538
1483
  `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-jinaai>`_
@@ -1616,11 +1561,6 @@ class InferenceClient(NamespacedClient):
1616
1561
 
1617
1562
  <p>Create a Mistral inference endpoint.</p>
1618
1563
  <p>Creates an inference endpoint to perform an inference task with the <code>mistral</code> service.</p>
1619
- <p>When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.
1620
- After creating the endpoint, wait for the model deployment to complete before using it.
1621
- To verify the deployment status, use the get trained model statistics API.
1622
- Look for <code>&quot;state&quot;: &quot;fully_allocated&quot;</code> in the response and ensure that the <code>&quot;allocation_count&quot;</code> matches the <code>&quot;target_allocation_count&quot;</code>.
1623
- Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.</p>
1624
1564
 
1625
1565
 
1626
1566
  `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-mistral>`_
@@ -1708,12 +1648,7 @@ class InferenceClient(NamespacedClient):
1708
1648
  .. raw:: html
1709
1649
 
1710
1650
  <p>Create an OpenAI inference endpoint.</p>
1711
- <p>Create an inference endpoint to perform an inference task with the <code>openai</code> service.</p>
1712
- <p>When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.
1713
- After creating the endpoint, wait for the model deployment to complete before using it.
1714
- To verify the deployment status, use the get trained model statistics API.
1715
- Look for <code>&quot;state&quot;: &quot;fully_allocated&quot;</code> in the response and ensure that the <code>&quot;allocation_count&quot;</code> matches the <code>&quot;target_allocation_count&quot;</code>.
1716
- Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.</p>
1651
+ <p>Create an inference endpoint to perform an inference task with the <code>openai</code> service or <code>openai</code> compatible APIs.</p>
1717
1652
 
1718
1653
 
1719
1654
  `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-openai>`_
@@ -1890,11 +1825,6 @@ class InferenceClient(NamespacedClient):
1890
1825
  <p>Create an inference endpoint to perform an inference task with the <code>watsonxai</code> service.
1891
1826
  You need an IBM Cloud Databases for Elasticsearch deployment to use the <code>watsonxai</code> inference service.
1892
1827
  You can provision one through the IBM catalog, the Cloud Databases CLI plug-in, the Cloud Databases API, or Terraform.</p>
1893
- <p>When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.
1894
- After creating the endpoint, wait for the model deployment to complete before using it.
1895
- To verify the deployment status, use the get trained model statistics API.
1896
- Look for <code>&quot;state&quot;: &quot;fully_allocated&quot;</code> in the response and ensure that the <code>&quot;allocation_count&quot;</code> matches the <code>&quot;target_allocation_count&quot;</code>.
1897
- Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.</p>
1898
1828
 
1899
1829
 
1900
1830
  `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-watsonx>`_
@@ -15,4 +15,4 @@
15
15
  # specific language governing permissions and limitations
16
16
  # under the License.
17
17
 
18
- __versionstr__ = "9.0.1"
18
+ __versionstr__ = "9.0.2"
@@ -96,7 +96,7 @@ class AsyncDocument(DocumentBase, metaclass=AsyncIndexMeta):
96
96
 
97
97
  @classmethod
98
98
  def _get_using(cls, using: Optional[AsyncUsingType] = None) -> AsyncUsingType:
99
- return cast(AsyncUsingType, using or cls._index._using)
99
+ return using or cls._index._using
100
100
 
101
101
  @classmethod
102
102
  def _get_connection(
@@ -0,0 +1,16 @@
1
+ # Licensed to Elasticsearch B.V. under one or more contributor
2
+ # license agreements. See the NOTICE file distributed with
3
+ # this work for additional information regarding copyright
4
+ # ownership. Elasticsearch B.V. licenses this file to you under
5
+ # the Apache License, Version 2.0 (the "License"); you may
6
+ # not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # http://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing,
12
+ # software distributed under the License is distributed on an
13
+ # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14
+ # KIND, either express or implied. See the License for the
15
+ # specific language governing permissions and limitations
16
+ # under the License.