class
Qdrant::Api::SearchGroupsRequest
- Qdrant::Api::SearchGroupsRequest
- Reference
- Object
Included Modules
- JSON::Serializable
- Qdrant::Api::Serializable
- Qdrant::Api::Validation
- YAML::Serializable
Defined in:
qdrant-api/models/search_groups_request.crConstructors
-
.new(vector : NamedVectorStruct, group_by : String, group_size : Int32, limit : Int32, shard_key : ShardKeySelector | Nil = nil, filter : Filter | Nil = nil, params : SearchParams | Nil = nil, with_payload : WithPayloadInterface | Nil = nil, with_vector : WithVector | Nil = nil, score_threshold : Float32 | Nil = nil, with_lookup : WithLookupInterface | Nil = nil)
Initializes the object @param [Hash] attributes Model attributes in the form of hash
- .new(ctx : YAML::ParseContext, node : YAML::Nodes::Node)
- .new(pull : JSON::PullParser)
- .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
Look only for points which satisfies this conditions
-
#filter=(filter : Filter | Nil)
Look only for points which satisfies this conditions
-
#group_by : String
Payload field to group by, must be a string or number field.
-
#group_by=(value : String)
Payload field to group by, must be a string or number field.
- #group_by_validation_error(value) : String | Nil
-
#group_size : Int32
Maximum amount of points to return per group
-
#group_size=(value : Int32)
Maximum amount of points to return per group
- #group_size_validation_error(value) : String | Nil
-
#hash(hasher)
See
Object#hash(hasher) -
#limit : Int32
Maximum amount of groups to return
-
#limit=(value : Int32)
Maximum amount of groups to return
- #limit_validation_error(value) : String | Nil
-
#list_invalid_properties
Show invalid properties with the reasons.
-
#params : SearchParams | Nil
Additional search params
-
#params=(params : SearchParams | Nil)
Additional search params
-
#score_threshold : Float32 | Nil
Define a minimal score threshold for the result.
-
#score_threshold=(score_threshold : Float32 | Nil)
Define a minimal score threshold for the result.
-
#shard_key : ShardKeySelector | Nil
Optional properties Specify in which shards to look for the points, if not specified - look in all shards
-
#shard_key=(shard_key : ShardKeySelector | Nil)
Optional properties Specify in which shards to look for the points, if not specified - look in all shards
-
#valid?
Check to see if the all the properties in the model are valid @return true if the model is valid
-
#vector : NamedVectorStruct
Required properties
-
#vector=(vector : NamedVectorStruct)
Required properties
-
#with_lookup : WithLookupInterface | Nil
Look for points in another collection using the group ids
-
#with_lookup=(with_lookup : WithLookupInterface | Nil)
Look for points in another collection using the group ids
-
#with_payload : WithPayloadInterface | Nil
Select which payload to return with the response.
-
#with_payload=(with_payload : WithPayloadInterface | Nil)
Select which payload to return with the response.
-
#with_vector : WithVector | Nil
Options for specifying which vectors to include into response.
-
#with_vector=(with_vector : WithVector | Nil)
Options for specifying which vectors to include into response.
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?.
Look only for points which satisfies this conditions
Payload field to group by, must be a string or number field. If the field contains more than 1 value, all values will be used for grouping. One point can be in multiple groups.
Payload field to group by, must be a string or number field. If the field contains more than 1 value, all values will be used for grouping. One point can be in multiple groups.
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
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.
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.
Optional properties Specify in which shards to look for the points, if not specified - look in all shards
Optional properties Specify in which shards to look for the points, if not specified - look in all shards
Check to see if the all the properties in the model are valid @return true if the model is valid
Look for points in another collection using the group ids
Look for points in another collection using the group ids
Select which payload to return with the response. Default is false.
Select which payload to return with the response. Default is false.
Options for specifying which vectors to include into response. Default is false.
Options for specifying which vectors to include into response. Default is false.