@@ -468,8 +468,9 @@ async def bulk(
468
468
] = None ,
469
469
) -> ObjectApiResponse [t .Any ]:
470
470
"""
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.
473
474
474
475
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-bulk.html>`_
475
476
@@ -825,9 +826,9 @@ async def create(
825
826
] = None ,
826
827
) -> ObjectApiResponse [t .Any ]:
827
828
"""
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.
831
832
832
833
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html>`_
833
834
@@ -931,7 +932,7 @@ async def delete(
931
932
] = None ,
932
933
) -> ObjectApiResponse [t .Any ]:
933
934
"""
934
- Removes a JSON document from the specified index.
935
+ Delete a document. Removes a JSON document from the specified index.
935
936
936
937
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete.html>`_
937
938
@@ -1055,7 +1056,7 @@ async def delete_by_query(
1055
1056
body : t .Optional [t .Dict [str , t .Any ]] = None ,
1056
1057
) -> ObjectApiResponse [t .Any ]:
1057
1058
"""
1058
- Deletes documents that match the specified query.
1059
+ Delete documents. Deletes documents that match the specified query.
1059
1060
1060
1061
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete-by-query.html>`_
1061
1062
@@ -1236,7 +1237,7 @@ async def delete_script(
1236
1237
timeout : t .Optional [t .Union ["t.Literal[-1]" , "t.Literal[0]" , str ]] = None ,
1237
1238
) -> ObjectApiResponse [t .Any ]:
1238
1239
"""
1239
- Deletes a stored script or search template.
1240
+ Delete a script or search template. Deletes a stored script or search template.
1240
1241
1241
1242
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html>`_
1242
1243
@@ -1304,7 +1305,7 @@ async def exists(
1304
1305
] = None ,
1305
1306
) -> HeadApiResponse :
1306
1307
"""
1307
- Checks if a document in an index exists.
1308
+ Check a document. Checks if a specified document exists.
1308
1309
1309
1310
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html>`_
1310
1311
@@ -1405,7 +1406,7 @@ async def exists_source(
1405
1406
] = None ,
1406
1407
) -> HeadApiResponse :
1407
1408
"""
1408
- Checks if a document's `_source` is stored.
1409
+ Check for a document source. Checks if a document's `_source` is stored.
1409
1410
1410
1411
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html>`_
1411
1412
@@ -1505,8 +1506,8 @@ async def explain(
1505
1506
body : t .Optional [t .Dict [str , t .Any ]] = None ,
1506
1507
) -> ObjectApiResponse [t .Any ]:
1507
1508
"""
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.
1510
1511
1511
1512
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/search-explain.html>`_
1512
1513
@@ -1744,7 +1745,8 @@ async def get(
1744
1745
] = None ,
1745
1746
) -> ObjectApiResponse [t .Any ]:
1746
1747
"""
1747
- Returns a document.
1748
+ Get a document by its ID. Retrieves the document with the specified ID from an
1749
+ index.
1748
1750
1749
1751
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html>`_
1750
1752
@@ -1835,7 +1837,7 @@ async def get_script(
1835
1837
pretty : t .Optional [bool ] = None ,
1836
1838
) -> ObjectApiResponse [t .Any ]:
1837
1839
"""
1838
- Retrieves a stored script or search template.
1840
+ Get a script or search template. Retrieves a stored script or search template.
1839
1841
1840
1842
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html>`_
1841
1843
@@ -1897,7 +1899,7 @@ async def get_source(
1897
1899
] = None ,
1898
1900
) -> ObjectApiResponse [t .Any ]:
1899
1901
"""
1900
- Returns the source of a document.
1902
+ Get a document's source. Returns the source of a document.
1901
1903
1902
1904
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html>`_
1903
1905
@@ -1999,9 +2001,9 @@ async def index(
1999
2001
] = None ,
2000
2002
) -> ObjectApiResponse [t .Any ]:
2001
2003
"""
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.
2005
2007
2006
2008
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html>`_
2007
2009
@@ -2110,7 +2112,7 @@ async def info(
2110
2112
pretty : t .Optional [bool ] = None ,
2111
2113
) -> ObjectApiResponse [t .Any ]:
2112
2114
"""
2113
- Returns basic information about the cluster.
2115
+ Get cluster info. Returns basic information about the cluster.
2114
2116
2115
2117
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/index.html>`_
2116
2118
"""
@@ -2688,7 +2690,8 @@ async def put_script(
2688
2690
body : t .Optional [t .Dict [str , t .Any ]] = None ,
2689
2691
) -> ObjectApiResponse [t .Any ]:
2690
2692
"""
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.
2692
2695
2693
2696
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html>`_
2694
2697
@@ -2868,9 +2871,9 @@ async def reindex(
2868
2871
body : t .Optional [t .Dict [str , t .Any ]] = None ,
2869
2872
) -> ObjectApiResponse [t .Any ]:
2870
2873
"""
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 .
2874
2877
2875
2878
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-reindex.html>`_
2876
2879
@@ -3040,7 +3043,7 @@ async def scripts_painless_execute(
3040
3043
body : t .Optional [t .Dict [str , t .Any ]] = None ,
3041
3044
) -> ObjectApiResponse [t .Any ]:
3042
3045
"""
3043
- Runs a script and returns a result.
3046
+ Run a script. Runs a script and returns a result.
3044
3047
3045
3048
`<https://www.elastic.co/guide/en/elasticsearch/painless/master/painless-execute-api.html>`_
3046
3049
@@ -3710,8 +3713,7 @@ async def search_mvt(
3710
3713
body : t .Optional [t .Dict [str , t .Any ]] = None ,
3711
3714
) -> BinaryApiResponse :
3712
3715
"""
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.
3715
3717
3716
3718
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/search-vector-tile-api.html>`_
3717
3719
@@ -4113,8 +4115,8 @@ async def termvectors(
4113
4115
body : t .Optional [t .Dict [str , t .Any ]] = None ,
4114
4116
) -> ObjectApiResponse [t .Any ]:
4115
4117
"""
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.
4118
4120
4119
4121
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-termvectors.html>`_
4120
4122
@@ -4256,7 +4258,8 @@ async def update(
4256
4258
body : t .Optional [t .Dict [str , t .Any ]] = None ,
4257
4259
) -> ObjectApiResponse [t .Any ]:
4258
4260
"""
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.
4260
4263
4261
4264
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update.html>`_
4262
4265
@@ -4421,9 +4424,9 @@ async def update_by_query(
4421
4424
body : t .Optional [t .Dict [str , t .Any ]] = None ,
4422
4425
) -> ObjectApiResponse [t .Any ]:
4423
4426
"""
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.
4427
4430
4428
4431
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update-by-query.html>`_
4429
4432
0 commit comments