Skip to content

Commit 5608225

Browse files
Auto-generated API code
1 parent bef0c24 commit 5608225

23 files changed

+600
-643
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

0 commit comments

Comments
 (0)