elasticsearch-api 9.0.3 → 9.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (533) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +1 -0
  3. data/lib/elasticsearch/api/actions/async_search/delete.rb +14 -3
  4. data/lib/elasticsearch/api/actions/async_search/get.rb +13 -2
  5. data/lib/elasticsearch/api/actions/async_search/status.rb +13 -2
  6. data/lib/elasticsearch/api/actions/async_search/submit.rb +17 -6
  7. data/lib/elasticsearch/api/actions/bulk.rb +86 -63
  8. data/lib/elasticsearch/api/actions/cat/aliases.rb +20 -9
  9. data/lib/elasticsearch/api/actions/cat/allocation.rb +19 -8
  10. data/lib/elasticsearch/api/actions/cat/component_templates.rb +19 -8
  11. data/lib/elasticsearch/api/actions/cat/count.rb +19 -8
  12. data/lib/elasticsearch/api/actions/cat/fielddata.rb +17 -6
  13. data/lib/elasticsearch/api/actions/cat/health.rb +20 -9
  14. data/lib/elasticsearch/api/actions/cat/help.rb +1 -1
  15. data/lib/elasticsearch/api/actions/cat/indices.rb +18 -7
  16. data/lib/elasticsearch/api/actions/cat/master.rb +19 -8
  17. data/lib/elasticsearch/api/actions/cat/ml_data_frame_analytics.rb +16 -5
  18. data/lib/elasticsearch/api/actions/cat/ml_datafeeds.rb +19 -8
  19. data/lib/elasticsearch/api/actions/cat/ml_jobs.rb +20 -9
  20. data/lib/elasticsearch/api/actions/cat/ml_trained_models.rb +18 -7
  21. data/lib/elasticsearch/api/actions/cat/nodeattrs.rb +19 -8
  22. data/lib/elasticsearch/api/actions/cat/nodes.rb +23 -11
  23. data/lib/elasticsearch/api/actions/cat/pending_tasks.rb +19 -8
  24. data/lib/elasticsearch/api/actions/cat/plugins.rb +19 -8
  25. data/lib/elasticsearch/api/actions/cat/recovery.rb +24 -12
  26. data/lib/elasticsearch/api/actions/cat/repositories.rb +19 -8
  27. data/lib/elasticsearch/api/actions/cat/segments.rb +24 -12
  28. data/lib/elasticsearch/api/actions/cat/shards.rb +22 -11
  29. data/lib/elasticsearch/api/actions/cat/snapshots.rb +21 -9
  30. data/lib/elasticsearch/api/actions/cat/tasks.rb +19 -8
  31. data/lib/elasticsearch/api/actions/cat/templates.rb +19 -8
  32. data/lib/elasticsearch/api/actions/cat/thread_pool.rb +21 -10
  33. data/lib/elasticsearch/api/actions/cat/transforms.rb +18 -7
  34. data/lib/elasticsearch/api/actions/clear_scroll.rb +13 -2
  35. data/lib/elasticsearch/api/actions/close_point_in_time.rb +15 -4
  36. data/lib/elasticsearch/api/actions/cluster/allocation_explain.rb +13 -1
  37. data/lib/elasticsearch/api/actions/cluster/delete_component_template.rb +12 -1
  38. data/lib/elasticsearch/api/actions/cluster/delete_voting_config_exclusions.rb +12 -1
  39. data/lib/elasticsearch/api/actions/cluster/exists_component_template.rb +12 -1
  40. data/lib/elasticsearch/api/actions/cluster/get_component_template.rb +17 -5
  41. data/lib/elasticsearch/api/actions/cluster/get_settings.rb +14 -3
  42. data/lib/elasticsearch/api/actions/cluster/health.rb +13 -2
  43. data/lib/elasticsearch/api/actions/cluster/info.rb +13 -2
  44. data/lib/elasticsearch/api/actions/cluster/pending_tasks.rb +14 -3
  45. data/lib/elasticsearch/api/actions/cluster/post_voting_config_exclusions.rb +16 -5
  46. data/lib/elasticsearch/api/actions/cluster/put_component_template.rb +20 -8
  47. data/lib/elasticsearch/api/actions/cluster/put_settings.rb +17 -6
  48. data/lib/elasticsearch/api/actions/cluster/remote_info.rb +13 -2
  49. data/lib/elasticsearch/api/actions/cluster/reroute.rb +16 -5
  50. data/lib/elasticsearch/api/actions/cluster/state.rb +15 -4
  51. data/lib/elasticsearch/api/actions/cluster/stats.rb +13 -2
  52. data/lib/elasticsearch/api/actions/connector/check_in.rb +14 -3
  53. data/lib/elasticsearch/api/actions/connector/delete.rb +12 -1
  54. data/lib/elasticsearch/api/actions/connector/get.rb +12 -1
  55. data/lib/elasticsearch/api/actions/connector/list.rb +12 -1
  56. data/lib/elasticsearch/api/actions/connector/post.rb +13 -2
  57. data/lib/elasticsearch/api/actions/connector/put.rb +13 -2
  58. data/lib/elasticsearch/api/actions/connector/sync_job_cancel.rb +14 -3
  59. data/lib/elasticsearch/api/actions/connector/sync_job_check_in.rb +14 -3
  60. data/lib/elasticsearch/api/actions/connector/sync_job_claim.rb +15 -4
  61. data/lib/elasticsearch/api/actions/connector/sync_job_delete.rb +13 -2
  62. data/lib/elasticsearch/api/actions/connector/sync_job_error.rb +14 -3
  63. data/lib/elasticsearch/api/actions/connector/sync_job_get.rb +13 -2
  64. data/lib/elasticsearch/api/actions/connector/sync_job_list.rb +13 -2
  65. data/lib/elasticsearch/api/actions/connector/sync_job_post.rb +13 -2
  66. data/lib/elasticsearch/api/actions/connector/sync_job_update_stats.rb +15 -4
  67. data/lib/elasticsearch/api/actions/connector/update_active_filtering.rb +13 -2
  68. data/lib/elasticsearch/api/actions/connector/update_api_key_id.rb +14 -3
  69. data/lib/elasticsearch/api/actions/connector/update_configuration.rb +13 -2
  70. data/lib/elasticsearch/api/actions/connector/update_error.rb +13 -2
  71. data/lib/elasticsearch/api/actions/connector/update_features.rb +13 -2
  72. data/lib/elasticsearch/api/actions/connector/update_filtering.rb +13 -2
  73. data/lib/elasticsearch/api/actions/connector/update_filtering_validation.rb +13 -2
  74. data/lib/elasticsearch/api/actions/connector/update_index_name.rb +14 -3
  75. data/lib/elasticsearch/api/actions/connector/update_name.rb +13 -2
  76. data/lib/elasticsearch/api/actions/connector/update_native.rb +13 -2
  77. data/lib/elasticsearch/api/actions/connector/update_pipeline.rb +13 -2
  78. data/lib/elasticsearch/api/actions/connector/update_scheduling.rb +13 -2
  79. data/lib/elasticsearch/api/actions/connector/update_service_type.rb +13 -2
  80. data/lib/elasticsearch/api/actions/connector/update_status.rb +13 -2
  81. data/lib/elasticsearch/api/actions/count.rb +29 -18
  82. data/lib/elasticsearch/api/actions/create.rb +44 -41
  83. data/lib/elasticsearch/api/actions/cross_cluster_replication/delete_auto_follow_pattern.rb +13 -2
  84. data/lib/elasticsearch/api/actions/cross_cluster_replication/follow.rb +12 -1
  85. data/lib/elasticsearch/api/actions/cross_cluster_replication/follow_info.rb +13 -2
  86. data/lib/elasticsearch/api/actions/cross_cluster_replication/follow_stats.rb +12 -1
  87. data/lib/elasticsearch/api/actions/cross_cluster_replication/forget_follower.rb +12 -1
  88. data/lib/elasticsearch/api/actions/cross_cluster_replication/get_auto_follow_pattern.rb +13 -2
  89. data/lib/elasticsearch/api/actions/cross_cluster_replication/pause_auto_follow_pattern.rb +13 -2
  90. data/lib/elasticsearch/api/actions/cross_cluster_replication/pause_follow.rb +13 -2
  91. data/lib/elasticsearch/api/actions/cross_cluster_replication/put_auto_follow_pattern.rb +12 -1
  92. data/lib/elasticsearch/api/actions/cross_cluster_replication/resume_auto_follow_pattern.rb +13 -2
  93. data/lib/elasticsearch/api/actions/cross_cluster_replication/resume_follow.rb +12 -1
  94. data/lib/elasticsearch/api/actions/cross_cluster_replication/stats.rb +13 -2
  95. data/lib/elasticsearch/api/actions/cross_cluster_replication/unfollow.rb +13 -2
  96. data/lib/elasticsearch/api/actions/dangling_indices/delete_dangling_index.rb +13 -2
  97. data/lib/elasticsearch/api/actions/dangling_indices/import_dangling_index.rb +13 -2
  98. data/lib/elasticsearch/api/actions/dangling_indices/list_dangling_indices.rb +14 -3
  99. data/lib/elasticsearch/api/actions/delete.rb +25 -12
  100. data/lib/elasticsearch/api/actions/delete_by_query.rb +63 -48
  101. data/lib/elasticsearch/api/actions/delete_by_query_rethrottle.rb +14 -3
  102. data/lib/elasticsearch/api/actions/delete_script.rb +14 -3
  103. data/lib/elasticsearch/api/actions/enrich/delete_policy.rb +12 -1
  104. data/lib/elasticsearch/api/actions/enrich/execute_policy.rb +13 -2
  105. data/lib/elasticsearch/api/actions/enrich/get_policy.rb +12 -1
  106. data/lib/elasticsearch/api/actions/enrich/put_policy.rb +12 -1
  107. data/lib/elasticsearch/api/actions/enrich/stats.rb +12 -1
  108. data/lib/elasticsearch/api/actions/eql/delete.rb +14 -3
  109. data/lib/elasticsearch/api/actions/eql/get.rb +12 -1
  110. data/lib/elasticsearch/api/actions/eql/get_status.rb +13 -2
  111. data/lib/elasticsearch/api/actions/eql/search.rb +15 -3
  112. data/lib/elasticsearch/api/actions/esql/async_query.rb +17 -14
  113. data/lib/elasticsearch/api/actions/esql/async_query_delete.rb +15 -4
  114. data/lib/elasticsearch/api/actions/esql/async_query_get.rb +17 -5
  115. data/lib/elasticsearch/api/actions/esql/async_query_stop.rb +15 -4
  116. data/lib/elasticsearch/api/actions/esql/get_query.rb +76 -0
  117. data/lib/elasticsearch/api/actions/esql/list_queries.rb +66 -0
  118. data/lib/elasticsearch/api/actions/esql/query.rb +15 -2
  119. data/lib/elasticsearch/api/actions/exists.rb +31 -18
  120. data/lib/elasticsearch/api/actions/exists_source.rb +21 -8
  121. data/lib/elasticsearch/api/actions/explain.rb +25 -14
  122. data/lib/elasticsearch/api/actions/features/get_features.rb +13 -2
  123. data/lib/elasticsearch/api/actions/features/reset_features.rb +12 -1
  124. data/lib/elasticsearch/api/actions/field_caps.rb +18 -7
  125. data/lib/elasticsearch/api/actions/fleet/global_checkpoints.rb +17 -6
  126. data/lib/elasticsearch/api/actions/fleet/msearch.rb +15 -4
  127. data/lib/elasticsearch/api/actions/fleet/search.rb +15 -4
  128. data/lib/elasticsearch/api/actions/get.rb +48 -29
  129. data/lib/elasticsearch/api/actions/get_script.rb +13 -2
  130. data/lib/elasticsearch/api/actions/get_script_context.rb +13 -2
  131. data/lib/elasticsearch/api/actions/get_script_languages.rb +13 -2
  132. data/lib/elasticsearch/api/actions/get_source.rb +24 -11
  133. data/lib/elasticsearch/api/actions/graph/explore.rb +13 -2
  134. data/lib/elasticsearch/api/actions/health_report.rb +13 -2
  135. data/lib/elasticsearch/api/actions/index.rb +55 -43
  136. data/lib/elasticsearch/api/actions/index_lifecycle_management/delete_lifecycle.rb +12 -1
  137. data/lib/elasticsearch/api/actions/index_lifecycle_management/explain_lifecycle.rb +14 -3
  138. data/lib/elasticsearch/api/actions/index_lifecycle_management/get_lifecycle.rb +12 -1
  139. data/lib/elasticsearch/api/actions/index_lifecycle_management/get_status.rb +13 -2
  140. data/lib/elasticsearch/api/actions/index_lifecycle_management/migrate_to_data_tiers.rb +14 -3
  141. data/lib/elasticsearch/api/actions/index_lifecycle_management/move_to_step.rb +14 -3
  142. data/lib/elasticsearch/api/actions/index_lifecycle_management/put_lifecycle.rb +12 -1
  143. data/lib/elasticsearch/api/actions/index_lifecycle_management/remove_policy.rb +13 -2
  144. data/lib/elasticsearch/api/actions/index_lifecycle_management/retry.rb +13 -2
  145. data/lib/elasticsearch/api/actions/index_lifecycle_management/start.rb +12 -1
  146. data/lib/elasticsearch/api/actions/index_lifecycle_management/stop.rb +12 -1
  147. data/lib/elasticsearch/api/actions/indices/add_block.rb +20 -9
  148. data/lib/elasticsearch/api/actions/indices/analyze.rb +15 -4
  149. data/lib/elasticsearch/api/actions/indices/cancel_migrate_reindex.rb +13 -2
  150. data/lib/elasticsearch/api/actions/indices/clear_cache.rb +24 -14
  151. data/lib/elasticsearch/api/actions/indices/clone.rb +17 -6
  152. data/lib/elasticsearch/api/actions/indices/close.rb +19 -9
  153. data/lib/elasticsearch/api/actions/indices/create.rb +24 -13
  154. data/lib/elasticsearch/api/actions/indices/create_data_stream.rb +15 -4
  155. data/lib/elasticsearch/api/actions/indices/create_from.rb +13 -2
  156. data/lib/elasticsearch/api/actions/indices/data_streams_stats.rb +15 -4
  157. data/lib/elasticsearch/api/actions/indices/delete.rb +17 -7
  158. data/lib/elasticsearch/api/actions/indices/delete_alias.rb +14 -3
  159. data/lib/elasticsearch/api/actions/indices/delete_data_lifecycle.rb +13 -2
  160. data/lib/elasticsearch/api/actions/indices/delete_data_stream.rb +14 -3
  161. data/lib/elasticsearch/api/actions/indices/delete_data_stream_options.rb +75 -0
  162. data/lib/elasticsearch/api/actions/indices/delete_index_template.rb +12 -1
  163. data/lib/elasticsearch/api/actions/indices/delete_template.rb +14 -2
  164. data/lib/elasticsearch/api/actions/indices/disk_usage.rb +21 -10
  165. data/lib/elasticsearch/api/actions/indices/downsample.rb +15 -4
  166. data/lib/elasticsearch/api/actions/indices/exists.rb +19 -9
  167. data/lib/elasticsearch/api/actions/indices/exists_alias.rb +18 -8
  168. data/lib/elasticsearch/api/actions/indices/exists_index_template.rb +12 -1
  169. data/lib/elasticsearch/api/actions/indices/exists_template.rb +14 -3
  170. data/lib/elasticsearch/api/actions/indices/explain_data_lifecycle.rb +12 -1
  171. data/lib/elasticsearch/api/actions/indices/field_usage_stats.rb +16 -5
  172. data/lib/elasticsearch/api/actions/indices/flush.rb +20 -10
  173. data/lib/elasticsearch/api/actions/indices/forcemerge.rb +23 -11
  174. data/lib/elasticsearch/api/actions/indices/get.rb +12 -1
  175. data/lib/elasticsearch/api/actions/indices/get_alias.rb +19 -9
  176. data/lib/elasticsearch/api/actions/indices/get_data_lifecycle.rb +16 -6
  177. data/lib/elasticsearch/api/actions/indices/get_data_lifecycle_stats.rb +13 -2
  178. data/lib/elasticsearch/api/actions/indices/get_data_stream.rb +14 -3
  179. data/lib/elasticsearch/api/actions/indices/get_data_stream_options.rb +77 -0
  180. data/lib/elasticsearch/api/actions/indices/get_data_stream_settings.rb +75 -0
  181. data/lib/elasticsearch/api/actions/indices/get_field_mapping.rb +19 -10
  182. data/lib/elasticsearch/api/actions/indices/get_index_template.rb +12 -1
  183. data/lib/elasticsearch/api/actions/indices/get_mapping.rb +18 -8
  184. data/lib/elasticsearch/api/actions/indices/get_migrate_reindex_status.rb +13 -2
  185. data/lib/elasticsearch/api/actions/indices/get_settings.rb +24 -13
  186. data/lib/elasticsearch/api/actions/indices/get_template.rb +17 -6
  187. data/lib/elasticsearch/api/actions/indices/migrate_reindex.rb +13 -2
  188. data/lib/elasticsearch/api/actions/indices/migrate_to_data_stream.rb +13 -2
  189. data/lib/elasticsearch/api/actions/indices/modify_data_stream.rb +13 -2
  190. data/lib/elasticsearch/api/actions/indices/open.rb +23 -13
  191. data/lib/elasticsearch/api/actions/indices/promote_data_stream.rb +12 -1
  192. data/lib/elasticsearch/api/actions/indices/put_alias.rb +13 -2
  193. data/lib/elasticsearch/api/actions/indices/put_data_lifecycle.rb +15 -5
  194. data/lib/elasticsearch/api/actions/indices/put_data_stream_options.rb +82 -0
  195. data/lib/elasticsearch/api/actions/indices/put_data_stream_settings.rb +85 -0
  196. data/lib/elasticsearch/api/actions/indices/put_index_template.rb +17 -6
  197. data/lib/elasticsearch/api/actions/indices/put_mapping.rb +26 -25
  198. data/lib/elasticsearch/api/actions/indices/put_settings.rb +66 -14
  199. data/lib/elasticsearch/api/actions/indices/put_template.rb +14 -3
  200. data/lib/elasticsearch/api/actions/indices/recovery.rb +22 -5
  201. data/lib/elasticsearch/api/actions/indices/refresh.rb +19 -9
  202. data/lib/elasticsearch/api/actions/indices/reload_search_analyzers.rb +15 -4
  203. data/lib/elasticsearch/api/actions/indices/remove_block.rb +93 -0
  204. data/lib/elasticsearch/api/actions/indices/resolve_cluster.rb +35 -25
  205. data/lib/elasticsearch/api/actions/indices/resolve_index.rb +17 -7
  206. data/lib/elasticsearch/api/actions/indices/rollover.rb +22 -11
  207. data/lib/elasticsearch/api/actions/indices/segments.rb +17 -7
  208. data/lib/elasticsearch/api/actions/indices/shard_stores.rb +13 -2
  209. data/lib/elasticsearch/api/actions/indices/shrink.rb +14 -3
  210. data/lib/elasticsearch/api/actions/indices/simulate_index_template.rb +12 -1
  211. data/lib/elasticsearch/api/actions/indices/simulate_template.rb +12 -1
  212. data/lib/elasticsearch/api/actions/indices/split.rb +19 -6
  213. data/lib/elasticsearch/api/actions/indices/stats.rb +19 -8
  214. data/lib/elasticsearch/api/actions/indices/update_aliases.rb +12 -1
  215. data/lib/elasticsearch/api/actions/indices/validate_query.rb +25 -15
  216. data/lib/elasticsearch/api/actions/inference/chat_completion_unified.rb +18 -1
  217. data/lib/elasticsearch/api/actions/inference/completion.rb +12 -1
  218. data/lib/elasticsearch/api/actions/inference/delete.rb +12 -1
  219. data/lib/elasticsearch/api/actions/inference/get.rb +13 -2
  220. data/lib/elasticsearch/api/actions/inference/inference.rb +12 -1
  221. data/lib/elasticsearch/api/actions/inference/put.rb +33 -8
  222. data/lib/elasticsearch/api/actions/inference/put_alibabacloud.rb +15 -8
  223. data/lib/elasticsearch/api/actions/inference/put_amazonbedrock.rb +15 -3
  224. data/lib/elasticsearch/api/actions/inference/put_anthropic.rb +16 -9
  225. data/lib/elasticsearch/api/actions/inference/put_azureaistudio.rb +15 -8
  226. data/lib/elasticsearch/api/actions/inference/put_azureopenai.rb +16 -9
  227. data/lib/elasticsearch/api/actions/inference/put_cohere.rb +15 -8
  228. data/lib/elasticsearch/api/actions/inference/put_custom.rb +112 -0
  229. data/lib/elasticsearch/api/actions/inference/put_deepseek.rb +82 -0
  230. data/lib/elasticsearch/api/actions/inference/put_elasticsearch.rb +16 -4
  231. data/lib/elasticsearch/api/actions/inference/put_elser.rb +15 -3
  232. data/lib/elasticsearch/api/actions/inference/put_googleaistudio.rb +15 -8
  233. data/lib/elasticsearch/api/actions/inference/put_googlevertexai.rb +15 -8
  234. data/lib/elasticsearch/api/actions/inference/put_hugging_face.rb +43 -19
  235. data/lib/elasticsearch/api/actions/inference/put_jinaai.rb +17 -10
  236. data/lib/elasticsearch/api/actions/inference/put_mistral.rb +16 -10
  237. data/lib/elasticsearch/api/actions/inference/put_openai.rb +16 -9
  238. data/lib/elasticsearch/api/actions/inference/put_voyageai.rb +15 -3
  239. data/lib/elasticsearch/api/actions/inference/put_watsonx.rb +17 -11
  240. data/lib/elasticsearch/api/actions/inference/rerank.rb +13 -2
  241. data/lib/elasticsearch/api/actions/inference/sparse_embedding.rb +12 -1
  242. data/lib/elasticsearch/api/actions/inference/stream_completion.rb +15 -3
  243. data/lib/elasticsearch/api/actions/inference/text_embedding.rb +12 -1
  244. data/lib/elasticsearch/api/actions/inference/update.rb +14 -3
  245. data/lib/elasticsearch/api/actions/info.rb +14 -2
  246. data/lib/elasticsearch/api/actions/ingest/delete_geoip_database.rb +12 -1
  247. data/lib/elasticsearch/api/actions/ingest/delete_ip_location_database.rb +14 -3
  248. data/lib/elasticsearch/api/actions/ingest/delete_pipeline.rb +13 -2
  249. data/lib/elasticsearch/api/actions/ingest/geo_ip_stats.rb +12 -1
  250. data/lib/elasticsearch/api/actions/ingest/get_geoip_database.rb +15 -4
  251. data/lib/elasticsearch/api/actions/ingest/get_ip_location_database.rb +14 -6
  252. data/lib/elasticsearch/api/actions/ingest/get_pipeline.rb +14 -3
  253. data/lib/elasticsearch/api/actions/ingest/processor_grok.rb +12 -1
  254. data/lib/elasticsearch/api/actions/ingest/put_geoip_database.rb +12 -1
  255. data/lib/elasticsearch/api/actions/ingest/put_ip_location_database.rb +14 -3
  256. data/lib/elasticsearch/api/actions/ingest/put_pipeline.rb +11 -0
  257. data/lib/elasticsearch/api/actions/ingest/simulate.rb +14 -3
  258. data/lib/elasticsearch/api/actions/license/delete.rb +12 -1
  259. data/lib/elasticsearch/api/actions/license/get.rb +14 -3
  260. data/lib/elasticsearch/api/actions/license/get_basic_status.rb +13 -2
  261. data/lib/elasticsearch/api/actions/license/get_trial_status.rb +13 -2
  262. data/lib/elasticsearch/api/actions/license/post.rb +12 -1
  263. data/lib/elasticsearch/api/actions/license/post_start_basic.rb +13 -2
  264. data/lib/elasticsearch/api/actions/license/post_start_trial.rb +13 -2
  265. data/lib/elasticsearch/api/actions/logstash/delete_pipeline.rb +13 -2
  266. data/lib/elasticsearch/api/actions/logstash/get_pipeline.rb +13 -2
  267. data/lib/elasticsearch/api/actions/logstash/put_pipeline.rb +13 -2
  268. data/lib/elasticsearch/api/actions/machine_learning/clear_trained_model_deployment_cache.rb +13 -2
  269. data/lib/elasticsearch/api/actions/machine_learning/close_job.rb +16 -5
  270. data/lib/elasticsearch/api/actions/machine_learning/delete_calendar.rb +13 -2
  271. data/lib/elasticsearch/api/actions/machine_learning/delete_calendar_event.rb +13 -2
  272. data/lib/elasticsearch/api/actions/machine_learning/delete_calendar_job.rb +13 -2
  273. data/lib/elasticsearch/api/actions/machine_learning/delete_data_frame_analytics.rb +13 -2
  274. data/lib/elasticsearch/api/actions/machine_learning/delete_datafeed.rb +12 -1
  275. data/lib/elasticsearch/api/actions/machine_learning/delete_expired_data.rb +14 -3
  276. data/lib/elasticsearch/api/actions/machine_learning/delete_filter.rb +13 -2
  277. data/lib/elasticsearch/api/actions/machine_learning/delete_forecast.rb +15 -4
  278. data/lib/elasticsearch/api/actions/machine_learning/delete_job.rb +12 -1
  279. data/lib/elasticsearch/api/actions/machine_learning/delete_model_snapshot.rb +14 -3
  280. data/lib/elasticsearch/api/actions/machine_learning/delete_trained_model.rb +12 -1
  281. data/lib/elasticsearch/api/actions/machine_learning/delete_trained_model_alias.rb +14 -3
  282. data/lib/elasticsearch/api/actions/machine_learning/estimate_model_memory.rb +13 -2
  283. data/lib/elasticsearch/api/actions/machine_learning/evaluate_data_frame.rb +13 -2
  284. data/lib/elasticsearch/api/actions/machine_learning/explain_data_frame_analytics.rb +13 -2
  285. data/lib/elasticsearch/api/actions/machine_learning/flush_job.rb +14 -3
  286. data/lib/elasticsearch/api/actions/machine_learning/forecast.rb +14 -3
  287. data/lib/elasticsearch/api/actions/machine_learning/get_buckets.rb +16 -5
  288. data/lib/elasticsearch/api/actions/machine_learning/get_calendar_events.rb +14 -3
  289. data/lib/elasticsearch/api/actions/machine_learning/get_calendars.rb +13 -2
  290. data/lib/elasticsearch/api/actions/machine_learning/get_categories.rb +12 -1
  291. data/lib/elasticsearch/api/actions/machine_learning/get_data_frame_analytics.rb +14 -3
  292. data/lib/elasticsearch/api/actions/machine_learning/get_data_frame_analytics_stats.rb +14 -3
  293. data/lib/elasticsearch/api/actions/machine_learning/get_datafeed_stats.rb +19 -8
  294. data/lib/elasticsearch/api/actions/machine_learning/get_datafeeds.rb +18 -7
  295. data/lib/elasticsearch/api/actions/machine_learning/get_filters.rb +12 -1
  296. data/lib/elasticsearch/api/actions/machine_learning/get_influencers.rb +14 -3
  297. data/lib/elasticsearch/api/actions/machine_learning/get_job_stats.rb +14 -3
  298. data/lib/elasticsearch/api/actions/machine_learning/get_jobs.rb +15 -4
  299. data/lib/elasticsearch/api/actions/machine_learning/get_memory_stats.rb +14 -3
  300. data/lib/elasticsearch/api/actions/machine_learning/get_model_snapshot_upgrade_stats.rb +14 -3
  301. data/lib/elasticsearch/api/actions/machine_learning/get_model_snapshots.rb +14 -3
  302. data/lib/elasticsearch/api/actions/machine_learning/get_overall_buckets.rb +31 -20
  303. data/lib/elasticsearch/api/actions/machine_learning/get_records.rb +13 -2
  304. data/lib/elasticsearch/api/actions/machine_learning/get_trained_models.rb +13 -2
  305. data/lib/elasticsearch/api/actions/machine_learning/get_trained_models_stats.rb +12 -1
  306. data/lib/elasticsearch/api/actions/machine_learning/infer_trained_model.rb +12 -1
  307. data/lib/elasticsearch/api/actions/machine_learning/info.rb +13 -2
  308. data/lib/elasticsearch/api/actions/machine_learning/open_job.rb +12 -1
  309. data/lib/elasticsearch/api/actions/machine_learning/post_calendar_events.rb +13 -2
  310. data/lib/elasticsearch/api/actions/machine_learning/post_data.rb +12 -1
  311. data/lib/elasticsearch/api/actions/machine_learning/preview_data_frame_analytics.rb +13 -2
  312. data/lib/elasticsearch/api/actions/machine_learning/preview_datafeed.rb +12 -1
  313. data/lib/elasticsearch/api/actions/machine_learning/put_calendar.rb +13 -2
  314. data/lib/elasticsearch/api/actions/machine_learning/put_calendar_job.rb +13 -2
  315. data/lib/elasticsearch/api/actions/machine_learning/put_data_frame_analytics.rb +14 -3
  316. data/lib/elasticsearch/api/actions/machine_learning/put_datafeed.rb +25 -6
  317. data/lib/elasticsearch/api/actions/machine_learning/put_filter.rb +14 -3
  318. data/lib/elasticsearch/api/actions/machine_learning/put_job.rb +19 -13
  319. data/lib/elasticsearch/api/actions/machine_learning/put_trained_model.rb +13 -2
  320. data/lib/elasticsearch/api/actions/machine_learning/put_trained_model_alias.rb +12 -1
  321. data/lib/elasticsearch/api/actions/machine_learning/put_trained_model_definition_part.rb +14 -3
  322. data/lib/elasticsearch/api/actions/machine_learning/put_trained_model_vocabulary.rb +14 -3
  323. data/lib/elasticsearch/api/actions/machine_learning/reset_job.rb +12 -1
  324. data/lib/elasticsearch/api/actions/machine_learning/revert_model_snapshot.rb +13 -2
  325. data/lib/elasticsearch/api/actions/machine_learning/set_upgrade_mode.rb +13 -2
  326. data/lib/elasticsearch/api/actions/machine_learning/start_data_frame_analytics.rb +13 -2
  327. data/lib/elasticsearch/api/actions/machine_learning/start_datafeed.rb +19 -8
  328. data/lib/elasticsearch/api/actions/machine_learning/start_trained_model_deployment.rb +14 -3
  329. data/lib/elasticsearch/api/actions/machine_learning/stop_data_frame_analytics.rb +12 -1
  330. data/lib/elasticsearch/api/actions/machine_learning/stop_datafeed.rb +17 -6
  331. data/lib/elasticsearch/api/actions/machine_learning/stop_trained_model_deployment.rb +14 -3
  332. data/lib/elasticsearch/api/actions/machine_learning/update_data_frame_analytics.rb +13 -2
  333. data/lib/elasticsearch/api/actions/machine_learning/update_datafeed.rb +17 -11
  334. data/lib/elasticsearch/api/actions/machine_learning/update_filter.rb +13 -2
  335. data/lib/elasticsearch/api/actions/machine_learning/update_job.rb +13 -2
  336. data/lib/elasticsearch/api/actions/machine_learning/update_model_snapshot.rb +13 -2
  337. data/lib/elasticsearch/api/actions/machine_learning/update_trained_model_deployment.rb +12 -1
  338. data/lib/elasticsearch/api/actions/machine_learning/upgrade_job_snapshot.rb +12 -1
  339. data/lib/elasticsearch/api/actions/mget.rb +25 -14
  340. data/lib/elasticsearch/api/actions/migration/deprecations.rb +13 -2
  341. data/lib/elasticsearch/api/actions/migration/get_feature_upgrade_status.rb +13 -2
  342. data/lib/elasticsearch/api/actions/migration/post_feature_upgrade.rb +13 -2
  343. data/lib/elasticsearch/api/actions/msearch.rb +28 -11
  344. data/lib/elasticsearch/api/actions/msearch_template.rb +22 -10
  345. data/lib/elasticsearch/api/actions/mtermvectors.rb +21 -10
  346. data/lib/elasticsearch/api/actions/nodes/clear_repositories_metering_archive.rb +14 -3
  347. data/lib/elasticsearch/api/actions/nodes/get_repositories_metering_info.rb +13 -2
  348. data/lib/elasticsearch/api/actions/nodes/hot_threads.rb +12 -1
  349. data/lib/elasticsearch/api/actions/nodes/info.rb +12 -1
  350. data/lib/elasticsearch/api/actions/nodes/reload_secure_settings.rb +12 -1
  351. data/lib/elasticsearch/api/actions/nodes/stats.rb +13 -2
  352. data/lib/elasticsearch/api/actions/nodes/usage.rb +14 -3
  353. data/lib/elasticsearch/api/actions/open_point_in_time.rb +23 -12
  354. data/lib/elasticsearch/api/actions/ping.rb +13 -2
  355. data/lib/elasticsearch/api/actions/put_script.rb +14 -3
  356. data/lib/elasticsearch/api/actions/query_rules/delete_rule.rb +13 -2
  357. data/lib/elasticsearch/api/actions/query_rules/delete_ruleset.rb +12 -1
  358. data/lib/elasticsearch/api/actions/query_rules/get_rule.rb +13 -2
  359. data/lib/elasticsearch/api/actions/query_rules/get_ruleset.rb +13 -2
  360. data/lib/elasticsearch/api/actions/query_rules/list_rulesets.rb +12 -1
  361. data/lib/elasticsearch/api/actions/query_rules/put_rule.rb +13 -2
  362. data/lib/elasticsearch/api/actions/query_rules/put_ruleset.rb +15 -4
  363. data/lib/elasticsearch/api/actions/query_rules/test.rb +13 -2
  364. data/lib/elasticsearch/api/actions/rank_eval.rb +16 -5
  365. data/lib/elasticsearch/api/actions/reindex.rb +35 -123
  366. data/lib/elasticsearch/api/actions/reindex_rethrottle.rb +17 -4
  367. data/lib/elasticsearch/api/actions/render_search_template.rb +14 -3
  368. data/lib/elasticsearch/api/actions/scripts_painless_execute.rb +12 -1
  369. data/lib/elasticsearch/api/actions/scroll.rb +16 -5
  370. data/lib/elasticsearch/api/actions/search.rb +71 -60
  371. data/lib/elasticsearch/api/actions/search_application/delete.rb +13 -2
  372. data/lib/elasticsearch/api/actions/search_application/delete_behavioral_analytics.rb +13 -2
  373. data/lib/elasticsearch/api/actions/search_application/get.rb +13 -2
  374. data/lib/elasticsearch/api/actions/search_application/get_behavioral_analytics.rb +13 -2
  375. data/lib/elasticsearch/api/actions/search_application/list.rb +12 -1
  376. data/lib/elasticsearch/api/actions/search_application/post_behavioral_analytics_event.rb +12 -1
  377. data/lib/elasticsearch/api/actions/search_application/put.rb +13 -2
  378. data/lib/elasticsearch/api/actions/search_application/put_behavioral_analytics.rb +13 -2
  379. data/lib/elasticsearch/api/actions/search_application/render_query.rb +15 -4
  380. data/lib/elasticsearch/api/actions/search_application/search.rb +12 -1
  381. data/lib/elasticsearch/api/actions/search_mvt.rb +39 -70
  382. data/lib/elasticsearch/api/actions/search_shards.rb +22 -12
  383. data/lib/elasticsearch/api/actions/search_template.rb +24 -14
  384. data/lib/elasticsearch/api/actions/searchable_snapshots/cache_stats.rb +12 -1
  385. data/lib/elasticsearch/api/actions/searchable_snapshots/clear_cache.rb +14 -3
  386. data/lib/elasticsearch/api/actions/searchable_snapshots/mount.rb +13 -2
  387. data/lib/elasticsearch/api/actions/searchable_snapshots/stats.rb +12 -1
  388. data/lib/elasticsearch/api/actions/security/activate_user_profile.rb +17 -6
  389. data/lib/elasticsearch/api/actions/security/authenticate.rb +13 -2
  390. data/lib/elasticsearch/api/actions/security/bulk_delete_role.rb +13 -2
  391. data/lib/elasticsearch/api/actions/security/bulk_put_role.rb +13 -2
  392. data/lib/elasticsearch/api/actions/security/bulk_update_api_keys.rb +15 -4
  393. data/lib/elasticsearch/api/actions/security/change_password.rb +13 -2
  394. data/lib/elasticsearch/api/actions/security/clear_api_key_cache.rb +14 -3
  395. data/lib/elasticsearch/api/actions/security/clear_cached_privileges.rb +14 -3
  396. data/lib/elasticsearch/api/actions/security/clear_cached_realms.rb +13 -2
  397. data/lib/elasticsearch/api/actions/security/clear_cached_roles.rb +14 -3
  398. data/lib/elasticsearch/api/actions/security/clear_cached_service_tokens.rb +17 -6
  399. data/lib/elasticsearch/api/actions/security/create_api_key.rb +13 -2
  400. data/lib/elasticsearch/api/actions/security/create_cross_cluster_api_key.rb +16 -5
  401. data/lib/elasticsearch/api/actions/security/create_service_token.rb +15 -4
  402. data/lib/elasticsearch/api/actions/security/delegate_pki.rb +15 -4
  403. data/lib/elasticsearch/api/actions/security/delete_privileges.rb +14 -3
  404. data/lib/elasticsearch/api/actions/security/delete_role.rb +13 -2
  405. data/lib/elasticsearch/api/actions/security/delete_role_mapping.rb +13 -2
  406. data/lib/elasticsearch/api/actions/security/delete_service_token.rb +13 -2
  407. data/lib/elasticsearch/api/actions/security/delete_user.rb +13 -2
  408. data/lib/elasticsearch/api/actions/security/disable_user.rb +13 -2
  409. data/lib/elasticsearch/api/actions/security/disable_user_profile.rb +12 -1
  410. data/lib/elasticsearch/api/actions/security/enable_user.rb +13 -2
  411. data/lib/elasticsearch/api/actions/security/enable_user_profile.rb +12 -1
  412. data/lib/elasticsearch/api/actions/security/enroll_kibana.rb +13 -2
  413. data/lib/elasticsearch/api/actions/security/enroll_node.rb +13 -2
  414. data/lib/elasticsearch/api/actions/security/get_api_key.rb +20 -9
  415. data/lib/elasticsearch/api/actions/security/get_builtin_privileges.rb +13 -2
  416. data/lib/elasticsearch/api/actions/security/get_privileges.rb +14 -3
  417. data/lib/elasticsearch/api/actions/security/get_role.rb +12 -1
  418. data/lib/elasticsearch/api/actions/security/get_role_mapping.rb +13 -2
  419. data/lib/elasticsearch/api/actions/security/get_service_accounts.rb +16 -5
  420. data/lib/elasticsearch/api/actions/security/get_service_credentials.rb +15 -4
  421. data/lib/elasticsearch/api/actions/security/get_settings.rb +15 -4
  422. data/lib/elasticsearch/api/actions/security/get_token.rb +15 -4
  423. data/lib/elasticsearch/api/actions/security/get_user.rb +13 -2
  424. data/lib/elasticsearch/api/actions/security/get_user_privileges.rb +12 -4
  425. data/lib/elasticsearch/api/actions/security/get_user_profile.rb +17 -6
  426. data/lib/elasticsearch/api/actions/security/grant_api_key.rb +17 -2
  427. data/lib/elasticsearch/api/actions/security/has_privileges.rb +13 -2
  428. data/lib/elasticsearch/api/actions/security/has_privileges_user_profile.rb +13 -2
  429. data/lib/elasticsearch/api/actions/security/invalidate_api_key.rb +21 -10
  430. data/lib/elasticsearch/api/actions/security/invalidate_token.rb +16 -5
  431. data/lib/elasticsearch/api/actions/security/oidc_authenticate.rb +13 -2
  432. data/lib/elasticsearch/api/actions/security/oidc_logout.rb +14 -3
  433. data/lib/elasticsearch/api/actions/security/oidc_prepare_authentication.rb +13 -2
  434. data/lib/elasticsearch/api/actions/security/put_privileges.rb +18 -7
  435. data/lib/elasticsearch/api/actions/security/put_role.rb +13 -2
  436. data/lib/elasticsearch/api/actions/security/put_role_mapping.rb +16 -5
  437. data/lib/elasticsearch/api/actions/security/put_user.rb +13 -2
  438. data/lib/elasticsearch/api/actions/security/query_api_keys.rb +18 -6
  439. data/lib/elasticsearch/api/actions/security/query_role.rb +13 -2
  440. data/lib/elasticsearch/api/actions/security/query_user.rb +12 -1
  441. data/lib/elasticsearch/api/actions/security/saml_authenticate.rb +14 -3
  442. data/lib/elasticsearch/api/actions/security/saml_complete_logout.rb +13 -2
  443. data/lib/elasticsearch/api/actions/security/saml_invalidate.rb +14 -3
  444. data/lib/elasticsearch/api/actions/security/saml_logout.rb +13 -2
  445. data/lib/elasticsearch/api/actions/security/saml_prepare_authentication.rb +16 -5
  446. data/lib/elasticsearch/api/actions/security/saml_service_provider_metadata.rb +13 -2
  447. data/lib/elasticsearch/api/actions/security/suggest_user_profiles.rb +17 -6
  448. data/lib/elasticsearch/api/actions/security/update_api_key.rb +17 -6
  449. data/lib/elasticsearch/api/actions/security/update_cross_cluster_api_key.rb +17 -5
  450. data/lib/elasticsearch/api/actions/security/update_settings.rb +14 -3
  451. data/lib/elasticsearch/api/actions/security/update_user_profile_data.rb +16 -5
  452. data/lib/elasticsearch/api/actions/simulate/ingest.rb +12 -1
  453. data/lib/elasticsearch/api/actions/snapshot/cleanup_repository.rb +14 -3
  454. data/lib/elasticsearch/api/actions/snapshot/clone.rb +13 -2
  455. data/lib/elasticsearch/api/actions/snapshot/create.rb +14 -3
  456. data/lib/elasticsearch/api/actions/snapshot/create_repository.rb +17 -6
  457. data/lib/elasticsearch/api/actions/snapshot/delete.rb +16 -3
  458. data/lib/elasticsearch/api/actions/snapshot/delete_repository.rb +15 -4
  459. data/lib/elasticsearch/api/actions/snapshot/get.rb +32 -19
  460. data/lib/elasticsearch/api/actions/snapshot/get_repository.rb +16 -5
  461. data/lib/elasticsearch/api/actions/snapshot/repository_analyze.rb +38 -16
  462. data/lib/elasticsearch/api/actions/snapshot/repository_verify_integrity.rb +113 -0
  463. data/lib/elasticsearch/api/actions/snapshot/restore.rb +19 -6
  464. data/lib/elasticsearch/api/actions/snapshot/status.rb +19 -8
  465. data/lib/elasticsearch/api/actions/snapshot/verify_repository.rb +14 -3
  466. data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/delete_lifecycle.rb +12 -1
  467. data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/execute_lifecycle.rb +12 -1
  468. data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/execute_retention.rb +12 -1
  469. data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_lifecycle.rb +12 -1
  470. data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_stats.rb +12 -1
  471. data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_status.rb +14 -3
  472. data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/put_lifecycle.rb +14 -3
  473. data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/start.rb +14 -3
  474. data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/stop.rb +14 -3
  475. data/lib/elasticsearch/api/actions/sql/clear_cursor.rb +13 -2
  476. data/lib/elasticsearch/api/actions/sql/delete_async.rb +14 -3
  477. data/lib/elasticsearch/api/actions/sql/get_async.rb +14 -3
  478. data/lib/elasticsearch/api/actions/sql/get_async_status.rb +13 -2
  479. data/lib/elasticsearch/api/actions/sql/query.rb +14 -3
  480. data/lib/elasticsearch/api/actions/sql/translate.rb +14 -3
  481. data/lib/elasticsearch/api/actions/ssl/certificates.rb +15 -4
  482. data/lib/elasticsearch/api/actions/streams/logs_disable.rb +50 -0
  483. data/lib/elasticsearch/api/actions/streams/logs_enable.rb +50 -0
  484. data/lib/elasticsearch/api/actions/streams/status.rb +50 -0
  485. data/lib/elasticsearch/api/actions/synonyms/delete_synonym.rb +13 -2
  486. data/lib/elasticsearch/api/actions/synonyms/delete_synonym_rule.rb +15 -2
  487. data/lib/elasticsearch/api/actions/synonyms/get_synonym.rb +12 -1
  488. data/lib/elasticsearch/api/actions/synonyms/get_synonym_rule.rb +13 -2
  489. data/lib/elasticsearch/api/actions/synonyms/get_synonyms_sets.rb +12 -1
  490. data/lib/elasticsearch/api/actions/synonyms/put_synonym.rb +16 -2
  491. data/lib/elasticsearch/api/actions/synonyms/put_synonym_rule.rb +15 -2
  492. data/lib/elasticsearch/api/actions/tasks/cancel.rb +15 -4
  493. data/lib/elasticsearch/api/actions/tasks/get.rb +13 -2
  494. data/lib/elasticsearch/api/actions/tasks/list.rb +30 -15
  495. data/lib/elasticsearch/api/actions/terms_enum.rb +15 -4
  496. data/lib/elasticsearch/api/actions/termvectors.rb +28 -15
  497. data/lib/elasticsearch/api/actions/text_structure/find_field_structure.rb +53 -42
  498. data/lib/elasticsearch/api/actions/text_structure/find_message_structure.rb +53 -42
  499. data/lib/elasticsearch/api/actions/text_structure/find_structure.rb +45 -45
  500. data/lib/elasticsearch/api/actions/text_structure/test_grok_pattern.rb +13 -2
  501. data/lib/elasticsearch/api/actions/transform/delete_transform.rb +12 -1
  502. data/lib/elasticsearch/api/actions/transform/get_node_stats.rb +2 -7
  503. data/lib/elasticsearch/api/actions/transform/get_transform.rb +14 -3
  504. data/lib/elasticsearch/api/actions/transform/get_transform_stats.rb +14 -3
  505. data/lib/elasticsearch/api/actions/transform/preview_transform.rb +12 -1
  506. data/lib/elasticsearch/api/actions/transform/put_transform.rb +19 -8
  507. data/lib/elasticsearch/api/actions/transform/reset_transform.rb +14 -3
  508. data/lib/elasticsearch/api/actions/transform/schedule_now_transform.rb +13 -2
  509. data/lib/elasticsearch/api/actions/transform/start_transform.rb +15 -4
  510. data/lib/elasticsearch/api/actions/transform/stop_transform.rb +15 -4
  511. data/lib/elasticsearch/api/actions/transform/update_transform.rb +15 -4
  512. data/lib/elasticsearch/api/actions/transform/upgrade_transforms.rb +12 -1
  513. data/lib/elasticsearch/api/actions/update.rb +20 -8
  514. data/lib/elasticsearch/api/actions/update_by_query.rb +76 -56
  515. data/lib/elasticsearch/api/actions/update_by_query_rethrottle.rb +13 -2
  516. data/lib/elasticsearch/api/actions/watcher/ack_watch.rb +16 -4
  517. data/lib/elasticsearch/api/actions/watcher/activate_watch.rb +13 -2
  518. data/lib/elasticsearch/api/actions/watcher/deactivate_watch.rb +13 -2
  519. data/lib/elasticsearch/api/actions/watcher/delete_watch.rb +15 -4
  520. data/lib/elasticsearch/api/actions/watcher/execute_watch.rb +14 -2
  521. data/lib/elasticsearch/api/actions/watcher/get_settings.rb +14 -3
  522. data/lib/elasticsearch/api/actions/watcher/get_watch.rb +13 -2
  523. data/lib/elasticsearch/api/actions/watcher/put_watch.rb +18 -7
  524. data/lib/elasticsearch/api/actions/watcher/query_watches.rb +14 -3
  525. data/lib/elasticsearch/api/actions/watcher/start.rb +12 -1
  526. data/lib/elasticsearch/api/actions/watcher/stats.rb +13 -2
  527. data/lib/elasticsearch/api/actions/watcher/stop.rb +13 -2
  528. data/lib/elasticsearch/api/actions/watcher/update_settings.rb +17 -6
  529. data/lib/elasticsearch/api/actions/xpack/info.rb +13 -2
  530. data/lib/elasticsearch/api/actions/xpack/usage.rb +13 -2
  531. data/lib/elasticsearch/api/version.rb +2 -2
  532. data/lib/elasticsearch/api.rb +1 -0
  533. metadata +18 -4
@@ -31,10 +31,21 @@ module Elasticsearch
31
31
  # @option arguments [String] :cause User defined reason for dry-run creating the new template for simulation purposes
32
32
  # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
33
33
  # @option arguments [Boolean] :include_defaults If true, returns all relevant default configurations for the index template.
34
+ # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
35
+ # when they occur.
36
+ # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
37
+ # returned by Elasticsearch.
38
+ # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
39
+ # For example `"exists_time": "1h"` for humans and
40
+ # `"exists_time_in_millis": 3600000` for computers. When disabled the human
41
+ # readable values will be omitted. This makes sense for responses being consumed
42
+ # only by machines.
43
+ # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
44
+ # this option for debugging only.
34
45
  # @option arguments [Hash] :headers Custom HTTP headers
35
46
  # @option arguments [Hash] :body request body
36
47
  #
37
- # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-simulate-template
48
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-simulate-template
38
49
  #
39
50
  def simulate_template(arguments = {})
40
51
  request_opts = { endpoint: arguments[:endpoint] || 'indices.simulate_template' }
@@ -28,14 +28,16 @@ module Elasticsearch
28
28
  # * The index must be read-only.
29
29
  # * The cluster health status must be green.
30
30
  # You can do make an index read-only with the following request using the add index block API:
31
- # +
31
+ #
32
+ # ```
32
33
  # PUT /my_source_index/_block/write
33
- # +
34
+ # ```
35
+ #
34
36
  # The current write index on a data stream cannot be split.
35
37
  # In order to split the current write index, the data stream must first be rolled over so that a new write index is created and then the previous write index can be split.
36
- # The number of times the index can be split (and the number of shards that each original shard can be split into) is determined by the +index.number_of_routing_shards+ setting.
38
+ # The number of times the index can be split (and the number of shards that each original shard can be split into) is determined by the `index.number_of_routing_shards` setting.
37
39
  # The number of routing shards specifies the hashing space that is used internally to distribute documents across shards with consistent hashing.
38
- # For instance, a 5 shard index with +number_of_routing_shards+ set to 30 (5 x 2 x 3) could be split by a factor of 2 or 3.
40
+ # For instance, a 5 shard index with `number_of_routing_shards` set to 30 (5 x 2 x 3) could be split by a factor of 2 or 3.
39
41
  # A split operation:
40
42
  # * Creates a new target index with the same definition as the source index, but with a larger number of primary shards.
41
43
  # * Hard-links segments from the source index into the target index. If the file system doesn't support hard-linking, all segments are copied into the new index, which is a much more time consuming process.
@@ -54,11 +56,22 @@ module Elasticsearch
54
56
  # @option arguments [Time] :timeout Period to wait for a response.
55
57
  # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
56
58
  # @option arguments [Integer, String] :wait_for_active_shards The number of shard copies that must be active before proceeding with the operation.
57
- # Set to +all+ or any positive integer up to the total number of shards in the index (+number_of_replicas+1+). Server default: 1.
59
+ # Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). Server default: 1.
60
+ # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
61
+ # when they occur.
62
+ # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
63
+ # returned by Elasticsearch.
64
+ # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
65
+ # For example `"exists_time": "1h"` for humans and
66
+ # `"exists_time_in_millis": 3600000` for computers. When disabled the human
67
+ # readable values will be omitted. This makes sense for responses being consumed
68
+ # only by machines.
69
+ # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
70
+ # this option for debugging only.
58
71
  # @option arguments [Hash] :headers Custom HTTP headers
59
72
  # @option arguments [Hash] :body request body
60
73
  #
61
- # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-split
74
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-split
62
75
  #
63
76
  def split(arguments = {})
64
77
  request_opts = { endpoint: arguments[:endpoint] || 'indices.split' }
@@ -24,29 +24,40 @@ module Elasticsearch
24
24
  module Actions
25
25
  # Get index statistics.
26
26
  # For data streams, the API retrieves statistics for the stream's backing indices.
27
- # By default, the returned statistics are index-level with +primaries+ and +total+ aggregations.
28
- # +primaries+ are the values for only the primary shards.
29
- # +total+ are the accumulated values for both primary and replica shards.
30
- # To get shard-level statistics, set the +level+ parameter to +shards+.
27
+ # By default, the returned statistics are index-level with `primaries` and `total` aggregations.
28
+ # `primaries` are the values for only the primary shards.
29
+ # `total` are the accumulated values for both primary and replica shards.
30
+ # To get shard-level statistics, set the `level` parameter to `shards`.
31
31
  # NOTE: When moving to another node, the shard-level statistics for a shard are cleared.
32
32
  # Although the shard is no longer part of the node, that node retains any node-level statistics to which the shard contributed.
33
33
  #
34
34
  # @option arguments [String, Array<String>] :metric Limit the information returned the specific metrics.
35
- # @option arguments [String, Array] :index A comma-separated list of index names; use +_all+ or empty string to perform the operation on all indices
35
+ # @option arguments [String, Array] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
36
36
  # @option arguments [String, Array<String>] :completion_fields Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics.
37
37
  # @option arguments [String, Array<String>] :expand_wildcards Type of index that wildcard patterns can match. If the request can target data streams, this argument
38
38
  # determines whether wildcard expressions match hidden data streams. Supports comma-separated values,
39
- # such as +open,hidden+.
39
+ # such as `open,hidden`.
40
40
  # @option arguments [String, Array<String>] :fielddata_fields Comma-separated list or wildcard expressions of fields to include in fielddata statistics.
41
41
  # @option arguments [String, Array<String>] :fields Comma-separated list or wildcard expressions of fields to include in the statistics.
42
42
  # @option arguments [Boolean] :forbid_closed_indices If true, statistics are not collected from closed indices. Server default: true.
43
- # @option arguments [String] :groups Comma-separated list of search groups to include in the search statistics.
43
+ # @option arguments [String, Array<String>] :groups Comma-separated list of search groups to include in the search statistics.
44
44
  # @option arguments [Boolean] :include_segment_file_sizes If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested).
45
45
  # @option arguments [Boolean] :include_unloaded_segments If true, the response includes information from segments that are not loaded into memory.
46
46
  # @option arguments [String] :level Indicates whether statistics are aggregated at the cluster, index, or shard level.
47
+ # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
48
+ # when they occur.
49
+ # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
50
+ # returned by Elasticsearch.
51
+ # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
52
+ # For example `"exists_time": "1h"` for humans and
53
+ # `"exists_time_in_millis": 3600000` for computers. When disabled the human
54
+ # readable values will be omitted. This makes sense for responses being consumed
55
+ # only by machines.
56
+ # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
57
+ # this option for debugging only.
47
58
  # @option arguments [Hash] :headers Custom HTTP headers
48
59
  #
49
- # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-stats
60
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-stats
50
61
  #
51
62
  def stats(arguments = {})
52
63
  request_opts = { endpoint: arguments[:endpoint] || 'indices.stats' }
@@ -29,10 +29,21 @@ module Elasticsearch
29
29
  # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
30
30
  # @option arguments [Time] :timeout Period to wait for a response.
31
31
  # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
32
+ # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
33
+ # when they occur.
34
+ # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
35
+ # returned by Elasticsearch.
36
+ # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
37
+ # For example `"exists_time": "1h"` for humans and
38
+ # `"exists_time_in_millis": 3600000` for computers. When disabled the human
39
+ # readable values will be omitted. This makes sense for responses being consumed
40
+ # only by machines.
41
+ # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
42
+ # this option for debugging only.
32
43
  # @option arguments [Hash] :headers Custom HTTP headers
33
44
  # @option arguments [Hash] :body request body
34
45
  #
35
- # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-update-aliases
46
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-update-aliases
36
47
  #
37
48
  def update_aliases(arguments = {})
38
49
  request_opts = { endpoint: arguments[:endpoint] || 'indices.update_aliases' }
@@ -26,30 +26,40 @@ module Elasticsearch
26
26
  # Validates a query without running it.
27
27
  #
28
28
  # @option arguments [String, Array] :index Comma-separated list of data streams, indices, and aliases to search.
29
- # Supports wildcards (+*+).
30
- # To search all data streams or indices, omit this parameter or use +*+ or +_all+.
31
- # @option arguments [Boolean] :allow_no_indices If +false+, the request returns an error if any wildcard expression, index alias, or +_all+ value targets only missing or closed indices.
29
+ # Supports wildcards (`*`).
30
+ # To search all data streams or indices, omit this parameter or use `*` or `_all`.
31
+ # @option arguments [Boolean] :allow_no_indices If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
32
32
  # This behavior applies even if the request targets other open indices. Server default: true.
33
- # @option arguments [Boolean] :all_shards If +true+, the validation is executed on all shards instead of one random shard per index.
33
+ # @option arguments [Boolean] :all_shards If `true`, the validation is executed on all shards instead of one random shard per index.
34
34
  # @option arguments [String] :analyzer Analyzer to use for the query string.
35
- # This parameter can only be used when the +q+ query string parameter is specified.
36
- # @option arguments [Boolean] :analyze_wildcard If +true+, wildcard and prefix queries are analyzed.
37
- # @option arguments [String] :default_operator The default operator for query string query: +AND+ or +OR+. Server default: OR.
35
+ # This parameter can only be used when the `q` query string parameter is specified.
36
+ # @option arguments [Boolean] :analyze_wildcard If `true`, wildcard and prefix queries are analyzed.
37
+ # @option arguments [String] :default_operator The default operator for query string query: `AND` or `OR`. Server default: OR.
38
38
  # @option arguments [String] :df Field to use as default where no field prefix is given in the query string.
39
- # This parameter can only be used when the +q+ query string parameter is specified.
39
+ # This parameter can only be used when the `q` query string parameter is specified.
40
40
  # @option arguments [String, Array<String>] :expand_wildcards Type of index that wildcard patterns can match.
41
41
  # If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
42
- # Supports comma-separated values, such as +open,hidden+.
43
- # Valid values are: +all+, +open+, +closed+, +hidden+, +none+. Server default: open.
44
- # @option arguments [Boolean] :explain If +true+, the response returns detailed information if an error has occurred.
45
- # @option arguments [Boolean] :ignore_unavailable If +false+, the request returns an error if it targets a missing or closed index.
46
- # @option arguments [Boolean] :lenient If +true+, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.
47
- # @option arguments [Boolean] :rewrite If +true+, returns a more detailed explanation showing the actual Lucene query that will be executed.
42
+ # Supports comma-separated values, such as `open,hidden`. Server default: open.
43
+ # @option arguments [Boolean] :explain If `true`, the response returns detailed information if an error has occurred.
44
+ # @option arguments [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a missing or closed index.
45
+ # @option arguments [Boolean] :lenient If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.
46
+ # @option arguments [Boolean] :rewrite If `true`, returns a more detailed explanation showing the actual Lucene query that will be executed.
48
47
  # @option arguments [String] :q Query in the Lucene query string syntax.
48
+ # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
49
+ # when they occur.
50
+ # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
51
+ # returned by Elasticsearch.
52
+ # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
53
+ # For example `"exists_time": "1h"` for humans and
54
+ # `"exists_time_in_millis": 3600000` for computers. When disabled the human
55
+ # readable values will be omitted. This makes sense for responses being consumed
56
+ # only by machines.
57
+ # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
58
+ # this option for debugging only.
49
59
  # @option arguments [Hash] :headers Custom HTTP headers
50
60
  # @option arguments [Hash] :body request body
51
61
  #
52
- # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-validate-query
62
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-validate-query
53
63
  #
54
64
  def validate_query(arguments = {})
55
65
  request_opts = { endpoint: arguments[:endpoint] || 'indices.validate_query' }
@@ -23,13 +23,30 @@ module Elasticsearch
23
23
  module Inference
24
24
  module Actions
25
25
  # Perform chat completion inference
26
+ # The chat completion inference API enables real-time responses for chat completion tasks by delivering answers incrementally, reducing response times during computation.
27
+ # It only works with the `chat_completion` task type for `openai` and `elastic` inference services.
28
+ # NOTE: The `chat_completion` task type is only available within the _stream API and only supports streaming.
29
+ # The Chat completion inference API and the Stream inference API differ in their response structure and capabilities.
30
+ # The Chat completion inference API provides more comprehensive customization options through more fields and function calling support.
31
+ # If you use the `openai`, `hugging_face` or the `elastic` service, use the Chat completion inference API.
26
32
  #
27
33
  # @option arguments [String] :inference_id The inference Id (*Required*)
28
34
  # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference request to complete. Server default: 30s.
35
+ # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
36
+ # when they occur.
37
+ # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
38
+ # returned by Elasticsearch.
39
+ # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
40
+ # For example `"exists_time": "1h"` for humans and
41
+ # `"exists_time_in_millis": 3600000` for computers. When disabled the human
42
+ # readable values will be omitted. This makes sense for responses being consumed
43
+ # only by machines.
44
+ # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
45
+ # this option for debugging only.
29
46
  # @option arguments [Hash] :headers Custom HTTP headers
30
47
  # @option arguments [Hash] :body chat_completion_request
31
48
  #
32
- # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-unified-inference
49
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-unified-inference
33
50
  #
34
51
  def chat_completion_unified(arguments = {})
35
52
  request_opts = { endpoint: arguments[:endpoint] || 'inference.chat_completion_unified' }
@@ -26,10 +26,21 @@ module Elasticsearch
26
26
  #
27
27
  # @option arguments [String] :inference_id The inference Id (*Required*)
28
28
  # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference request to complete. Server default: 30s.
29
+ # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
30
+ # when they occur.
31
+ # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
32
+ # returned by Elasticsearch.
33
+ # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
34
+ # For example `"exists_time": "1h"` for humans and
35
+ # `"exists_time_in_millis": 3600000` for computers. When disabled the human
36
+ # readable values will be omitted. This makes sense for responses being consumed
37
+ # only by machines.
38
+ # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
39
+ # this option for debugging only.
29
40
  # @option arguments [Hash] :headers Custom HTTP headers
30
41
  # @option arguments [Hash] :body request body
31
42
  #
32
- # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-inference
43
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-inference
33
44
  #
34
45
  def completion(arguments = {})
35
46
  request_opts = { endpoint: arguments[:endpoint] || 'inference.completion' }
@@ -28,9 +28,20 @@ module Elasticsearch
28
28
  # @option arguments [String] :inference_id The inference identifier. (*Required*)
29
29
  # @option arguments [Boolean] :dry_run When true, the endpoint is not deleted and a list of ingest processors which reference this endpoint is returned.
30
30
  # @option arguments [Boolean] :force When true, the inference endpoint is forcefully deleted even if it is still being used by ingest processors or semantic text fields.
31
+ # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
32
+ # when they occur.
33
+ # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
34
+ # returned by Elasticsearch.
35
+ # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
36
+ # For example `"exists_time": "1h"` for humans and
37
+ # `"exists_time_in_millis": 3600000` for computers. When disabled the human
38
+ # readable values will be omitted. This makes sense for responses being consumed
39
+ # only by machines.
40
+ # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
41
+ # this option for debugging only.
31
42
  # @option arguments [Hash] :headers Custom HTTP headers
32
43
  #
33
- # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-delete
44
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-delete
34
45
  #
35
46
  def delete(arguments = {})
36
47
  request_opts = { endpoint: arguments[:endpoint] || 'inference.delete' }
@@ -26,9 +26,20 @@ module Elasticsearch
26
26
  #
27
27
  # @option arguments [String] :task_type The task type
28
28
  # @option arguments [String] :inference_id The inference Id
29
+ # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
30
+ # when they occur.
31
+ # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
32
+ # returned by Elasticsearch.
33
+ # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
34
+ # For example `"exists_time": "1h"` for humans and
35
+ # `"exists_time_in_millis": 3600000` for computers. When disabled the human
36
+ # readable values will be omitted. This makes sense for responses being consumed
37
+ # only by machines.
38
+ # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
39
+ # this option for debugging only.
29
40
  # @option arguments [Hash] :headers Custom HTTP headers
30
41
  #
31
- # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-get
42
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-get
32
43
  #
33
44
  def get(arguments = {})
34
45
  request_opts = { endpoint: arguments[:endpoint] || 'inference.get' }
@@ -55,7 +66,7 @@ module Elasticsearch
55
66
  else
56
67
  '_inference'
57
68
  end
58
- params = {}
69
+ params = Utils.process_params(arguments)
59
70
 
60
71
  Elasticsearch::API::Response.new(
61
72
  perform_request(method, path, params, body, headers, request_opts)
@@ -31,10 +31,21 @@ module Elasticsearch
31
31
  # @option arguments [String] :task_type The type of inference task that the model performs.
32
32
  # @option arguments [String] :inference_id The unique identifier for the inference endpoint. (*Required*)
33
33
  # @option arguments [Time] :timeout The amount of time to wait for the inference request to complete. Server default: 30s.
34
+ # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
35
+ # when they occur.
36
+ # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
37
+ # returned by Elasticsearch.
38
+ # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
39
+ # For example `"exists_time": "1h"` for humans and
40
+ # `"exists_time_in_millis": 3600000` for computers. When disabled the human
41
+ # readable values will be omitted. This makes sense for responses being consumed
42
+ # only by machines.
43
+ # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
44
+ # this option for debugging only.
34
45
  # @option arguments [Hash] :headers Custom HTTP headers
35
46
  # @option arguments [Hash] :body request body
36
47
  #
37
- # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-inference
48
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-inference
38
49
  #
39
50
  def inference(arguments = {})
40
51
  request_opts = { endpoint: arguments[:endpoint] || 'inference.inference' }
@@ -23,21 +23,46 @@ module Elasticsearch
23
23
  module Inference
24
24
  module Actions
25
25
  # Create an inference endpoint.
26
- # When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.
27
- # After creating the endpoint, wait for the model deployment to complete before using it.
28
- # To verify the deployment status, use the get trained model statistics API.
29
- # Look for +"state": "fully_allocated"+ in the response and ensure that the +"allocation_count"+ matches the +"target_allocation_count"+.
30
- # Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.
31
26
  # IMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Mistral, Azure OpenAI, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face.
32
27
  # For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models.
33
28
  # However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs.
29
+ # The following integrations are available through the inference API. You can find the available task types next to the integration name:
30
+ # * AlibabaCloud AI Search (`completion`, `rerank`, `sparse_embedding`, `text_embedding`)
31
+ # * Amazon Bedrock (`completion`, `text_embedding`)
32
+ # * Anthropic (`completion`)
33
+ # * Azure AI Studio (`completion`, `text_embedding`)
34
+ # * Azure OpenAI (`completion`, `text_embedding`)
35
+ # * Cohere (`completion`, `rerank`, `text_embedding`)
36
+ # * DeepSeek (`completion`, `chat_completion`)
37
+ # * Elasticsearch (`rerank`, `sparse_embedding`, `text_embedding` - this service is for built-in models and models uploaded through Eland)
38
+ # * ELSER (`sparse_embedding`)
39
+ # * Google AI Studio (`completion`, `text_embedding`)
40
+ # * Google Vertex AI (`rerank`, `text_embedding`)
41
+ # * Hugging Face (`chat_completion`, `completion`, `rerank`, `text_embedding`)
42
+ # * Mistral (`chat_completion`, `completion`, `text_embedding`)
43
+ # * OpenAI (`chat_completion`, `completion`, `text_embedding`)
44
+ # * VoyageAI (`text_embedding`, `rerank`)
45
+ # * Watsonx inference integration (`text_embedding`)
46
+ # * JinaAI (`text_embedding`, `rerank`)
34
47
  #
35
- # @option arguments [String] :task_type The task type
48
+ # @option arguments [String] :task_type The task type. Refer to the integration list in the API description for the available task types.
36
49
  # @option arguments [String] :inference_id The inference Id (*Required*)
50
+ # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created. Server default: 30s.
51
+ # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
52
+ # when they occur.
53
+ # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
54
+ # returned by Elasticsearch.
55
+ # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
56
+ # For example `"exists_time": "1h"` for humans and
57
+ # `"exists_time_in_millis": 3600000` for computers. When disabled the human
58
+ # readable values will be omitted. This makes sense for responses being consumed
59
+ # only by machines.
60
+ # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
61
+ # this option for debugging only.
37
62
  # @option arguments [Hash] :headers Custom HTTP headers
38
63
  # @option arguments [Hash] :body inference_config
39
64
  #
40
- # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put
65
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put
41
66
  #
42
67
  def put(arguments = {})
43
68
  request_opts = { endpoint: arguments[:endpoint] || 'inference.put' }
@@ -65,7 +90,7 @@ module Elasticsearch
65
90
  else
66
91
  "_inference/#{Utils.listify(_inference_id)}"
67
92
  end
68
- params = {}
93
+ params = Utils.process_params(arguments)
69
94
 
70
95
  Elasticsearch::API::Response.new(
71
96
  perform_request(method, path, params, body, headers, request_opts)
@@ -23,19 +23,26 @@ module Elasticsearch
23
23
  module Inference
24
24
  module Actions
25
25
  # Create an AlibabaCloud AI Search inference endpoint.
26
- # Create an inference endpoint to perform an inference task with the +alibabacloud-ai-search+ service.
27
- # When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.
28
- # After creating the endpoint, wait for the model deployment to complete before using it.
29
- # To verify the deployment status, use the get trained model statistics API.
30
- # Look for +"state": "fully_allocated"+ in the response and ensure that the +"allocation_count"+ matches the +"target_allocation_count"+.
31
- # Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.
26
+ # Create an inference endpoint to perform an inference task with the `alibabacloud-ai-search` service.
32
27
  #
33
28
  # @option arguments [String] :task_type The type of the inference task that the model will perform. (*Required*)
34
29
  # @option arguments [String] :alibabacloud_inference_id The unique identifier of the inference endpoint. (*Required*)
30
+ # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created. Server default: 30s.
31
+ # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
32
+ # when they occur.
33
+ # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
34
+ # returned by Elasticsearch.
35
+ # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
36
+ # For example `"exists_time": "1h"` for humans and
37
+ # `"exists_time_in_millis": 3600000` for computers. When disabled the human
38
+ # readable values will be omitted. This makes sense for responses being consumed
39
+ # only by machines.
40
+ # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
41
+ # this option for debugging only.
35
42
  # @option arguments [Hash] :headers Custom HTTP headers
36
43
  # @option arguments [Hash] :body request body
37
44
  #
38
- # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-alibabacloud
45
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-alibabacloud
39
46
  #
40
47
  def put_alibabacloud(arguments = {})
41
48
  request_opts = { endpoint: arguments[:endpoint] || 'inference.put_alibabacloud' }
@@ -63,7 +70,7 @@ module Elasticsearch
63
70
 
64
71
  method = Elasticsearch::API::HTTP_PUT
65
72
  path = "_inference/#{Utils.listify(_task_type)}/#{Utils.listify(_alibabacloud_inference_id)}"
66
- params = {}
73
+ params = Utils.process_params(arguments)
67
74
 
68
75
  Elasticsearch::API::Response.new(
69
76
  perform_request(method, path, params, body, headers, request_opts)
@@ -23,14 +23,26 @@ module Elasticsearch
23
23
  module Inference
24
24
  module Actions
25
25
  # Create an Amazon Bedrock inference endpoint.
26
- # Creates an inference endpoint to perform an inference task with the +amazonbedrock+ service.
26
+ # Create an inference endpoint to perform an inference task with the `amazonbedrock` service.
27
27
  #
28
28
  # @option arguments [String] :task_type The type of the inference task that the model will perform. (*Required*)
29
29
  # @option arguments [String] :amazonbedrock_inference_id The unique identifier of the inference endpoint. (*Required*)
30
+ # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created. Server default: 30s.
31
+ # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
32
+ # when they occur.
33
+ # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
34
+ # returned by Elasticsearch.
35
+ # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
36
+ # For example `"exists_time": "1h"` for humans and
37
+ # `"exists_time_in_millis": 3600000` for computers. When disabled the human
38
+ # readable values will be omitted. This makes sense for responses being consumed
39
+ # only by machines.
40
+ # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
41
+ # this option for debugging only.
30
42
  # @option arguments [Hash] :headers Custom HTTP headers
31
43
  # @option arguments [Hash] :body request body
32
44
  #
33
- # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-amazonbedrock
45
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-amazonbedrock
34
46
  #
35
47
  def put_amazonbedrock(arguments = {})
36
48
  request_opts = { endpoint: arguments[:endpoint] || 'inference.put_amazonbedrock' }
@@ -58,7 +70,7 @@ module Elasticsearch
58
70
 
59
71
  method = Elasticsearch::API::HTTP_PUT
60
72
  path = "_inference/#{Utils.listify(_task_type)}/#{Utils.listify(_amazonbedrock_inference_id)}"
61
- params = {}
73
+ params = Utils.process_params(arguments)
62
74
 
63
75
  Elasticsearch::API::Response.new(
64
76
  perform_request(method, path, params, body, headers, request_opts)
@@ -23,20 +23,27 @@ module Elasticsearch
23
23
  module Inference
24
24
  module Actions
25
25
  # Create an Anthropic inference endpoint.
26
- # Create an inference endpoint to perform an inference task with the +anthropic+ service.
27
- # When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.
28
- # After creating the endpoint, wait for the model deployment to complete before using it.
29
- # To verify the deployment status, use the get trained model statistics API.
30
- # Look for +"state": "fully_allocated"+ in the response and ensure that the +"allocation_count"+ matches the +"target_allocation_count"+.
31
- # Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.
26
+ # Create an inference endpoint to perform an inference task with the `anthropic` service.
32
27
  #
33
28
  # @option arguments [String] :task_type The task type.
34
- # The only valid task type for the model to perform is +completion+. (*Required*)
29
+ # The only valid task type for the model to perform is `completion`. (*Required*)
35
30
  # @option arguments [String] :anthropic_inference_id The unique identifier of the inference endpoint. (*Required*)
31
+ # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created. Server default: 30s.
32
+ # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
33
+ # when they occur.
34
+ # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
35
+ # returned by Elasticsearch.
36
+ # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
37
+ # For example `"exists_time": "1h"` for humans and
38
+ # `"exists_time_in_millis": 3600000` for computers. When disabled the human
39
+ # readable values will be omitted. This makes sense for responses being consumed
40
+ # only by machines.
41
+ # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
42
+ # this option for debugging only.
36
43
  # @option arguments [Hash] :headers Custom HTTP headers
37
44
  # @option arguments [Hash] :body request body
38
45
  #
39
- # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-anthropic
46
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-anthropic
40
47
  #
41
48
  def put_anthropic(arguments = {})
42
49
  request_opts = { endpoint: arguments[:endpoint] || 'inference.put_anthropic' }
@@ -64,7 +71,7 @@ module Elasticsearch
64
71
 
65
72
  method = Elasticsearch::API::HTTP_PUT
66
73
  path = "_inference/#{Utils.listify(_task_type)}/#{Utils.listify(_anthropic_inference_id)}"
67
- params = {}
74
+ params = Utils.process_params(arguments)
68
75
 
69
76
  Elasticsearch::API::Response.new(
70
77
  perform_request(method, path, params, body, headers, request_opts)
@@ -23,19 +23,26 @@ module Elasticsearch
23
23
  module Inference
24
24
  module Actions
25
25
  # Create an Azure AI studio inference endpoint.
26
- # Create an inference endpoint to perform an inference task with the +azureaistudio+ service.
27
- # When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.
28
- # After creating the endpoint, wait for the model deployment to complete before using it.
29
- # To verify the deployment status, use the get trained model statistics API.
30
- # Look for +"state": "fully_allocated"+ in the response and ensure that the +"allocation_count"+ matches the +"target_allocation_count"+.
31
- # Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.
26
+ # Create an inference endpoint to perform an inference task with the `azureaistudio` service.
32
27
  #
33
28
  # @option arguments [String] :task_type The type of the inference task that the model will perform. (*Required*)
34
29
  # @option arguments [String] :azureaistudio_inference_id The unique identifier of the inference endpoint. (*Required*)
30
+ # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created. Server default: 30s.
31
+ # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
32
+ # when they occur.
33
+ # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
34
+ # returned by Elasticsearch.
35
+ # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
36
+ # For example `"exists_time": "1h"` for humans and
37
+ # `"exists_time_in_millis": 3600000` for computers. When disabled the human
38
+ # readable values will be omitted. This makes sense for responses being consumed
39
+ # only by machines.
40
+ # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
41
+ # this option for debugging only.
35
42
  # @option arguments [Hash] :headers Custom HTTP headers
36
43
  # @option arguments [Hash] :body request body
37
44
  #
38
- # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-azureaistudio
45
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-azureaistudio
39
46
  #
40
47
  def put_azureaistudio(arguments = {})
41
48
  request_opts = { endpoint: arguments[:endpoint] || 'inference.put_azureaistudio' }
@@ -63,7 +70,7 @@ module Elasticsearch
63
70
 
64
71
  method = Elasticsearch::API::HTTP_PUT
65
72
  path = "_inference/#{Utils.listify(_task_type)}/#{Utils.listify(_azureaistudio_inference_id)}"
66
- params = {}
73
+ params = Utils.process_params(arguments)
67
74
 
68
75
  Elasticsearch::API::Response.new(
69
76
  perform_request(method, path, params, body, headers, request_opts)