class
Qdrant::Api::SetPayload
- Qdrant::Api::SetPayload
- Reference
- Object
Overview
This data structure is used in API interface and applied across multiple shards
Included Modules
- JSON::Serializable
- Qdrant::Api::Serializable
- Qdrant::Api::Validation
- YAML::Serializable
Defined in:
qdrant-api/models/set_payload.crConstructors
- .new(ctx : YAML::ParseContext, node : YAML::Nodes::Node)
- .new(pull : JSON::PullParser)
-
.new(payload : Hash(String, JSON::Any), points : Array(ExtendedPointId) | Nil = nil, filter : Filter | Nil = nil, shard_key : ShardKeySelector | Nil = nil, key : String | Nil = nil)
Initializes the object @param [Hash] attributes Model attributes in the form of hash
- .new(*, __pull_for_json_serializable pull : JSON::PullParser)
- .new(*, __context_for_yaml_serializable ctx : YAML::ParseContext, __node_for_yaml_serializable node : YAML::Nodes::Node)
Instance Method Summary
-
#==(other : self)
Returns
trueif this reference is the same as other. -
#filter : Filter | Nil
Assigns payload to each point that satisfy this filter condition
-
#filter=(filter : Filter | Nil)
Assigns payload to each point that satisfy this filter condition
-
#hash(hasher)
See
Object#hash(hasher) -
#key : String | Nil
Assigns payload to each point that satisfy this path of property
-
#key=(key : String | Nil)
Assigns payload to each point that satisfy this path of property
-
#list_invalid_properties
Show invalid properties with the reasons.
-
#payload : Hash(String, JSON::Any)
Required properties
-
#payload=(payload : Hash(String, JSON::Any))
Required properties
-
#points : Array(ExtendedPointId) | Nil
Optional properties Assigns payload to each point in this list
-
#points=(points : Array(ExtendedPointId) | Nil)
Optional properties Assigns payload to each point in this list
- #shard_key : ShardKeySelector | Nil
- #shard_key=(shard_key : ShardKeySelector | Nil)
-
#valid?
Check to see if the all the properties in the model are valid @return true if the model is valid
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
Initializes the object @param [Hash] attributes Model attributes in the form of hash
Instance Method Detail
Returns true if this reference is the same as other. Invokes same?.
Assigns payload to each point that satisfy this filter condition
Assigns payload to each point that satisfy this filter condition
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
Optional properties Assigns payload to each point in this list
Optional properties Assigns payload to each point in this list
Check to see if the all the properties in the model are valid @return true if the model is valid