class
Qdrant::Api::FacetRequest
- Qdrant::Api::FacetRequest
- Reference
- Object
Included Modules
- JSON::Serializable
- Qdrant::Api::Serializable
- Qdrant::Api::Validation
- YAML::Serializable
Defined in:
qdrant-api/models/facet_request.crConstructors
- .new(ctx : YAML::ParseContext, node : YAML::Nodes::Node)
- .new(pull : JSON::PullParser)
-
.new(key : String, shard_key : ShardKeySelector | Nil = nil, limit : Int32 | Nil = nil, filter : Filter | Nil = nil, exact : Bool | 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. -
#exact : Bool | Nil
Whether to do a more expensive exact count for each of the values in the facet.
-
#exact=(exact : Bool | Nil)
Whether to do a more expensive exact count for each of the values in the facet.
-
#filter : Filter | Nil
Filter conditions - only consider points that satisfy these conditions.
-
#filter=(filter : Filter | Nil)
Filter conditions - only consider points that satisfy these conditions.
-
#hash(hasher)
See
Object#hash(hasher) -
#key : String
Required properties Payload key to use for faceting.
-
#key=(key : String)
Required properties Payload key to use for faceting.
-
#limit : Int32 | Nil
Max number of hits to return.
-
#limit=(value : Int32 | Nil)
Max number of hits to return.
- #limit_validation_error(value) : String | Nil
-
#list_invalid_properties
Show invalid properties with the reasons.
-
#shard_key : ShardKeySelector | Nil
Optional properties
-
#shard_key=(shard_key : ShardKeySelector | Nil)
Optional properties
-
#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?.
Whether to do a more expensive exact count for each of the values in the facet. Default is false.
Whether to do a more expensive exact count for each of the values in the facet. Default is false.
Filter conditions - only consider points that satisfy these conditions.
Filter conditions - only consider points that satisfy these conditions.
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
Check to see if the all the properties in the model are valid @return true if the model is valid