File: function_score.rb

package info (click to toggle)
ruby-elasticsearch 7.17.11-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 7,820 kB
  • sloc: ruby: 44,308; sh: 16; makefile: 2
file content (119 lines) | stat: -rw-r--r-- 3,775 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
# 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 Elasticsearch
  module DSL
    module Search
      module Queries

        # A query which allows to modify the score of documents matching the query,
        # either via built-in functions or a custom script
        #
        # @example Find documents with specific amenities, boosting documents within a certain
        #          price range and geogprahical location
        #
        #     search do
        #       query do
        #         function_score do
        #           filter do
        #             terms amenities: ['wifi', 'pets']
        #           end
        #           functions << { gauss: { price:    { origin: 100, scale: 200 } } }
        #           functions << { gauss: { location: { origin: '50.090223,14.399590', scale: '5km' } } }
        #         end
        #       end
        #     end
        #
        # @see http://elasticsearch.org/guide/en/elasticsearch/guide/current/function-score-query.html
        #
        class FunctionScore
          include BaseComponent

          option_method :script_score
          option_method :boost
          option_method :max_boost
          option_method :score_mode
          option_method :boost_mode

          def initialize(*args, &block)
            super
            @functions = []
          end

          # DSL method for building the `query` part of the query definition
          #
          # @return [self]
          #
          def query(*args, &block)
            @query = block ? @query = Query.new(*args, &block) : args.first
            self
          end

          # DSL method for building the `filter` part of the query definition
          #
          # @return [self]
          #
          def filter(*args, &block)
            @filter = block ? Filter.new(*args, &block) : args.first
            self
          end

          # DSL method for building the `functions` part of the query definition
          #
          # @return [Array]
          #
          def functions(value=nil)
            if value
              @functions = value
            else
              @functions
            end
          end

          # Set the `functions` part of the query definition
          #
          # @return [Array]
          #
          def functions=(value)
            @functions = value
          end

          # Converts the query definition to a Hash
          #
          # @return [Hash]
          #
          def to_hash
            hash = super
            if @query
              _query = @query.respond_to?(:to_hash) ? @query.to_hash : @query
              hash[self.name].update(query: _query)
            end
            if @filter
              _filter = @filter.respond_to?(:to_hash) ? @filter.to_hash : @filter
              hash[self.name].update(filter: _filter)
            end
            unless @functions.empty?
              hash[self.name].update(functions: @functions)
            end
            hash
          end
        end

      end
    end
  end
end