elastic-enterprise-search 8.2.1 → 8.3.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (125) hide show
  1. checksums.yaml +4 -4
  2. data/.ci/jobs/elastic+enterprise-search-ruby+8.1.yml +12 -0
  3. data/.ci/jobs/elastic+enterprise-search-ruby+8.2.yml +12 -0
  4. data/.ci/test-matrix.yml +1 -1
  5. data/docs/guide/connecting.asciidoc +14 -0
  6. data/docs/guide/enterprise-search-api.asciidoc +17 -2
  7. data/docs/guide/index.asciidoc +1 -1
  8. data/docs/guide/overview.asciidoc +4 -2
  9. data/lib/elastic/app-search/api/adaptive_relevance_settings.rb +1 -0
  10. data/lib/elastic/app-search/api/adaptive_relevance_suggestions.rb +1 -0
  11. data/lib/elastic/app-search/api/add_meta_engine_source.rb +1 -0
  12. data/lib/elastic/app-search/api/api_key.rb +1 -0
  13. data/lib/elastic/app-search/api/api_logs.rb +1 -0
  14. data/lib/elastic/app-search/api/count_analytics.rb +1 -0
  15. data/lib/elastic/app-search/api/crawler_active_crawl_request.rb +1 -0
  16. data/lib/elastic/app-search/api/crawler_crawl_request.rb +1 -0
  17. data/lib/elastic/app-search/api/crawler_crawl_schedule.rb +1 -0
  18. data/lib/elastic/app-search/api/crawler_domain.rb +1 -0
  19. data/lib/elastic/app-search/api/crawler_domain_validation_result.rb +1 -0
  20. data/lib/elastic/app-search/api/crawler_metrics.rb +1 -0
  21. data/lib/elastic/app-search/api/crawler_overview.rb +1 -0
  22. data/lib/elastic/app-search/api/crawler_process_crawl.rb +1 -0
  23. data/lib/elastic/app-search/api/crawler_process_crawl_denied_urls.rb +1 -0
  24. data/lib/elastic/app-search/api/crawler_url_extraction_result.rb +1 -0
  25. data/lib/elastic/app-search/api/crawler_url_tracing_result.rb +1 -0
  26. data/lib/elastic/app-search/api/crawler_url_validation_result.rb +1 -0
  27. data/lib/elastic/app-search/api/crawler_user_agent.rb +1 -0
  28. data/lib/elastic/app-search/api/create_api_key.rb +1 -0
  29. data/lib/elastic/app-search/api/create_crawler_crawl_request.rb +1 -0
  30. data/lib/elastic/app-search/api/create_crawler_crawl_rule.rb +1 -0
  31. data/lib/elastic/app-search/api/create_crawler_domain.rb +1 -0
  32. data/lib/elastic/app-search/api/create_crawler_entry_point.rb +1 -0
  33. data/lib/elastic/app-search/api/create_crawler_process_crawl.rb +1 -0
  34. data/lib/elastic/app-search/api/create_crawler_sitemap.rb +1 -0
  35. data/lib/elastic/app-search/api/create_curation.rb +1 -0
  36. data/lib/elastic/app-search/api/create_engine.rb +1 -0
  37. data/lib/elastic/app-search/api/create_synonym_set.rb +1 -0
  38. data/lib/elastic/app-search/api/curation.rb +1 -0
  39. data/lib/elastic/app-search/api/delete_api_key.rb +1 -0
  40. data/lib/elastic/app-search/api/delete_crawler_active_crawl_request.rb +1 -0
  41. data/lib/elastic/app-search/api/delete_crawler_crawl_rule.rb +1 -0
  42. data/lib/elastic/app-search/api/delete_crawler_crawl_schedule.rb +1 -0
  43. data/lib/elastic/app-search/api/delete_crawler_domain.rb +1 -0
  44. data/lib/elastic/app-search/api/delete_crawler_entry_point.rb +1 -0
  45. data/lib/elastic/app-search/api/delete_crawler_sitemap.rb +1 -0
  46. data/lib/elastic/app-search/api/delete_curation.rb +1 -0
  47. data/lib/elastic/app-search/api/delete_documents.rb +1 -0
  48. data/lib/elastic/app-search/api/delete_engine.rb +1 -0
  49. data/lib/elastic/app-search/api/delete_meta_engine_source.rb +1 -0
  50. data/lib/elastic/app-search/api/delete_synonym_set.rb +1 -0
  51. data/lib/elastic/app-search/api/documents.rb +1 -0
  52. data/lib/elastic/app-search/api/engine.rb +1 -0
  53. data/lib/elastic/app-search/api/index_documents.rb +1 -0
  54. data/lib/elastic/app-search/api/list_adaptive_relevance_suggestions.rb +1 -0
  55. data/lib/elastic/app-search/api/list_api_keys.rb +1 -0
  56. data/lib/elastic/app-search/api/list_crawler_crawl_requests.rb +1 -0
  57. data/lib/elastic/app-search/api/list_crawler_domains.rb +1 -0
  58. data/lib/elastic/app-search/api/list_crawler_process_crawls.rb +1 -0
  59. data/lib/elastic/app-search/api/list_curations.rb +1 -0
  60. data/lib/elastic/app-search/api/list_documents.rb +1 -0
  61. data/lib/elastic/app-search/api/list_engines.rb +1 -0
  62. data/lib/elastic/app-search/api/list_synonym_sets.rb +1 -0
  63. data/lib/elastic/app-search/api/log_clickthrough.rb +1 -0
  64. data/lib/elastic/app-search/api/multi_search.rb +8 -6
  65. data/lib/elastic/app-search/api/put_adaptive_relevance_settings.rb +1 -0
  66. data/lib/elastic/app-search/api/put_adaptive_relevance_suggestions.rb +1 -0
  67. data/lib/elastic/app-search/api/put_api_key.rb +1 -0
  68. data/lib/elastic/app-search/api/put_crawler_crawl_rule.rb +1 -0
  69. data/lib/elastic/app-search/api/put_crawler_crawl_schedule.rb +1 -0
  70. data/lib/elastic/app-search/api/put_crawler_domain.rb +1 -0
  71. data/lib/elastic/app-search/api/put_crawler_entry_point.rb +1 -0
  72. data/lib/elastic/app-search/api/put_crawler_sitemap.rb +1 -0
  73. data/lib/elastic/app-search/api/put_curation.rb +1 -0
  74. data/lib/elastic/app-search/api/put_documents.rb +1 -0
  75. data/lib/elastic/app-search/api/put_schema.rb +1 -0
  76. data/lib/elastic/app-search/api/put_search_settings.rb +1 -0
  77. data/lib/elastic/app-search/api/put_synonym_set.rb +1 -0
  78. data/lib/elastic/app-search/api/query_suggestion.rb +1 -0
  79. data/lib/elastic/app-search/api/refresh_adaptive_relevance_update_process.rb +1 -0
  80. data/lib/elastic/app-search/api/reset_search_settings.rb +1 -0
  81. data/lib/elastic/app-search/api/schema.rb +1 -0
  82. data/lib/elastic/app-search/api/search.rb +1 -0
  83. data/lib/elastic/app-search/api/search_es_search.rb +1 -0
  84. data/lib/elastic/app-search/api/search_explain.rb +1 -0
  85. data/lib/elastic/app-search/api/search_settings.rb +1 -0
  86. data/lib/elastic/app-search/api/synonym_set.rb +1 -0
  87. data/lib/elastic/app-search/api/top_clicks_analytics.rb +1 -0
  88. data/lib/elastic/app-search/api/top_queries_analytics.rb +1 -0
  89. data/lib/elastic/enterprise-search/api/health.rb +1 -0
  90. data/lib/elastic/enterprise-search/api/put_read_only.rb +1 -0
  91. data/lib/elastic/enterprise-search/api/read_only.rb +1 -0
  92. data/lib/elastic/enterprise-search/api/search_engines.rb +44 -0
  93. data/lib/elastic/enterprise-search/api/stats.rb +1 -0
  94. data/lib/elastic/enterprise-search/api/version.rb +1 -0
  95. data/lib/elastic/enterprise-search/version.rb +1 -1
  96. data/lib/elastic/workplace-search/api/auto_query_refinement_details.rb +1 -0
  97. data/lib/elastic/workplace-search/api/command_sync_jobs.rb +1 -0
  98. data/lib/elastic/workplace-search/api/content_source.rb +1 -0
  99. data/lib/elastic/workplace-search/api/create_analytics_event.rb +1 -0
  100. data/lib/elastic/workplace-search/api/create_batch_synonym_sets.rb +1 -0
  101. data/lib/elastic/workplace-search/api/create_content_source.rb +1 -0
  102. data/lib/elastic/workplace-search/api/create_external_identity.rb +1 -0
  103. data/lib/elastic/workplace-search/api/current_user.rb +1 -0
  104. data/lib/elastic/workplace-search/api/delete_content_source.rb +1 -0
  105. data/lib/elastic/workplace-search/api/delete_documents.rb +1 -0
  106. data/lib/elastic/workplace-search/api/delete_documents_by_query.rb +1 -0
  107. data/lib/elastic/workplace-search/api/delete_external_identity.rb +1 -0
  108. data/lib/elastic/workplace-search/api/delete_synonym_set.rb +1 -0
  109. data/lib/elastic/workplace-search/api/document.rb +1 -0
  110. data/lib/elastic/workplace-search/api/external_identity.rb +1 -0
  111. data/lib/elastic/workplace-search/api/index_documents.rb +1 -0
  112. data/lib/elastic/workplace-search/api/list_content_sources.rb +1 -0
  113. data/lib/elastic/workplace-search/api/list_documents.rb +1 -0
  114. data/lib/elastic/workplace-search/api/list_external_identities.rb +1 -0
  115. data/lib/elastic/workplace-search/api/list_synonym_sets.rb +1 -0
  116. data/lib/elastic/workplace-search/api/put_content_source.rb +1 -0
  117. data/lib/elastic/workplace-search/api/put_content_source_icons.rb +1 -0
  118. data/lib/elastic/workplace-search/api/put_external_identity.rb +1 -0
  119. data/lib/elastic/workplace-search/api/put_synonym_set.rb +1 -0
  120. data/lib/elastic/workplace-search/api/put_triggers_blocklist.rb +1 -0
  121. data/lib/elastic/workplace-search/api/search.rb +1 -0
  122. data/lib/elastic/workplace-search/api/synonym_set.rb +1 -0
  123. data/lib/elastic/workplace-search/api/triggers_blocklist.rb +1 -0
  124. data/spec/integration/enterprise_search_api_spec.rb +11 -0
  125. metadata +5 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: f6d66a77dd32e97bc9bb48101c97ee7b96d3ffef54db3779866a7371ab131523
4
- data.tar.gz: 3b31e2deec924443691908abef0be3ed985e09282074e1c3fd37ac1b87b3d67f
3
+ metadata.gz: 95fb62ab62fbcabaccdcdbebc1b8caf15fbfe6ca1cec388af5778da738ce0aff
4
+ data.tar.gz: 1ce82e08b5ab98ea8a0ea47076806b709e765b98b01d6ecb1c1a3284b3660922
5
5
  SHA512:
6
- metadata.gz: '060287850883e09c45626b58b282c06d6aa52a177a915636459a452aec11d96ecda0e17bd8ba8c47546543a483761bbadd40ec16da2def6e4bccfcbbc0696cb8'
7
- data.tar.gz: 372c2381a0fe668b9fb160b0e0d9eb407607df1f36b49faff209c1a73fa71cc742b0619ccc0f997683e8193f4e15d7f4e60b8b37c3547103d46a46729240da4c
6
+ metadata.gz: 6681c1fb77c29e120cc726345bc97e244aada238720255ad375bf8e6447beb31b4bbeb6283f4153196c6be42f8a807e1b234dd3caa064d5d2fd4da021965e800
7
+ data.tar.gz: df33f6629dcf8b0ec537b47619fbcce2327cb715a69536df22ed6693429948874c49f2728504a0ae11c351d73020865f77e42ca3addfe0226ba7e1ce570da021
@@ -0,0 +1,12 @@
1
+ ---
2
+ - job:
3
+ name: elastic+enterprise-search-ruby+8.1
4
+ display-name: 'elastic / enterprise-search-ruby # 8.1'
5
+ description: Testing the enterprise-search-ruby 8.1 branch.
6
+ junit_results: "*-junit.xml"
7
+ parameters:
8
+ - string:
9
+ name: branch_specifier
10
+ default: refs/heads/8.1
11
+ description: the Git branch specifier to build (<branchName>, <tagName>,
12
+ <commitId>, etc.)
@@ -0,0 +1,12 @@
1
+ ---
2
+ - job:
3
+ name: elastic+enterprise-search-ruby+8.2
4
+ display-name: 'elastic / enterprise-search-ruby # 8.2'
5
+ description: Testing the enterprise-search-ruby 8.2 branch.
6
+ junit_results: "*-junit.xml"
7
+ parameters:
8
+ - string:
9
+ name: branch_specifier
10
+ default: refs/heads/8.2
11
+ description: the Git branch specifier to build (<branchName>, <tagName>,
12
+ <commitId>, etc.)
data/.ci/test-matrix.yml CHANGED
@@ -5,7 +5,7 @@ RUBY_VERSION:
5
5
  - 2.7
6
6
 
7
7
  STACK_VERSION:
8
- - 8.2.0-SNAPSHOT
8
+ - 8.3-SNAPSHOT
9
9
 
10
10
  SERVICE:
11
11
  - appsearch
@@ -7,6 +7,7 @@ This page contains the information you need to connect and use the Client with E
7
7
 
8
8
  * <<authentication>>
9
9
  * <<custom_headers>>
10
+ * <<transport>>
10
11
 
11
12
 
12
13
  [discrete]
@@ -168,3 +169,16 @@ workplace_search_client.index_documents(
168
169
  { body: documents, headers: headers }
169
170
  )
170
171
  ----------------------------
172
+
173
+ [discrete]
174
+ [[transport]]
175
+ === Transport
176
+
177
+ The Enterprise Search Ruby client is powered by the https://github.com/elastic/elastic-transport-ruby/[`elastic-transport`] gem. You can read more about it https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/transport.html[here]. The client accepts a transport object as an initializer:
178
+
179
+ [source,rb]
180
+ ----------------------------
181
+ transport = Elastic::Transport::Transport::HTTP::Curb.new
182
+ ent_client = Elastic::EnterpriseSearch::Client.new(transport: transport)
183
+ ----------------------------
184
+
@@ -3,6 +3,8 @@
3
3
 
4
4
  === Health API
5
5
 
6
+ Get information on the health of a deployment and basic statistics around resource usage.
7
+
6
8
  [source,rb]
7
9
  ----------------------------
8
10
  > response = ent_client.health
@@ -17,6 +19,8 @@
17
19
 
18
20
  === Version API
19
21
 
22
+ Get version information for the server.
23
+
20
24
  [source,rb]
21
25
  ----------------------------
22
26
  > response = ent_client.version
@@ -29,14 +33,16 @@
29
33
  [source,rb]
30
34
  ----------------------------
31
35
  # Set read-only flag state
32
- ent_client.put_read_only(body: { enabled: false })
36
+ > ent_client.put_read_only(body: { enabled: false })
33
37
 
34
38
  # Get read-only flag state
35
- ent_client.read_only
39
+ > ent_client.read_only
36
40
  ----------------------------
37
41
 
38
42
  === Stats API
39
43
 
44
+ Get information about the resource usage of the application, the state of different internal queues, etc.
45
+
40
46
  [source,rb]
41
47
  ----------------------------
42
48
  > ent_client.stats.body
@@ -44,3 +50,12 @@ ent_client.read_only
44
50
  "queues"=>{"connectors"=>{...}, "document_destroyer"=>{...}, "engine_destroyer"=>{...}, "index_adder"=>{...}, ...},
45
51
  "connectors"=>{"alive"=>true, "pool"=>{...}, "job_store"=>{...}}}}
46
52
  ----------------------------
53
+
54
+ === Search Engines
55
+
56
+ Retrieve information about search engines
57
+
58
+ [source,rb]
59
+ ----------------------------
60
+ > ent_client.search_engines
61
+ ----------------------------
@@ -1,4 +1,4 @@
1
- = enterprise-search-ruby
1
+ = Enterprise Search Ruby client
2
2
 
3
3
  :doctype: book
4
4
 
@@ -10,7 +10,9 @@ Current development happens in the main branch.
10
10
 
11
11
  The library is compatible with all Elastic Enterprise Search versions since `7.x` but you **have to use a matching major version**:
12
12
 
13
- For **Elastic Enterprise Search 7.0** and later, use the major version 7 (`7.x.y`) of the library.
13
+ * For **Elastic Enterprise Search 7.0** and later, use the major version 7 (`7.x.y`) of the library.
14
+ * For **Elastic Enterprise Search 8.0** and later, use the major version 8 (`8.x.y`) of the library.
15
+
14
16
 
15
17
  [discrete]
16
18
  === HTTP Library
@@ -27,7 +29,7 @@ client = Elastic::EnterpriseSearch::Client.new(adapter: :net_http_persistent)
27
29
 
28
30
  All requests, if successful, will return an `Elastic::Transport::Transport::Response` instance. You can access the response `body`, `headers` and `status`.
29
31
 
30
- `elastic-transport` defines a https://github.com/elastic/elastic-transport-ruby/blob/main/lib/elastic/transport/transport/errors.rb[number of exception classes] for various client and server errors, as well as unsuccessful HTTP responses, making it possible to rescue specific exceptions with desired granularity. More details https://github.com/elastic/elastic-transport-ruby#exception-handling[here]. You can find the full documentation for `elastic-transport` at https://rubydoc.info/gems/elastic-transport[RubyDoc].
32
+ `elastic-transport` defines a https://github.com/elastic/elastic-transport-ruby/blob/main/lib/elastic/transport/transport/errors.rb[number of exception classes] for various client and server errors, as well as unsuccessful HTTP responses, making it possible to rescue specific exceptions with desired granularity. More details https://github.com/elastic/elastic-transport-ruby#exception-handling[here]. You can find the full documentation for `elastic-transport` at https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/transport.html[our official documentation] and https://rubydoc.info/gems/elastic-transport[RubyDoc].
31
33
 
32
34
  The clients pass different options to transport, you can check them out https://rubydoc.info/github/elastic/enterprise-search-ruby/Elastic/EnterpriseSearch/Client[on RubyDocs].
33
35
 
@@ -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
  # Retrieve 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 - Retrieve adaptive relevance
25
26
  # Retrieve adaptive relevance for a single query
@@ -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 - Add a source engine
25
26
  # Adds a source engine to 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
  # Credentials - Retrieve an API key
25
26
  # Retrieves details of 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
  # APILogs - Retrieve API logs
25
26
  # The API Log displays API request and response data at the Engine level
@@ -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 counts data
25
26
  # Returns the number of clicks and total number of queries over a period
@@ -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 - Get active crawl request details
25
26
  # Returns active crawl request details.
@@ -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 - Get crawl request details
25
26
  # Returns crawl request details.
@@ -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 - Get crawl schedule
25
26
  # Returns the current 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 - Get domain configuration
25
26
  # Returns crawler domain configuration details
@@ -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 - Validate Domain with Crawler
25
26
  # Performs a number of checks on a given domain name to make sure it is ready to be crawled and ingested into App 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
  # Crawler - Retrieve a snapshot of crawler metrics
25
26
  # Retrieves a momentary snapshot of key crawler metrics, including global and node-level crawler health
@@ -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 - Retrieve crawler configuration overview
25
26
  # Retrieves crawler configuration overview of a given engine, including configured 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 - Get process crawl details
25
26
  # Returns process crawl details.
@@ -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 - View denied urls for Process Crawl
25
26
  # Provides a sample list of urls identified for deletion by the given process crawl 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
  # Crawler - Extract content from a URL
25
26
  # Performs an HTTP request to a given URL and extracts content from the page using standard App Search Crawler extraction pipeline.
@@ -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 - Trace a history of a crawled URL
25
26
  # Returns information about the history of a given URL with the App Search Crawler.
@@ -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 - Validate URL with Crawler
25
26
  # Performs a number of checks on a given URL to make sure it is ready to be crawled and ingested into App 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
  # Crawler - Get the User-Agent header value for the crawler
25
26
  # Retrieves the currently configured value for the User-Agent header used for all Crawler HTTP requests
@@ -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 - Create an API key
25
26
  # Creates an App Search 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 - Create a crawl request
25
26
  # Creates a request to perform a crawl of a given engine with the Crawler.
@@ -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 - Create a crawl rule
25
26
  # Creates a crawl rule for a given engine and 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 - Create a crawler domain
25
26
  # Creates a crawler domain configuration 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 - Create a crawler entry point
25
26
  # Creates a crawler domain entry point for a given engine and 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 - Create a process crawl
25
26
  # Queues a task to reprocess crawled documents with current crawl 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 - Create a crawler sitemap
25
26
  # Creates a crawler sitemap configuration for a given engine and 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 - Create a new curation
25
26
  # Create a new curation 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
  # Engines - Create an Engine
25
26
  # Creates an App Search 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 - Create a synonym set
25
26
  # Creates a new synonym set 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
  # Curations - Retrieve a curation
25
26
  # Retrieves a curation 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
  # Credentials - Delete an API key
25
26
  # Deletes a given 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 - Cancel an active crawl request
25
26
  # Cancels an active crawl request, stopping a running crawl if needed.
@@ -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 crawl rule
25
26
  # Deletes a crawl rule 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
  # Crawler - Delete a crawl schedule
25
26
  # Deletes 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 - Delete domain configuration
25
26
  # Deletes 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 - 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
@@ -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