class Qdrant::Api::ScoredPoint

Overview

Search result

Included Modules

Defined in:

qdrant-api/models/scored_point.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(id : ExtendedPointId, version : Int32, score : Float32, payload : Hash(String, JSON::Any) | Nil = nil, vector : VectorStructOutput | Nil = nil, shard_key : ShardKey | Nil = nil, order_value : OrderValue | Nil = nil) #

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


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

[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 hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def id : ExtendedPointId #

Required properties


[View source]
def id=(id : ExtendedPointId) #

Required properties


[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 order_value : OrderValue | Nil #

Order-by value


[View source]
def order_value=(order_value : OrderValue | Nil) #

Order-by value


[View source]
def payload : Hash(String, JSON::Any) | Nil #

Optional properties Payload - values assigned to the point


[View source]
def payload=(payload : Hash(String, JSON::Any) | Nil) #

Optional properties Payload - values assigned to the point


[View source]
def score : Float32 #

Points vector distance to the query vector


[View source]
def score=(score : Float32) #

Points vector distance to the query vector


[View source]
def shard_key : ShardKey | Nil #

Shard Key


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

Shard Key


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

Vector of the point


[View source]
def vector=(vector : VectorStructOutput | Nil) #

Vector of the point


[View source]
def version : Int32 #

Point version


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

Point version


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

[View source]