class Qdrant::Api::SearchRequest

Overview

Search request. Holds all conditions and parameters for the search of most similar points by vector similarity given the filtering restrictions.

Included Modules

Defined in:

qdrant-api/models/search_request.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(vector : NamedVectorStruct, limit : Int32, shard_key : ShardKeySelector | Nil = nil, filter : Filter | Nil = nil, params : SearchParams | Nil = nil, offset : Int32 | Nil = nil, with_payload : WithPayloadInterface | Nil = nil, with_vector : WithVector | Nil = nil, score_threshold : Float32 | Nil = nil) #

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


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

[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 filter : Filter | Nil #

Look only for points which satisfies this conditions


[View source]
def filter=(filter : Filter | Nil) #

Look only for points which satisfies this conditions


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

See Object#hash(hasher)


def limit : Int32 #

Max number of result to return


[View source]
def limit=(value : Int32) #

Max number of result to return


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

[View source]
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 offset : Int32 | Nil #

Offset of the first result to return. May be used to paginate results. Note: large offset values may cause performance issues.


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

Offset of the first result to return. May be used to paginate results. Note: large offset values may cause performance issues.


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

[View source]
def params : SearchParams | Nil #

Additional search params


[View source]
def params=(params : SearchParams | Nil) #

Additional search params


[View source]
def score_threshold : Float32 | Nil #

Define a minimal score threshold for the result. If defined, less similar results will not be returned. Score of the returned result might be higher or smaller than the threshold depending on the Distance function used. E.g. for cosine similarity only higher scores will be returned.


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

Define a minimal score threshold for the result. If defined, less similar results will not be returned. Score of the returned result might be higher or smaller than the threshold depending on the Distance function used. E.g. for cosine similarity only higher scores will be returned.


[View source]
def shard_key : ShardKeySelector | Nil #

Optional properties Specify in which shards to look for the points, if not specified - look in all shards


[View source]
def shard_key=(shard_key : ShardKeySelector | Nil) #

Optional properties Specify in which shards to look for the points, if not specified - look in all shards


[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]
def vector : NamedVectorStruct #

Required properties


[View source]
def vector=(vector : NamedVectorStruct) #

Required properties


[View source]
def with_payload : WithPayloadInterface | Nil #

Select which payload to return with the response. Default is false.


[View source]
def with_payload=(with_payload : WithPayloadInterface | Nil) #

Select which payload to return with the response. Default is false.


[View source]
def with_vector : WithVector | Nil #

Options for specifying which vectors to include into response. Default is false.


[View source]
def with_vector=(with_vector : WithVector | Nil) #

Options for specifying which vectors to include into response. Default is false.


[View source]