class Qdrant::Api::ScrollRequest

• Qdrant::Api::ScrollRequest
• Reference
• Object

Overview

Scroll request - paginate over all points which matches given condition

Included Modules

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

Defined in:

Constructors

• .new(ctx : YAML::ParseContext, node : YAML::Nodes::Node)
• .new(pull : JSON::PullParser)
• .new(shard_key : ShardKeySelector | Nil = nil, offset : ExtendedPointId | Nil = nil, limit : Int32 | Nil = nil, filter : Filter | Nil = nil, with_payload : WithPayloadInterface | Nil = nil, with_vector : WithVector | Nil = nil, order_by : OrderByInterface | 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

  Look only for points which satisfies this conditions.

• #filter=(filter : Filter | Nil)

  Look only for points which satisfies this conditions.

• #hash(hasher)

  See Object#hash(hasher)

• #limit : Int32 | Nil

  Page size.

• #limit=(value : Int32 | Nil)

  Page size.

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

  Show invalid properties with the reasons.

• #offset : ExtendedPointId | Nil

  Start ID to read points from.

• #offset=(offset : ExtendedPointId | Nil)

  Start ID to read points from.

• #order_by : OrderByInterface | Nil

  Order the records by a payload field.

• #order_by=(order_by : OrderByInterface | Nil)

  Order the records by a payload field.

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

• #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
• #with_vector=(with_vector : WithVector | Nil)

Constructor Detail

Instance Method Detail