qdrant-ruby 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fd79e1fac58cbc38dfb04e780f1a4b82ceca0ec8b601090c4414fc519afb6388
+  data.tar.gz: 32c2e01c18699a532ca332fb69fb87881e4f627f69ad3091a5246f07bb54c268
+SHA512:
+  metadata.gz: 9bf396fa44eaa91e55f7ab32931d94abaef25b08cad04343ea84cfef598be83efa7f24bce089adacd72862d716ad64dc0292a2afc5e53a2b0b17c604411b5879
+  data.tar.gz: ff78d356d410a6fbf1bc60e6373cd50c924bc0531650abe998b21ec0cb91656fc996911992ddba195aa1ef7cf913ca8e99c582b2d9a8a8f1d0e1809507e12d13

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.9.0] - 2023-04-08
+
+- Initial release

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in qdrant.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+gem "standard", "~> 1.25.0"

data/Gemfile.lock

@@ -0,0 +1,82 @@
+PATH
+  remote: .
+  specs:
+    qdrant-ruby (0.9.0)
+      faraday (~> 2.7)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    diff-lcs (1.5.0)
+    faraday (2.7.4)
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (3.0.2)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    method_source (1.0.0)
+    parallel (1.22.1)
+    parser (3.2.1.1)
+      ast (~> 2.4.1)
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.10.1)
+      byebug (~> 11.0)
+      pry (>= 0.13, < 0.15)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.7.0)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.48.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.26.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.28.0)
+      parser (>= 3.2.1.0)
+    rubocop-performance (1.16.0)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
+    standard (1.25.3)
+      language_server-protocol (~> 3.17.0.2)
+      rubocop (~> 1.48.1)
+      rubocop-performance (~> 1.16.0)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  x86_64-darwin-19
+  x86_64-linux
+
+DEPENDENCIES
+  pry-byebug (~> 3.9)
+  qdrant-ruby!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  standard (~> 1.25.0)
+
+BUNDLED WITH
+   2.4.0

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,385 @@
+# Qdrant
+
+<p>
+    <img alt='Qdrant logo' src='https://qdrant.tech/images/logo_with_text.svg' height='50' />
+    &nbsp;&nbsp;+&nbsp;&nbsp;
+    <img alt='Ruby logo' src='https://user-images.githubusercontent.com/541665/230231593-43861278-4550-421d-a543-fd3553aac4f6.png' height='40' />
+</p>
+
+Ruby wrapper for the Qdrant vector search database API
+
+![Tests status](https://github.com/andreibondarev/qdrant-ruby/actions/workflows/ci.yml/badge.svg)
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add qdrant-ruby
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install qdrant-ruby
+
+## Usage
+
+### Instantiating API client
+
+```ruby
+require 'qdrant-ruby'
+
+client = Qdrant::Client.new(
+  url: "your-qdrant-url",
+  api_key: "your-qdrant-api-key"
+)
+```
+
+### Collections
+
+```ruby
+# Get list name of all existing collections
+client.collections.list(collection_name: "string")
+
+# Get detailed information about specified existing collection
+client.collections.get(collection_name: "string")
+
+# Create new collection with given parameters
+client.collections.create(
+    collection_name: "string",     # required
+    vectors: {},                   # required
+    shard_number: nil,
+    replication_factor: nil,
+    write_consistency_factor: nil,
+    on_disk_payload: nil,
+    hnsw_config: nil,
+    wal_config: nil,
+    optimizers_config: nil,
+    init_from: nil,
+    quantization_config: nil
+)
+
+# Update parameters of the existing collection
+client.collections.update(
+    collection_name: '',    # required
+    optimizers_config: nil,
+    params: nil
+)
+
+# Drop collection and all associated data
+client.collections.delete(collection_name: '')
+
+# Get list of all aliases (for a collection)
+client.collections.aliases(
+    collection_name: "string" # optional
+)
+
+# Update aliases of the collections
+client.collections.update_aliases(
+    actions: [{
+        # `create_alias:`, `delete_alias` and/or `rename_alias` is required
+        create_alias: {
+            collection_name: "string", # required
+            alias_name: "string"       # required
+        }
+    }]
+)
+
+# Create index for field in collection
+client.collections.create_index(
+    collection_name: "string", # required
+    field_name: "string",      # required
+    field_schema: "string",
+    wait: "boolean",
+    ordering: "ordering"
+)
+
+# Delete field index for collection
+client.collections.delete_index(
+    collection_name: "string", # required
+    field_name: "string",      # required
+    wait: "boolean",
+    ordering: "ordering"
+)
+
+# Get cluster information for a collection
+client.collections.cluster_info(
+    collection_name: "test_collection" # required
+)
+
+# Update collection cluster setup
+client.collections.update_cluster(
+    collection_name: "string", # required
+    move_shard: {              # required
+        shard_id: "int",
+        to_peer_id: "int",
+        from_peer_id: "int"
+    },
+    timeout: "int"
+)
+
+# Create new snapshot for a collection
+client.collections.create_snapshot(
+    collection_name: "string", # required
+)
+
+# Get list of snapshots for a collection
+client.collections.list_snapshots(
+    collection_name: "string", # required
+)
+
+# Delete snapshot for a collection
+client.collections.delete_snapshot(
+    collection_name: "string", # required
+    snapshot_name: "string"    # required
+)
+
+# Recover local collection data from a snapshot. This will overwrite any data, stored on this node, for the collection. If collection does not exist - it will be created.
+client.collections.restore_snapshot(
+    collection_name: "string", # required
+    filepath: "string",        # required
+    wait: "boolean",
+    priority: "string"
+)
+
+# Download specified snapshot from a collection as a file
+client.collections.download_snapshot(
+    collection_name: "string",         # required
+    snapshot_name: "string",           # required
+    filepath: "/dir/filename.snapshot" #require 
+)
+```
+
+### Points
+```ruby
+# Retrieve full information of single point by id
+client.points.get(
+    collection_name: "string", # required
+    id: "int/string",          # required
+    consistency: "int"
+)
+
+# Lists all data objects in reverse order of creation. The data will be returned as an array of objects.
+client.points.list(
+    collection_name: "string", # required
+    ids: "[int/string]",       # required
+    with_payload: nil,
+    with_vector: nil,
+    consistency: nil
+
+)
+
+# Get a single data object.
+client.points.upsert(
+    collection_name: "string", # required
+    batch: {},                 # required
+    wait: "boolean",
+    ordering: "string"
+)
+
+# Delete points
+client.points.delete(
+    collection_name: "string", # required
+    points: "[int/string]",    # either `points:` or `filter:` required
+    filter: {},
+    wait: "boolean",
+    ordering: "string"
+)
+
+# Set payload values for points
+client.points.set_payload(
+    collection_name: "string", # required
+    payload: {                 # required
+        "property name" => "value" 
+    },  
+    points: "[int/string]",    # `points:` or `filter:` are required
+    filter: {},
+    wait: "boolean",
+    ordering: "string"
+)
+
+# Replace full payload of points with new one
+client.points.overwrite_payload(
+    collection_name: "string", # required
+    payload: {},               # required 
+    wait: "boolean",
+    ordering: "string",
+    points: "[int/string]",
+    filter: {}
+)
+
+# Delete specified key payload for points
+client.points.clear_payload_keys(
+    collection_name: "string", # required
+    keys: "[string]",          # required
+    points: "[int/string]",
+    filter: {},
+    wait: "boolean",
+    ordering: "string"
+)
+
+# Delete specified key payload for points
+client.points.clear_payload(
+    collection_name: "string", # required
+    points: "[int/string]",    # required
+    wait: "boolean",
+    ordering: "string"
+)
+
+# Scroll request - paginate over all points which matches given filtering condition
+client.points.scroll(
+    collection_name: "string", # required
+    limit: "int",
+    filter: {},
+    offset: "string",
+    with_payload: "boolean",
+    with_vector: "boolean",
+    consistency: "int/string"
+)
+
+# Retrieve closest points based on vector similarity and given filtering conditions
+client.points.search(
+    collection_name: "string", # required
+    limit: "int",              # required
+    vector: "[int]",           # required
+    filter: {},
+    params: {},
+    offset: "int",
+    with_payload: "boolean",
+    with_vector: "boolean",
+    score_threshold: "float"
+)
+
+
+# Retrieve by batch the closest points based on vector similarity and given filtering conditions
+client.points.batch_search(
+    collection_name: "string", # required
+    searches: [{}],            # required  
+    consistency: "int/string"
+)
+
+# Look for the points which are closer to stored positive examples and at the same time further to negative examples.
+client.points.recommend(
+    collection_name: "string", # required
+    positive: "[int/string]",  # required; Arrray of point IDs
+    limit: "int",              # required
+    negative: "[int/string]",
+    filter: {},
+    params: {},
+    offset: "int",
+    with_payload: "boolean",
+    with_vector: "boolean",
+    score_threshold: "float"
+    using: "string",
+    lookup_from: {},
+)
+
+# Look for the points which are closer to stored positive examples and at the same time further to negative examples.
+client.points.batch_recommend(
+    collection_name: "string", # required
+    searches: [{}],            # required
+    consistency: "string"
+)
+
+# Count points which matches given filtering condition
+client.points.count(
+    collection_name: "string", # required
+    filter: {},
+    exact: "boolean"
+)
+```
+
+### Snapshots
+```ruby
+# Get list of snapshots of the whole storage
+client.snapshots.list(
+    collection_name: "string" # optional
+)
+
+# Create new snapshot of the whole storage
+client.snapshots.create(
+    collection_name: "string" # required
+)
+
+# Delete snapshot of the whole storage
+client.snapshots.delete(
+    collection_name: "string", # required
+    snapshot_name: "string"    # required
+)
+
+# Download specified snapshot of the whole storage as a file
+client.snapshots.download(
+    collection_name: "string", # required
+    snapshot_name: "string"    # required
+    filepath: "~/Downloads/backup.txt" # required
+)
+
+
+# Get the backup
+client.backups.get(
+    backend: "filesystem",
+    id: "my-first-backup"
+)
+
+# Restore backup
+client.backups.restore(
+    backend: "filesystem",
+    id: "my-first-backup"
+)
+
+# Check the backup restore status
+client.backups.restore_status(
+    backend: "filesystem",
+    id: "my-first-backup"
+)
+```
+
+### Cluster
+```ruby
+# Get information about the current state and composition of the cluster
+client.cluster.info
+
+# Tries to recover current peer Raft state.
+client.cluster.recover
+
+# Tries to remove peer from the cluster. Will return an error if peer has shards on it.
+client.cluster.remove_peer(
+    peer_id: "int",  # required
+    force: "boolean"
+)
+```
+
+### Service
+```ruby
+# Collect telemetry data including app info, system info, collections info, cluster info, configs and statistics
+client.telemetry(
+    anonymize: "boolean" # optional
+)
+
+# Collect metrics data including app info, collections info, cluster info and statistics
+client.metrics(
+    anonymize: "boolean" # optional
+)
+
+# Get lock options. If write is locked, all write operations and collection creation are forbidden
+client.locks
+
+# Set lock options. If write is locked, all write operations and collection creation are forbidden. Returns previous lock options
+client.set_lock(
+    write: "boolean" # required
+    error_message: "string"
+)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/andreibondarev/qdrant.
+
+## License
+
+qdrant-ruby is licensed under the Apache License, Version 2.0. View a copy of the License file.
+