elastic-enterprise-search 7.14.0 → 7.16.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (207) hide show
  1. checksums.yaml +4 -4
  2. data/.ci/functions/imports.sh +1 -0
  3. data/.ci/jobs/defaults.yml +4 -0
  4. data/.ci/jobs/{elastic+enterprise-search-ruby+master.yml → elastic+enterprise-search-ruby+main.yml} +4 -4
  5. data/.ci/run-repository.sh +2 -1
  6. data/.ci/test-matrix.yml +5 -3
  7. data/{spec/app-search/api_spec_helper.rb → .github/compatibility/Gemfile} +4 -11
  8. data/.github/workflows/compatibility.yml +20 -0
  9. data/.github/workflows/testing.yml +1 -1
  10. data/CONTRIBUTING.md +1 -1
  11. data/README.md +1 -1
  12. data/Rakefile +19 -0
  13. data/docs/guide/app-search-api.asciidoc +155 -1
  14. data/docs/guide/overview.asciidoc +3 -3
  15. data/docs/guide/release_notes/714.asciidoc +12 -0
  16. data/docs/guide/release_notes/715.asciidoc +48 -0
  17. data/docs/guide/release_notes/716.asciidoc +16 -0
  18. data/docs/guide/release_notes/index.asciidoc +4 -0
  19. data/docs/guide/workplace-search-api.asciidoc +17 -0
  20. data/elastic-enterprise-search.gemspec +1 -1
  21. data/lib/elastic/app-search/api/adaptive_relevance_settings.rb +51 -0
  22. data/lib/elastic/app-search/api/adaptive_relevance_suggestions.rb +56 -0
  23. data/lib/elastic/app-search/api/add_meta_engine_source.rb +3 -2
  24. data/lib/elastic/app-search/api/api_key.rb +2 -1
  25. data/lib/elastic/app-search/api/api_logs.rb +14 -13
  26. data/lib/elastic/app-search/api/count_analytics.rb +7 -6
  27. data/lib/elastic/app-search/api/crawler_active_crawl_request.rb +51 -0
  28. data/lib/elastic/app-search/api/crawler_crawl_request.rb +54 -0
  29. data/lib/elastic/app-search/api/crawler_crawl_schedule.rb +51 -0
  30. data/lib/elastic/app-search/api/crawler_domain.rb +54 -0
  31. data/lib/elastic/app-search/api/crawler_domain_validation_result.rb +48 -0
  32. data/lib/elastic/app-search/api/crawler_metrics.rb +48 -0
  33. data/lib/elastic/app-search/api/crawler_overview.rb +51 -0
  34. data/lib/elastic/app-search/api/crawler_process_crawl.rb +54 -0
  35. data/lib/elastic/app-search/api/crawler_process_crawl_denied_urls.rb +54 -0
  36. data/lib/elastic/app-search/api/crawler_url_extraction_result.rb +52 -0
  37. data/lib/elastic/app-search/api/crawler_url_tracing_result.rb +51 -0
  38. data/lib/elastic/app-search/api/crawler_url_validation_result.rb +51 -0
  39. data/lib/elastic/app-search/api/crawler_user_agent.rb +48 -0
  40. data/lib/elastic/app-search/api/create_api_key.rb +9 -1
  41. data/lib/elastic/app-search/api/create_crawler_crawl_request.rb +51 -0
  42. data/lib/elastic/app-search/api/create_crawler_crawl_rule.rb +60 -0
  43. data/lib/elastic/app-search/api/create_crawler_domain.rb +55 -0
  44. data/lib/elastic/app-search/api/create_crawler_entry_point.rb +57 -0
  45. data/lib/elastic/app-search/api/create_crawler_process_crawl.rb +53 -0
  46. data/lib/elastic/app-search/api/create_crawler_sitemap.rb +57 -0
  47. data/lib/elastic/app-search/api/create_curation.rb +8 -6
  48. data/lib/elastic/app-search/api/create_engine.rb +9 -7
  49. data/lib/elastic/app-search/api/create_synonym_set.rb +7 -4
  50. data/lib/elastic/app-search/api/curation.rb +4 -3
  51. data/lib/elastic/app-search/api/delete_active_crawl_request.rb +51 -0
  52. data/lib/elastic/app-search/api/delete_api_key.rb +1 -0
  53. data/lib/elastic/app-search/api/delete_crawler_active_crawl_request.rb +51 -0
  54. data/lib/elastic/app-search/api/delete_crawler_crawl_rule.rb +57 -0
  55. data/lib/elastic/app-search/api/delete_crawler_crawl_schedule.rb +51 -0
  56. data/lib/elastic/app-search/api/delete_crawler_domain.rb +54 -0
  57. data/lib/elastic/app-search/api/delete_crawler_entry_point.rb +57 -0
  58. data/lib/elastic/app-search/api/delete_crawler_sitemap.rb +57 -0
  59. data/lib/elastic/app-search/api/delete_curation.rb +4 -3
  60. data/lib/elastic/app-search/api/delete_documents.rb +2 -1
  61. data/lib/elastic/app-search/api/delete_engine.rb +3 -2
  62. data/lib/elastic/app-search/api/delete_meta_engine_source.rb +3 -3
  63. data/lib/elastic/app-search/api/delete_synonym_set.rb +4 -3
  64. data/lib/elastic/app-search/api/denied_urls.rb +54 -0
  65. data/lib/elastic/app-search/api/documents.rb +3 -2
  66. data/lib/elastic/app-search/api/engine.rb +3 -2
  67. data/lib/elastic/app-search/api/index_documents.rb +3 -2
  68. data/lib/elastic/app-search/api/list_adaptive_relevance_suggestions.rb +53 -0
  69. data/lib/elastic/app-search/api/list_api_keys.rb +2 -1
  70. data/lib/elastic/app-search/api/list_crawler_crawl_requests.rb +52 -0
  71. data/lib/elastic/app-search/api/list_crawler_domains.rb +51 -0
  72. data/lib/elastic/app-search/api/list_crawler_process_crawls.rb +51 -0
  73. data/lib/elastic/app-search/api/list_curations.rb +3 -2
  74. data/lib/elastic/app-search/api/list_documents.rb +3 -2
  75. data/lib/elastic/app-search/api/list_engines.rb +2 -1
  76. data/lib/elastic/app-search/api/list_synonym_sets.rb +3 -2
  77. data/lib/elastic/app-search/api/log_clickthrough.rb +8 -10
  78. data/lib/elastic/app-search/api/put_adaptive_relevance_settings.rb +52 -0
  79. data/lib/elastic/app-search/api/put_adaptive_relevance_suggestions.rb +51 -0
  80. data/lib/elastic/app-search/api/put_api_key.rb +9 -2
  81. data/lib/elastic/app-search/api/put_crawler_crawl_rule.rb +63 -0
  82. data/lib/elastic/app-search/api/put_crawler_crawl_schedule.rb +53 -0
  83. data/lib/elastic/app-search/api/put_crawler_domain.rb +58 -0
  84. data/lib/elastic/app-search/api/put_crawler_entry_point.rb +60 -0
  85. data/lib/elastic/app-search/api/put_crawler_sitemap.rb +60 -0
  86. data/lib/elastic/app-search/api/put_curation.rb +10 -8
  87. data/lib/elastic/app-search/api/put_documents.rb +3 -3
  88. data/lib/elastic/app-search/api/put_schema.rb +4 -4
  89. data/lib/elastic/app-search/api/put_search_settings.rb +6 -2
  90. data/lib/elastic/app-search/api/put_synonym_set.rb +8 -5
  91. data/lib/elastic/app-search/api/query_suggestion.rb +7 -7
  92. data/lib/elastic/app-search/api/reset_search_settings.rb +3 -2
  93. data/lib/elastic/app-search/api/schema.rb +3 -2
  94. data/lib/elastic/app-search/api/search.rb +14 -3
  95. data/lib/elastic/app-search/api/search_settings.rb +3 -2
  96. data/lib/elastic/app-search/api/synonym_set.rb +4 -3
  97. data/lib/elastic/app-search/api/top_clicks_analytics.rb +8 -8
  98. data/lib/elastic/app-search/api/top_queries_analytics.rb +7 -7
  99. data/lib/elastic/app-search/app_search.rb +0 -10
  100. data/lib/elastic/enterprise-search/api/health.rb +1 -0
  101. data/lib/elastic/enterprise-search/api/put_read_only.rb +3 -2
  102. data/lib/elastic/enterprise-search/api/read_only.rb +1 -0
  103. data/lib/elastic/enterprise-search/api/version.rb +1 -0
  104. data/lib/elastic/enterprise-search/client.rb +12 -1
  105. data/lib/elastic/enterprise-search/request.rb +10 -1
  106. data/lib/elastic/enterprise-search/version.rb +1 -1
  107. data/lib/elastic/workplace-search/api/auto_query_refinement_details.rb +49 -0
  108. data/lib/elastic/workplace-search/api/create_content_source.rb +1 -0
  109. data/lib/elastic/workplace-search/api/delete_synonym_set.rb +1 -1
  110. data/lib/elastic/workplace-search/api/list_documents.rb +55 -0
  111. data/lib/elastic/workplace-search/api/put_content_source.rb +1 -0
  112. data/lib/elastic/workplace-search/api/put_synonym_set.rb +1 -1
  113. data/lib/elastic/workplace-search/api/put_triggers_blocklist.rb +47 -0
  114. data/lib/elastic/workplace-search/api/search.rb +3 -0
  115. data/lib/elastic/workplace-search/api/synonym_set.rb +1 -1
  116. data/{spec/app-search/api_logs_spec.rb → lib/elastic/workplace-search/api/triggers_blocklist.rb} +23 -14
  117. data/lib/elastic/workplace-search/workplace_search.rb +0 -15
  118. data/spec/integration/app-search/adaptive_relevance_spec.rb +80 -0
  119. data/spec/integration/app-search/api_key_spec.rb +110 -0
  120. data/spec/integration/app-search/api_logs_spec.rb +59 -0
  121. data/spec/integration/app-search/app_search_helper.rb +51 -0
  122. data/spec/integration/app-search/count_analytics_spec.rb +47 -0
  123. data/spec/integration/app-search/crawl_requests_spec.rb +86 -0
  124. data/spec/integration/app-search/crawler_crawl_rule_spec.rb +73 -0
  125. data/spec/integration/app-search/crawler_domain_spec.rb +87 -0
  126. data/spec/integration/app-search/crawler_entry_point_spec.rb +77 -0
  127. data/spec/integration/app-search/crawler_metrics_spec.rb +46 -0
  128. data/spec/integration/app-search/crawler_overview_spec.rb +45 -0
  129. data/spec/integration/app-search/crawler_process_crawl_denied_urls_spec.rb +50 -0
  130. data/spec/integration/app-search/crawler_process_crawl_spec.rb +66 -0
  131. data/spec/integration/app-search/crawler_scheduling_spec.rb +69 -0
  132. data/spec/integration/app-search/crawler_sitemap_spec.rb +72 -0
  133. data/spec/integration/app-search/crawler_urls_spec.rb +60 -0
  134. data/spec/{app-search/api_count_analytics_spec.rb → integration/app-search/crawler_user_agent_spec.rb} +6 -9
  135. data/spec/integration/app-search/curations_spec.rb +118 -0
  136. data/spec/integration/app-search/documents_spec.rb +123 -0
  137. data/spec/integration/app-search/engines_spec.rb +78 -0
  138. data/spec/{app-search/api_log_clickthrough_spec.rb → integration/app-search/log_clickthrough_spec.rb} +14 -7
  139. data/spec/integration/app-search/meta_engines_spec.rb +75 -0
  140. data/spec/integration/app-search/query_suggestion_spec.rb +50 -0
  141. data/spec/{app-search/api_schema_spec.rb → integration/app-search/schema_spec.rb} +21 -16
  142. data/spec/integration/app-search/search_and_multiple_search_spec.rb +67 -0
  143. data/spec/integration/app-search/search_settings_spec.rb +87 -0
  144. data/spec/integration/app-search/synonyms_spec.rb +79 -0
  145. data/spec/{app-search/api_top_clicks_analytics_spec.rb → integration/app-search/top_clicks_analytics_spec.rb} +20 -14
  146. data/spec/{app-search/api_top_queries_analytics_spec.rb → integration/app-search/top_queries_analytics_spec.rb} +16 -8
  147. data/spec/integration/workplace-search/content_sources_spec.rb +106 -0
  148. data/spec/integration/workplace-search/documents_spec.rb +102 -0
  149. data/spec/integration/workplace-search/external_identities_spec.rb +97 -0
  150. data/spec/integration/{icon.png → workplace-search/icon.png} +0 -0
  151. data/spec/integration/workplace-search/permissions_spec.rb +77 -0
  152. data/spec/integration/workplace-search/synonym_sets_spec.rb +92 -0
  153. data/spec/integration/workplace-search/triggers_spec.rb +43 -0
  154. data/spec/{app-search/api_query_suggestion_spec.rb → integration/workplace-search/users_spec.rb} +12 -15
  155. data/spec/integration/workplace-search/workplace_search_helper.rb +39 -0
  156. metadata +94 -68
  157. data/spec/app-search/api_apikey_spec.rb +0 -92
  158. data/spec/app-search/api_curations_spec.rb +0 -97
  159. data/spec/app-search/api_documents_spec.rb +0 -102
  160. data/spec/app-search/api_engines_spec.rb +0 -67
  161. data/spec/app-search/api_meta_engines_spec.rb +0 -72
  162. data/spec/app-search/api_search_and_multi_search_spec.rb +0 -48
  163. data/spec/app-search/api_search_settings_spec.rb +0 -76
  164. data/spec/app-search/api_synonyms_spec.rb +0 -79
  165. data/spec/fixtures/vcr/app_search/add_meta_engine_source.yml +0 -109
  166. data/spec/fixtures/vcr/app_search/api_documents.yml +0 -56
  167. data/spec/fixtures/vcr/app_search/api_index_documents.yml +0 -57
  168. data/spec/fixtures/vcr/app_search/api_log_clickthrough.yml +0 -54
  169. data/spec/fixtures/vcr/app_search/api_logs.yml +0 -70
  170. data/spec/fixtures/vcr/app_search/api_put_schema.yml +0 -109
  171. data/spec/fixtures/vcr/app_search/api_put_search_settings.yml +0 -56
  172. data/spec/fixtures/vcr/app_search/api_query_suggestion.yml +0 -59
  173. data/spec/fixtures/vcr/app_search/api_reset_search_settings.yml +0 -56
  174. data/spec/fixtures/vcr/app_search/api_schema.yml +0 -56
  175. data/spec/fixtures/vcr/app_search/api_search_settings.yml +0 -56
  176. data/spec/fixtures/vcr/app_search/api_top_clicks_analytics.yml +0 -55
  177. data/spec/fixtures/vcr/app_search/api_top_clicks_analytics_query.yml +0 -55
  178. data/spec/fixtures/vcr/app_search/api_top_queries_analytics.yml +0 -55
  179. data/spec/fixtures/vcr/app_search/count_analytics.yml +0 -55
  180. data/spec/fixtures/vcr/app_search/create_and_update_document.yml +0 -107
  181. data/spec/fixtures/vcr/app_search/create_api_key.yml +0 -52
  182. data/spec/fixtures/vcr/app_search/create_curation.yml +0 -113
  183. data/spec/fixtures/vcr/app_search/create_engine.yml +0 -55
  184. data/spec/fixtures/vcr/app_search/create_meta_engine.yml +0 -56
  185. data/spec/fixtures/vcr/app_search/create_synonym_set.yml +0 -56
  186. data/spec/fixtures/vcr/app_search/delete_api_key.yml +0 -52
  187. data/spec/fixtures/vcr/app_search/delete_curation.yml +0 -56
  188. data/spec/fixtures/vcr/app_search/delete_engine.yml +0 -55
  189. data/spec/fixtures/vcr/app_search/delete_meta_engine_source.yml +0 -56
  190. data/spec/fixtures/vcr/app_search/delete_synonym_set.yml +0 -56
  191. data/spec/fixtures/vcr/app_search/get_api_key.yml +0 -52
  192. data/spec/fixtures/vcr/app_search/get_curation.yml +0 -56
  193. data/spec/fixtures/vcr/app_search/get_engine.yml +0 -55
  194. data/spec/fixtures/vcr/app_search/index_and_delete_document.yml +0 -107
  195. data/spec/fixtures/vcr/app_search/list_api_keys.yml +0 -52
  196. data/spec/fixtures/vcr/app_search/list_curations.yml +0 -56
  197. data/spec/fixtures/vcr/app_search/list_documents.yml +0 -57
  198. data/spec/fixtures/vcr/app_search/list_engines.yml +0 -55
  199. data/spec/fixtures/vcr/app_search/list_synonym_sets.yml +0 -56
  200. data/spec/fixtures/vcr/app_search/multi_query_search.yml +0 -63
  201. data/spec/fixtures/vcr/app_search/put_api_key.yml +0 -52
  202. data/spec/fixtures/vcr/app_search/put_curation.yml +0 -113
  203. data/spec/fixtures/vcr/app_search/put_synonym_set.yml +0 -56
  204. data/spec/fixtures/vcr/app_search/search.yml +0 -57
  205. data/spec/fixtures/vcr/app_search/single_query_search.yml +0 -60
  206. data/spec/fixtures/vcr/app_search/synonym_set.yml +0 -56
  207. data/spec/integration/workplace_search_spec.rb +0 -375
@@ -22,17 +22,17 @@ module Elastic
22
22
  module AppSearch
23
23
  module Actions
24
24
  # Documents - Partial update of documents
25
+ # Update specific document fields by id and field
25
26
  #
26
- # @param engine_name [String] (*Required*)
27
+ # @param engine_name [String] Name of the engine (*Required*)
27
28
  # @param arguments [Hash] endpoint arguments
28
- # @option arguments [Array] :documents List of documents to update (*Required*)
29
+ # @option arguments [Array] :documents
29
30
  # @option arguments [Hash] :headers optional HTTP headers to send with the request
30
31
  #
31
32
  # @see https://www.elastic.co/guide/en/app-search/current/documents.html#documents-partial
32
33
  #
33
34
  def put_documents(engine_name, arguments = {})
34
35
  raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
35
- raise ArgumentError, "Required parameter 'documents' missing" unless arguments[:documents]
36
36
 
37
37
  documents = arguments.delete(:documents) || {}
38
38
  headers = arguments.delete(:headers) || {}
@@ -21,18 +21,18 @@ module Elastic
21
21
  module EnterpriseSearch
22
22
  module AppSearch
23
23
  module Actions
24
- # Schema - Update schema for the current engine
24
+ # Schema - Update engine schema
25
+ # Update schema for the current engine
25
26
  #
26
- # @param engine_name [String] (*Required*)
27
+ # @param engine_name [String] Name of the engine (*Required*)
27
28
  # @param arguments [Hash] endpoint arguments
28
- # @option arguments [Object] :schema Schema description (*Required*)
29
+ # @option arguments [Object] :schema
29
30
  # @option arguments [Hash] :headers optional HTTP headers to send with the request
30
31
  #
31
32
  # @see https://www.elastic.co/guide/en/app-search/current/schema.html#schema-patch
32
33
  #
33
34
  def put_schema(engine_name, arguments = {})
34
35
  raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
35
- raise ArgumentError, "Required parameter 'schema' missing" unless arguments[:schema]
36
36
 
37
37
  schema = arguments.delete(:schema) || {}
38
38
  headers = arguments.delete(:headers) || {}
@@ -23,9 +23,13 @@ module Elastic
23
23
  module Actions
24
24
  # Searchsettings - Update search settings for the engine
25
25
  #
26
- # @param engine_name [String] (*Required*)
26
+ # @param engine_name [String] Name of the engine (*Required*)
27
27
  # @param arguments [Hash] endpoint arguments
28
- # @option arguments [Object] :body Search settings (*Required*)
28
+ # @option arguments [Hash] :body
29
+ # @option body :boosts
30
+ # @option body :search_fields
31
+ # @option body :result_fields
32
+ # @option body [Integer] :precision
29
33
  # @option arguments [Hash] :headers optional HTTP headers to send with the request
30
34
  #
31
35
  # @see https://www.elastic.co/guide/en/app-search/current/search-settings.html#search-settings-update
@@ -21,12 +21,15 @@ module Elastic
21
21
  module EnterpriseSearch
22
22
  module AppSearch
23
23
  module Actions
24
- # Synonyms - Update a synonym set by ID
24
+ # Synonyms - Update a synonym set
25
+ # Updates a synonym set by ID
25
26
  #
26
- # @param engine_name [String] (*Required*)
27
+ # @param engine_name [String] Name of the engine (*Required*)
27
28
  # @param arguments [Hash] endpoint arguments
28
- # @option arguments [String] :synonym_set_id (*Required*)
29
- # @option arguments [Object] :body Synonym set description (*Required*)
29
+ # @option arguments [String] :synonym_set_id Synonym Set ID (*Required*)
30
+ # @option arguments [Hash] :body (Required: synonyms)
31
+ # @option body [String] :id
32
+ # @option body :synonyms (*Required)
30
33
  # @option arguments [Hash] :headers optional HTTP headers to send with the request
31
34
  #
32
35
  # @see https://www.elastic.co/guide/en/app-search/current/synonyms.html#synonyms-update
@@ -34,7 +37,7 @@ module Elastic
34
37
  def put_synonym_set(engine_name, arguments = {})
35
38
  raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
36
39
  raise ArgumentError, "Required parameter 'synonym_set_id' missing" unless arguments[:synonym_set_id]
37
- raise ArgumentError, "Required parameter 'body' missing" unless arguments[:body]
40
+ raise ArgumentError, "Required parameter 'body (synonyms)' missing" unless arguments[:body] || arguments[:synonyms]
38
41
 
39
42
  synonym_set_id = arguments[:synonym_set_id]
40
43
  body = arguments.delete(:body) || {}
@@ -21,20 +21,20 @@ module Elastic
21
21
  module EnterpriseSearch
22
22
  module AppSearch
23
23
  module Actions
24
- # Querysuggestion - Provide relevant query suggestions for incomplete queries
24
+ # QuerySuggestion - Retrieve query suggestions
25
+ # Provide relevant query suggestions for incomplete queries
25
26
  #
26
- # @param engine_name [String] (*Required*)
27
+ # @param engine_name [String] Name of the engine (*Required*)
27
28
  # @param arguments [Hash] endpoint arguments
28
- # @option arguments [String] :query A partial query for which to receive suggestions (*Required*)
29
- # @option arguments [Array] :fields List of fields to use to generate suggestions. Defaults to all text fields
30
- # @option arguments [Integer] :size Number of query suggestions to return. Must be between 1 and 20. Defaults to 5
31
- # @option arguments [Hash] :body The request body
29
+ # @option arguments [Hash] :body
30
+ # @option body [String] :query
31
+ # @option body :types
32
+ # @option body [Integer] :size
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/query-suggestion.html
35
36
  #
36
37
  def query_suggestion(engine_name, arguments = {})
37
- raise ArgumentError, "Required parameter 'query' missing" unless arguments[:query]
38
38
  raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
39
39
 
40
40
  body = arguments.delete(:body) || {}
@@ -21,9 +21,10 @@ module Elastic
21
21
  module EnterpriseSearch
22
22
  module AppSearch
23
23
  module Actions
24
- # Searchsettings - Reset search settings for the engine
24
+ # Synonyms - Reset search settings
25
+ # Resets search settings for the engine
25
26
  #
26
- # @param engine_name [String] (*Required*)
27
+ # @param engine_name [String] Name of the engine (*Required*)
27
28
  # @param arguments [Hash] endpoint arguments
28
29
  # @option arguments [Hash] :body The request body
29
30
  # @option arguments [Hash] :headers optional HTTP headers to send with the request
@@ -21,9 +21,10 @@ module Elastic
21
21
  module EnterpriseSearch
22
22
  module AppSearch
23
23
  module Actions
24
- # Schema - Retrieve current schema for the engine
24
+ # Schema - Retrieve engine schema
25
+ # Retrieve current schema for the engine
25
26
  #
26
- # @param engine_name [String] (*Required*)
27
+ # @param engine_name [String] Name of the engine (*Required*)
27
28
  # @param arguments [Hash] endpoint arguments
28
29
  # @option arguments [Hash] :body The request body
29
30
  # @option arguments [Hash] :headers optional HTTP headers to send with the request
@@ -21,11 +21,22 @@ module Elastic
21
21
  module EnterpriseSearch
22
22
  module AppSearch
23
23
  module Actions
24
- # Search - Allows you to search over, facet and filter your data
24
+ # Search - Submit a search
25
+ # Submit a search and receive a set of results with meta data
25
26
  #
26
- # @param engine_name [String] (*Required*)
27
+ # @param engine_name [String] Name of the engine (*Required*)
27
28
  # @param arguments [Hash] endpoint arguments
28
- # @option arguments [Object] :body Search request parameters
29
+ # @option arguments [Hash] :body (Required: query)
30
+ # @option body [String] :query (*Required)
31
+ # @option body :analytics
32
+ # @option body :boost
33
+ # @option body :facets
34
+ # @option body :filters
35
+ # @option body :group
36
+ # @option body :page
37
+ # @option body :result_fields
38
+ # @option body :search_fields
39
+ # @option body :sort
29
40
  # @option arguments [Hash] :headers optional HTTP headers to send with the request
30
41
  #
31
42
  # @see https://www.elastic.co/guide/en/app-search/current/search.html
@@ -21,9 +21,10 @@ module Elastic
21
21
  module EnterpriseSearch
22
22
  module AppSearch
23
23
  module Actions
24
- # Searchsettings - Retrieve current search settings for the engine
24
+ # SearchSettings - Retrieve search settings
25
+ # Retrieve current search settings for the engine
25
26
  #
26
- # @param engine_name [String] (*Required*)
27
+ # @param engine_name [String] Name of the engine (*Required*)
27
28
  # @param arguments [Hash] endpoint arguments
28
29
  # @option arguments [Hash] :body The request body
29
30
  # @option arguments [Hash] :headers optional HTTP headers to send with the request
@@ -21,11 +21,12 @@ module Elastic
21
21
  module EnterpriseSearch
22
22
  module AppSearch
23
23
  module Actions
24
- # Synonyms - Retrieve a synonym set by ID
24
+ # Synonyms - Retrieve a synonym set
25
+ # Retrieves a synonym set by ID
25
26
  #
26
- # @param engine_name [String] (*Required*)
27
+ # @param engine_name [String] Name of the engine (*Required*)
27
28
  # @param arguments [Hash] endpoint arguments
28
- # @option arguments [String] :synonym_set_id (*Required*)
29
+ # @option arguments [String] :synonym_set_id Synonym Set ID (*Required*)
29
30
  # @option arguments [Hash] :body The request body
30
31
  # @option arguments [Hash] :headers optional HTTP headers to send with the request
31
32
  #
@@ -21,15 +21,15 @@ module Elastic
21
21
  module EnterpriseSearch
22
22
  module AppSearch
23
23
  module Actions
24
- # Analytics - Returns the number of clicks received by a document in descending order
24
+ # Analytics - Query for analytics click data
25
+ # Returns the number of clicks received by a document in descending order
25
26
  #
26
- # @param engine_name [String] (*Required*)
27
+ # @param engine_name [String] Name of the engine (*Required*)
27
28
  # @param arguments [Hash] endpoint arguments
28
- # @option arguments [String] :query Filter clicks over a search query
29
- # @option arguments [Integer] :current_page The page to fetch. Defaults to 1
30
- # @option arguments [Integer] :page_size The number of results per page
31
- # @option arguments [Array] :filters Analytics filters
32
- # @option arguments [Hash] :body The request body
29
+ # @option arguments [Hash] :body
30
+ # @option body [String] :query
31
+ # @option body :filters
32
+ # @option body [Object] :page
33
33
  # @option arguments [Hash] :headers optional HTTP headers to send with the request
34
34
  #
35
35
  # @see https://www.elastic.co/guide/en/app-search/current/clicks.html
@@ -41,7 +41,7 @@ module Elastic
41
41
  headers = arguments.delete(:headers) || {}
42
42
 
43
43
  request(
44
- :get,
44
+ :post,
45
45
  "api/as/v1/engines/#{engine_name}/analytics/clicks/",
46
46
  arguments,
47
47
  body,
@@ -21,14 +21,14 @@ module Elastic
21
21
  module EnterpriseSearch
22
22
  module AppSearch
23
23
  module Actions
24
- # Analytics - Returns queries analytics by usage count
24
+ # Analytics - Query for analytics query data
25
+ # Returns queries analytics by usage count
25
26
  #
26
- # @param engine_name [String] (*Required*)
27
+ # @param engine_name [String] Name of the engine (*Required*)
27
28
  # @param arguments [Hash] endpoint arguments
28
- # @option arguments [Integer] :current_page The page to fetch. Defaults to 1
29
- # @option arguments [Integer] :page_size The number of results per page
30
- # @option arguments [Array] :filters Analytics filters
31
- # @option arguments [Hash] :body The request body
29
+ # @option arguments [Hash] :body
30
+ # @option body :filters
31
+ # @option body [Object] :page
32
32
  # @option arguments [Hash] :headers optional HTTP headers to send with the request
33
33
  #
34
34
  # @see https://www.elastic.co/guide/en/app-search/current/queries.html#queries-top-queries
@@ -40,7 +40,7 @@ module Elastic
40
40
  headers = arguments.delete(:headers) || {}
41
41
 
42
42
  request(
43
- :get,
43
+ :post,
44
44
  "api/as/v1/engines/#{engine_name}/analytics/queries/",
45
45
  arguments,
46
46
  body,
@@ -25,20 +25,10 @@ module Elastic
25
25
  #
26
26
  # @see https://www.elastic.co/guide/en/app-search/current/index.html
27
27
  module AppSearch
28
- # The Request module is included in the AppSearch Client to override
29
- # EnterpriseSearch client's authentication method with App's
30
- # authentication.
31
- module Request
32
- def setup_authentication_header
33
- "Bearer #{http_auth}"
34
- end
35
- end
36
-
37
28
  # The App Search Client
38
29
  # Extends EnterpriseSearch client but overrides authentication to use access token.
39
30
  class Client < Elastic::EnterpriseSearch::Client
40
31
  include Elastic::EnterpriseSearch::AppSearch::Actions
41
- include Elastic::EnterpriseSearch::AppSearch::Request
42
32
 
43
33
  # Create a new Elastic::EnterpriseSearch::AppSearch::Client client
44
34
  #
@@ -23,6 +23,7 @@ module Elastic
23
23
  # Health - Get information on the health of a deployment and basic statistics around resource usage
24
24
  # Get information on the health of a deployment and basic statistics around resource usage
25
25
  #
26
+ # @param arguments [Hash] endpoint arguments
26
27
  # @option arguments [Hash] :headers optional HTTP headers to send with the request
27
28
  #
28
29
  # @see https://www.elastic.co/guide/en/enterprise-search/current/monitoring-apis.html#health-api-example
@@ -23,8 +23,9 @@ module Elastic
23
23
  # Read-Only - Update the read-only flag's state
24
24
  # Update the read-only flag's state
25
25
  #
26
- # @option arguments [Object] :body
27
- # @option body [Boolean] :enabled
26
+ # @param arguments [Hash] endpoint arguments
27
+ # @option arguments [Hash] :body (Required: enabled)
28
+ # @option body [Boolean] :enabled (*Required)
28
29
  # @option arguments [Hash] :headers optional HTTP headers to send with the request
29
30
  #
30
31
  # @see https://www.elastic.co/guide/en/enterprise-search/current/read-only-api.html#setting-read-only-state
@@ -23,6 +23,7 @@ module Elastic
23
23
  # Read-Only - Get the read-only flag's state
24
24
  # Get the read-only flag's state
25
25
  #
26
+ # @param arguments [Hash] endpoint arguments
26
27
  # @option arguments [Hash] :headers optional HTTP headers to send with the request
27
28
  #
28
29
  # @see https://www.elastic.co/guide/en/enterprise-search/current/read-only-api.html#getting-read-only-state
@@ -23,6 +23,7 @@ module Elastic
23
23
  # Version - Get version information for this server
24
24
  # Get version information for this server
25
25
  #
26
+ # @param arguments [Hash] endpoint arguments
26
27
  # @option arguments [Hash] :headers optional HTTP headers to send with the request
27
28
  #
28
29
  # @see https://www.elastic.co/guide/en/enterprise-search/current/management-apis.html
@@ -67,7 +67,7 @@ module Elastic
67
67
 
68
68
  def transport
69
69
  @options[:transport] ||
70
- Elasticsearch::Client.new(
70
+ transport_klass.new(
71
71
  host: host,
72
72
  log: log,
73
73
  logger: logger,
@@ -110,6 +110,17 @@ module Elastic
110
110
 
111
111
  @options[:host]
112
112
  end
113
+
114
+ private
115
+
116
+ def transport_klass
117
+ case Elasticsearch::Transport::VERSION
118
+ when /7\.1[123]/
119
+ Elasticsearch::Client
120
+ else
121
+ Elasticsearch::Transport::Client
122
+ end
123
+ end
113
124
  end
114
125
  end
115
126
  end
@@ -58,7 +58,16 @@ module Elastic
58
58
  end
59
59
 
60
60
  def setup_authentication_header
61
- basic_auth_header
61
+ if instance_of? Elastic::EnterpriseSearch::Client
62
+ basic_auth_header
63
+ else
64
+ case http_auth
65
+ when Hash
66
+ basic_auth_header
67
+ when String
68
+ "Bearer #{http_auth}"
69
+ end
70
+ end
62
71
  end
63
72
 
64
73
  def basic_auth_header
@@ -19,6 +19,6 @@
19
19
 
20
20
  module Elastic
21
21
  module EnterpriseSearch
22
- VERSION = '7.14.0'
22
+ VERSION = '7.16.0'
23
23
  end
24
24
  end
@@ -0,0 +1,49 @@
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 WorkplaceSearch
23
+ module Actions
24
+ # ContentSources - Retrieves a content source's automatic query refinement details
25
+ # Retrieves a content source's automatic query refinement details
26
+ #
27
+ # @param content_source_id [String] Unique ID for a Custom API source, provided upon creation of a Custom API Source (*Required*)
28
+ # @param arguments [Hash] endpoint arguments
29
+ # @option arguments [Hash] :headers optional HTTP headers to send with the request
30
+ #
31
+ # @see https://www.elastic.co/guide/en/workplace-search/current/workplace-search-content-sources-api.html#get-automatic-query-refinement-details-api
32
+ #
33
+ def auto_query_refinement_details(content_source_id, arguments = {})
34
+ raise ArgumentError, "Required parameter 'content_source_id' missing" unless content_source_id
35
+
36
+ headers = arguments.delete(:headers) || {}
37
+
38
+ request(
39
+ :get,
40
+ "api/ws/v1/sources/#{content_source_id}/automatic_query_refinement/",
41
+ arguments,
42
+ {},
43
+ headers
44
+ )
45
+ end
46
+ end
47
+ end
48
+ end
49
+ end
@@ -32,6 +32,7 @@ module Elastic
32
32
  # @option body [Boolean] :is_searchable Whether or not this Content Source will be searchable on the search page.
33
33
  # @option body :indexing
34
34
  # @option body :facets
35
+ # @option body :automatic_query_refinement
35
36
  # @option arguments [Hash] :headers optional HTTP headers to send with the request
36
37
  #
37
38
  # @see https://www.elastic.co/guide/en/workplace-search/current/workplace-search-content-sources-api.html#create-content-source-api
@@ -25,7 +25,7 @@ module Elastic
25
25
  # Delete a synonym set
26
26
  #
27
27
  # @param arguments [Hash] endpoint arguments
28
- # @option arguments [String] :synonym_set_id Unique ID for a content source document. Provided upon or returned at creation. (*Required*)
28
+ # @option arguments [String] :synonym_set_id Synonym Set ID (*Required*)
29
29
  # @option arguments [Hash] :headers optional HTTP headers to send with the request
30
30
  #
31
31
  # @see https://www.elastic.co/guide/en/workplace-search/current/workplace-synonyms-api.html#delete-synonym
@@ -0,0 +1,55 @@
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 WorkplaceSearch
23
+ module Actions
24
+ # Documents - Lists documents from a custom content source
25
+ # Lists documents from a custom content source
26
+ #
27
+ # @param content_source_id [String] Unique ID for a Custom API source, provided upon creation of a Custom API Source (*Required*)
28
+ # @param arguments [Hash] endpoint arguments
29
+ # @option arguments [Hash] :body
30
+ # @option body [Object] :page Paging controls for the result set
31
+ # @option body :filters
32
+ # @option body :sort
33
+ # @option body [String] :cursor
34
+ # @option arguments [Hash] :headers optional HTTP headers to send with the request
35
+ #
36
+ # @see https://www.elastic.co/guide/en/workplace-search/current/workplace-search-custom-sources-api.html#list-documents
37
+ #
38
+ def list_documents(content_source_id, arguments = {})
39
+ raise ArgumentError, "Required parameter 'content_source_id' missing" unless content_source_id
40
+
41
+ body = arguments.delete(:body) || {}
42
+ headers = arguments.delete(:headers) || {}
43
+
44
+ request(
45
+ :post,
46
+ "api/ws/v1/sources/#{content_source_id}/documents/",
47
+ arguments,
48
+ body,
49
+ headers
50
+ )
51
+ end
52
+ end
53
+ end
54
+ end
55
+ end
@@ -33,6 +33,7 @@ module Elastic
33
33
  # @option body [Boolean] :is_searchable Whether or not this Content Source will be searchable on the search page. (*Required)
34
34
  # @option body :indexing
35
35
  # @option body :facets
36
+ # @option body :automatic_query_refinement
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/workplace-search/current/workplace-search-content-sources-api.html#update-content-source-api
@@ -25,7 +25,7 @@ module Elastic
25
25
  # Update a synonym set
26
26
  #
27
27
  # @param arguments [Hash] endpoint arguments
28
- # @option arguments [String] :synonym_set_id Unique ID for a content source document. Provided upon or returned at creation. (*Required*)
28
+ # @option arguments [String] :synonym_set_id Synonym Set ID (*Required*)
29
29
  # @option arguments [Hash] :body (Required: synonyms)
30
30
  # @option body [Array] :synonyms A list of terms for this synonym set (*Required)
31
31
  # @option arguments [Hash] :headers optional HTTP headers to send with the request
@@ -0,0 +1,47 @@
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 WorkplaceSearch
23
+ module Actions
24
+ # Update current triggers blocklist
25
+ #
26
+ # @param arguments [Hash] endpoint arguments
27
+ # @option arguments [Hash] :body The request body
28
+ # @option arguments [Hash] :headers optional HTTP headers to send with the request
29
+ #
30
+ # @see https://www.elastic.co/guide/en/workplace-search/current/automatic-query-refinement-blocklist.html
31
+ #
32
+ def put_triggers_blocklist(arguments = {})
33
+ body = arguments.delete(:body) || {}
34
+ headers = arguments.delete(:headers) || {}
35
+
36
+ request(
37
+ :put,
38
+ 'api/ws/v1/automatic_query_refinement/',
39
+ arguments,
40
+ body,
41
+ headers
42
+ )
43
+ end
44
+ end
45
+ end
46
+ end
47
+ end
@@ -36,6 +36,9 @@ module Elastic
36
36
  # @option body :sort
37
37
  # @option body [Object] :facets
38
38
  # @option body [Object] :boosts
39
+ # @option body :source_type Optional parameter to search standard, remote only, or all available sources
40
+ # @option body [Integer] :timeout Optional timeout in ms for searching remote sources
41
+ # @option body [Array] :content_sources Optional list of content source ids to only return results from
39
42
  # @option arguments [Hash] :headers optional HTTP headers to send with the request
40
43
  #
41
44
  # @see https://www.elastic.co/guide/en/workplace-search/current/workplace-search-search-api.html
@@ -25,7 +25,7 @@ module Elastic
25
25
  # Retrieve a synonym set by ID
26
26
  #
27
27
  # @param arguments [Hash] endpoint arguments
28
- # @option arguments [String] :synonym_set_id Unique ID for a content source document. Provided upon or returned at creation. (*Required*)
28
+ # @option arguments [String] :synonym_set_id Synonym Set ID (*Required*)
29
29
  # @option arguments [Hash] :headers optional HTTP headers to send with the request
30
30
  #
31
31
  # @see https://www.elastic.co/guide/en/workplace-search/current/workplace-synonyms-api.html#show-synonym