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.
- checksums.yaml +4 -4
- data/.ci/jobs/elastic+enterprise-search-ruby+8.1.yml +12 -0
- data/.ci/jobs/elastic+enterprise-search-ruby+8.2.yml +12 -0
- data/.ci/test-matrix.yml +1 -1
- data/docs/guide/connecting.asciidoc +14 -0
- data/docs/guide/enterprise-search-api.asciidoc +17 -2
- data/docs/guide/index.asciidoc +1 -1
- data/docs/guide/overview.asciidoc +4 -2
- data/lib/elastic/app-search/api/adaptive_relevance_settings.rb +1 -0
- data/lib/elastic/app-search/api/adaptive_relevance_suggestions.rb +1 -0
- data/lib/elastic/app-search/api/add_meta_engine_source.rb +1 -0
- data/lib/elastic/app-search/api/api_key.rb +1 -0
- data/lib/elastic/app-search/api/api_logs.rb +1 -0
- data/lib/elastic/app-search/api/count_analytics.rb +1 -0
- data/lib/elastic/app-search/api/crawler_active_crawl_request.rb +1 -0
- data/lib/elastic/app-search/api/crawler_crawl_request.rb +1 -0
- data/lib/elastic/app-search/api/crawler_crawl_schedule.rb +1 -0
- data/lib/elastic/app-search/api/crawler_domain.rb +1 -0
- data/lib/elastic/app-search/api/crawler_domain_validation_result.rb +1 -0
- data/lib/elastic/app-search/api/crawler_metrics.rb +1 -0
- data/lib/elastic/app-search/api/crawler_overview.rb +1 -0
- data/lib/elastic/app-search/api/crawler_process_crawl.rb +1 -0
- data/lib/elastic/app-search/api/crawler_process_crawl_denied_urls.rb +1 -0
- data/lib/elastic/app-search/api/crawler_url_extraction_result.rb +1 -0
- data/lib/elastic/app-search/api/crawler_url_tracing_result.rb +1 -0
- data/lib/elastic/app-search/api/crawler_url_validation_result.rb +1 -0
- data/lib/elastic/app-search/api/crawler_user_agent.rb +1 -0
- data/lib/elastic/app-search/api/create_api_key.rb +1 -0
- data/lib/elastic/app-search/api/create_crawler_crawl_request.rb +1 -0
- data/lib/elastic/app-search/api/create_crawler_crawl_rule.rb +1 -0
- data/lib/elastic/app-search/api/create_crawler_domain.rb +1 -0
- data/lib/elastic/app-search/api/create_crawler_entry_point.rb +1 -0
- data/lib/elastic/app-search/api/create_crawler_process_crawl.rb +1 -0
- data/lib/elastic/app-search/api/create_crawler_sitemap.rb +1 -0
- data/lib/elastic/app-search/api/create_curation.rb +1 -0
- data/lib/elastic/app-search/api/create_engine.rb +1 -0
- data/lib/elastic/app-search/api/create_synonym_set.rb +1 -0
- data/lib/elastic/app-search/api/curation.rb +1 -0
- data/lib/elastic/app-search/api/delete_api_key.rb +1 -0
- data/lib/elastic/app-search/api/delete_crawler_active_crawl_request.rb +1 -0
- data/lib/elastic/app-search/api/delete_crawler_crawl_rule.rb +1 -0
- data/lib/elastic/app-search/api/delete_crawler_crawl_schedule.rb +1 -0
- data/lib/elastic/app-search/api/delete_crawler_domain.rb +1 -0
- data/lib/elastic/app-search/api/delete_crawler_entry_point.rb +1 -0
- data/lib/elastic/app-search/api/delete_crawler_sitemap.rb +1 -0
- data/lib/elastic/app-search/api/delete_curation.rb +1 -0
- data/lib/elastic/app-search/api/delete_documents.rb +1 -0
- data/lib/elastic/app-search/api/delete_engine.rb +1 -0
- data/lib/elastic/app-search/api/delete_meta_engine_source.rb +1 -0
- data/lib/elastic/app-search/api/delete_synonym_set.rb +1 -0
- data/lib/elastic/app-search/api/documents.rb +1 -0
- data/lib/elastic/app-search/api/engine.rb +1 -0
- data/lib/elastic/app-search/api/index_documents.rb +1 -0
- data/lib/elastic/app-search/api/list_adaptive_relevance_suggestions.rb +1 -0
- data/lib/elastic/app-search/api/list_api_keys.rb +1 -0
- data/lib/elastic/app-search/api/list_crawler_crawl_requests.rb +1 -0
- data/lib/elastic/app-search/api/list_crawler_domains.rb +1 -0
- data/lib/elastic/app-search/api/list_crawler_process_crawls.rb +1 -0
- data/lib/elastic/app-search/api/list_curations.rb +1 -0
- data/lib/elastic/app-search/api/list_documents.rb +1 -0
- data/lib/elastic/app-search/api/list_engines.rb +1 -0
- data/lib/elastic/app-search/api/list_synonym_sets.rb +1 -0
- data/lib/elastic/app-search/api/log_clickthrough.rb +1 -0
- data/lib/elastic/app-search/api/multi_search.rb +8 -6
- data/lib/elastic/app-search/api/put_adaptive_relevance_settings.rb +1 -0
- data/lib/elastic/app-search/api/put_adaptive_relevance_suggestions.rb +1 -0
- data/lib/elastic/app-search/api/put_api_key.rb +1 -0
- data/lib/elastic/app-search/api/put_crawler_crawl_rule.rb +1 -0
- data/lib/elastic/app-search/api/put_crawler_crawl_schedule.rb +1 -0
- data/lib/elastic/app-search/api/put_crawler_domain.rb +1 -0
- data/lib/elastic/app-search/api/put_crawler_entry_point.rb +1 -0
- data/lib/elastic/app-search/api/put_crawler_sitemap.rb +1 -0
- data/lib/elastic/app-search/api/put_curation.rb +1 -0
- data/lib/elastic/app-search/api/put_documents.rb +1 -0
- data/lib/elastic/app-search/api/put_schema.rb +1 -0
- data/lib/elastic/app-search/api/put_search_settings.rb +1 -0
- data/lib/elastic/app-search/api/put_synonym_set.rb +1 -0
- data/lib/elastic/app-search/api/query_suggestion.rb +1 -0
- data/lib/elastic/app-search/api/refresh_adaptive_relevance_update_process.rb +1 -0
- data/lib/elastic/app-search/api/reset_search_settings.rb +1 -0
- data/lib/elastic/app-search/api/schema.rb +1 -0
- data/lib/elastic/app-search/api/search.rb +1 -0
- data/lib/elastic/app-search/api/search_es_search.rb +1 -0
- data/lib/elastic/app-search/api/search_explain.rb +1 -0
- data/lib/elastic/app-search/api/search_settings.rb +1 -0
- data/lib/elastic/app-search/api/synonym_set.rb +1 -0
- data/lib/elastic/app-search/api/top_clicks_analytics.rb +1 -0
- data/lib/elastic/app-search/api/top_queries_analytics.rb +1 -0
- data/lib/elastic/enterprise-search/api/health.rb +1 -0
- data/lib/elastic/enterprise-search/api/put_read_only.rb +1 -0
- data/lib/elastic/enterprise-search/api/read_only.rb +1 -0
- data/lib/elastic/enterprise-search/api/search_engines.rb +44 -0
- data/lib/elastic/enterprise-search/api/stats.rb +1 -0
- data/lib/elastic/enterprise-search/api/version.rb +1 -0
- data/lib/elastic/enterprise-search/version.rb +1 -1
- data/lib/elastic/workplace-search/api/auto_query_refinement_details.rb +1 -0
- data/lib/elastic/workplace-search/api/command_sync_jobs.rb +1 -0
- data/lib/elastic/workplace-search/api/content_source.rb +1 -0
- data/lib/elastic/workplace-search/api/create_analytics_event.rb +1 -0
- data/lib/elastic/workplace-search/api/create_batch_synonym_sets.rb +1 -0
- data/lib/elastic/workplace-search/api/create_content_source.rb +1 -0
- data/lib/elastic/workplace-search/api/create_external_identity.rb +1 -0
- data/lib/elastic/workplace-search/api/current_user.rb +1 -0
- data/lib/elastic/workplace-search/api/delete_content_source.rb +1 -0
- data/lib/elastic/workplace-search/api/delete_documents.rb +1 -0
- data/lib/elastic/workplace-search/api/delete_documents_by_query.rb +1 -0
- data/lib/elastic/workplace-search/api/delete_external_identity.rb +1 -0
- data/lib/elastic/workplace-search/api/delete_synonym_set.rb +1 -0
- data/lib/elastic/workplace-search/api/document.rb +1 -0
- data/lib/elastic/workplace-search/api/external_identity.rb +1 -0
- data/lib/elastic/workplace-search/api/index_documents.rb +1 -0
- data/lib/elastic/workplace-search/api/list_content_sources.rb +1 -0
- data/lib/elastic/workplace-search/api/list_documents.rb +1 -0
- data/lib/elastic/workplace-search/api/list_external_identities.rb +1 -0
- data/lib/elastic/workplace-search/api/list_synonym_sets.rb +1 -0
- data/lib/elastic/workplace-search/api/put_content_source.rb +1 -0
- data/lib/elastic/workplace-search/api/put_content_source_icons.rb +1 -0
- data/lib/elastic/workplace-search/api/put_external_identity.rb +1 -0
- data/lib/elastic/workplace-search/api/put_synonym_set.rb +1 -0
- data/lib/elastic/workplace-search/api/put_triggers_blocklist.rb +1 -0
- data/lib/elastic/workplace-search/api/search.rb +1 -0
- data/lib/elastic/workplace-search/api/synonym_set.rb +1 -0
- data/lib/elastic/workplace-search/api/triggers_blocklist.rb +1 -0
- data/spec/integration/enterprise_search_api_spec.rb +11 -0
- metadata +5 -2
@@ -20,6 +20,7 @@
|
|
20
20
|
module Elastic
|
21
21
|
module EnterpriseSearch
|
22
22
|
module AppSearch
|
23
|
+
# Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
|
23
24
|
module Actions
|
24
25
|
# Click - Tracks results that were clicked after a query
|
25
26
|
# Tracks results that were clicked after a query
|
@@ -20,23 +20,25 @@
|
|
20
20
|
module Elastic
|
21
21
|
module EnterpriseSearch
|
22
22
|
module AppSearch
|
23
|
+
# Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
|
23
24
|
module Actions
|
24
|
-
#
|
25
|
+
# MultiSearch - Submit a multi search
|
26
|
+
# Submit a multi search query and receive a set of results with meta data
|
25
27
|
#
|
26
|
-
# @param
|
27
|
-
# @param
|
28
|
-
# @option arguments [
|
28
|
+
# @param [String] engine_name Name of the engine (*Required*)
|
29
|
+
# @param [Hash] arguments endpoint arguments
|
30
|
+
# @option arguments [Hash] :body (Required: queries)
|
31
|
+
# @option body :queries
|
29
32
|
# @option arguments [Hash] :headers optional HTTP headers to send with the request
|
30
33
|
#
|
31
34
|
# @see https://www.elastic.co/guide/en/app-search/current/multi-search.html
|
32
35
|
#
|
33
36
|
def multi_search(engine_name, arguments = {})
|
34
37
|
raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
|
35
|
-
raise ArgumentError, "Required parameter 'body' missing" unless arguments[:body]
|
38
|
+
raise ArgumentError, "Required parameter 'body (queries)' missing" unless arguments[:body]
|
36
39
|
|
37
40
|
body = arguments.delete(:body) || {}
|
38
41
|
headers = arguments.delete(:headers) || {}
|
39
|
-
|
40
42
|
request(
|
41
43
|
:post,
|
42
44
|
"api/as/v1/engines/#{engine_name}/multi_search/",
|
@@ -20,6 +20,7 @@
|
|
20
20
|
module Elastic
|
21
21
|
module EnterpriseSearch
|
22
22
|
module AppSearch
|
23
|
+
# Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
|
23
24
|
module Actions
|
24
25
|
# AdaptiveRelevanceSettings - Update adaptive relevance settings
|
25
26
|
# Update adaptive relevance settings
|
@@ -20,6 +20,7 @@
|
|
20
20
|
module Elastic
|
21
21
|
module EnterpriseSearch
|
22
22
|
module AppSearch
|
23
|
+
# Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
|
23
24
|
module Actions
|
24
25
|
# QuerySuggestion - Retrieve query suggestions
|
25
26
|
# Provide relevant query suggestions for incomplete queries
|
@@ -20,6 +20,7 @@
|
|
20
20
|
module Elastic
|
21
21
|
module EnterpriseSearch
|
22
22
|
module AppSearch
|
23
|
+
# Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
|
23
24
|
module Actions
|
24
25
|
# AdaptiveRelevanceSettings - Retrieve adaptive relevance settings
|
25
26
|
# Update suggestions process refresh
|
@@ -20,6 +20,7 @@
|
|
20
20
|
module Elastic
|
21
21
|
module EnterpriseSearch
|
22
22
|
module AppSearch
|
23
|
+
# Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
|
23
24
|
module Actions
|
24
25
|
# ElasticsearchSearch - Run a search
|
25
26
|
# Execute the provided Elasticsearch search query against 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
|
# Analytics - Query for analytics click data
|
25
26
|
# Returns the number of clicks received by a document in descending order
|
@@ -19,6 +19,7 @@
|
|
19
19
|
|
20
20
|
module Elastic
|
21
21
|
module EnterpriseSearch
|
22
|
+
# Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
|
22
23
|
module Actions
|
23
24
|
# Health - Get information on the health of a deployment and basic statistics around resource usage
|
24
25
|
# Get information on the health of a deployment and basic statistics around resource usage
|
@@ -0,0 +1,44 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Licensed to Elasticsearch B.V. under one or more contributor
|
4
|
+
# license agreements. See the NOTICE file distributed with
|
5
|
+
# this work for additional information regarding copyright
|
6
|
+
# ownership. Elasticsearch B.V. licenses this file to you under
|
7
|
+
# the Apache License, Version 2.0 (the "License"); you may
|
8
|
+
# not use this file except in compliance with the License.
|
9
|
+
# You may obtain a copy of the License at
|
10
|
+
#
|
11
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
12
|
+
#
|
13
|
+
# Unless required by applicable law or agreed to in writing,
|
14
|
+
# software distributed under the License is distributed on an
|
15
|
+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
16
|
+
# KIND, either express or implied. See the License for the
|
17
|
+
# specific language governing permissions and limitations
|
18
|
+
# under the License.
|
19
|
+
|
20
|
+
module Elastic
|
21
|
+
module EnterpriseSearch
|
22
|
+
# Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
|
23
|
+
module Actions
|
24
|
+
# SearchEngines - Retrieve information about search engines
|
25
|
+
# Retrieve information about search engines
|
26
|
+
#
|
27
|
+
# @param [Hash] arguments endpoint arguments
|
28
|
+
# @option arguments [Hash] :headers optional HTTP headers to send with the request
|
29
|
+
#
|
30
|
+
# @see https://www.elastic.co/guide/en/enterprise-search/current/search-engines-apis.html
|
31
|
+
#
|
32
|
+
def search_engines(arguments = {})
|
33
|
+
headers = arguments.delete(:headers) || {}
|
34
|
+
request(
|
35
|
+
:get,
|
36
|
+
'api/search_engines/',
|
37
|
+
arguments,
|
38
|
+
nil,
|
39
|
+
headers
|
40
|
+
)
|
41
|
+
end
|
42
|
+
end
|
43
|
+
end
|
44
|
+
end
|
@@ -19,6 +19,7 @@
|
|
19
19
|
|
20
20
|
module Elastic
|
21
21
|
module EnterpriseSearch
|
22
|
+
# Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
|
22
23
|
module Actions
|
23
24
|
# Stats - Get information about the resource usage of the application, the state of different internal queues, etc.
|
24
25
|
# Get information about the resource usage of the application, the state of different internal queues, etc.
|
@@ -20,6 +20,7 @@
|
|
20
20
|
module Elastic
|
21
21
|
module EnterpriseSearch
|
22
22
|
module WorkplaceSearch
|
23
|
+
# Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
|
23
24
|
module Actions
|
24
25
|
# ContentSources - Retrieves a content source's automatic query refinement details
|
25
26
|
# Retrieves a content source's automatic query refinement details
|
@@ -20,6 +20,7 @@
|
|
20
20
|
module Elastic
|
21
21
|
module EnterpriseSearch
|
22
22
|
module WorkplaceSearch
|
23
|
+
# Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
|
23
24
|
module Actions
|
24
25
|
# SyncJobs - Issue commands to a Content Source's sync jobs
|
25
26
|
# Control a content source's sync jobs
|
@@ -20,6 +20,7 @@
|
|
20
20
|
module Elastic
|
21
21
|
module EnterpriseSearch
|
22
22
|
module WorkplaceSearch
|
23
|
+
# Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
|
23
24
|
module Actions
|
24
25
|
# Analytics - Capture click and feedback analytic events
|
25
26
|
# Capture Analytic events for click and feedback
|
@@ -20,6 +20,7 @@
|
|
20
20
|
module Elastic
|
21
21
|
module EnterpriseSearch
|
22
22
|
module WorkplaceSearch
|
23
|
+
# Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
|
23
24
|
module Actions
|
24
25
|
# Documents - Deletes a list of documents from a custom content source
|
25
26
|
# Remove documents from a Custom API Source
|
@@ -20,6 +20,7 @@
|
|
20
20
|
module Elastic
|
21
21
|
module EnterpriseSearch
|
22
22
|
module WorkplaceSearch
|
23
|
+
# Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
|
23
24
|
module Actions
|
24
25
|
# Documents - Deletes documents by query in a custom content source
|
25
26
|
# Deletes documents by query in a custom content source
|
@@ -20,6 +20,7 @@
|
|
20
20
|
module Elastic
|
21
21
|
module EnterpriseSearch
|
22
22
|
module WorkplaceSearch
|
23
|
+
# Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
|
23
24
|
module Actions
|
24
25
|
# Documents - Retrieves a document by ID from the specified content source
|
25
26
|
# Retrieves a document by ID from the specified content source
|
@@ -20,6 +20,7 @@
|
|
20
20
|
module Elastic
|
21
21
|
module EnterpriseSearch
|
22
22
|
module WorkplaceSearch
|
23
|
+
# Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
|
23
24
|
module Actions
|
24
25
|
# Documents - Indexes one or more new documents into a custom content source, or updates one or more existing documents
|
25
26
|
# Indexes one or more new documents into a custom content source, or updates one or more existing documents
|
@@ -20,6 +20,7 @@
|
|
20
20
|
module Elastic
|
21
21
|
module EnterpriseSearch
|
22
22
|
module WorkplaceSearch
|
23
|
+
# Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
|
23
24
|
module Actions
|
24
25
|
# Documents - Lists documents from a custom content source
|
25
26
|
# Lists documents from a custom content source
|
@@ -20,6 +20,7 @@
|
|
20
20
|
module Elastic
|
21
21
|
module EnterpriseSearch
|
22
22
|
module WorkplaceSearch
|
23
|
+
# Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
|
23
24
|
module Actions
|
24
25
|
# Search - Search across available sources with various query tuning options
|
25
26
|
# Issue a Search Query
|