@@ -638,8 +638,9 @@ async def bulk(
638
638
] = None ,
639
639
) -> ObjectApiResponse [t .Any ]:
640
640
"""
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.
643
644
644
645
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-bulk.html>`_
645
646
@@ -995,9 +996,9 @@ async def create(
995
996
] = None ,
996
997
) -> ObjectApiResponse [t .Any ]:
997
998
"""
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.
1001
1002
1002
1003
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html>`_
1003
1004
@@ -1101,7 +1102,7 @@ async def delete(
1101
1102
] = None ,
1102
1103
) -> ObjectApiResponse [t .Any ]:
1103
1104
"""
1104
- Removes a JSON document from the specified index.
1105
+ Delete a document. Removes a JSON document from the specified index.
1105
1106
1106
1107
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete.html>`_
1107
1108
@@ -1225,7 +1226,7 @@ async def delete_by_query(
1225
1226
body : t .Optional [t .Dict [str , t .Any ]] = None ,
1226
1227
) -> ObjectApiResponse [t .Any ]:
1227
1228
"""
1228
- Deletes documents that match the specified query.
1229
+ Delete documents. Deletes documents that match the specified query.
1229
1230
1230
1231
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete-by-query.html>`_
1231
1232
@@ -1451,7 +1452,7 @@ async def delete_script(
1451
1452
timeout : t .Optional [t .Union ["t.Literal[-1]" , "t.Literal[0]" , str ]] = None ,
1452
1453
) -> ObjectApiResponse [t .Any ]:
1453
1454
"""
1454
- Deletes a stored script or search template.
1455
+ Delete a script or search template. Deletes a stored script or search template.
1455
1456
1456
1457
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html>`_
1457
1458
@@ -1519,7 +1520,7 @@ async def exists(
1519
1520
] = None ,
1520
1521
) -> HeadApiResponse :
1521
1522
"""
1522
- Checks if a document in an index exists.
1523
+ Check a document. Checks if a specified document exists.
1523
1524
1524
1525
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html>`_
1525
1526
@@ -1620,7 +1621,7 @@ async def exists_source(
1620
1621
] = None ,
1621
1622
) -> HeadApiResponse :
1622
1623
"""
1623
- Checks if a document's `_source` is stored.
1624
+ Check for a document source. Checks if a document's `_source` is stored.
1624
1625
1625
1626
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html>`_
1626
1627
@@ -1720,8 +1721,8 @@ async def explain(
1720
1721
body : t .Optional [t .Dict [str , t .Any ]] = None ,
1721
1722
) -> ObjectApiResponse [t .Any ]:
1722
1723
"""
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.
1725
1726
1726
1727
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/search-explain.html>`_
1727
1728
@@ -1959,7 +1960,8 @@ async def get(
1959
1960
] = None ,
1960
1961
) -> ObjectApiResponse [t .Any ]:
1961
1962
"""
1962
- Returns a document.
1963
+ Get a document by its ID. Retrieves the document with the specified ID from an
1964
+ index.
1963
1965
1964
1966
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html>`_
1965
1967
@@ -2050,7 +2052,7 @@ async def get_script(
2050
2052
pretty : t .Optional [bool ] = None ,
2051
2053
) -> ObjectApiResponse [t .Any ]:
2052
2054
"""
2053
- Retrieves a stored script or search template.
2055
+ Get a script or search template. Retrieves a stored script or search template.
2054
2056
2055
2057
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html>`_
2056
2058
@@ -2182,7 +2184,7 @@ async def get_source(
2182
2184
] = None ,
2183
2185
) -> ObjectApiResponse [t .Any ]:
2184
2186
"""
2185
- Returns the source of a document.
2187
+ Get a document's source. Returns the source of a document.
2186
2188
2187
2189
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html>`_
2188
2190
@@ -2340,9 +2342,9 @@ async def index(
2340
2342
] = None ,
2341
2343
) -> ObjectApiResponse [t .Any ]:
2342
2344
"""
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.
2346
2348
2347
2349
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html>`_
2348
2350
@@ -2451,7 +2453,7 @@ async def info(
2451
2453
pretty : t .Optional [bool ] = None ,
2452
2454
) -> ObjectApiResponse [t .Any ]:
2453
2455
"""
2454
- Returns basic information about the cluster.
2456
+ Get cluster info. Returns basic information about the cluster.
2455
2457
2456
2458
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/index.html>`_
2457
2459
"""
@@ -3131,7 +3133,8 @@ async def put_script(
3131
3133
body : t .Optional [t .Dict [str , t .Any ]] = None ,
3132
3134
) -> ObjectApiResponse [t .Any ]:
3133
3135
"""
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.
3135
3138
3136
3139
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html>`_
3137
3140
@@ -3311,9 +3314,9 @@ async def reindex(
3311
3314
body : t .Optional [t .Dict [str , t .Any ]] = None ,
3312
3315
) -> ObjectApiResponse [t .Any ]:
3313
3316
"""
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 .
3317
3320
3318
3321
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-reindex.html>`_
3319
3322
@@ -3528,7 +3531,7 @@ async def scripts_painless_execute(
3528
3531
body : t .Optional [t .Dict [str , t .Any ]] = None ,
3529
3532
) -> ObjectApiResponse [t .Any ]:
3530
3533
"""
3531
- Runs a script and returns a result.
3534
+ Run a script. Runs a script and returns a result.
3532
3535
3533
3536
`<https://www.elastic.co/guide/en/elasticsearch/painless/master/painless-execute-api.html>`_
3534
3537
@@ -4198,8 +4201,7 @@ async def search_mvt(
4198
4201
body : t .Optional [t .Dict [str , t .Any ]] = None ,
4199
4202
) -> BinaryApiResponse :
4200
4203
"""
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.
4203
4205
4204
4206
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/search-vector-tile-api.html>`_
4205
4207
@@ -4687,8 +4689,8 @@ async def termvectors(
4687
4689
body : t .Optional [t .Dict [str , t .Any ]] = None ,
4688
4690
) -> ObjectApiResponse [t .Any ]:
4689
4691
"""
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.
4692
4694
4693
4695
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-termvectors.html>`_
4694
4696
@@ -4830,7 +4832,8 @@ async def update(
4830
4832
body : t .Optional [t .Dict [str , t .Any ]] = None ,
4831
4833
) -> ObjectApiResponse [t .Any ]:
4832
4834
"""
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.
4834
4837
4835
4838
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update.html>`_
4836
4839
@@ -4995,9 +4998,9 @@ async def update_by_query(
4995
4998
body : t .Optional [t .Dict [str , t .Any ]] = None ,
4996
4999
) -> ObjectApiResponse [t .Any ]:
4997
5000
"""
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.
5001
5004
5002
5005
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update-by-query.html>`_
5003
5006
0 commit comments