Skip to content

Commit 3181430

Browse files
Auto-generated code for main (#76)
* Auto-generated API code * Add esql again, remove Literal change for now * Trigger CI --------- Co-authored-by: Quentin Pradet <quentin.pradet@elastic.co>
1 parent bef0c24 commit 3181430

24 files changed

+692
-566
lines changed

elasticsearch_serverless/_async/client/__init__.py

Lines changed: 35 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -468,8 +468,9 @@ async def bulk(
468468
] = None,
469469
) -> ObjectApiResponse[t.Any]:
470470
"""
471-
Performs multiple indexing or delete operations in a single API call. This reduces
472-
overhead and can greatly increase indexing speed.
471+
Bulk index or delete documents. Performs multiple indexing or delete operations
472+
in a single API call. This reduces overhead and can greatly increase indexing
473+
speed.
473474
474475
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-bulk.html>`_
475476
@@ -825,9 +826,9 @@ async def create(
825826
] = None,
826827
) -> ObjectApiResponse[t.Any]:
827828
"""
828-
Adds a JSON document to the specified data stream or index and makes it searchable.
829-
If the target is an index and the document already exists, the request updates
830-
the document and increments its version.
829+
Index a document. Adds a JSON document to the specified data stream or index
830+
and makes it searchable. If the target is an index and the document already exists,
831+
the request updates the document and increments its version.
831832
832833
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html>`_
833834
@@ -931,7 +932,7 @@ async def delete(
931932
] = None,
932933
) -> ObjectApiResponse[t.Any]:
933934
"""
934-
Removes a JSON document from the specified index.
935+
Delete a document. Removes a JSON document from the specified index.
935936
936937
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete.html>`_
937938
@@ -1055,7 +1056,7 @@ async def delete_by_query(
10551056
body: t.Optional[t.Dict[str, t.Any]] = None,
10561057
) -> ObjectApiResponse[t.Any]:
10571058
"""
1058-
Deletes documents that match the specified query.
1059+
Delete documents. Deletes documents that match the specified query.
10591060
10601061
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete-by-query.html>`_
10611062
@@ -1236,7 +1237,7 @@ async def delete_script(
12361237
timeout: t.Optional[t.Union["t.Literal[-1]", "t.Literal[0]", str]] = None,
12371238
) -> ObjectApiResponse[t.Any]:
12381239
"""
1239-
Deletes a stored script or search template.
1240+
Delete a script or search template. Deletes a stored script or search template.
12401241
12411242
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html>`_
12421243
@@ -1304,7 +1305,7 @@ async def exists(
13041305
] = None,
13051306
) -> HeadApiResponse:
13061307
"""
1307-
Checks if a document in an index exists.
1308+
Check a document. Checks if a specified document exists.
13081309
13091310
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html>`_
13101311
@@ -1405,7 +1406,7 @@ async def exists_source(
14051406
] = None,
14061407
) -> HeadApiResponse:
14071408
"""
1408-
Checks if a document's `_source` is stored.
1409+
Check for a document source. Checks if a document's `_source` is stored.
14091410
14101411
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html>`_
14111412
@@ -1505,8 +1506,8 @@ async def explain(
15051506
body: t.Optional[t.Dict[str, t.Any]] = None,
15061507
) -> ObjectApiResponse[t.Any]:
15071508
"""
1508-
Returns information about why a specific document matches (or doesn’t match)
1509-
a query.
1509+
Explain a document match result. Returns information about why a specific document
1510+
matches, or doesn’t match, a query.
15101511
15111512
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/search-explain.html>`_
15121513
@@ -1744,7 +1745,8 @@ async def get(
17441745
] = None,
17451746
) -> ObjectApiResponse[t.Any]:
17461747
"""
1747-
Returns a document.
1748+
Get a document by its ID. Retrieves the document with the specified ID from an
1749+
index.
17481750
17491751
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html>`_
17501752
@@ -1835,7 +1837,7 @@ async def get_script(
18351837
pretty: t.Optional[bool] = None,
18361838
) -> ObjectApiResponse[t.Any]:
18371839
"""
1838-
Retrieves a stored script or search template.
1840+
Get a script or search template. Retrieves a stored script or search template.
18391841
18401842
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html>`_
18411843
@@ -1897,7 +1899,7 @@ async def get_source(
18971899
] = None,
18981900
) -> ObjectApiResponse[t.Any]:
18991901
"""
1900-
Returns the source of a document.
1902+
Get a document's source. Returns the source of a document.
19011903
19021904
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html>`_
19031905
@@ -1999,9 +2001,9 @@ async def index(
19992001
] = None,
20002002
) -> ObjectApiResponse[t.Any]:
20012003
"""
2002-
Adds a JSON document to the specified data stream or index and makes it searchable.
2003-
If the target is an index and the document already exists, the request updates
2004-
the document and increments its version.
2004+
Index a document. Adds a JSON document to the specified data stream or index
2005+
and makes it searchable. If the target is an index and the document already exists,
2006+
the request updates the document and increments its version.
20052007
20062008
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html>`_
20072009
@@ -2110,7 +2112,7 @@ async def info(
21102112
pretty: t.Optional[bool] = None,
21112113
) -> ObjectApiResponse[t.Any]:
21122114
"""
2113-
Returns basic information about the cluster.
2115+
Get cluster info. Returns basic information about the cluster.
21142116
21152117
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/index.html>`_
21162118
"""
@@ -2688,7 +2690,8 @@ async def put_script(
26882690
body: t.Optional[t.Dict[str, t.Any]] = None,
26892691
) -> ObjectApiResponse[t.Any]:
26902692
"""
2691-
Creates or updates a stored script or search template.
2693+
Create or update a script or search template. Creates or updates a stored script
2694+
or search template.
26922695
26932696
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html>`_
26942697
@@ -2868,9 +2871,9 @@ async def reindex(
28682871
body: t.Optional[t.Dict[str, t.Any]] = None,
28692872
) -> ObjectApiResponse[t.Any]:
28702873
"""
2871-
Allows to copy documents from one index to another, optionally filtering the
2872-
source documents by a query, changing the destination index settings, or fetching
2873-
the documents from a remote cluster.
2874+
Reindex documents. Copies documents from a source to a destination. The source
2875+
can be any existing index, alias, or data stream. The destination must differ
2876+
from the source. For example, you cannot reindex a data stream into itself.
28742877
28752878
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-reindex.html>`_
28762879
@@ -3040,7 +3043,7 @@ async def scripts_painless_execute(
30403043
body: t.Optional[t.Dict[str, t.Any]] = None,
30413044
) -> ObjectApiResponse[t.Any]:
30423045
"""
3043-
Runs a script and returns a result.
3046+
Run a script. Runs a script and returns a result.
30443047
30453048
`<https://www.elastic.co/guide/en/elasticsearch/painless/master/painless-execute-api.html>`_
30463049
@@ -3710,8 +3713,7 @@ async def search_mvt(
37103713
body: t.Optional[t.Dict[str, t.Any]] = None,
37113714
) -> BinaryApiResponse:
37123715
"""
3713-
Searches a vector tile for geospatial values. Returns results as a binary Mapbox
3714-
vector tile.
3716+
Search a vector tile. Searches a vector tile for geospatial values.
37153717
37163718
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/search-vector-tile-api.html>`_
37173719
@@ -4113,8 +4115,8 @@ async def termvectors(
41134115
body: t.Optional[t.Dict[str, t.Any]] = None,
41144116
) -> ObjectApiResponse[t.Any]:
41154117
"""
4116-
Returns information and statistics about terms in the fields of a particular
4117-
document.
4118+
Get term vector information. Returns information and statistics about terms in
4119+
the fields of a particular document.
41184120
41194121
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-termvectors.html>`_
41204122
@@ -4256,7 +4258,8 @@ async def update(
42564258
body: t.Optional[t.Dict[str, t.Any]] = None,
42574259
) -> ObjectApiResponse[t.Any]:
42584260
"""
4259-
Updates a document with a script or partial document.
4261+
Update a document. Updates a document by running a script or passing a partial
4262+
document.
42604263
42614264
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update.html>`_
42624265
@@ -4421,9 +4424,9 @@ async def update_by_query(
44214424
body: t.Optional[t.Dict[str, t.Any]] = None,
44224425
) -> ObjectApiResponse[t.Any]:
44234426
"""
4424-
Updates documents that match the specified query. If no query is specified, performs
4425-
an update on every document in the data stream or index without modifying the
4426-
source, which is useful for picking up mapping changes.
4427+
Update documents. Updates documents that match the specified query. If no query
4428+
is specified, performs an update on every document in the data stream or index
4429+
without modifying the source, which is useful for picking up mapping changes.
44274430
44284431
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update-by-query.html>`_
44294432

elasticsearch_serverless/_async/client/cat.py

Lines changed: 48 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -53,11 +53,11 @@ async def aliases(
5353
v: t.Optional[bool] = None,
5454
) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
5555
"""
56-
Retrieves the cluster’s index aliases, including filter and routing information.
57-
The API does not return data stream aliases. IMPORTANT: cat APIs are only intended
56+
Get aliases. Retrieves the cluster’s index aliases, including filter and routing
57+
information. The API does not return data stream aliases. CAT APIs are only intended
5858
for human consumption using the command line or the Kibana console. They are
59-
not intended for use by applications. For application consumption, use the aliases
60-
API.
59+
not intended for use by applications. For application consumption, use the /_alias
60+
endpoints.
6161
6262
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-alias.html>`_
6363
@@ -142,11 +142,12 @@ async def component_templates(
142142
v: t.Optional[bool] = None,
143143
) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
144144
"""
145-
Returns information about component templates in a cluster. Component templates
146-
are building blocks for constructing index templates that specify index mappings,
147-
settings, and aliases. IMPORTANT: cat APIs are only intended for human consumption
148-
using the command line or Kibana console. They are not intended for use by applications.
149-
For application consumption, use the get component template API.
145+
Get component templates. Returns information about component templates in a cluster.
146+
Component templates are building blocks for constructing index templates that
147+
specify index mappings, settings, and aliases. CAT APIs are only intended for
148+
human consumption using the command line or Kibana console. They are not intended
149+
for use by applications. For application consumption, use the /_component_template
150+
endpoints.
150151
151152
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-component-templates.html>`_
152153
@@ -227,12 +228,12 @@ async def count(
227228
v: t.Optional[bool] = None,
228229
) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
229230
"""
230-
Provides quick access to a document count for a data stream, an index, or an
231-
entire cluster. NOTE: The document count only includes live documents, not deleted
232-
documents which have not yet been removed by the merge process. IMPORTANT: cat
231+
Get a document count. Provides quick access to a document count for a data stream,
232+
an index, or an entire cluster.n/ The document count only includes live documents,
233+
not deleted documents which have not yet been removed by the merge process. CAT
233234
APIs are only intended for human consumption using the command line or Kibana
234235
console. They are not intended for use by applications. For application consumption,
235-
use the count API.
236+
use /_count endpoints.
236237
237238
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-count.html>`_
238239
@@ -313,7 +314,7 @@ async def help(
313314
v: t.Optional[bool] = None,
314315
) -> TextApiResponse:
315316
"""
316-
Returns help for the Cat APIs.
317+
Get CAT help. Returns help for the CAT APIs.
317318
318319
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat.html>`_
319320
@@ -404,16 +405,16 @@ async def indices(
404405
v: t.Optional[bool] = None,
405406
) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
406407
"""
407-
Returns high-level information about indices in a cluster, including backing
408-
indices for data streams. IMPORTANT: cat APIs are only intended for human consumption
409-
using the command line or Kibana console. They are not intended for use by applications.
410-
For application consumption, use the get index API. Use the cat indices API to
411-
get the following information for each index in a cluster: shard count; document
412-
count; deleted document count; primary store size; total store size of all shards,
413-
including shard replicas. These metrics are retrieved directly from Lucene, which
414-
Elasticsearch uses internally to power indexing and search. As a result, all
415-
document counts include hidden nested documents. To get an accurate count of
416-
Elasticsearch documents, use the cat count or count APIs.
408+
Get index information. Returns high-level information about indices in a cluster,
409+
including backing indices for data streams. Use this request to get the following
410+
information for each index in a cluster: - shard count - document count - deleted
411+
document count - primary store size - total store size of all shards, including
412+
shard replicas These metrics are retrieved directly from Lucene, which Elasticsearch
413+
uses internally to power indexing and search. As a result, all document counts
414+
include hidden nested documents. To get an accurate count of Elasticsearch documents,
415+
use the /_cat/count or _count endpoints. CAT APIs are only intended for human
416+
consumption using the command line or Kibana console. They are not intended for
417+
use by applications. For application consumption, use an index endpoint.
417418
418419
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-indices.html>`_
419420
@@ -546,10 +547,10 @@ async def ml_data_frame_analytics(
546547
v: t.Optional[bool] = None,
547548
) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
548549
"""
549-
Returns configuration and usage information about data frame analytics jobs.
550-
IMPORTANT: cat APIs are only intended for human consumption using the Kibana
551-
console or command line. They are not intended for use by applications. For application
552-
consumption, use the get data frame analytics jobs statistics API.
550+
Get data frame analytics jobs. Returns configuration and usage information about
551+
data frame analytics jobs. CAT APIs are only intended for human consumption using
552+
the Kibana console or command line. They are not intended for use by applications.
553+
For application consumption, use the /_ml/data_frame/analytics endpoints.
553554
554555
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-dfanalytics.html>`_
555556
@@ -668,12 +669,12 @@ async def ml_datafeeds(
668669
v: t.Optional[bool] = None,
669670
) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
670671
"""
671-
Returns configuration and usage information about datafeeds. This API returns
672-
a maximum of 10,000 datafeeds. If the Elasticsearch security features are enabled,
673-
you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage` cluster privileges
674-
to use this API. IMPORTANT: cat APIs are only intended for human consumption
672+
Get datafeeds. Returns configuration and usage information about datafeeds. This
673+
API returns a maximum of 10,000 datafeeds. If the Elasticsearch security features
674+
are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage`
675+
cluster privileges to use this API. CAT APIs are only intended for human consumption
675676
using the Kibana console or command line. They are not intended for use by applications.
676-
For application consumption, use the get datafeed statistics API.
677+
For application consumption, use the /_ml/datafeeds endpoints.
677678
678679
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-datafeeds.html>`_
679680
@@ -798,13 +799,13 @@ async def ml_jobs(
798799
v: t.Optional[bool] = None,
799800
) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
800801
"""
801-
Returns configuration and usage information for anomaly detection jobs. This
802-
API returns a maximum of 10,000 jobs. If the Elasticsearch security features
803-
are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage`
804-
cluster privileges to use this API. IMPORTANT: cat APIs are only intended for
802+
Get anomaly detection jobs. Returns configuration and usage information for anomaly
803+
detection jobs. This API returns a maximum of 10,000 jobs. If the Elasticsearch
804+
security features are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`,
805+
or `manage` cluster privileges to use this API. CAT APIs are only intended for
805806
human consumption using the Kibana console or command line. They are not intended
806-
for use by applications. For application consumption, use the get anomaly detection
807-
job statistics API.
807+
for use by applications. For application consumption, use the /_ml/anomaly_detectors
808+
endpoints.
808809
809810
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-anomaly-detectors.html>`_
810811
@@ -932,10 +933,10 @@ async def ml_trained_models(
932933
v: t.Optional[bool] = None,
933934
) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
934935
"""
935-
Returns configuration and usage information about inference trained models. IMPORTANT:
936-
cat APIs are only intended for human consumption using the Kibana console or
937-
command line. They are not intended for use by applications. For application
938-
consumption, use the get trained models statistics API.
936+
Get trained models. Returns configuration and usage information about inference
937+
trained models. CAT APIs are only intended for human consumption using the Kibana
938+
console or command line. They are not intended for use by applications. For application
939+
consumption, use the /_ml/trained_models endpoints.
939940
940941
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-trained-model.html>`_
941942
@@ -1066,10 +1067,10 @@ async def transforms(
10661067
v: t.Optional[bool] = None,
10671068
) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
10681069
"""
1069-
Returns configuration and usage information about transforms. IMPORTANT: cat
1070-
APIs are only intended for human consumption using the Kibana console or command
1071-
line. They are not intended for use by applications. For application consumption,
1072-
use the get transform statistics API.
1070+
Get transforms. Returns configuration and usage information about transforms.
1071+
CAT APIs are only intended for human consumption using the Kibana console or
1072+
command line. They are not intended for use by applications. For application
1073+
consumption, use the /_transform endpoints.
10731074
10741075
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-transforms.html>`_
10751076

0 commit comments

Comments
 (0)