ruby-pinecone 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 447e688337c17e18023d086c8804315bc1a099de3340c07671d65aae4cddebac
-  data.tar.gz: 29d79c0ff8231503de054078444f25261887a23ce6c8e84ac946192e164ee3f7
+  metadata.gz: 94a8d0986de77f82632dfd0d579e9b97f2bf7021e568f892c7cc16860047627b
+  data.tar.gz: aeb5cad4f8e4d2db064b8e0c545954f785470b0722a162f9e20cf7484f771143
 SHA512:
-  metadata.gz: a02a1a45d1091741e4cd390ff701b850e2a0b4bb391f156228890a69e265390838a7a572a4a8223404a6deee8d6d7ccac73715bd6d44c650e411029add55741b
-  data.tar.gz: be810f94389decfd4548edd56ba81cbd390821c7d8ace6a510a41ad053a96c83dfb444637289cc3146997284d1bd5132898d3783553952c3029b21d2cb1a977d
+  metadata.gz: 9ae89d24205bd3fd6b4dfbd6db5441fe0e4cc865db14f4645c6ba9af8cb19b0e0b3bb3eb7668524cdd3021a2355b619fdd7341648be3dad6ec2bf6bea1099c9b
+  data.tar.gz: 619783997bc2a1f170c1af1dea37d063434f7cb67adfd120c79218eefda695c1dd473877eeb64c4f324df86aebc0048207278722b9fc99a9347b6506e0a0a1ac

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## [Unreleased]
 
+## [0.1.2] - 2023-03-10
+
+- Index#Query to return parsed body
+- Add QueryError
+- Document Index#query
+
 ## [0.1.1] - 2023-03-08
 
 - Initial release

data/README.md

@@ -111,6 +111,23 @@ index = client.indexes['my-index']
 index.vectors.delete(ids: ['id-1', 'id-2'])
 ```
 
+#### Query
+```ruby
+client = Pinecone::Client.new
+index = client.indexes['my-index']
+
+options = {
+  "includeValues": false,
+  "includeMetadata": true,
+  "topK": 10,
+}
+index.query([1.0, 1.0], options: options)
+# => {"results"=>[], "matches"=>[{"id"=>"id-1", "score"=>1, "values"=>[], "metadata"=>{"type"=>"Thing"}}, {"id"=>"id-2", "score"=>0.89825207, "values"=>[], "metadata"=>{"type"=>"Thing"}}], "namespace"=>""}
+
+index.query(nil, options: options)
+# => raise QueryError (Query failed with 400 - {"code"=>3, "message"=>"No query provided", "details"=>[]})
+```
+
 ## 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.

data/lib/pinecone/index.rb

@@ -1,5 +1,7 @@
 module Pinecone
   class Index
+    class QueryError < StandardError; end
+
     attr_accessor :name
     def initialize(name:)
       self.name = name
@@ -51,7 +53,11 @@ module Pinecone
         "vector": vector
       }
       body = defaults.merge(options)
-      Pinecone::Client.json_post(prefix: prefix, path: '/query', parameters: body)
+      result = Pinecone::Client.json_post(prefix: prefix, path: '/query', parameters: body)
+      if !result.success?
+        raise QueryError.new("Query failed with #{result.response.code} - #{result.parsed_response.to_s}")
+      end
+      result.parsed_response
     end
 
     # # Get Show

data/lib/pinecone/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Pinecone
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-pinecone
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Matthew Hirst
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-08 00:00:00.000000000 Z
+date: 2023-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty