Skip to content

Commit f0e263f

Browse files
[Backport 8.10] Update APIs to 8.10 (#179)
* Update APIs to 8.10 (#175) (cherry picked from commit f8ef115) Co-authored-by: Quentin Pradet <quentin.pradet@elastic.co>
1 parent c67f2c6 commit f0e263f

File tree

4 files changed

+130
-18
lines changed

4 files changed

+130
-18
lines changed

elastic_enterprise_search/_async/client/app_search.py

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2321,7 +2321,7 @@ async def search(
23212321
engine_name: str,
23222322
query: str,
23232323
analytics: t.Optional[t.Mapping[str, t.Any]] = None,
2324-
boost: t.Optional[t.Mapping[str, t.Any]] = None,
2324+
boosts: t.Optional[t.Mapping[str, t.Any]] = None,
23252325
current_page: t.Optional[int] = None,
23262326
facets: t.Optional[t.Mapping[str, t.Any]] = None,
23272327
filters: t.Optional[t.Mapping[str, t.Any]] = None,
@@ -2341,7 +2341,7 @@ async def search(
23412341
:param engine_name: Name of the engine
23422342
:param query:
23432343
:param analytics:
2344-
:param boost:
2344+
:param boosts:
23452345
:param current_page:
23462346
:param facets:
23472347
:param filters:
@@ -2360,8 +2360,8 @@ async def search(
23602360
__body["query"] = query
23612361
if analytics is not None:
23622362
__body["analytics"] = analytics
2363-
if boost is not None:
2364-
__body["boost"] = boost
2363+
if boosts is not None:
2364+
__body["boosts"] = boosts
23652365
if current_page is not None:
23662366
__body.setdefault("page", {})
23672367
__body["page"]["current"] = current_page
@@ -2431,7 +2431,7 @@ async def search_explain(
24312431
engine_name: str,
24322432
query: str,
24332433
analytics: t.Optional[t.Mapping[str, t.Any]] = None,
2434-
boost: t.Optional[t.Mapping[str, t.Any]] = None,
2434+
boosts: t.Optional[t.Mapping[str, t.Any]] = None,
24352435
current_page: t.Optional[int] = None,
24362436
facets: t.Optional[t.Mapping[str, t.Any]] = None,
24372437
filters: t.Optional[t.Mapping[str, t.Any]] = None,
@@ -2451,7 +2451,7 @@ async def search_explain(
24512451
:param engine_name: Name of the engine
24522452
:param query:
24532453
:param analytics:
2454-
:param boost:
2454+
:param boosts:
24552455
:param current_page:
24562456
:param facets:
24572457
:param filters:
@@ -2470,8 +2470,8 @@ async def search_explain(
24702470
__body["query"] = query
24712471
if analytics is not None:
24722472
__body["analytics"] = analytics
2473-
if boost is not None:
2474-
__body["boost"] = boost
2473+
if boosts is not None:
2474+
__body["boosts"] = boosts
24752475
if current_page is not None:
24762476
__body.setdefault("page", {})
24772477
__body["page"]["current"] = current_page
@@ -2493,7 +2493,7 @@ async def search_explain(
24932493
__headers = {"accept": "application/json", "content-type": "application/json"}
24942494
return await self.perform_request( # type: ignore[return-value]
24952495
"POST",
2496-
f"/api/as/v0/engines/{_quote(engine_name)}/search_explain",
2496+
f"/api/as/v1/engines/{_quote(engine_name)}/search_explain",
24972497
body=__body,
24982498
headers=__headers,
24992499
)
@@ -2529,6 +2529,7 @@ async def put_search_settings(
25292529
engine_name: str,
25302530
boosts: t.Optional[t.Mapping[str, t.Any]] = None,
25312531
precision: t.Optional[int] = None,
2532+
precision_enabled: t.Optional[bool] = None,
25322533
result_fields: t.Optional[t.Mapping[str, t.Any]] = None,
25332534
search_fields: t.Optional[t.Mapping[str, t.Any]] = None,
25342535
) -> ObjectApiResponse[t.Any]:
@@ -2540,6 +2541,7 @@ async def put_search_settings(
25402541
:param engine_name: Name of the engine
25412542
:param boosts:
25422543
:param precision:
2544+
:param precision_enabled:
25432545
:param result_fields:
25442546
:param search_fields:
25452547
"""
@@ -2550,6 +2552,8 @@ async def put_search_settings(
25502552
__body["boosts"] = boosts
25512553
if precision is not None:
25522554
__body["precision"] = precision
2555+
if precision_enabled is not None:
2556+
__body["precision_enabled"] = precision_enabled
25532557
if result_fields is not None:
25542558
__body["result_fields"] = result_fields
25552559
if search_fields is not None:

elastic_enterprise_search/_async/client/enterprise_search.py

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,58 @@ async def get_stats(
102102
"GET", "/api/ent/v1/internal/stats", params=__query, headers=__headers
103103
)
104104

105+
@_rewrite_parameters()
106+
async def get_storage(
107+
self,
108+
) -> ObjectApiResponse[t.Any]:
109+
"""
110+
Get information on the application indices and the space used
111+
112+
`<https://www.elastic.co/guide/en/enterprise-search/current/storage-api.html#get-storage-api>`_
113+
"""
114+
__headers = {"accept": "application/json"}
115+
return await self.perform_request( # type: ignore[return-value]
116+
"GET", "/api/ent/v1/internal/storage", headers=__headers
117+
)
118+
119+
@_rewrite_parameters()
120+
async def get_stale_storage(
121+
self,
122+
) -> ObjectApiResponse[t.Any]:
123+
"""
124+
Get information on the outdated application indices
125+
126+
`<https://www.elastic.co/guide/en/enterprise-search/current/storage-api.html#get-stale-storage-api>`_
127+
"""
128+
__headers = {"accept": "application/json"}
129+
return await self.perform_request( # type: ignore[return-value]
130+
"GET", "/api/ent/v1/internal/storage/stale", headers=__headers
131+
)
132+
133+
@_rewrite_parameters()
134+
async def delete_stale_storage(
135+
self,
136+
*,
137+
force: t.Optional[bool] = None,
138+
) -> ObjectApiResponse[t.Any]:
139+
"""
140+
Cleanup outdated application indices
141+
142+
`<https://www.elastic.co/guide/en/enterprise-search/current/storage-api.html#delete-stale-storage-api>`_
143+
144+
:param force: The value for the "force" flag
145+
"""
146+
__query: t.Dict[str, t.Any] = {}
147+
if force is not None:
148+
__query["force"] = force
149+
__headers = {"accept": "application/json"}
150+
return await self.perform_request( # type: ignore[return-value]
151+
"DELETE",
152+
"/api/ent/v1/internal/storage/stale",
153+
params=__query,
154+
headers=__headers,
155+
)
156+
105157
@_rewrite_parameters()
106158
async def get_version(
107159
self,

elastic_enterprise_search/_sync/client/app_search.py

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2321,7 +2321,7 @@ def search(
23212321
engine_name: str,
23222322
query: str,
23232323
analytics: t.Optional[t.Mapping[str, t.Any]] = None,
2324-
boost: t.Optional[t.Mapping[str, t.Any]] = None,
2324+
boosts: t.Optional[t.Mapping[str, t.Any]] = None,
23252325
current_page: t.Optional[int] = None,
23262326
facets: t.Optional[t.Mapping[str, t.Any]] = None,
23272327
filters: t.Optional[t.Mapping[str, t.Any]] = None,
@@ -2341,7 +2341,7 @@ def search(
23412341
:param engine_name: Name of the engine
23422342
:param query:
23432343
:param analytics:
2344-
:param boost:
2344+
:param boosts:
23452345
:param current_page:
23462346
:param facets:
23472347
:param filters:
@@ -2360,8 +2360,8 @@ def search(
23602360
__body["query"] = query
23612361
if analytics is not None:
23622362
__body["analytics"] = analytics
2363-
if boost is not None:
2364-
__body["boost"] = boost
2363+
if boosts is not None:
2364+
__body["boosts"] = boosts
23652365
if current_page is not None:
23662366
__body.setdefault("page", {})
23672367
__body["page"]["current"] = current_page
@@ -2431,7 +2431,7 @@ def search_explain(
24312431
engine_name: str,
24322432
query: str,
24332433
analytics: t.Optional[t.Mapping[str, t.Any]] = None,
2434-
boost: t.Optional[t.Mapping[str, t.Any]] = None,
2434+
boosts: t.Optional[t.Mapping[str, t.Any]] = None,
24352435
current_page: t.Optional[int] = None,
24362436
facets: t.Optional[t.Mapping[str, t.Any]] = None,
24372437
filters: t.Optional[t.Mapping[str, t.Any]] = None,
@@ -2451,7 +2451,7 @@ def search_explain(
24512451
:param engine_name: Name of the engine
24522452
:param query:
24532453
:param analytics:
2454-
:param boost:
2454+
:param boosts:
24552455
:param current_page:
24562456
:param facets:
24572457
:param filters:
@@ -2470,8 +2470,8 @@ def search_explain(
24702470
__body["query"] = query
24712471
if analytics is not None:
24722472
__body["analytics"] = analytics
2473-
if boost is not None:
2474-
__body["boost"] = boost
2473+
if boosts is not None:
2474+
__body["boosts"] = boosts
24752475
if current_page is not None:
24762476
__body.setdefault("page", {})
24772477
__body["page"]["current"] = current_page
@@ -2493,7 +2493,7 @@ def search_explain(
24932493
__headers = {"accept": "application/json", "content-type": "application/json"}
24942494
return self.perform_request( # type: ignore[return-value]
24952495
"POST",
2496-
f"/api/as/v0/engines/{_quote(engine_name)}/search_explain",
2496+
f"/api/as/v1/engines/{_quote(engine_name)}/search_explain",
24972497
body=__body,
24982498
headers=__headers,
24992499
)
@@ -2529,6 +2529,7 @@ def put_search_settings(
25292529
engine_name: str,
25302530
boosts: t.Optional[t.Mapping[str, t.Any]] = None,
25312531
precision: t.Optional[int] = None,
2532+
precision_enabled: t.Optional[bool] = None,
25322533
result_fields: t.Optional[t.Mapping[str, t.Any]] = None,
25332534
search_fields: t.Optional[t.Mapping[str, t.Any]] = None,
25342535
) -> ObjectApiResponse[t.Any]:
@@ -2540,6 +2541,7 @@ def put_search_settings(
25402541
:param engine_name: Name of the engine
25412542
:param boosts:
25422543
:param precision:
2544+
:param precision_enabled:
25432545
:param result_fields:
25442546
:param search_fields:
25452547
"""
@@ -2550,6 +2552,8 @@ def put_search_settings(
25502552
__body["boosts"] = boosts
25512553
if precision is not None:
25522554
__body["precision"] = precision
2555+
if precision_enabled is not None:
2556+
__body["precision_enabled"] = precision_enabled
25532557
if result_fields is not None:
25542558
__body["result_fields"] = result_fields
25552559
if search_fields is not None:

elastic_enterprise_search/_sync/client/enterprise_search.py

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,58 @@ def get_stats(
102102
"GET", "/api/ent/v1/internal/stats", params=__query, headers=__headers
103103
)
104104

105+
@_rewrite_parameters()
106+
def get_storage(
107+
self,
108+
) -> ObjectApiResponse[t.Any]:
109+
"""
110+
Get information on the application indices and the space used
111+
112+
`<https://www.elastic.co/guide/en/enterprise-search/current/storage-api.html#get-storage-api>`_
113+
"""
114+
__headers = {"accept": "application/json"}
115+
return self.perform_request( # type: ignore[return-value]
116+
"GET", "/api/ent/v1/internal/storage", headers=__headers
117+
)
118+
119+
@_rewrite_parameters()
120+
def get_stale_storage(
121+
self,
122+
) -> ObjectApiResponse[t.Any]:
123+
"""
124+
Get information on the outdated application indices
125+
126+
`<https://www.elastic.co/guide/en/enterprise-search/current/storage-api.html#get-stale-storage-api>`_
127+
"""
128+
__headers = {"accept": "application/json"}
129+
return self.perform_request( # type: ignore[return-value]
130+
"GET", "/api/ent/v1/internal/storage/stale", headers=__headers
131+
)
132+
133+
@_rewrite_parameters()
134+
def delete_stale_storage(
135+
self,
136+
*,
137+
force: t.Optional[bool] = None,
138+
) -> ObjectApiResponse[t.Any]:
139+
"""
140+
Cleanup outdated application indices
141+
142+
`<https://www.elastic.co/guide/en/enterprise-search/current/storage-api.html#delete-stale-storage-api>`_
143+
144+
:param force: The value for the "force" flag
145+
"""
146+
__query: t.Dict[str, t.Any] = {}
147+
if force is not None:
148+
__query["force"] = force
149+
__headers = {"accept": "application/json"}
150+
return self.perform_request( # type: ignore[return-value]
151+
"DELETE",
152+
"/api/ent/v1/internal/storage/stale",
153+
params=__query,
154+
headers=__headers,
155+
)
156+
105157
@_rewrite_parameters()
106158
def get_version(
107159
self,

0 commit comments

Comments
 (0)