class Qdrant::Api::Mmr

Overview

Maximal Marginal Relevance (MMR) algorithm for re-ranking the points.

Included Modules

Defined in:

qdrant-api/models/mmr.cr

Constructors

Instance Method Summary

Macros inherited from module Qdrant::Api::Validation

validates(name, klass, nilable, **rules) validates

Instance methods inherited from module Qdrant::Api::Serializable

eql?(other) eql?, to_body : Hash(String, JSON::Any) to_body, to_h : Hash(String, JSON::Any) to_h, to_s(io : IO) : Nil to_s

Constructor Detail

def self.new(ctx : YAML::ParseContext, node : YAML::Nodes::Node) #

[View source]
def self.new(pull : JSON::PullParser) #

[View source]
def self.new(diversity : Float32 | Nil = nil, candidates_limit : Int32 | Nil = nil) #

Initializes the object @param [Hash] attributes Model attributes in the form of hash


[View source]
def self.new(*, __pull_for_json_serializable pull : JSON::PullParser) #

[View source]
def self.new(*, __context_for_yaml_serializable ctx : YAML::ParseContext, __node_for_yaml_serializable node : YAML::Nodes::Node) #

[View source]

Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def candidates_limit : Int32 | Nil #

The maximum number of candidates to consider for re-ranking. If not specified, the limit value is used.


[View source]
def candidates_limit=(value : Int32 | Nil) #

The maximum number of candidates to consider for re-ranking. If not specified, the limit value is used.


[View source]
def candidates_limit_validation_error(value) : String | Nil #

[View source]
def diversity : Float32 | Nil #

Optional properties Tunable parameter for the MMR algorithm. Determines the balance between diversity and relevance. A higher value favors diversity (dissimilarity to selected results), while a lower value favors relevance (similarity to the query vector). Must be in the range [0, 1]. Default value is 0.5.


[View source]
def diversity=(value : Float32 | Nil) #

Optional properties Tunable parameter for the MMR algorithm. Determines the balance between diversity and relevance. A higher value favors diversity (dissimilarity to selected results), while a lower value favors relevance (similarity to the query vector). Must be in the range [0, 1]. Default value is 0.5.


[View source]
def diversity_validation_error(value) : String | Nil #

[View source]
def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def list_invalid_properties #

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons


[View source]
def valid? #

Check to see if the all the properties in the model are valid @return true if the model is valid


[View source]