class Qdrant::Api::QueryGroupsRequest

• Qdrant::Api::QueryGroupsRequest
• Reference
• Object

Included Modules

• JSON::Serializable
• Qdrant::Api::Serializable
• Qdrant::Api::Validation
• YAML::Serializable

Defined in:

qdrant-api/models/query_groups_request.cr

Constructors

• .new(ctx : YAML::ParseContext, node : YAML::Nodes::Node)
• .new(pull : JSON::PullParser)
• .new(group_by : String, shard_key : ShardKeySelector | Nil = nil, prefetch : QueryRequestPrefetch | Nil = nil, query : QueryInterface | Nil = nil, using : String | Nil = nil, filter : Filter | Nil = nil, params : SearchParams | Nil = nil, score_threshold : Float32 | Nil = nil, with_vector : WithVector | Nil = nil, with_payload : WithPayloadInterface | Nil = nil, lookup_from : LookupLocation | Nil = nil, group_size : Int32 | Nil = nil, limit : Int32 | Nil = nil, with_lookup : WithLookupInterface | 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 true if this reference is the same as other.

• #filter : Filter | Nil

  Filter conditions - return only those points that satisfy the specified conditions.

• #filter=(filter : Filter | Nil)

  Filter conditions - return only those points that satisfy the specified conditions.

• #group_by : String

  Required properties Payload field to group by, must be a string or number field.

• #group_by=(value : String)

  Required properties Payload field to group by, must be a string or number field.

• #group_by_validation_error(value) : String | Nil
• #group_size : Int32 | Nil

  Maximum amount of points to return per group.

• #group_size=(value : Int32 | Nil)

  Maximum amount of points to return per group.

• #group_size_validation_error(value) : String | Nil
• #hash(hasher)

  See Object#hash(hasher)

• #limit : Int32 | Nil

  Maximum amount of groups to return.

• #limit=(value : Int32 | Nil)

  Maximum amount of groups to return.

• #limit_validation_error(value) : String | Nil
• #list_invalid_properties

  Show invalid properties with the reasons.

• #lookup_from : LookupLocation | Nil

  The location to use for IDs lookup, if not specified - use the current collection and the 'using' vector Note: the other collection vectors should have the same vector size as the 'using' vector in the current collection

• #lookup_from=(lookup_from : LookupLocation | Nil)

  The location to use for IDs lookup, if not specified - use the current collection and the 'using' vector Note: the other collection vectors should have the same vector size as the 'using' vector in the current collection

• #params : SearchParams | Nil

  Search params for when there is no prefetch

• #params=(params : SearchParams | Nil)

  Search params for when there is no prefetch

• #prefetch : QueryRequestPrefetch | Nil
• #prefetch=(prefetch : QueryRequestPrefetch | Nil)
• #query : QueryInterface | Nil

  Query to perform.

• #query=(query : QueryInterface | Nil)

  Query to perform.

• #score_threshold : Float32 | Nil

  Return points with scores better than this threshold.

• #score_threshold=(score_threshold : Float32 | Nil)

  Return points with scores better than this threshold.

• #shard_key : ShardKeySelector | Nil

  Optional properties

• #shard_key=(shard_key : ShardKeySelector | Nil)

  Optional properties

• #using : String | Nil

  Define which vector name to use for querying.

• #using=(using : String | Nil)

  Define which vector name to use for querying.

• #valid?

  Check to see if the all the properties in the model are valid @return true if the model is valid

• #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

  Options for specifying which payload to include or not.

• #with_payload=(with_payload : WithPayloadInterface | Nil)

  Options for specifying which payload to include or not.

• #with_vector : WithVector | Nil

  Options for specifying which vectors to include into the response.

• #with_vector=(with_vector : WithVector | Nil)

  Options for specifying which vectors to include into the response.

Constructor Detail

Instance Method Detail