opensearch-ruby 2.0.3 → 3.4.0

data/lib/opensearch/dsl/search/aggregations/pipeline/moving_avg.rb

@@ -0,0 +1,66 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+#
+# Modifications Copyright OpenSearch Contributors. See
+# GitHub history for details.
+#
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module OpenSearch
+  module DSL
+    module Search
+      module Aggregations
+        # Given an ordered series of data, the Moving Average aggregation will slide a window across the data and emit the average value of that window.
+        #
+        # @example Passing the options as a Hash
+        #
+        #     aggregation :the_movavg do
+        #       moving_avg buckets_path: 'the_sum'
+        #     end
+        #
+        # @example Passing the options as a block
+        #
+        #     aggregation :the_movavg do
+        #       moving_avg do
+        #         buckets_path 'the_sum'
+        #         model 'holt'
+        #         window 5
+        #         gap_policy 'insert_zero'
+        #         settings({ alpha: 0.5 })
+        #       end
+        #     end
+        #
+        #
+        class MovingAvg
+          include BaseAggregationComponent
+
+          option_method :buckets_path
+          option_method :model
+          option_method :gap_policy
+          option_method :window
+          option_method :format
+          option_method :minimize
+          option_method :settings
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/aggregations/pipeline/percentiles_bucket.rb

@@ -0,0 +1,60 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+#
+# Modifications Copyright OpenSearch Contributors. See
+# GitHub history for details.
+#
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module OpenSearch
+  module DSL
+    module Search
+      module Aggregations
+        # A sibling pipeline aggregation which calculates percentiles across all bucket of a specified metric in a sibling aggregation.
+        #
+        # @example Passing the options as a Hash
+        #
+        #     aggregation :sum_monthly_sales do
+        #       percentiles_bucket buckets_path: 'sales_per_month>sales'
+        #     end
+        #
+        # @example Passing the options as a block
+        #
+        #     aggregation :sum_monthly_sales do
+        #       percentiles_bucket do
+        #         buckets_path 'sales_per_month>sales'
+        #         percents [25.0 50.0 75.0]
+        #       end
+        #     end
+        #
+        #
+        class PercentilesBucket
+          include BaseAggregationComponent
+
+          option_method :buckets_path
+          option_method :gap_policy
+          option_method :format
+          option_method :percents
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/aggregations/pipeline/serial_diff.rb

@@ -0,0 +1,60 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+#
+# Modifications Copyright OpenSearch Contributors. See
+# GitHub history for details.
+#
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module OpenSearch
+  module DSL
+    module Search
+      module Aggregations
+        # Serial differencing is a technique where values in a time series are subtracted from itself at different time lags or periods.
+        #
+        # @example Passing the options as a Hash
+        #
+        #     aggregation :thirtieth_difference do
+        #       serial_diff buckets_path: 'the_sum'
+        #     end
+        #
+        # @example Passing the options as a block
+        #
+        #     aggregation :thirtieth_difference do
+        #       serial_diff do
+        #         buckets_path 'the_sum'
+        #         lag 30
+        #       end
+        #     end
+        #
+        #
+        class SerialDiff
+          include BaseAggregationComponent
+
+          option_method :buckets_path
+          option_method :lag
+          option_method :gap_policy
+          option_method :format
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/aggregations/pipeline/stats_bucket.rb

@@ -0,0 +1,58 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+#
+# Modifications Copyright OpenSearch Contributors. See
+# GitHub history for details.
+#
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module OpenSearch
+  module DSL
+    module Search
+      module Aggregations
+        # A sibling pipeline aggregation which calculates a variety of stats across all bucket of a specified metric in a sibling aggregation.
+        #
+        # @example Passing the options as a Hash
+        #
+        #     aggregation :stats_monthly_sales do
+        #       stats_bucket buckets_path: 'sales_per_month>sales'
+        #     end
+        #
+        # @example Passing the options as a block
+        #
+        #     aggregation :stats_monthly_sales do
+        #       stats_bucket do
+        #         buckets_path 'sales_per_month>sales'
+        #       end
+        #     end
+        #
+        #
+        class StatsBucket
+          include BaseAggregationComponent
+
+          option_method :buckets_path
+          option_method :gap_policy
+          option_method :format
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/aggregations/pipeline/sum_bucket.rb

@@ -0,0 +1,58 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+#
+# Modifications Copyright OpenSearch Contributors. See
+# GitHub history for details.
+#
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module OpenSearch
+  module DSL
+    module Search
+      module Aggregations
+        # A sibling pipeline aggregation which calculates the sum across all bucket of a specified metric in a sibling aggregation.
+        #
+        # @example Passing the options as a Hash
+        #
+        #     aggregation :sum_monthly_sales do
+        #       sum_bucket buckets_path: 'sales_per_month>sales'
+        #     end
+        #
+        # @example Passing the options as a block
+        #
+        #     aggregation :sum_monthly_sales do
+        #       sum_bucket do
+        #         buckets_path 'sales_per_month>sales'
+        #       end
+        #     end
+        #
+        #
+        class SumBucket
+          include BaseAggregationComponent
+
+          option_method :buckets_path
+          option_method :gap_policy
+          option_method :format
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/aggregations/range.rb

@@ -0,0 +1,77 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+#
+# Modifications Copyright OpenSearch Contributors. See
+# GitHub history for details.
+#
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module OpenSearch
+  module DSL
+    module Search
+      module Aggregations
+        # A multi-bucket aggregation which returns document counts for custom numerical ranges,
+        # which define the buckets
+        #
+        # @example
+        #
+        #     search do
+        #       aggregation :clicks do
+        #         range field: 'clicks',
+        #               ranges: [
+        #                 { to: 10 },
+        #                 { from: 10, to: 20 }
+        #               ]
+        #       end
+        #     end
+        #
+        # @example Using custom names for the ranges
+        #
+        #     search do
+        #       aggregation :clicks do
+        #         range do
+        #           field 'clicks'
+        #           key :low, to: 10
+        #           key :mid, from: 10, to: 20
+        #         end
+        #       end
+        #     end
+        #
+        class Range
+          include BaseAggregationComponent
+
+          option_method :field
+          option_method :script
+          option_method :params
+          option_method :keyed
+
+          def key(key, value)
+            @hash[name].update(@args) if @args
+            @hash[name][:keyed] = true unless @hash[name].key?(:keyed)
+            @hash[name][:ranges] ||= []
+            @hash[name][:ranges] << value.merge(key: key) unless @hash[name][:ranges].any? { |i| i[:key] == key }
+            self
+          end
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/aggregations/reverse_nested.rb

@@ -0,0 +1,61 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+#
+# Modifications Copyright OpenSearch Contributors. See
+# GitHub history for details.
+#
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module OpenSearch
+  module DSL
+    module Search
+      module Aggregations
+        # A single-bucket aggregation which allows to aggregate on "parent" documents
+        # from the nested documents
+        #
+        # @example
+        #
+        #     search do
+        #       aggregation :offers do
+        #         nested do
+        #           path 'offers'
+        #           aggregation :top_categories do
+        #             reverse_nested do
+        #               aggregation :top_category_per_offer do
+        #                 terms field: 'category'
+        #               end
+        #             end
+        #           end
+        #         end
+        #       end
+        #     end
+        #
+        # See the integration test for a full example.
+        #
+        # @see http://opensearch.org/guide/en/opensearch/guide/current/nested-aggregation.html
+        #
+        class ReverseNested
+          include BaseAggregationComponent
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/aggregations/scripted_metric.rb

@@ -0,0 +1,63 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+#
+# Modifications Copyright OpenSearch Contributors. See
+# GitHub history for details.
+#
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module OpenSearch
+  module DSL
+    module Search
+      module Aggregations
+        # A metric aggregation which uses scripts for the computation
+        #
+        # @example
+        #
+        #     search do
+        #       aggregation :clicks_for_one do
+        #         scripted_metric do
+        #           init_script "_agg['transactions'] = []"
+        #           map_script  "if (doc['tags'].value.contains('one')) { _agg.transactions.add(doc['clicks'].value) }"
+        #           combine_script "sum = 0; for (t in _agg.transactions) { sum += t }; return sum"
+        #           reduce_script "sum = 0; for (a in _aggs) { sum += a }; return sum"
+        #         end
+        #       end
+        #     end
+        #
+        # @see http://opensearch.org/guide/en/opensearch/reference/current/search-aggregations-metrics-scripted-metric-aggregation.html
+        #
+        # See the integration test for a full example.
+        #
+        class ScriptedMetric
+          include BaseComponent
+
+          option_method :init_script
+          option_method :map_script
+          option_method :combine_script
+          option_method :reduce_script
+          option_method :params
+          option_method :lang
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/aggregations/significant_terms.rb

@@ -0,0 +1,69 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+#
+# Modifications Copyright OpenSearch Contributors. See
+# GitHub history for details.
+#
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module OpenSearch
+  module DSL
+    module Search
+      module Aggregations
+        # A multi-bucket aggregation that returns interesting or unusual occurrences of terms in a set
+        #
+        # @example
+        #
+        #     search do
+        #       query do
+        #         match :title do
+        #           query 'fink'
+        #         end
+        #       end
+        #
+        #       aggregation :interesting_terms do
+        #         significant_terms do
+        #           field :body
+        #         end
+        #       end
+        #     end
+        #
+        # @see http://opensearch.org/guide/en/opensearch/reference/current/search-aggregations-bucket-significantterms-aggregation.html
+        #
+        class SignificantTerms
+          include BaseAggregationComponent
+
+          option_method :field
+          option_method :size
+          option_method :shard_size
+          option_method :min_doc_count
+          option_method :shard_min_doc_count
+          option_method :include
+          option_method :exclude
+          option_method :background_filter
+          option_method :mutual_information
+          option_method :chi_square
+          option_method :gnd
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/aggregations/stats.rb

@@ -0,0 +1,61 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+#
+# Modifications Copyright OpenSearch Contributors. See
+# GitHub history for details.
+#
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module OpenSearch
+  module DSL
+    module Search
+      module Aggregations
+        # A multi-value metrics aggregation which returns statistical information on numeric values
+        #
+        # @example Passing the options as a Hash
+        #
+        #     search do
+        #       aggregation :clicks_stats do
+        #         stats field: 'clicks'
+        #       end
+        #     end
+        #
+        # @example Passing the options as a block
+        #
+        #     search do
+        #       aggregation :clicks_stats do
+        #         stats do
+        #           field 'clicks'
+        #         end
+        #       end
+        #     end
+        #
+        #
+        class Stats
+          include BaseComponent
+
+          option_method :field
+          option_method :script
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/aggregations/sum.rb

@@ -0,0 +1,49 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+#
+# Modifications Copyright OpenSearch Contributors. See
+# GitHub history for details.
+#
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module OpenSearch
+  module DSL
+    module Search
+      module Aggregations
+        # A single-value metric aggregation which returns the sum of numeric values
+        #
+        # @example
+        #
+        #     search do
+        #       aggregation :sum_clicks do
+        #         sum field: 'clicks'
+        #       end
+        #     end
+        #
+        # @see http://opensearch.org/guide/en/opensearch/reference/current/search-aggregations-metrics-sum-aggregation.html
+        #
+        class Sum
+          include BaseComponent
+        end
+      end
+    end
+  end
+end