Skip to content

Commit a08f22a

Browse files
Auto-generated API code
1 parent 3073f9c commit a08f22a

24 files changed

+1292
-566
lines changed

elasticsearch/_async/client/__init__.py

Lines changed: 35 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -638,8 +638,9 @@ async def bulk(
638638
] = None,
639639
) -> ObjectApiResponse[t.Any]:
640640
"""
641-
Performs multiple indexing or delete operations in a single API call. This reduces
642-
overhead and can greatly increase indexing speed.
641+
Bulk index or delete documents. Performs multiple indexing or delete operations
642+
in a single API call. This reduces overhead and can greatly increase indexing
643+
speed.
643644
644645
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-bulk.html>`_
645646
@@ -995,9 +996,9 @@ async def create(
995996
] = None,
996997
) -> ObjectApiResponse[t.Any]:
997998
"""
998-
Adds a JSON document to the specified data stream or index and makes it searchable.
999-
If the target is an index and the document already exists, the request updates
1000-
the document and increments its version.
999+
Index a document. Adds a JSON document to the specified data stream or index
1000+
and makes it searchable. If the target is an index and the document already exists,
1001+
the request updates the document and increments its version.
10011002
10021003
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html>`_
10031004
@@ -1101,7 +1102,7 @@ async def delete(
11011102
] = None,
11021103
) -> ObjectApiResponse[t.Any]:
11031104
"""
1104-
Removes a JSON document from the specified index.
1105+
Delete a document. Removes a JSON document from the specified index.
11051106
11061107
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete.html>`_
11071108
@@ -1225,7 +1226,7 @@ async def delete_by_query(
12251226
body: t.Optional[t.Dict[str, t.Any]] = None,
12261227
) -> ObjectApiResponse[t.Any]:
12271228
"""
1228-
Deletes documents that match the specified query.
1229+
Delete documents. Deletes documents that match the specified query.
12291230
12301231
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete-by-query.html>`_
12311232
@@ -1451,7 +1452,7 @@ async def delete_script(
14511452
timeout: t.Optional[t.Union["t.Literal[-1]", "t.Literal[0]", str]] = None,
14521453
) -> ObjectApiResponse[t.Any]:
14531454
"""
1454-
Deletes a stored script or search template.
1455+
Delete a script or search template. Deletes a stored script or search template.
14551456
14561457
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html>`_
14571458
@@ -1519,7 +1520,7 @@ async def exists(
15191520
] = None,
15201521
) -> HeadApiResponse:
15211522
"""
1522-
Checks if a document in an index exists.
1523+
Check a document. Checks if a specified document exists.
15231524
15241525
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html>`_
15251526
@@ -1620,7 +1621,7 @@ async def exists_source(
16201621
] = None,
16211622
) -> HeadApiResponse:
16221623
"""
1623-
Checks if a document's `_source` is stored.
1624+
Check for a document source. Checks if a document's `_source` is stored.
16241625
16251626
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html>`_
16261627
@@ -1720,8 +1721,8 @@ async def explain(
17201721
body: t.Optional[t.Dict[str, t.Any]] = None,
17211722
) -> ObjectApiResponse[t.Any]:
17221723
"""
1723-
Returns information about why a specific document matches (or doesn’t match)
1724-
a query.
1724+
Explain a document match result. Returns information about why a specific document
1725+
matches, or doesn’t match, a query.
17251726
17261727
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/search-explain.html>`_
17271728
@@ -1959,7 +1960,8 @@ async def get(
19591960
] = None,
19601961
) -> ObjectApiResponse[t.Any]:
19611962
"""
1962-
Returns a document.
1963+
Get a document by its ID. Retrieves the document with the specified ID from an
1964+
index.
19631965
19641966
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html>`_
19651967
@@ -2050,7 +2052,7 @@ async def get_script(
20502052
pretty: t.Optional[bool] = None,
20512053
) -> ObjectApiResponse[t.Any]:
20522054
"""
2053-
Retrieves a stored script or search template.
2055+
Get a script or search template. Retrieves a stored script or search template.
20542056
20552057
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html>`_
20562058
@@ -2182,7 +2184,7 @@ async def get_source(
21822184
] = None,
21832185
) -> ObjectApiResponse[t.Any]:
21842186
"""
2185-
Returns the source of a document.
2187+
Get a document's source. Returns the source of a document.
21862188
21872189
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html>`_
21882190
@@ -2340,9 +2342,9 @@ async def index(
23402342
] = None,
23412343
) -> ObjectApiResponse[t.Any]:
23422344
"""
2343-
Adds a JSON document to the specified data stream or index and makes it searchable.
2344-
If the target is an index and the document already exists, the request updates
2345-
the document and increments its version.
2345+
Index a document. Adds a JSON document to the specified data stream or index
2346+
and makes it searchable. If the target is an index and the document already exists,
2347+
the request updates the document and increments its version.
23462348
23472349
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html>`_
23482350
@@ -2451,7 +2453,7 @@ async def info(
24512453
pretty: t.Optional[bool] = None,
24522454
) -> ObjectApiResponse[t.Any]:
24532455
"""
2454-
Returns basic information about the cluster.
2456+
Get cluster info. Returns basic information about the cluster.
24552457
24562458
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/index.html>`_
24572459
"""
@@ -3131,7 +3133,8 @@ async def put_script(
31313133
body: t.Optional[t.Dict[str, t.Any]] = None,
31323134
) -> ObjectApiResponse[t.Any]:
31333135
"""
3134-
Creates or updates a stored script or search template.
3136+
Create or update a script or search template. Creates or updates a stored script
3137+
or search template.
31353138
31363139
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html>`_
31373140
@@ -3311,9 +3314,9 @@ async def reindex(
33113314
body: t.Optional[t.Dict[str, t.Any]] = None,
33123315
) -> ObjectApiResponse[t.Any]:
33133316
"""
3314-
Allows to copy documents from one index to another, optionally filtering the
3315-
source documents by a query, changing the destination index settings, or fetching
3316-
the documents from a remote cluster.
3317+
Reindex documents. Copies documents from a source to a destination. The source
3318+
can be any existing index, alias, or data stream. The destination must differ
3319+
from the source. For example, you cannot reindex a data stream into itself.
33173320
33183321
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-reindex.html>`_
33193322
@@ -3528,7 +3531,7 @@ async def scripts_painless_execute(
35283531
body: t.Optional[t.Dict[str, t.Any]] = None,
35293532
) -> ObjectApiResponse[t.Any]:
35303533
"""
3531-
Runs a script and returns a result.
3534+
Run a script. Runs a script and returns a result.
35323535
35333536
`<https://www.elastic.co/guide/en/elasticsearch/painless/master/painless-execute-api.html>`_
35343537
@@ -4198,8 +4201,7 @@ async def search_mvt(
41984201
body: t.Optional[t.Dict[str, t.Any]] = None,
41994202
) -> BinaryApiResponse:
42004203
"""
4201-
Searches a vector tile for geospatial values. Returns results as a binary Mapbox
4202-
vector tile.
4204+
Search a vector tile. Searches a vector tile for geospatial values.
42034205
42044206
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/search-vector-tile-api.html>`_
42054207
@@ -4687,8 +4689,8 @@ async def termvectors(
46874689
body: t.Optional[t.Dict[str, t.Any]] = None,
46884690
) -> ObjectApiResponse[t.Any]:
46894691
"""
4690-
Returns information and statistics about terms in the fields of a particular
4691-
document.
4692+
Get term vector information. Returns information and statistics about terms in
4693+
the fields of a particular document.
46924694
46934695
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-termvectors.html>`_
46944696
@@ -4830,7 +4832,8 @@ async def update(
48304832
body: t.Optional[t.Dict[str, t.Any]] = None,
48314833
) -> ObjectApiResponse[t.Any]:
48324834
"""
4833-
Updates a document with a script or partial document.
4835+
Update a document. Updates a document by running a script or passing a partial
4836+
document.
48344837
48354838
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update.html>`_
48364839
@@ -4995,9 +4998,9 @@ async def update_by_query(
49954998
body: t.Optional[t.Dict[str, t.Any]] = None,
49964999
) -> ObjectApiResponse[t.Any]:
49975000
"""
4998-
Updates documents that match the specified query. If no query is specified, performs
4999-
an update on every document in the data stream or index without modifying the
5000-
source, which is useful for picking up mapping changes.
5001+
Update documents. Updates documents that match the specified query. If no query
5002+
is specified, performs an update on every document in the data stream or index
5003+
without modifying the source, which is useful for picking up mapping changes.
50015004
50025005
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update-by-query.html>`_
50035006

0 commit comments

Comments
 (0)