Class: OpenSearch::DSL::Search::Queries::ScriptScore

Inherits:
Object
  • Object
show all
Includes:
BaseComponent
Defined in:
lib/opensearch/dsl/search/queries/script_score.rb

Overview

A query which wraps another query and returns a customized score for matching documents

Examples:


search do
  query do
    script_score do
      query do
        match content: 'Twitter'
      end

      script source: "_score * params['multiplier']",
             params: { multiplier: 2.0 }
    end
  end
end

See Also:

Instance Method Summary collapse

Methods included from BaseComponent

included, #initialize

Instance Method Details

#query(*args, &block) ⇒ self

DSL method for building the ‘query` part of the query definition

Returns:

  • (self) 


41
42
43
44
 
# File 'lib/opensearch/dsl/search/queries/script_score.rb', line 41

def query(*args, &block)
  @query = block ? @query = Query.new(*args, &block) : args.first
  self
end

#to_hash ⇒ Hash

Converts the query definition to a Hash

Returns:

  • (Hash) 


50
51
52
53
54
55
56
57
 
# File 'lib/opensearch/dsl/search/queries/script_score.rb', line 50

def to_hash
  hash = super
  if @query
    _query = @query.respond_to?(:to_hash) ? @query.to_hash : @query
    hash[name].update(query: _query)
  end
  hash
end