@@ -638,7 +638,8 @@ async def bulk(
638
638
] = None ,
639
639
) -> ObjectApiResponse [t .Any ]:
640
640
"""
641
- Allows to perform multiple index/update/delete operations in a single request.
641
+ Performs multiple indexing or delete operations in a single API call. This reduces
642
+ overhead and can greatly increase indexing speed.
642
643
643
644
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-bulk.html>`_
644
645
@@ -737,7 +738,7 @@ async def clear_scroll(
737
738
body : t .Optional [t .Dict [str , t .Any ]] = None ,
738
739
) -> ObjectApiResponse [t .Any ]:
739
740
"""
740
- Explicitly clears the search context for a scroll .
741
+ Clears the search context and results for a scrolling search .
741
742
742
743
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/clear-scroll-api.html>`_
743
744
@@ -787,7 +788,7 @@ async def close_point_in_time(
787
788
body : t .Optional [t .Dict [str , t .Any ]] = None ,
788
789
) -> ObjectApiResponse [t .Any ]:
789
790
"""
790
- Close a point in time
791
+ Closes a point-in- time.
791
792
792
793
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/point-in-time-api.html>`_
793
794
@@ -994,8 +995,9 @@ async def create(
994
995
] = None ,
995
996
) -> ObjectApiResponse [t .Any ]:
996
997
"""
997
- Creates a new document in the index. Returns a 409 response when a document with
998
- a same ID already exists in the index.
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
1001
1000
1002
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html>`_
1001
1003
@@ -1099,7 +1101,7 @@ async def delete(
1099
1101
] = None ,
1100
1102
) -> ObjectApiResponse [t .Any ]:
1101
1103
"""
1102
- Removes a document from the index.
1104
+ Removes a JSON document from the specified index.
1103
1105
1104
1106
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete.html>`_
1105
1107
@@ -1223,7 +1225,7 @@ async def delete_by_query(
1223
1225
body : t .Optional [t .Dict [str , t .Any ]] = None ,
1224
1226
) -> ObjectApiResponse [t .Any ]:
1225
1227
"""
1226
- Deletes documents matching the provided query.
1228
+ Deletes documents that match the specified query.
1227
1229
1228
1230
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete-by-query.html>`_
1229
1231
@@ -1449,7 +1451,7 @@ async def delete_script(
1449
1451
timeout : t .Optional [t .Union ["t.Literal[-1]" , "t.Literal[0]" , str ]] = None ,
1450
1452
) -> ObjectApiResponse [t .Any ]:
1451
1453
"""
1452
- Deletes a script.
1454
+ Deletes a stored script or search template .
1453
1455
1454
1456
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html>`_
1455
1457
@@ -1517,7 +1519,7 @@ async def exists(
1517
1519
] = None ,
1518
1520
) -> HeadApiResponse :
1519
1521
"""
1520
- Returns information about whether a document exists in an index.
1522
+ Checks if a document in an index exists .
1521
1523
1522
1524
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html>`_
1523
1525
@@ -1618,7 +1620,7 @@ async def exists_source(
1618
1620
] = None ,
1619
1621
) -> HeadApiResponse :
1620
1622
"""
1621
- Returns information about whether a document source exists in an index .
1623
+ Checks if a document's `_source` is stored .
1622
1624
1623
1625
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html>`_
1624
1626
@@ -1718,7 +1720,8 @@ async def explain(
1718
1720
body : t .Optional [t .Dict [str , t .Any ]] = None ,
1719
1721
) -> ObjectApiResponse [t .Any ]:
1720
1722
"""
1721
- Returns information about why a specific matches (or doesn't match) a query.
1723
+ Returns information about why a specific document matches (or doesn’t match)
1724
+ a query.
1722
1725
1723
1726
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/search-explain.html>`_
1724
1727
@@ -1837,7 +1840,10 @@ async def field_caps(
1837
1840
body : t .Optional [t .Dict [str , t .Any ]] = None ,
1838
1841
) -> ObjectApiResponse [t .Any ]:
1839
1842
"""
1840
- Returns the information about the capabilities of fields among multiple indices.
1843
+ The field capabilities API returns the information about the capabilities of
1844
+ fields among multiple indices. The field capabilities API returns runtime fields
1845
+ like any other field. For example, a runtime field with a type of keyword is
1846
+ returned as any other field that belongs to the `keyword` family.
1841
1847
1842
1848
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/search-field-caps.html>`_
1843
1849
@@ -2044,7 +2050,7 @@ async def get_script(
2044
2050
pretty : t .Optional [bool ] = None ,
2045
2051
) -> ObjectApiResponse [t .Any ]:
2046
2052
"""
2047
- Returns a script.
2053
+ Retrieves a stored script or search template .
2048
2054
2049
2055
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html>`_
2050
2056
@@ -2334,7 +2340,9 @@ async def index(
2334
2340
] = None ,
2335
2341
) -> ObjectApiResponse [t .Any ]:
2336
2342
"""
2337
- Creates or updates a document in an index.
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.
2338
2346
2339
2347
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html>`_
2340
2348
@@ -2843,7 +2851,7 @@ async def msearch_template(
2843
2851
typed_keys : t .Optional [bool ] = None ,
2844
2852
) -> ObjectApiResponse [t .Any ]:
2845
2853
"""
2846
- Allows to execute several search template operations in one request.
2854
+ Runs multiple templated searches with a single request.
2847
2855
2848
2856
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/search-multi-search.html>`_
2849
2857
@@ -3045,7 +3053,13 @@ async def open_point_in_time(
3045
3053
routing : t .Optional [str ] = None ,
3046
3054
) -> ObjectApiResponse [t .Any ]:
3047
3055
"""
3048
- Open a point in time that can be used in subsequent searches
3056
+ A search request by default executes against the most recent visible data of
3057
+ the target indices, which is called point in time. Elasticsearch pit (point in
3058
+ time) is a lightweight view into the state of the data as it existed when initiated.
3059
+ In some cases, it’s preferred to perform multiple search requests using the same
3060
+ point in time. For example, if refreshes happen between `search_after` requests,
3061
+ then the results of those requests might not be consistent as changes happening
3062
+ between searches are only visible to the more recent point in time.
3049
3063
3050
3064
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/point-in-time-api.html>`_
3051
3065
@@ -3117,7 +3131,7 @@ async def put_script(
3117
3131
body : t .Optional [t .Dict [str , t .Any ]] = None ,
3118
3132
) -> ObjectApiResponse [t .Any ]:
3119
3133
"""
3120
- Creates or updates a script.
3134
+ Creates or updates a stored script or search template .
3121
3135
3122
3136
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html>`_
3123
3137
@@ -3202,8 +3216,8 @@ async def rank_eval(
3202
3216
body : t .Optional [t .Dict [str , t .Any ]] = None ,
3203
3217
) -> ObjectApiResponse [t .Any ]:
3204
3218
"""
3205
- Allows to evaluate the quality of ranked search results over a set of typical
3206
- search queries
3219
+ Enables you to evaluate the quality of ranked search results over a set of typical
3220
+ search queries.
3207
3221
3208
3222
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/search-rank-eval.html>`_
3209
3223
@@ -3395,7 +3409,7 @@ async def reindex_rethrottle(
3395
3409
requests_per_second : t .Optional [float ] = None ,
3396
3410
) -> ObjectApiResponse [t .Any ]:
3397
3411
"""
3398
- Changes the number of requests per second for a particular Reindex operation .
3412
+ Copies documents from a source to a destination .
3399
3413
3400
3414
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-reindex.html>`_
3401
3415
@@ -3446,7 +3460,7 @@ async def render_search_template(
3446
3460
body : t .Optional [t .Dict [str , t .Any ]] = None ,
3447
3461
) -> ObjectApiResponse [t .Any ]:
3448
3462
"""
3449
- Allows to use the Mustache language to pre-render a search definition .
3463
+ Renders a search template as a search request body .
3450
3464
3451
3465
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/render-search-template-api.html>`_
3452
3466
@@ -3514,7 +3528,7 @@ async def scripts_painless_execute(
3514
3528
body : t .Optional [t .Dict [str , t .Any ]] = None ,
3515
3529
) -> ObjectApiResponse [t .Any ]:
3516
3530
"""
3517
- Allows an arbitrary script to be executed and a result to be returned
3531
+ Runs a script and returns a result.
3518
3532
3519
3533
`<https://www.elastic.co/guide/en/elasticsearch/painless/master/painless-execute-api.html>`_
3520
3534
@@ -3761,7 +3775,9 @@ async def search(
3761
3775
body : t .Optional [t .Dict [str , t .Any ]] = None ,
3762
3776
) -> ObjectApiResponse [t .Any ]:
3763
3777
"""
3764
- Returns results matching a query.
3778
+ Returns search hits that match the query defined in the request. You can provide
3779
+ search queries using the `q` query string parameter or the request body. If both
3780
+ are specified, only the query parameter is used.
3765
3781
3766
3782
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/search-search.html>`_
3767
3783
@@ -4439,7 +4455,7 @@ async def search_template(
4439
4455
body : t .Optional [t .Dict [str , t .Any ]] = None ,
4440
4456
) -> ObjectApiResponse [t .Any ]:
4441
4457
"""
4442
- Allows to use the Mustache language to pre-render a search definition .
4458
+ Runs a search with a search template .
4443
4459
4444
4460
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/search-template.html>`_
4445
4461
@@ -4980,8 +4996,8 @@ async def update_by_query(
4980
4996
) -> ObjectApiResponse [t .Any ]:
4981
4997
"""
4982
4998
Updates documents that match the specified query. If no query is specified, performs
4983
- an update on every document in the index without changing the source, for example
4984
- to pick up a mapping change .
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 .
4985
5001
4986
5002
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update-by-query.html>`_
4987
5003
0 commit comments