elastic-enterprise-search 8.1.1 → 8.3.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (134) hide show
  1. checksums.yaml +4 -4
  2. data/.ci/jobs/{elastic+enterprise-search-ruby+7.15.yml → elastic+enterprise-search-ruby+7.17.yml} +4 -4
  3. data/.ci/jobs/{elastic+enterprise-search-ruby+7.16.yml → elastic+enterprise-search-ruby+8.0.yml} +4 -4
  4. data/.ci/jobs/elastic+enterprise-search-ruby+8.1.yml +12 -0
  5. data/.ci/jobs/elastic+enterprise-search-ruby+8.2.yml +12 -0
  6. data/.ci/run-enterprise-search.sh +1 -0
  7. data/.ci/test-matrix.yml +1 -1
  8. data/docs/guide/app-search-api.asciidoc +21 -0
  9. data/docs/guide/connecting.asciidoc +14 -0
  10. data/docs/guide/enterprise-search-api.asciidoc +17 -2
  11. data/docs/guide/index.asciidoc +1 -1
  12. data/docs/guide/overview.asciidoc +4 -2
  13. data/docs/guide/release_notes/82.asciidoc +42 -0
  14. data/docs/guide/release_notes/index.asciidoc +3 -0
  15. data/elastic-enterprise-search.gemspec +1 -1
  16. data/lib/elastic/app-search/api/adaptive_relevance_settings.rb +1 -0
  17. data/lib/elastic/app-search/api/adaptive_relevance_suggestions.rb +2 -1
  18. data/lib/elastic/app-search/api/add_meta_engine_source.rb +1 -0
  19. data/lib/elastic/app-search/api/api_key.rb +1 -0
  20. data/lib/elastic/app-search/api/api_logs.rb +1 -0
  21. data/lib/elastic/app-search/api/count_analytics.rb +1 -0
  22. data/lib/elastic/app-search/api/crawler_active_crawl_request.rb +1 -0
  23. data/lib/elastic/app-search/api/crawler_crawl_request.rb +1 -0
  24. data/lib/elastic/app-search/api/crawler_crawl_schedule.rb +1 -0
  25. data/lib/elastic/app-search/api/crawler_domain.rb +1 -0
  26. data/lib/elastic/app-search/api/crawler_domain_validation_result.rb +1 -0
  27. data/lib/elastic/app-search/api/crawler_metrics.rb +1 -0
  28. data/lib/elastic/app-search/api/crawler_overview.rb +1 -0
  29. data/lib/elastic/app-search/api/crawler_process_crawl.rb +1 -0
  30. data/lib/elastic/app-search/api/crawler_process_crawl_denied_urls.rb +1 -0
  31. data/lib/elastic/app-search/api/crawler_url_extraction_result.rb +1 -0
  32. data/lib/elastic/app-search/api/crawler_url_tracing_result.rb +1 -0
  33. data/lib/elastic/app-search/api/crawler_url_validation_result.rb +1 -0
  34. data/lib/elastic/app-search/api/crawler_user_agent.rb +1 -0
  35. data/lib/elastic/app-search/api/create_api_key.rb +1 -0
  36. data/lib/elastic/app-search/api/create_crawler_crawl_request.rb +1 -0
  37. data/lib/elastic/app-search/api/create_crawler_crawl_rule.rb +1 -0
  38. data/lib/elastic/app-search/api/create_crawler_domain.rb +1 -0
  39. data/lib/elastic/app-search/api/create_crawler_entry_point.rb +1 -0
  40. data/lib/elastic/app-search/api/create_crawler_process_crawl.rb +1 -0
  41. data/lib/elastic/app-search/api/create_crawler_sitemap.rb +1 -0
  42. data/lib/elastic/app-search/api/create_curation.rb +2 -1
  43. data/lib/elastic/app-search/api/create_engine.rb +1 -0
  44. data/lib/elastic/app-search/api/create_synonym_set.rb +1 -0
  45. data/lib/elastic/app-search/api/curation.rb +1 -0
  46. data/lib/elastic/app-search/api/delete_api_key.rb +1 -0
  47. data/lib/elastic/app-search/api/delete_crawler_active_crawl_request.rb +1 -0
  48. data/lib/elastic/app-search/api/delete_crawler_crawl_rule.rb +1 -0
  49. data/lib/elastic/app-search/api/delete_crawler_crawl_schedule.rb +1 -0
  50. data/lib/elastic/app-search/api/delete_crawler_domain.rb +1 -0
  51. data/lib/elastic/app-search/api/delete_crawler_entry_point.rb +1 -0
  52. data/lib/elastic/app-search/api/delete_crawler_sitemap.rb +1 -0
  53. data/lib/elastic/app-search/api/delete_curation.rb +1 -0
  54. data/lib/elastic/app-search/api/delete_documents.rb +1 -0
  55. data/lib/elastic/app-search/api/delete_engine.rb +1 -0
  56. data/lib/elastic/app-search/api/delete_meta_engine_source.rb +1 -0
  57. data/lib/elastic/app-search/api/delete_synonym_set.rb +1 -0
  58. data/lib/elastic/app-search/api/documents.rb +1 -0
  59. data/lib/elastic/app-search/api/engine.rb +1 -0
  60. data/lib/elastic/app-search/api/index_documents.rb +1 -0
  61. data/lib/elastic/app-search/api/list_adaptive_relevance_suggestions.rb +2 -1
  62. data/lib/elastic/app-search/api/list_api_keys.rb +1 -0
  63. data/lib/elastic/app-search/api/list_crawler_crawl_requests.rb +1 -0
  64. data/lib/elastic/app-search/api/list_crawler_domains.rb +1 -0
  65. data/lib/elastic/app-search/api/list_crawler_process_crawls.rb +1 -0
  66. data/lib/elastic/app-search/api/list_curations.rb +1 -0
  67. data/lib/elastic/app-search/api/list_documents.rb +1 -0
  68. data/lib/elastic/app-search/api/list_engines.rb +1 -0
  69. data/lib/elastic/app-search/api/list_synonym_sets.rb +1 -0
  70. data/lib/elastic/app-search/api/log_clickthrough.rb +1 -0
  71. data/lib/elastic/app-search/api/multi_search.rb +8 -6
  72. data/lib/elastic/app-search/api/put_adaptive_relevance_settings.rb +2 -1
  73. data/lib/elastic/app-search/api/put_adaptive_relevance_suggestions.rb +1 -0
  74. data/lib/elastic/app-search/api/put_api_key.rb +1 -0
  75. data/lib/elastic/app-search/api/put_crawler_crawl_rule.rb +1 -0
  76. data/lib/elastic/app-search/api/put_crawler_crawl_schedule.rb +1 -0
  77. data/lib/elastic/app-search/api/put_crawler_domain.rb +1 -0
  78. data/lib/elastic/app-search/api/put_crawler_entry_point.rb +1 -0
  79. data/lib/elastic/app-search/api/put_crawler_sitemap.rb +1 -0
  80. data/lib/elastic/app-search/api/put_curation.rb +2 -1
  81. data/lib/elastic/app-search/api/put_documents.rb +1 -0
  82. data/lib/elastic/app-search/api/put_schema.rb +1 -0
  83. data/lib/elastic/app-search/api/put_search_settings.rb +1 -0
  84. data/lib/elastic/app-search/api/put_synonym_set.rb +1 -0
  85. data/lib/elastic/app-search/api/query_suggestion.rb +1 -0
  86. data/lib/elastic/app-search/api/refresh_adaptive_relevance_update_process.rb +1 -0
  87. data/lib/elastic/app-search/api/reset_search_settings.rb +1 -0
  88. data/lib/elastic/app-search/api/schema.rb +1 -0
  89. data/lib/elastic/app-search/api/search.rb +1 -0
  90. data/lib/elastic/app-search/api/search_es_search.rb +54 -0
  91. data/lib/elastic/app-search/api/search_explain.rb +62 -0
  92. data/lib/elastic/app-search/api/search_settings.rb +1 -0
  93. data/lib/elastic/app-search/api/synonym_set.rb +1 -0
  94. data/lib/elastic/app-search/api/top_clicks_analytics.rb +1 -0
  95. data/lib/elastic/app-search/api/top_queries_analytics.rb +1 -0
  96. data/lib/elastic/enterprise-search/api/health.rb +1 -0
  97. data/lib/elastic/enterprise-search/api/put_read_only.rb +1 -0
  98. data/lib/elastic/enterprise-search/api/read_only.rb +1 -0
  99. data/lib/elastic/enterprise-search/api/search_engines.rb +44 -0
  100. data/lib/elastic/enterprise-search/api/stats.rb +1 -0
  101. data/lib/elastic/enterprise-search/api/version.rb +2 -1
  102. data/lib/elastic/enterprise-search/version.rb +1 -1
  103. data/lib/elastic/workplace-search/api/auto_query_refinement_details.rb +1 -0
  104. data/lib/elastic/workplace-search/api/command_sync_jobs.rb +1 -0
  105. data/lib/elastic/workplace-search/api/content_source.rb +1 -0
  106. data/lib/elastic/workplace-search/api/create_analytics_event.rb +1 -0
  107. data/lib/elastic/workplace-search/api/create_batch_synonym_sets.rb +1 -0
  108. data/lib/elastic/workplace-search/api/create_content_source.rb +1 -0
  109. data/lib/elastic/workplace-search/api/create_external_identity.rb +1 -0
  110. data/lib/elastic/workplace-search/api/current_user.rb +1 -0
  111. data/lib/elastic/workplace-search/api/delete_content_source.rb +1 -0
  112. data/lib/elastic/workplace-search/api/delete_documents.rb +1 -0
  113. data/lib/elastic/workplace-search/api/delete_documents_by_query.rb +1 -0
  114. data/lib/elastic/workplace-search/api/delete_external_identity.rb +1 -0
  115. data/lib/elastic/workplace-search/api/delete_synonym_set.rb +1 -0
  116. data/lib/elastic/workplace-search/api/document.rb +1 -0
  117. data/lib/elastic/workplace-search/api/external_identity.rb +1 -0
  118. data/lib/elastic/workplace-search/api/index_documents.rb +1 -0
  119. data/lib/elastic/workplace-search/api/list_content_sources.rb +1 -0
  120. data/lib/elastic/workplace-search/api/list_documents.rb +1 -0
  121. data/lib/elastic/workplace-search/api/list_external_identities.rb +1 -0
  122. data/lib/elastic/workplace-search/api/list_synonym_sets.rb +1 -0
  123. data/lib/elastic/workplace-search/api/put_content_source.rb +1 -0
  124. data/lib/elastic/workplace-search/api/put_content_source_icons.rb +1 -0
  125. data/lib/elastic/workplace-search/api/put_external_identity.rb +1 -0
  126. data/lib/elastic/workplace-search/api/put_synonym_set.rb +1 -0
  127. data/lib/elastic/workplace-search/api/put_triggers_blocklist.rb +1 -0
  128. data/lib/elastic/workplace-search/api/search.rb +1 -0
  129. data/lib/elastic/workplace-search/api/synonym_set.rb +1 -0
  130. data/lib/elastic/workplace-search/api/triggers_blocklist.rb +1 -0
  131. data/spec/integration/app-search/elasticsearch_search_spec.rb +63 -0
  132. data/spec/integration/app-search/explain_search_spec.rb +59 -0
  133. data/spec/integration/enterprise_search_api_spec.rb +11 -0
  134. metadata +16 -8
@@ -20,6 +20,7 @@
20
20
  module Elastic
21
21
  module EnterpriseSearch
22
22
  module AppSearch
23
+ # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
23
24
  module Actions
24
25
  # Crawler - Delete an entry point
25
26
  # Deletes a crawler entry point
@@ -20,6 +20,7 @@
20
20
  module Elastic
21
21
  module EnterpriseSearch
22
22
  module AppSearch
23
+ # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
23
24
  module Actions
24
25
  # Crawler - Delete a sitemap
25
26
  # Deletes a sitemap from a given domain
@@ -20,6 +20,7 @@
20
20
  module Elastic
21
21
  module EnterpriseSearch
22
22
  module AppSearch
23
+ # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
23
24
  module Actions
24
25
  # Curations - Delete a curation
25
26
  # Deletes a curation set by ID
@@ -20,6 +20,7 @@
20
20
  module Elastic
21
21
  module EnterpriseSearch
22
22
  module AppSearch
23
+ # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
23
24
  module Actions
24
25
  # Documents - Delete documents by ID
25
26
  # Deletes documents for given Document IDs
@@ -20,6 +20,7 @@
20
20
  module Elastic
21
21
  module EnterpriseSearch
22
22
  module AppSearch
23
+ # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
23
24
  module Actions
24
25
  # Engines - Delete an Engine
25
26
  # Delete an engine by name
@@ -20,6 +20,7 @@
20
20
  module Elastic
21
21
  module EnterpriseSearch
22
22
  module AppSearch
23
+ # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
23
24
  module Actions
24
25
  # Engines - Delete a source engine
25
26
  # Deletes a source engine from a given meta engine
@@ -20,6 +20,7 @@
20
20
  module Elastic
21
21
  module EnterpriseSearch
22
22
  module AppSearch
23
+ # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
23
24
  module Actions
24
25
  # Synonyms - Delete a synonym set
25
26
  # Deletes a synonym set by ID
@@ -20,6 +20,7 @@
20
20
  module Elastic
21
21
  module EnterpriseSearch
22
22
  module AppSearch
23
+ # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
23
24
  module Actions
24
25
  # Documents - Retrieve one or more documents
25
26
  # Retrieves one or more documents by id
@@ -20,6 +20,7 @@
20
20
  module Elastic
21
21
  module EnterpriseSearch
22
22
  module AppSearch
23
+ # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
23
24
  module Actions
24
25
  # Engines - Retrieve an engine
25
26
  # Retrieves details of a given engine by its name
@@ -20,6 +20,7 @@
20
20
  module Elastic
21
21
  module EnterpriseSearch
22
22
  module AppSearch
23
+ # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
23
24
  module Actions
24
25
  # Documents - Create a new document
25
26
  # Create or update documents
@@ -20,6 +20,7 @@
20
20
  module Elastic
21
21
  module EnterpriseSearch
22
22
  module AppSearch
23
+ # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
23
24
  module Actions
24
25
  # AdaptiveRelevanceSuggestions - Retrieve adaptive relevance
25
26
  # Retrieve adaptive relevance
@@ -28,7 +29,7 @@ module Elastic
28
29
  # @param [Hash] arguments endpoint arguments
29
30
  # @option arguments [Hash] :body
30
31
  # @option body :page
31
- # @option body [string] :filters
32
+ # @option body [Hash] :filters
32
33
  # @option arguments [Hash] :headers optional HTTP headers to send with the request
33
34
  #
34
35
  # @see https://www.elastic.co/guide/en/app-search/current/adaptive-relevance-api-reference.html#adaptive-relevance-api-get-engine-adaptive-relevance-suggestions
@@ -20,6 +20,7 @@
20
20
  module Elastic
21
21
  module EnterpriseSearch
22
22
  module AppSearch
23
+ # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
23
24
  module Actions
24
25
  # Credentials - Retrieve all API keys
25
26
  # List the details of all API keys
@@ -20,6 +20,7 @@
20
20
  module Elastic
21
21
  module EnterpriseSearch
22
22
  module AppSearch
23
+ # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
23
24
  module Actions
24
25
  # Crawler - List crawl requests
25
26
  # Returns a list of latest crawl requests for a given engine.
@@ -20,6 +20,7 @@
20
20
  module Elastic
21
21
  module EnterpriseSearch
22
22
  module AppSearch
23
+ # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
23
24
  module Actions
24
25
  # Crawler - List crawler domains
25
26
  # Returns a list of crawler domains
@@ -20,6 +20,7 @@
20
20
  module Elastic
21
21
  module EnterpriseSearch
22
22
  module AppSearch
23
+ # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
23
24
  module Actions
24
25
  # Crawler - List process crawls
25
26
  # Returns a list of latest process crawls for a given engine
@@ -20,6 +20,7 @@
20
20
  module Elastic
21
21
  module EnterpriseSearch
22
22
  module AppSearch
23
+ # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
23
24
  module Actions
24
25
  # Curations - Retrieve all curations
25
26
  # Retrieve available curations for the given engine
@@ -20,6 +20,7 @@
20
20
  module Elastic
21
21
  module EnterpriseSearch
22
22
  module AppSearch
23
+ # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
23
24
  module Actions
24
25
  # Documents - Retrieve all documents
25
26
  # Lists up to 10,000 documents
@@ -20,6 +20,7 @@
20
20
  module Elastic
21
21
  module EnterpriseSearch
22
22
  module AppSearch
23
+ # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
23
24
  module Actions
24
25
  # Engines - Retrieve all engines
25
26
  # Retrieves all engines with optional pagination support
@@ -20,6 +20,7 @@
20
20
  module Elastic
21
21
  module EnterpriseSearch
22
22
  module AppSearch
23
+ # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
23
24
  module Actions
24
25
  # Synonyms - Retrieve all synonym sets
25
26
  # Retrieves all available synonym sets for the engine
@@ -20,6 +20,7 @@
20
20
  module Elastic
21
21
  module EnterpriseSearch
22
22
  module AppSearch
23
+ # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
23
24
  module Actions
24
25
  # Click - Tracks results that were clicked after a query
25
26
  # Tracks results that were clicked after a query
@@ -20,23 +20,25 @@
20
20
  module Elastic
21
21
  module EnterpriseSearch
22
22
  module AppSearch
23
+ # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
23
24
  module Actions
24
- # Search - Run several search in the same request
25
+ # MultiSearch - Submit a multi search
26
+ # Submit a multi search query and receive a set of results with meta data
25
27
  #
26
- # @param engine_name [String] (*Required*)
27
- # @param arguments [Hash] endpoint arguments
28
- # @option arguments [Object] :body One or more queries to execute in parallel (*Required*)
28
+ # @param [String] engine_name Name of the engine (*Required*)
29
+ # @param [Hash] arguments endpoint arguments
30
+ # @option arguments [Hash] :body (Required: queries)
31
+ # @option body :queries
29
32
  # @option arguments [Hash] :headers optional HTTP headers to send with the request
30
33
  #
31
34
  # @see https://www.elastic.co/guide/en/app-search/current/multi-search.html
32
35
  #
33
36
  def multi_search(engine_name, arguments = {})
34
37
  raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
35
- raise ArgumentError, "Required parameter 'body' missing" unless arguments[:body]
38
+ raise ArgumentError, "Required parameter 'body (queries)' missing" unless arguments[:body]
36
39
 
37
40
  body = arguments.delete(:body) || {}
38
41
  headers = arguments.delete(:headers) || {}
39
-
40
42
  request(
41
43
  :post,
42
44
  "api/as/v1/engines/#{engine_name}/multi_search/",
@@ -20,6 +20,7 @@
20
20
  module Elastic
21
21
  module EnterpriseSearch
22
22
  module AppSearch
23
+ # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
23
24
  module Actions
24
25
  # AdaptiveRelevanceSettings - Update adaptive relevance settings
25
26
  # Update adaptive relevance settings
@@ -27,7 +28,7 @@ module Elastic
27
28
  # @param [String] engine_name Name of the engine (*Required*)
28
29
  # @param [Hash] arguments endpoint arguments
29
30
  # @option arguments [Hash] :body (Required: curation)
30
- # @option body [Hash] :curation (Required: )
31
+ # @option body [Hash] :curation
31
32
  # @option arguments [Hash] :headers optional HTTP headers to send with the request
32
33
  #
33
34
  # @see https://www.elastic.co/guide/en/app-search/current/adaptive-relevance-api-reference.html#adaptive-relevance-api-put-engine-adaptive-relevance-settings
@@ -20,6 +20,7 @@
20
20
  module Elastic
21
21
  module EnterpriseSearch
22
22
  module AppSearch
23
+ # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
23
24
  module Actions
24
25
  # AdaptiveRelevanceSuggestions - Update adaptive relevance
25
26
  # Update adaptive relevance
@@ -20,6 +20,7 @@
20
20
  module Elastic
21
21
  module EnterpriseSearch
22
22
  module AppSearch
23
+ # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
23
24
  module Actions
24
25
  # Credentials - Update an API key
25
26
  # Updates an API key
@@ -20,6 +20,7 @@
20
20
  module Elastic
21
21
  module EnterpriseSearch
22
22
  module AppSearch
23
+ # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
23
24
  module Actions
24
25
  # Crawler - Update a crawl rule
25
26
  # Updates crawl rule configuration
@@ -20,6 +20,7 @@
20
20
  module Elastic
21
21
  module EnterpriseSearch
22
22
  module AppSearch
23
+ # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
23
24
  module Actions
24
25
  # Crawler - Set crawl schedule
25
26
  # Sets up a crawl schedule for a given engine
@@ -20,6 +20,7 @@
20
20
  module Elastic
21
21
  module EnterpriseSearch
22
22
  module AppSearch
23
+ # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
23
24
  module Actions
24
25
  # Crawler - Update domain configuration
25
26
  # Updates crawler domain configuration for a given domain
@@ -20,6 +20,7 @@
20
20
  module Elastic
21
21
  module EnterpriseSearch
22
22
  module AppSearch
23
+ # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
23
24
  module Actions
24
25
  # Crawler - Update a crawler entry point
25
26
  # Updates a crawler entry point with a new value
@@ -20,6 +20,7 @@
20
20
  module Elastic
21
21
  module EnterpriseSearch
22
22
  module AppSearch
23
+ # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
23
24
  module Actions
24
25
  # Crawler - Update a sitemap
25
26
  # Updates sitemap configuration
@@ -20,6 +20,7 @@
20
20
  module Elastic
21
21
  module EnterpriseSearch
22
22
  module AppSearch
23
+ # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
23
24
  module Actions
24
25
  # Curations - Update a curation
25
26
  # Updates an existing curation
@@ -32,7 +33,7 @@ module Elastic
32
33
  # @option body [Array<string>] :queries List of affected search queries
33
34
  # @option body [Array<string>] :promoted List of promoted document IDs
34
35
  # @option body [Array<string>] :hidden List of hidden document IDs
35
- # @option body [Hash] :suggestion
36
+ # @option body :suggestion
36
37
  # @option arguments [Hash] :headers optional HTTP headers to send with the request
37
38
  #
38
39
  # @see https://www.elastic.co/guide/en/app-search/current/curations.html#curations-update
@@ -20,6 +20,7 @@
20
20
  module Elastic
21
21
  module EnterpriseSearch
22
22
  module AppSearch
23
+ # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
23
24
  module Actions
24
25
  # Documents - Partial update of documents
25
26
  # Update specific document fields by id and field
@@ -20,6 +20,7 @@
20
20
  module Elastic
21
21
  module EnterpriseSearch
22
22
  module AppSearch
23
+ # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
23
24
  module Actions
24
25
  # Schema - Update engine schema
25
26
  # Update schema for the current engine
@@ -20,6 +20,7 @@
20
20
  module Elastic
21
21
  module EnterpriseSearch
22
22
  module AppSearch
23
+ # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
23
24
  module Actions
24
25
  # Synonyms - Update search settings
25
26
  # Updates search settings for the engine
@@ -20,6 +20,7 @@
20
20
  module Elastic
21
21
  module EnterpriseSearch
22
22
  module AppSearch
23
+ # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
23
24
  module Actions
24
25
  # Synonyms - Update a synonym set
25
26
  # Updates a synonym set by ID
@@ -20,6 +20,7 @@
20
20
  module Elastic
21
21
  module EnterpriseSearch
22
22
  module AppSearch
23
+ # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
23
24
  module Actions
24
25
  # QuerySuggestion - Retrieve query suggestions
25
26
  # Provide relevant query suggestions for incomplete queries
@@ -20,6 +20,7 @@
20
20
  module Elastic
21
21
  module EnterpriseSearch
22
22
  module AppSearch
23
+ # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
23
24
  module Actions
24
25
  # AdaptiveRelevanceSettings - Retrieve adaptive relevance settings
25
26
  # Update suggestions process refresh
@@ -20,6 +20,7 @@
20
20
  module Elastic
21
21
  module EnterpriseSearch
22
22
  module AppSearch
23
+ # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
23
24
  module Actions
24
25
  # Synonyms - Reset search settings
25
26
  # Resets search settings for the engine
@@ -20,6 +20,7 @@
20
20
  module Elastic
21
21
  module EnterpriseSearch
22
22
  module AppSearch
23
+ # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
23
24
  module Actions
24
25
  # Schema - Retrieve engine schema
25
26
  # Retrieve current schema for the engine
@@ -20,6 +20,7 @@
20
20
  module Elastic
21
21
  module EnterpriseSearch
22
22
  module AppSearch
23
+ # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
23
24
  module Actions
24
25
  # Search - Submit a search
25
26
  # Submit a search and receive a set of results with meta data
@@ -0,0 +1,54 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Licensed to Elasticsearch B.V. under one or more contributor
4
+ # license agreements. See the NOTICE file distributed with
5
+ # this work for additional information regarding copyright
6
+ # ownership. Elasticsearch B.V. licenses this file to you under
7
+ # the Apache License, Version 2.0 (the "License"); you may
8
+ # not use this file except in compliance with the License.
9
+ # You may obtain a copy of the License at
10
+ #
11
+ # http://www.apache.org/licenses/LICENSE-2.0
12
+ #
13
+ # Unless required by applicable law or agreed to in writing,
14
+ # software distributed under the License is distributed on an
15
+ # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16
+ # KIND, either express or implied. See the License for the
17
+ # specific language governing permissions and limitations
18
+ # under the License.
19
+
20
+ module Elastic
21
+ module EnterpriseSearch
22
+ module AppSearch
23
+ # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
24
+ module Actions
25
+ # ElasticsearchSearch - Run a search
26
+ # Execute the provided Elasticsearch search query against an App Search Engine
27
+ #
28
+ # @param [String] engine_name Name of the engine (*Required*)
29
+ # @param [Hash] arguments endpoint arguments
30
+ # @option arguments [Hash] :body (Required: request)
31
+ # @option body :request
32
+ # @option body :analytics
33
+ # @option arguments [Hash] :headers optional HTTP headers to send with the request
34
+ #
35
+ # @see https://www.elastic.co/guide/en/app-search/current/elasticsearch-search-api-reference.html
36
+ #
37
+ def search_es_search(engine_name, arguments = {})
38
+ raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
39
+ raise ArgumentError, "Required parameter 'body (request)' missing" unless arguments[:body]
40
+
41
+ body = arguments.delete(:body) || {}
42
+ headers = arguments.delete(:headers) || {}
43
+ request(
44
+ :post,
45
+ "api/as/v0/engines/#{engine_name}/elasticsearch/_search/",
46
+ arguments,
47
+ body,
48
+ headers
49
+ )
50
+ end
51
+ end
52
+ end
53
+ end
54
+ end
@@ -0,0 +1,62 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Licensed to Elasticsearch B.V. under one or more contributor
4
+ # license agreements. See the NOTICE file distributed with
5
+ # this work for additional information regarding copyright
6
+ # ownership. Elasticsearch B.V. licenses this file to you under
7
+ # the Apache License, Version 2.0 (the "License"); you may
8
+ # not use this file except in compliance with the License.
9
+ # You may obtain a copy of the License at
10
+ #
11
+ # http://www.apache.org/licenses/LICENSE-2.0
12
+ #
13
+ # Unless required by applicable law or agreed to in writing,
14
+ # software distributed under the License is distributed on an
15
+ # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16
+ # KIND, either express or implied. See the License for the
17
+ # specific language governing permissions and limitations
18
+ # under the License.
19
+
20
+ module Elastic
21
+ module EnterpriseSearch
22
+ module AppSearch
23
+ # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
24
+ module Actions
25
+ # SearchExplain - Retrieve the search query
26
+ # Submit a search and retrieve an Elasticsearch query
27
+ #
28
+ # @param [String] engine_name Name of the engine (*Required*)
29
+ # @param [Hash] arguments endpoint arguments
30
+ # @option arguments [Hash] :body (Required: query)
31
+ # @option body [string] :query
32
+ # @option body :analytics
33
+ # @option body :boost
34
+ # @option body :facets
35
+ # @option body :filters
36
+ # @option body :group
37
+ # @option body :page
38
+ # @option body :result_fields
39
+ # @option body :search_fields
40
+ # @option body :sort
41
+ # @option arguments [Hash] :headers optional HTTP headers to send with the request
42
+ #
43
+ # @see https://www.elastic.co/guide/en/app-search/current/search-explain.html
44
+ #
45
+ def search_explain(engine_name, arguments = {})
46
+ raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
47
+ raise ArgumentError, "Required parameter 'body (query)' missing" unless arguments[:body]
48
+
49
+ body = arguments.delete(:body) || {}
50
+ headers = arguments.delete(:headers) || {}
51
+ request(
52
+ :post,
53
+ "api/as/v0/engines/#{engine_name}/search_explain/",
54
+ arguments,
55
+ body,
56
+ headers
57
+ )
58
+ end
59
+ end
60
+ end
61
+ end
62
+ end
@@ -20,6 +20,7 @@
20
20
  module Elastic
21
21
  module EnterpriseSearch
22
22
  module AppSearch
23
+ # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
23
24
  module Actions
24
25
  # SearchSettings - Retrieve search settings
25
26
  # Retrieve current search settings for the engine
@@ -20,6 +20,7 @@
20
20
  module Elastic
21
21
  module EnterpriseSearch
22
22
  module AppSearch
23
+ # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
23
24
  module Actions
24
25
  # Synonyms - Retrieve a synonym set
25
26
  # Retrieves a synonym set by ID
@@ -20,6 +20,7 @@
20
20
  module Elastic
21
21
  module EnterpriseSearch
22
22
  module AppSearch
23
+ # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
23
24
  module Actions
24
25
  # Analytics - Query for analytics click data
25
26
  # Returns the number of clicks received by a document in descending order
@@ -20,6 +20,7 @@
20
20
  module Elastic
21
21
  module EnterpriseSearch
22
22
  module AppSearch
23
+ # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
23
24
  module Actions
24
25
  # Analytics - Query for analytics query data
25
26
  # Returns queries analytics by usage count
@@ -19,6 +19,7 @@
19
19
 
20
20
  module Elastic
21
21
  module EnterpriseSearch
22
+ # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
22
23
  module Actions
23
24
  # Health - Get information on the health of a deployment and basic statistics around resource usage
24
25
  # Get information on the health of a deployment and basic statistics around resource usage
@@ -19,6 +19,7 @@
19
19
 
20
20
  module Elastic
21
21
  module EnterpriseSearch
22
+ # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
22
23
  module Actions
23
24
  # Read-Only - Update the read-only flag's state
24
25
  # Update the read-only flag's state
@@ -19,6 +19,7 @@
19
19
 
20
20
  module Elastic
21
21
  module EnterpriseSearch
22
+ # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
22
23
  module Actions
23
24
  # Read-Only - Get the read-only flag's state
24
25
  # Get the read-only flag's state
@@ -0,0 +1,44 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Licensed to Elasticsearch B.V. under one or more contributor
4
+ # license agreements. See the NOTICE file distributed with
5
+ # this work for additional information regarding copyright
6
+ # ownership. Elasticsearch B.V. licenses this file to you under
7
+ # the Apache License, Version 2.0 (the "License"); you may
8
+ # not use this file except in compliance with the License.
9
+ # You may obtain a copy of the License at
10
+ #
11
+ # http://www.apache.org/licenses/LICENSE-2.0
12
+ #
13
+ # Unless required by applicable law or agreed to in writing,
14
+ # software distributed under the License is distributed on an
15
+ # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16
+ # KIND, either express or implied. See the License for the
17
+ # specific language governing permissions and limitations
18
+ # under the License.
19
+
20
+ module Elastic
21
+ module EnterpriseSearch
22
+ # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
23
+ module Actions
24
+ # SearchEngines - Retrieve information about search engines
25
+ # Retrieve information about search engines
26
+ #
27
+ # @param [Hash] arguments endpoint arguments
28
+ # @option arguments [Hash] :headers optional HTTP headers to send with the request
29
+ #
30
+ # @see https://www.elastic.co/guide/en/enterprise-search/current/search-engines-apis.html
31
+ #
32
+ def search_engines(arguments = {})
33
+ headers = arguments.delete(:headers) || {}
34
+ request(
35
+ :get,
36
+ 'api/search_engines/',
37
+ arguments,
38
+ nil,
39
+ headers
40
+ )
41
+ end
42
+ end
43
+ end
44
+ end
@@ -19,6 +19,7 @@
19
19
 
20
20
  module Elastic
21
21
  module EnterpriseSearch
22
+ # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
22
23
  module Actions
23
24
  # Stats - Get information about the resource usage of the application, the state of different internal queues, etc.
24
25
  # Get information about the resource usage of the application, the state of different internal queues, etc.