elastic-enterprise-search 7.17.0 → 8.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (158) hide show
  1. checksums.yaml +4 -4
  2. data/.ci/jobs/elastic+enterprise-search-ruby+7.15.yml +12 -0
  3. data/.ci/jobs/elastic+enterprise-search-ruby+7.16.yml +12 -0
  4. data/.ci/test-matrix.yml +1 -2
  5. data/.github/workflows/testing.yml +3 -4
  6. data/.rubocop.yml +1 -1
  7. data/CHANGELOG +1 -0
  8. data/CODE_OF_CONDUCT +1 -0
  9. data/CONTRIBUTING.md +37 -0
  10. data/NOTICE +2 -0
  11. data/README.md +25 -29
  12. data/docs/guide/app-search-api.asciidoc +52 -18
  13. data/docs/guide/overview.asciidoc +11 -3
  14. data/docs/guide/release_notes/712.asciidoc +10 -0
  15. data/docs/guide/release_notes/80.asciidoc +117 -0
  16. data/docs/guide/release_notes/81.asciidoc +8 -0
  17. data/docs/guide/release_notes/index.asciidoc +6 -0
  18. data/docs/guide/workplace-search-api.asciidoc +14 -7
  19. data/elastic-enterprise-search.gemspec +3 -3
  20. data/lib/elastic/api/response.rb +52 -0
  21. data/lib/elastic/{workplace-search/api/user_permissions.rb → app-search/api/adaptive_relevance_settings.rb} +10 -15
  22. data/lib/elastic/{workplace-search/api/add_user_permissions.rb → app-search/api/adaptive_relevance_suggestions.rb} +19 -14
  23. data/lib/elastic/app-search/api/add_meta_engine_source.rb +3 -5
  24. data/lib/elastic/app-search/api/api_key.rb +3 -6
  25. data/lib/elastic/app-search/api/api_logs.rb +7 -15
  26. data/lib/elastic/app-search/api/count_analytics.rb +4 -5
  27. data/lib/elastic/app-search/api/crawler_active_crawl_request.rb +4 -7
  28. data/lib/elastic/app-search/api/crawler_crawl_request.rb +5 -8
  29. data/lib/elastic/app-search/api/crawler_crawl_schedule.rb +4 -7
  30. data/lib/elastic/app-search/api/crawler_domain.rb +5 -8
  31. data/lib/elastic/app-search/api/crawler_domain_validation_result.rb +5 -5
  32. data/lib/elastic/app-search/api/crawler_metrics.rb +3 -6
  33. data/lib/elastic/app-search/api/crawler_overview.rb +4 -7
  34. data/lib/elastic/app-search/api/crawler_process_crawl.rb +5 -8
  35. data/lib/elastic/app-search/api/crawler_process_crawl_denied_urls.rb +5 -8
  36. data/lib/elastic/app-search/api/crawler_url_extraction_result.rb +6 -7
  37. data/lib/elastic/app-search/api/crawler_url_tracing_result.rb +6 -7
  38. data/lib/elastic/app-search/api/crawler_url_validation_result.rb +6 -7
  39. data/lib/elastic/app-search/api/crawler_user_agent.rb +3 -6
  40. data/lib/elastic/app-search/api/create_api_key.rb +9 -10
  41. data/lib/elastic/app-search/api/create_crawler_crawl_request.rb +9 -5
  42. data/lib/elastic/app-search/api/create_crawler_crawl_rule.rb +12 -11
  43. data/lib/elastic/app-search/api/create_crawler_domain.rb +7 -8
  44. data/lib/elastic/app-search/api/create_crawler_entry_point.rb +9 -8
  45. data/lib/elastic/app-search/api/create_crawler_process_crawl.rb +5 -6
  46. data/lib/elastic/app-search/api/create_crawler_sitemap.rb +9 -8
  47. data/lib/elastic/app-search/api/create_curation.rb +9 -8
  48. data/lib/elastic/app-search/api/create_engine.rb +7 -7
  49. data/lib/elastic/app-search/api/create_synonym_set.rb +5 -6
  50. data/lib/elastic/app-search/api/curation.rb +4 -7
  51. data/lib/elastic/app-search/api/delete_api_key.rb +3 -6
  52. data/lib/elastic/app-search/api/delete_crawler_active_crawl_request.rb +4 -7
  53. data/lib/elastic/app-search/api/delete_crawler_crawl_rule.rb +6 -9
  54. data/lib/elastic/app-search/api/delete_crawler_crawl_schedule.rb +4 -7
  55. data/lib/elastic/app-search/api/delete_crawler_domain.rb +5 -8
  56. data/lib/elastic/app-search/api/delete_crawler_entry_point.rb +6 -9
  57. data/lib/elastic/app-search/api/delete_crawler_sitemap.rb +6 -9
  58. data/lib/elastic/app-search/api/delete_curation.rb +4 -7
  59. data/lib/elastic/app-search/api/delete_documents.rb +3 -5
  60. data/lib/elastic/app-search/api/delete_engine.rb +3 -6
  61. data/lib/elastic/app-search/api/delete_meta_engine_source.rb +3 -4
  62. data/lib/elastic/app-search/api/delete_synonym_set.rb +4 -7
  63. data/lib/elastic/app-search/api/documents.rb +4 -5
  64. data/lib/elastic/app-search/api/engine.rb +3 -6
  65. data/lib/elastic/app-search/api/index_documents.rb +3 -5
  66. data/lib/elastic/{workplace-search/api/remove_user_permissions.rb → app-search/api/list_adaptive_relevance_suggestions.rb} +12 -14
  67. data/lib/elastic/app-search/api/list_api_keys.rb +2 -5
  68. data/lib/elastic/app-search/api/list_crawler_crawl_requests.rb +6 -8
  69. data/lib/elastic/{workplace-search/api/list_permissions.rb → app-search/api/list_crawler_domains.rb} +12 -13
  70. data/lib/elastic/app-search/api/list_crawler_process_crawls.rb +6 -7
  71. data/lib/elastic/app-search/api/list_curations.rb +3 -6
  72. data/lib/elastic/app-search/api/list_documents.rb +3 -6
  73. data/lib/elastic/app-search/api/list_engines.rb +2 -5
  74. data/lib/elastic/app-search/api/list_synonym_sets.rb +3 -6
  75. data/lib/elastic/app-search/api/log_clickthrough.rb +8 -8
  76. data/lib/elastic/{workplace-search/api/put_user_permissions.rb → app-search/api/put_adaptive_relevance_settings.rb} +12 -14
  77. data/lib/elastic/app-search/api/put_adaptive_relevance_suggestions.rb +50 -0
  78. data/lib/elastic/app-search/api/put_api_key.rb +10 -10
  79. data/lib/elastic/app-search/api/put_crawler_crawl_rule.rb +13 -12
  80. data/lib/elastic/app-search/api/put_crawler_crawl_schedule.rb +7 -7
  81. data/lib/elastic/app-search/api/put_crawler_domain.rb +8 -9
  82. data/lib/elastic/app-search/api/put_crawler_entry_point.rb +10 -9
  83. data/lib/elastic/app-search/api/put_crawler_sitemap.rb +10 -9
  84. data/lib/elastic/app-search/api/put_curation.rb +10 -9
  85. data/lib/elastic/app-search/api/put_documents.rb +3 -4
  86. data/lib/elastic/app-search/api/put_schema.rb +3 -4
  87. data/lib/elastic/app-search/api/put_search_settings.rb +5 -6
  88. data/lib/elastic/app-search/api/put_synonym_set.rb +7 -8
  89. data/lib/elastic/app-search/api/query_suggestion.rb +4 -5
  90. data/lib/elastic/app-search/api/refresh_adaptive_relevance_update_process.rb +55 -0
  91. data/lib/elastic/app-search/api/reset_search_settings.rb +3 -6
  92. data/lib/elastic/app-search/api/schema.rb +3 -6
  93. data/lib/elastic/app-search/api/search.rb +5 -5
  94. data/lib/elastic/app-search/api/search_settings.rb +3 -6
  95. data/lib/elastic/app-search/api/synonym_set.rb +4 -7
  96. data/lib/elastic/app-search/api/top_clicks_analytics.rb +4 -5
  97. data/lib/elastic/app-search/api/top_queries_analytics.rb +3 -4
  98. data/lib/elastic/enterprise-search/api/health.rb +2 -3
  99. data/lib/elastic/enterprise-search/api/put_read_only.rb +5 -4
  100. data/lib/elastic/enterprise-search/api/read_only.rb +2 -3
  101. data/lib/elastic/enterprise-search/api/stats.rb +2 -3
  102. data/lib/elastic/enterprise-search/api/version.rb +2 -3
  103. data/lib/elastic/enterprise-search/client.rb +8 -13
  104. data/lib/elastic/enterprise-search/request.rb +5 -3
  105. data/lib/elastic/enterprise-search/version.rb +1 -1
  106. data/lib/elastic/workplace-search/api/auto_query_refinement_details.rb +3 -4
  107. data/lib/elastic/workplace-search/api/command_sync_jobs.rb +4 -5
  108. data/lib/elastic/workplace-search/api/content_source.rb +3 -4
  109. data/lib/elastic/workplace-search/api/create_analytics_event.rb +16 -12
  110. data/lib/elastic/workplace-search/api/create_batch_synonym_sets.rb +4 -3
  111. data/lib/elastic/workplace-search/api/create_content_source.rb +6 -5
  112. data/lib/elastic/workplace-search/api/create_external_identity.rb +11 -6
  113. data/lib/elastic/workplace-search/api/current_user.rb +3 -5
  114. data/lib/elastic/workplace-search/api/delete_content_source.rb +3 -4
  115. data/lib/elastic/workplace-search/api/delete_documents.rb +4 -4
  116. data/lib/elastic/workplace-search/api/delete_documents_by_query.rb +4 -3
  117. data/lib/elastic/workplace-search/api/delete_external_identity.rb +7 -9
  118. data/lib/elastic/workplace-search/api/delete_synonym_set.rb +3 -5
  119. data/lib/elastic/workplace-search/api/document.rb +4 -6
  120. data/lib/elastic/workplace-search/api/external_identity.rb +7 -9
  121. data/lib/elastic/workplace-search/api/index_documents.rb +3 -4
  122. data/lib/elastic/workplace-search/api/list_content_sources.rb +2 -3
  123. data/lib/elastic/workplace-search/api/list_documents.rb +4 -5
  124. data/lib/elastic/workplace-search/api/list_external_identities.rb +3 -4
  125. data/lib/elastic/workplace-search/api/list_synonym_sets.rb +1 -2
  126. data/lib/elastic/workplace-search/api/put_content_source.rb +6 -6
  127. data/lib/elastic/workplace-search/api/put_content_source_icons.rb +6 -6
  128. data/lib/elastic/workplace-search/api/put_external_identity.rb +11 -10
  129. data/lib/elastic/workplace-search/api/put_synonym_set.rb +4 -4
  130. data/lib/elastic/workplace-search/api/put_triggers_blocklist.rb +3 -5
  131. data/lib/elastic/workplace-search/api/search.rb +13 -13
  132. data/lib/elastic/workplace-search/api/synonym_set.rb +3 -5
  133. data/lib/elastic/workplace-search/api/triggers_blocklist.rb +3 -3
  134. data/spec/app-search/client_spec.rb +29 -0
  135. data/spec/enterprise-search/client_spec.rb +29 -0
  136. data/spec/enterprise-search/request_spec.rb +1 -1
  137. data/spec/integration/app-search/adaptive_relevance_settings_spec.rb +60 -0
  138. data/spec/integration/app-search/adaptive_relevance_suggestions_spec.rb +54 -0
  139. data/spec/integration/app-search/api_logs_spec.rb +11 -3
  140. data/spec/integration/app-search/app_search_helper.rb +2 -2
  141. data/spec/integration/app-search/count_analytics_spec.rb +3 -2
  142. data/spec/integration/app-search/crawler_domain_spec.rb +16 -0
  143. data/spec/integration/app-search/curations_spec.rb +15 -9
  144. data/spec/integration/app-search/engines_spec.rb +24 -26
  145. data/spec/integration/app-search/log_clickthrough_spec.rb +1 -1
  146. data/spec/integration/app-search/meta_engines_spec.rb +5 -5
  147. data/spec/integration/app-search/search_and_multiple_search_spec.rb +1 -1
  148. data/spec/integration/workplace-search/content_sources_spec.rb +6 -6
  149. data/spec/integration/workplace-search/documents_spec.rb +20 -10
  150. data/spec/integration/workplace-search/external_identities_spec.rb +26 -16
  151. data/spec/integration/workplace-search/triggers_spec.rb +2 -2
  152. data/spec/integration/workplace-search/users_spec.rb +0 -6
  153. data/spec/workplace-search/client_spec.rb +29 -0
  154. metadata +27 -19
  155. data/.ci/jobs/elastic+enterprise-search-ruby+7.10.0.beta.1.yml +0 -12
  156. data/.github/compatibility/Gemfile +0 -23
  157. data/.github/workflows/compatibility.yml +0 -20
  158. data/spec/integration/workplace-search/permissions_spec.rb +0 -77
@@ -24,20 +24,18 @@ module Elastic
24
24
  # Documents - Delete documents by ID
25
25
  # Deletes documents for given Document IDs
26
26
  #
27
- # @param engine_name [String] Name of the engine (*Required*)
28
- # @param arguments [Hash] endpoint arguments
29
- # @option arguments [Array] :document_ids List of document IDs (*Required*)
27
+ # @param [String] engine_name Name of the engine (*Required*)
28
+ # @param [Hash] arguments endpoint arguments
29
+ # @option arguments [Array<String>] :document_ids
30
30
  # @option arguments [Hash] :headers optional HTTP headers to send with the request
31
31
  #
32
32
  # @see https://www.elastic.co/guide/en/app-search/current/documents.html#documents-delete
33
33
  #
34
34
  def delete_documents(engine_name, arguments = {})
35
35
  raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
36
- raise ArgumentError, "Required parameter 'document_ids' missing" unless arguments[:document_ids]
37
36
 
38
37
  document_ids = arguments.delete(:document_ids) || {}
39
38
  headers = arguments.delete(:headers) || {}
40
-
41
39
  request(
42
40
  :delete,
43
41
  "api/as/v1/engines/#{engine_name}/documents/",
@@ -24,9 +24,8 @@ module Elastic
24
24
  # Engines - Delete an Engine
25
25
  # Delete an engine by name
26
26
  #
27
- # @param engine_name [String] Name of the engine (*Required*)
28
- # @param arguments [Hash] endpoint arguments
29
- # @option arguments [Hash] :body The request body
27
+ # @param [String] engine_name Name of the engine (*Required*)
28
+ # @param [Hash] arguments endpoint arguments
30
29
  # @option arguments [Hash] :headers optional HTTP headers to send with the request
31
30
  #
32
31
  # @see https://www.elastic.co/guide/en/app-search/current/engines.html#engines-delete
@@ -34,14 +33,12 @@ module Elastic
34
33
  def delete_engine(engine_name, arguments = {})
35
34
  raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
36
35
 
37
- body = arguments.delete(:body) || {}
38
36
  headers = arguments.delete(:headers) || {}
39
-
40
37
  request(
41
38
  :delete,
42
39
  "api/as/v1/engines/#{engine_name}/",
43
40
  arguments,
44
- body,
41
+ nil,
45
42
  headers
46
43
  )
47
44
  end
@@ -24,9 +24,9 @@ module Elastic
24
24
  # Engines - Delete a source engine
25
25
  # Deletes a source engine from a given meta engine
26
26
  #
27
- # @param engine_name [String] Name of the engine (*Required*)
28
- # @param arguments [Hash] endpoint arguments
29
- # @option arguments [Array] :source_engines List of engine names (*Required*)
27
+ # @param [String] engine_name Name of the engine (*Required*)
28
+ # @param [Hash] arguments endpoint arguments
29
+ # @option arguments [Array<String>] :source_engines
30
30
  # @option arguments [Hash] :headers optional HTTP headers to send with the request
31
31
  #
32
32
  # @see https://www.elastic.co/guide/en/app-search/current/meta-engines.html#meta-engines-remove-source-engines
@@ -36,7 +36,6 @@ module Elastic
36
36
 
37
37
  source_engines = arguments.delete(:source_engines) || {}
38
38
  headers = arguments.delete(:headers) || {}
39
-
40
39
  request(
41
40
  :delete,
42
41
  "api/as/v1/engines/#{engine_name}/source_engines/",
@@ -24,10 +24,9 @@ module Elastic
24
24
  # Synonyms - Delete a synonym set
25
25
  # Deletes a synonym set by ID
26
26
  #
27
- # @param engine_name [String] Name of the engine (*Required*)
28
- # @param arguments [Hash] endpoint arguments
27
+ # @param [String] engine_name Name of the engine (*Required*)
28
+ # @param [Hash] arguments endpoint arguments
29
29
  # @option arguments [String] :synonym_set_id Synonym Set ID (*Required*)
30
- # @option arguments [Hash] :body The request body
31
30
  # @option arguments [Hash] :headers optional HTTP headers to send with the request
32
31
  #
33
32
  # @see https://www.elastic.co/guide/en/app-search/current/synonyms.html#synonyms-delete
@@ -36,15 +35,13 @@ module Elastic
36
35
  raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
37
36
  raise ArgumentError, "Required parameter 'synonym_set_id' missing" unless arguments[:synonym_set_id]
38
37
 
39
- synonym_set_id = arguments[:synonym_set_id]
40
- body = arguments.delete(:body) || {}
38
+ synonym_set_id = arguments.delete(:synonym_set_id)
41
39
  headers = arguments.delete(:headers) || {}
42
-
43
40
  request(
44
41
  :delete,
45
42
  "api/as/v1/engines/#{engine_name}/synonyms/#{synonym_set_id}/",
46
43
  arguments,
47
- body,
44
+ nil,
48
45
  headers
49
46
  )
50
47
  end
@@ -24,20 +24,19 @@ module Elastic
24
24
  # Documents - Retrieve one or more documents
25
25
  # Retrieves one or more documents by id
26
26
  #
27
- # @param engine_name [String] Name of the engine (*Required*)
28
- # @param arguments [Hash] endpoint arguments
29
- # @option arguments [Array] :document_ids List of document IDs (*Required*)
27
+ # @param [String] engine_name Name of the engine (*Required*)
28
+ # @param [Hash] arguments endpoint arguments
29
+ # @option arguments [Array] :ids[] List of Document IDs to fetch
30
+ # @option arguments [Array<String>] :document_ids
30
31
  # @option arguments [Hash] :headers optional HTTP headers to send with the request
31
32
  #
32
33
  # @see https://www.elastic.co/guide/en/app-search/current/documents.html#documents-get
33
34
  #
34
35
  def documents(engine_name, arguments = {})
35
36
  raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
36
- raise ArgumentError, "Required parameter 'document_ids' missing" unless arguments[:document_ids]
37
37
 
38
38
  document_ids = arguments.delete(:document_ids) || {}
39
39
  headers = arguments.delete(:headers) || {}
40
-
41
40
  request(
42
41
  :get,
43
42
  "api/as/v1/engines/#{engine_name}/documents/",
@@ -24,9 +24,8 @@ module Elastic
24
24
  # Engines - Retrieve an engine
25
25
  # Retrieves details of a given engine by its name
26
26
  #
27
- # @param engine_name [String] Name of the engine (*Required*)
28
- # @param arguments [Hash] endpoint arguments
29
- # @option arguments [Hash] :body The request body
27
+ # @param [String] engine_name Name of the engine (*Required*)
28
+ # @param [Hash] arguments endpoint arguments
30
29
  # @option arguments [Hash] :headers optional HTTP headers to send with the request
31
30
  #
32
31
  # @see https://www.elastic.co/guide/en/app-search/current/engines.html#engines-get
@@ -34,14 +33,12 @@ module Elastic
34
33
  def engine(engine_name, arguments = {})
35
34
  raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
36
35
 
37
- body = arguments.delete(:body) || {}
38
36
  headers = arguments.delete(:headers) || {}
39
-
40
37
  request(
41
38
  :get,
42
39
  "api/as/v1/engines/#{engine_name}/",
43
40
  arguments,
44
- body,
41
+ nil,
45
42
  headers
46
43
  )
47
44
  end
@@ -24,20 +24,18 @@ module Elastic
24
24
  # Documents - Create a new document
25
25
  # Create or update documents
26
26
  #
27
- # @param engine_name [String] Name of the engine (*Required*)
28
- # @param arguments [Hash] endpoint arguments
29
- # @option arguments [Array] :documents List of document to index (*Required*)
27
+ # @param [String] engine_name Name of the engine (*Required*)
28
+ # @param [Hash] arguments endpoint arguments
29
+ # @option arguments [Array<Hash> { id: [string] }] :documents
30
30
  # @option arguments [Hash] :headers optional HTTP headers to send with the request
31
31
  #
32
32
  # @see https://www.elastic.co/guide/en/app-search/current/documents.html#documents-create
33
33
  #
34
34
  def index_documents(engine_name, arguments = {})
35
35
  raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
36
- raise ArgumentError, "Required parameter 'documents' missing" unless arguments[:documents]
37
36
 
38
37
  documents = arguments.delete(:documents) || {}
39
38
  headers = arguments.delete(:headers) || {}
40
-
41
39
  request(
42
40
  :post,
43
41
  "api/as/v1/engines/#{engine_name}/documents/",
@@ -19,30 +19,28 @@
19
19
 
20
20
  module Elastic
21
21
  module EnterpriseSearch
22
- module WorkplaceSearch
22
+ module AppSearch
23
23
  module Actions
24
- # Permissions - Removes one or more permissions from an existing set of permissions
25
- # Remove one or more permission for a given user
24
+ # AdaptiveRelevanceSuggestions - Retrieve adaptive relevance
25
+ # Retrieve adaptive relevance
26
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 [String] :user The username in context (*Required*)
30
- # @option arguments [Array] :body List of permissions
27
+ # @param [String] engine_name Name of the engine (*Required*)
28
+ # @param [Hash] arguments endpoint arguments
29
+ # @option arguments [Hash] :body
30
+ # @option body :page
31
+ # @option body [string] :filters
31
32
  # @option arguments [Hash] :headers optional HTTP headers to send with the request
32
33
  #
33
- # @see https://www.elastic.co/guide/en/workplace-search/current/workplace-search-document-permissions-api.html#remove-one
34
+ # @see https://www.elastic.co/guide/en/app-search/current/adaptive-relevance-api-reference.html#adaptive-relevance-api-get-engine-adaptive-relevance-suggestions
34
35
  #
35
- def remove_user_permissions(content_source_id, arguments = {})
36
- raise ArgumentError, "Required parameter 'content_source_id' missing" unless content_source_id
37
- raise ArgumentError, "Required parameter 'user' missing" unless arguments[:user]
36
+ def list_adaptive_relevance_suggestions(engine_name, arguments = {})
37
+ raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
38
38
 
39
- user = arguments[:user]
40
39
  body = arguments.delete(:body) || {}
41
40
  headers = arguments.delete(:headers) || {}
42
-
43
41
  request(
44
42
  :post,
45
- "api/ws/v1/sources/#{content_source_id}/permissions/#{user}/remove/",
43
+ "api/as/v0/engines/#{engine_name}/adaptive_relevance/suggestions/",
46
44
  arguments,
47
45
  body,
48
46
  headers
@@ -24,23 +24,20 @@ module Elastic
24
24
  # Credentials - Retrieve all API keys
25
25
  # List the details of all API keys
26
26
  #
27
- # @param arguments [Hash] endpoint arguments
27
+ # @param [Hash] arguments endpoint arguments
28
28
  # @option arguments [Integer] :current_page The page to fetch. Defaults to 1
29
29
  # @option arguments [Integer] :page_size The number of results per page
30
- # @option arguments [Hash] :body The request body
31
30
  # @option arguments [Hash] :headers optional HTTP headers to send with the request
32
31
  #
33
32
  # @see https://www.elastic.co/guide/en/app-search/current/credentials.html#credentials-all
34
33
  #
35
34
  def list_api_keys(arguments = {})
36
- body = arguments.delete(:body) || {}
37
35
  headers = arguments.delete(:headers) || {}
38
-
39
36
  request(
40
37
  :get,
41
38
  'api/as/v1/credentials/',
42
39
  arguments,
43
- body,
40
+ nil,
44
41
  headers
45
42
  )
46
43
  end
@@ -24,10 +24,10 @@ module Elastic
24
24
  # Crawler - List crawl requests
25
25
  # Returns a list of latest crawl requests for a given engine.
26
26
  #
27
- # @param engine_name [String] Name of the engine (*Required*)
28
- # @param arguments [Hash] endpoint arguments
29
- # @option arguments [Integer] :limit The number of results
30
- # @option arguments [Hash] :body The request body
27
+ # @param [String] engine_name Name of the engine (*Required*)
28
+ # @param [Hash] arguments endpoint arguments
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
31
  # @option arguments [Hash] :headers optional HTTP headers to send with the request
32
32
  #
33
33
  # @see https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html#web-crawler-apis-get-crawler-crawl-requests
@@ -35,14 +35,12 @@ module Elastic
35
35
  def list_crawler_crawl_requests(engine_name, arguments = {})
36
36
  raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
37
37
 
38
- body = arguments.delete(:body) || {}
39
38
  headers = arguments.delete(:headers) || {}
40
-
41
39
  request(
42
40
  :get,
43
- "api/as/v0/engines/#{engine_name}/crawler/crawl_requests/",
41
+ "api/as/v1/engines/#{engine_name}/crawler/crawl_requests/",
44
42
  arguments,
45
- body,
43
+ nil,
46
44
  headers
47
45
  )
48
46
  end
@@ -19,29 +19,28 @@
19
19
 
20
20
  module Elastic
21
21
  module EnterpriseSearch
22
- module WorkplaceSearch
22
+ module AppSearch
23
23
  module Actions
24
- # Permissions - Lists all permissions for all users
25
- # List all permissions for all users
24
+ # Crawler - List crawler domains
25
+ # Returns a list of crawler domains
26
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 [Integer] :current_page Which page of results to request
30
- # @option arguments [Integer] :page_size The number of results to return in a page
27
+ # @param [String] engine_name Name of the engine (*Required*)
28
+ # @param [Hash] arguments endpoint arguments
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
31
  # @option arguments [Hash] :headers optional HTTP headers to send with the request
32
32
  #
33
- # @see https://www.elastic.co/guide/en/workplace-search/current/workplace-search-document-permissions-api.html#list
33
+ # @see https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html#web-crawler-apis-get-crawler-domain
34
34
  #
35
- def list_permissions(content_source_id, arguments = {})
36
- raise ArgumentError, "Required parameter 'content_source_id' missing" unless content_source_id
35
+ def list_crawler_domains(engine_name, arguments = {})
36
+ raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
37
37
 
38
38
  headers = arguments.delete(:headers) || {}
39
-
40
39
  request(
41
40
  :get,
42
- "api/ws/v1/sources/#{content_source_id}/permissions/",
41
+ "api/as/v1/engines/#{engine_name}/crawler/domains/",
43
42
  arguments,
44
- {},
43
+ nil,
45
44
  headers
46
45
  )
47
46
  end
@@ -24,9 +24,10 @@ module Elastic
24
24
  # Crawler - List process crawls
25
25
  # Returns a list of latest process crawls for a given engine
26
26
  #
27
- # @param engine_name [String] Name of the engine (*Required*)
28
- # @param arguments [Hash] endpoint arguments
29
- # @option arguments [Hash] :body The request body
27
+ # @param [String] engine_name Name of the engine (*Required*)
28
+ # @param [Hash] arguments endpoint arguments
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
30
31
  # @option arguments [Hash] :headers optional HTTP headers to send with the request
31
32
  #
32
33
  # @see https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html#web-crawler-apis-get-crawler-process-crawls
@@ -34,14 +35,12 @@ module Elastic
34
35
  def list_crawler_process_crawls(engine_name, arguments = {})
35
36
  raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
36
37
 
37
- body = arguments.delete(:body) || {}
38
38
  headers = arguments.delete(:headers) || {}
39
-
40
39
  request(
41
40
  :get,
42
- "api/as/v0/engines/#{engine_name}/crawler/process_crawls/",
41
+ "api/as/v1/engines/#{engine_name}/crawler/process_crawls/",
43
42
  arguments,
44
- body,
43
+ nil,
45
44
  headers
46
45
  )
47
46
  end
@@ -24,11 +24,10 @@ module Elastic
24
24
  # Curations - Retrieve all curations
25
25
  # Retrieve available curations for the given engine
26
26
  #
27
- # @param engine_name [String] Name of the engine (*Required*)
28
- # @param arguments [Hash] endpoint arguments
27
+ # @param [String] engine_name Name of the engine (*Required*)
28
+ # @param [Hash] arguments endpoint arguments
29
29
  # @option arguments [Integer] :current_page The page to fetch. Defaults to 1
30
30
  # @option arguments [Integer] :page_size The number of results per page
31
- # @option arguments [Hash] :body The request body
32
31
  # @option arguments [Hash] :headers optional HTTP headers to send with the request
33
32
  #
34
33
  # @see https://www.elastic.co/guide/en/app-search/current/curations.html#curations-read
@@ -36,14 +35,12 @@ module Elastic
36
35
  def list_curations(engine_name, arguments = {})
37
36
  raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
38
37
 
39
- body = arguments.delete(:body) || {}
40
38
  headers = arguments.delete(:headers) || {}
41
-
42
39
  request(
43
40
  :get,
44
41
  "api/as/v1/engines/#{engine_name}/curations/",
45
42
  arguments,
46
- body,
43
+ nil,
47
44
  headers
48
45
  )
49
46
  end
@@ -24,11 +24,10 @@ module Elastic
24
24
  # Documents - Retrieve all documents
25
25
  # Lists up to 10,000 documents
26
26
  #
27
- # @param engine_name [String] Name of the engine (*Required*)
28
- # @param arguments [Hash] endpoint arguments
27
+ # @param [String] engine_name Name of the engine (*Required*)
28
+ # @param [Hash] arguments endpoint arguments
29
29
  # @option arguments [Integer] :current_page The page to fetch. Defaults to 1
30
30
  # @option arguments [Integer] :page_size The number of results per page
31
- # @option arguments [Hash] :body The request body
32
31
  # @option arguments [Hash] :headers optional HTTP headers to send with the request
33
32
  #
34
33
  # @see https://www.elastic.co/guide/en/app-search/current/documents.html#documents-list
@@ -36,14 +35,12 @@ module Elastic
36
35
  def list_documents(engine_name, arguments = {})
37
36
  raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
38
37
 
39
- body = arguments.delete(:body) || {}
40
38
  headers = arguments.delete(:headers) || {}
41
-
42
39
  request(
43
40
  :get,
44
41
  "api/as/v1/engines/#{engine_name}/documents/list/",
45
42
  arguments,
46
- body,
43
+ nil,
47
44
  headers
48
45
  )
49
46
  end
@@ -24,23 +24,20 @@ module Elastic
24
24
  # Engines - Retrieve all engines
25
25
  # Retrieves all engines with optional pagination support
26
26
  #
27
- # @param arguments [Hash] endpoint arguments
27
+ # @param [Hash] arguments endpoint arguments
28
28
  # @option arguments [Integer] :current_page The page to fetch. Defaults to 1
29
29
  # @option arguments [Integer] :page_size The number of results per page
30
- # @option arguments [Hash] :body The request body
31
30
  # @option arguments [Hash] :headers optional HTTP headers to send with the request
32
31
  #
33
32
  # @see https://www.elastic.co/guide/en/app-search/current/engines.html#engines-list
34
33
  #
35
34
  def list_engines(arguments = {})
36
- body = arguments.delete(:body) || {}
37
35
  headers = arguments.delete(:headers) || {}
38
-
39
36
  request(
40
37
  :get,
41
38
  'api/as/v1/engines/',
42
39
  arguments,
43
- body,
40
+ nil,
44
41
  headers
45
42
  )
46
43
  end
@@ -24,11 +24,10 @@ module Elastic
24
24
  # Synonyms - Retrieve all synonym sets
25
25
  # Retrieves all available synonym sets for the engine
26
26
  #
27
- # @param engine_name [String] Name of the engine (*Required*)
28
- # @param arguments [Hash] endpoint arguments
27
+ # @param [String] engine_name Name of the engine (*Required*)
28
+ # @param [Hash] arguments endpoint arguments
29
29
  # @option arguments [Integer] :current_page The page to fetch. Defaults to 1
30
30
  # @option arguments [Integer] :page_size The number of results per page
31
- # @option arguments [Hash] :body The request body
32
31
  # @option arguments [Hash] :headers optional HTTP headers to send with the request
33
32
  #
34
33
  # @see https://www.elastic.co/guide/en/app-search/current/synonyms.html#synonyms-get
@@ -36,14 +35,12 @@ module Elastic
36
35
  def list_synonym_sets(engine_name, arguments = {})
37
36
  raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
38
37
 
39
- body = arguments.delete(:body) || {}
40
38
  headers = arguments.delete(:headers) || {}
41
-
42
39
  request(
43
40
  :get,
44
41
  "api/as/v1/engines/#{engine_name}/synonyms/",
45
42
  arguments,
46
- body,
43
+ nil,
47
44
  headers
48
45
  )
49
46
  end
@@ -24,23 +24,23 @@ module Elastic
24
24
  # Click - Tracks results that were clicked after a query
25
25
  # Tracks results that were clicked after a query
26
26
  #
27
- # @param engine_name [String] Name of the engine (*Required*)
28
- # @param arguments [Hash] endpoint arguments
29
- # @option arguments :body Search request parameters
30
- # @option body [String] :query Search query text (*Required*)
31
- # @option body [String] :document_id The id of the document that was clicked on (*Required*)
32
- # @option body [String] :request_id The request id returned in the meta tag of a search API response
33
- # @option body [Array] :tags Array of strings representing additional information you wish to track with the clickthrough. You may submit up to 16 tags, and each may be up to 64 characters in length.
27
+ # @param [String] engine_name Name of the engine (*Required*)
28
+ # @param [Hash] arguments endpoint arguments
29
+ # @option arguments [Hash] :body (Required: query, document_id)
30
+ # @option body [string] :query
31
+ # @option body [string] :request_id
32
+ # @option body :document_id
33
+ # @option body [Array<string>] :tags
34
34
  # @option arguments [Hash] :headers optional HTTP headers to send with the request
35
35
  #
36
36
  # @see https://www.elastic.co/guide/en/app-search/current/clickthrough.html
37
37
  #
38
38
  def log_clickthrough(engine_name, arguments = {})
39
39
  raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
40
+ raise ArgumentError, "Required parameter 'body (query,document_id)' missing" unless arguments[:body]
40
41
 
41
42
  body = arguments.delete(:body) || {}
42
43
  headers = arguments.delete(:headers) || {}
43
-
44
44
  request(
45
45
  :post,
46
46
  "api/as/v1/engines/#{engine_name}/click/",
@@ -19,30 +19,28 @@
19
19
 
20
20
  module Elastic
21
21
  module EnterpriseSearch
22
- module WorkplaceSearch
22
+ module AppSearch
23
23
  module Actions
24
- # Permissions - Creates a new set of permissions or over-writes all existing permissions
25
- # Create a set of permissions or overwrite existing permissions
24
+ # AdaptiveRelevanceSettings - Update adaptive relevance settings
25
+ # Update adaptive relevance settings
26
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 [String] :user The username in context (*Required*)
30
- # @option arguments [Array] :body List of permissions
27
+ # @param [String] engine_name Name of the engine (*Required*)
28
+ # @param [Hash] arguments endpoint arguments
29
+ # @option arguments [Hash] :body (Required: curation)
30
+ # @option body [Hash] :curation (Required: )
31
31
  # @option arguments [Hash] :headers optional HTTP headers to send with the request
32
32
  #
33
- # @see https://www.elastic.co/guide/en/workplace-search/current/workplace-search-document-permissions-api.html#add-all
33
+ # @see https://www.elastic.co/guide/en/app-search/current/adaptive-relevance-api-reference.html#adaptive-relevance-api-put-engine-adaptive-relevance-settings
34
34
  #
35
- def put_user_permissions(content_source_id, arguments = {})
36
- raise ArgumentError, "Required parameter 'content_source_id' missing" unless content_source_id
37
- raise ArgumentError, "Required parameter 'user' missing" unless arguments[:user]
35
+ def put_adaptive_relevance_settings(engine_name, arguments = {})
36
+ raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
37
+ raise ArgumentError, "Required parameter 'body (curation)' missing" unless arguments[:body]
38
38
 
39
- user = arguments[:user]
40
39
  body = arguments.delete(:body) || {}
41
40
  headers = arguments.delete(:headers) || {}
42
-
43
41
  request(
44
42
  :put,
45
- "api/ws/v1/sources/#{content_source_id}/permissions/#{user}/",
43
+ "api/as/v0/engines/#{engine_name}/adaptive_relevance/settings/",
46
44
  arguments,
47
45
  body,
48
46
  headers
@@ -0,0 +1,50 @@
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
+ module Actions
24
+ # AdaptiveRelevanceSuggestions - Update adaptive relevance
25
+ # Update adaptive relevance
26
+ #
27
+ # @param [String] engine_name Name of the engine (*Required*)
28
+ # @param [Hash] arguments endpoint arguments
29
+ # @option arguments [Array<Hash> { query: [string] }, { type: [] }, { status: [] }] :body
30
+ # @option arguments [Hash] :headers optional HTTP headers to send with the request
31
+ #
32
+ # @see https://www.elastic.co/guide/en/app-search/current/adaptive-relevance-api-reference.html#adaptive-relevance-api-put-engine-adaptive-relevance-suggestions
33
+ #
34
+ def put_adaptive_relevance_suggestions(engine_name, arguments = {})
35
+ raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
36
+
37
+ body = arguments.delete(:body) || {}
38
+ headers = arguments.delete(:headers) || {}
39
+ request(
40
+ :put,
41
+ "api/as/v0/engines/#{engine_name}/adaptive_relevance/suggestions/",
42
+ arguments,
43
+ body,
44
+ headers
45
+ )
46
+ end
47
+ end
48
+ end
49
+ end
50
+ end