pinecone 0.1.6 → 1.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/pinecone/client.rb +3 -2
- data/lib/pinecone/collection.rb +7 -6
- data/lib/pinecone/index.rb +11 -10
- data/lib/pinecone/response_parser.rb +16 -0
- data/lib/pinecone/vector/filter.rb +5 -5
- data/lib/pinecone/vector/query.rb +10 -10
- data/lib/pinecone/vector/sparse_vector.rb +3 -3
- data/lib/pinecone/vector.rb +25 -20
- data/lib/pinecone/version.rb +2 -2
- data/lib/pinecone.rb +6 -3
- metadata +8 -105
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: ab3d946459844e4448d5d9ef3ec0856db62ce97c4e1201013ba33c046cc9d200
|
4
|
+
data.tar.gz: 419f33cf6d1c4876eb882b9109356bfc25f5d74fff52244f2b962c691d162301
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: e552468414c4b38a77694e40b8cfd2782d0b48609b138e4e2559333b6ec1b31eef71274eb09db5bd15821a5e3419cfceb95bbdd67f5550066cebad14531e4fa3
|
7
|
+
data.tar.gz: fe81f10ec021bd54e9d5243e67446e69423d0e0845cfaa3f72cd06ab1a3c381136728b2eed9423fcb9305c9c8973101cef6588568ad7575c0be6dc40528e86f8
|
data/lib/pinecone/client.rb
CHANGED
@@ -39,8 +39,9 @@ module Pinecone
|
|
39
39
|
end
|
40
40
|
|
41
41
|
# This is a very confusing naming convention
|
42
|
+
# Pinecone's reference now delineates between 'control plane' and 'data plane' which we'll reflect eventually
|
42
43
|
def index(index_name)
|
43
|
-
|
44
|
+
Pinecone::Vector.new(index_name)
|
44
45
|
end
|
45
46
|
end
|
46
|
-
end
|
47
|
+
end
|
data/lib/pinecone/collection.rb
CHANGED
@@ -1,19 +1,20 @@
|
|
1
1
|
module Pinecone
|
2
2
|
class Collection
|
3
3
|
include HTTParty
|
4
|
+
parser Pinecone::ResponseParser
|
4
5
|
|
5
6
|
def initialize
|
6
|
-
self.class.base_uri "https://
|
7
|
+
self.class.base_uri "https://api.pinecone.io"
|
7
8
|
|
8
9
|
@headers = {
|
9
10
|
"Content-Type" => "application/json",
|
10
11
|
"Accept" => "application/json",
|
11
|
-
"Api-Key" => Pinecone.configuration.api_key
|
12
|
+
"Api-Key" => Pinecone.configuration.api_key
|
12
13
|
}
|
13
14
|
end
|
14
15
|
|
15
16
|
def list
|
16
|
-
self.class.get(
|
17
|
+
self.class.get("/collections", options)
|
17
18
|
end
|
18
19
|
|
19
20
|
def describe(collection_name)
|
@@ -22,7 +23,7 @@ module Pinecone
|
|
22
23
|
|
23
24
|
def create(body)
|
24
25
|
payload = options.merge(body: body.to_json)
|
25
|
-
self.class.post(
|
26
|
+
self.class.post("/collections", payload)
|
26
27
|
end
|
27
28
|
|
28
29
|
def delete(collection_name)
|
@@ -31,8 +32,8 @@ module Pinecone
|
|
31
32
|
|
32
33
|
def options
|
33
34
|
{
|
34
|
-
headers: @headers
|
35
|
+
headers: @headers
|
35
36
|
}
|
36
37
|
end
|
37
38
|
end
|
38
|
-
end
|
39
|
+
end
|
data/lib/pinecone/index.rb
CHANGED
@@ -1,42 +1,43 @@
|
|
1
1
|
module Pinecone
|
2
2
|
class Index
|
3
3
|
include HTTParty
|
4
|
+
parser Pinecone::ResponseParser
|
4
5
|
|
5
6
|
def initialize
|
6
|
-
self.class.base_uri "https://
|
7
|
+
self.class.base_uri "https://api.pinecone.io"
|
7
8
|
@headers = {
|
8
9
|
"Content-Type" => "application/json",
|
9
10
|
"Accept" => "application/json",
|
10
|
-
"Api-Key" => Pinecone.configuration.api_key
|
11
|
+
"Api-Key" => Pinecone.configuration.api_key
|
11
12
|
}
|
12
13
|
end
|
13
14
|
|
14
15
|
def list
|
15
|
-
self.class.get(
|
16
|
+
self.class.get("/indexes", options)
|
16
17
|
end
|
17
18
|
|
18
19
|
def describe(index_name)
|
19
|
-
self.class.get("/
|
20
|
+
self.class.get("/indexes/#{index_name}", options)
|
20
21
|
end
|
21
|
-
|
22
|
+
|
22
23
|
def create(body)
|
23
24
|
payload = options.merge(body: body.to_json)
|
24
|
-
self.class.post(
|
25
|
+
self.class.post("/indexes", payload)
|
25
26
|
end
|
26
27
|
|
27
28
|
def delete(index_name)
|
28
|
-
self.class.delete("/
|
29
|
+
self.class.delete("/indexes/#{index_name}", options)
|
29
30
|
end
|
30
31
|
|
31
32
|
def configure(index_name, body)
|
32
33
|
payload = options.merge(body: body.to_json)
|
33
|
-
self.class.patch("/
|
34
|
+
self.class.patch("/indexes/#{index_name}", payload)
|
34
35
|
end
|
35
36
|
|
36
37
|
def options
|
37
38
|
{
|
38
|
-
headers: @headers
|
39
|
+
headers: @headers
|
39
40
|
}
|
40
41
|
end
|
41
42
|
end
|
42
|
-
end
|
43
|
+
end
|
@@ -0,0 +1,16 @@
|
|
1
|
+
module Pinecone
|
2
|
+
class ResponseParser < HTTParty::Parser
|
3
|
+
# standard:disable Naming/ConstantName
|
4
|
+
SupportedFormats = {
|
5
|
+
"application/json" => :json,
|
6
|
+
"text/plain" => :json
|
7
|
+
}
|
8
|
+
# standard:enable Naming/ConstantName
|
9
|
+
|
10
|
+
def json
|
11
|
+
JSON.parse(body)
|
12
|
+
rescue
|
13
|
+
body
|
14
|
+
end
|
15
|
+
end
|
16
|
+
end
|
@@ -6,9 +6,9 @@ require "dry-validation"
|
|
6
6
|
module Types
|
7
7
|
include Dry.Types()
|
8
8
|
|
9
|
-
StringOrNumberOrBoolean = Dry::Types[
|
10
|
-
StringOrNumber = Dry::Types[
|
11
|
-
Number = Dry::Types[
|
9
|
+
StringOrNumberOrBoolean = Dry::Types["string"] | Dry::Types["integer"] | Dry::Types["float"] | Dry::Types["bool"]
|
10
|
+
StringOrNumber = Dry::Types["string"] | Dry::Types["integer"] | Dry::Types["float"]
|
11
|
+
Number = Dry::Types["integer"] | Dry::Types["float"]
|
12
12
|
end
|
13
13
|
|
14
14
|
module Pinecone
|
@@ -50,7 +50,7 @@ module Pinecone
|
|
50
50
|
|
51
51
|
def to_filter(input)
|
52
52
|
return false unless input.is_a?(Hash)
|
53
|
-
|
53
|
+
Filter.new(input)
|
54
54
|
end
|
55
55
|
end
|
56
56
|
|
@@ -68,4 +68,4 @@ module Pinecone
|
|
68
68
|
end
|
69
69
|
end
|
70
70
|
end
|
71
|
-
end
|
71
|
+
end
|
@@ -29,17 +29,17 @@ module Pinecone
|
|
29
29
|
|
30
30
|
schema schema.strict
|
31
31
|
|
32
|
-
attribute :namespace, Dry::Types[
|
33
|
-
attribute :include_values, Dry::Types[
|
34
|
-
attribute :include_metadata, Dry::Types[
|
35
|
-
attribute :top_k, Dry::Types[
|
36
|
-
attribute? :vector, Dry::Types[
|
32
|
+
attribute :namespace, Dry::Types["string"].default("")
|
33
|
+
attribute :include_values, Dry::Types["bool"].default(false)
|
34
|
+
attribute :include_metadata, Dry::Types["bool"].default(true)
|
35
|
+
attribute :top_k, Dry::Types["integer"].default(10)
|
36
|
+
attribute? :vector, Dry::Types["array"].of(Dry::Types["float"] | Dry::Types["integer"])
|
37
37
|
# Disabled contract since it wasn't carrying forward attributes to to_json
|
38
38
|
# See failing test in query_spec.rb
|
39
|
-
# attribute? :filter, Filter
|
40
|
-
attribute? :filter, Dry::Types[
|
39
|
+
# attribute? :filter, Filter
|
40
|
+
attribute? :filter, Dry::Types["hash"]
|
41
41
|
attribute? :sparse_vector, SparseVector
|
42
|
-
attribute? :id, Dry::Types[
|
42
|
+
attribute? :id, Dry::Types["string"]
|
43
43
|
|
44
44
|
def self.new(input)
|
45
45
|
validation = QueryContract.new.call(input)
|
@@ -53,10 +53,10 @@ module Pinecone
|
|
53
53
|
def to_json
|
54
54
|
to_h.map do |key, value|
|
55
55
|
[key.to_s.split("_").map.with_index do |word, index|
|
56
|
-
index == 0 ? word : word.capitalize
|
56
|
+
(index == 0) ? word : word.capitalize
|
57
57
|
end.join.to_sym, value]
|
58
58
|
end.to_h.to_json
|
59
59
|
end
|
60
60
|
end
|
61
61
|
end
|
62
|
-
end
|
62
|
+
end
|
@@ -24,8 +24,8 @@ module Pinecone
|
|
24
24
|
end
|
25
25
|
end
|
26
26
|
|
27
|
-
attribute :indices, Dry::Types[
|
28
|
-
attribute :values, Dry::Types[
|
27
|
+
attribute :indices, Dry::Types["array"].of(Dry::Types["integer"])
|
28
|
+
attribute :values, Dry::Types["array"].of(Dry::Types["float"] | Dry::Types["integer"])
|
29
29
|
|
30
30
|
def self.new(input)
|
31
31
|
validation = SparseVectorContract.new.call(input)
|
@@ -37,4 +37,4 @@ module Pinecone
|
|
37
37
|
end
|
38
38
|
end
|
39
39
|
end
|
40
|
-
end
|
40
|
+
end
|
data/lib/pinecone/vector.rb
CHANGED
@@ -5,46 +5,52 @@ require "pinecone/vector/sparse_vector"
|
|
5
5
|
module Pinecone
|
6
6
|
class Vector
|
7
7
|
include HTTParty
|
8
|
+
parser Pinecone::ResponseParser
|
9
|
+
|
10
|
+
attr_reader :base_uri
|
8
11
|
|
9
12
|
def initialize(index_name)
|
10
|
-
|
13
|
+
@base_uri = set_base_uri(index_name)
|
11
14
|
|
12
15
|
@headers = {
|
13
16
|
"Content-Type" => "application/json",
|
14
17
|
"Accept" => "application/json",
|
15
|
-
"Api-Key" => Pinecone.configuration.api_key
|
18
|
+
"Api-Key" => Pinecone.configuration.api_key
|
16
19
|
}
|
17
20
|
end
|
18
21
|
|
19
|
-
def delete(namespace: "", ids: [], delete_all: false)
|
22
|
+
def delete(namespace: "", ids: [], delete_all: false, filter: {})
|
20
23
|
inputs = {
|
21
|
-
|
22
|
-
|
23
|
-
|
24
|
-
|
25
|
-
|
26
|
-
|
24
|
+
namespace: namespace,
|
25
|
+
ids: ids,
|
26
|
+
deleteAll: delete_all,
|
27
|
+
filter: filter
|
28
|
+
}
|
29
|
+
|
30
|
+
inputs.delete(:filter) if delete_all || ids.any?
|
31
|
+
payload = options.merge(body: inputs.to_json)
|
32
|
+
self.class.post("#{@base_uri}/vectors/delete", payload)
|
27
33
|
end
|
28
34
|
|
29
35
|
def fetch(namespace: "", ids: [])
|
30
|
-
query_string = URI.encode_www_form({
|
31
|
-
self.class.get("/vectors/fetch?#{query_string}", options)
|
36
|
+
query_string = URI.encode_www_form({namespace: namespace, ids: ids})
|
37
|
+
self.class.get("#{@base_uri}/vectors/fetch?#{query_string}", options)
|
32
38
|
end
|
33
39
|
|
34
40
|
def upsert(body)
|
35
41
|
payload = options.merge(body: body.to_json)
|
36
|
-
self.class.post(
|
42
|
+
self.class.post("#{@base_uri}/vectors/upsert", payload)
|
37
43
|
end
|
38
44
|
|
39
45
|
def query(query)
|
40
46
|
object = query.is_a?(Pinecone::Vector::Query) ? query : Pinecone::Vector::Query.new(query)
|
41
47
|
payload = options.merge(body: object.to_json)
|
42
|
-
self.class.post(
|
48
|
+
self.class.post("#{@base_uri}/query", payload)
|
43
49
|
end
|
44
50
|
|
45
51
|
def update(id:, values: [], sparse_values: {indices: [], values: []}, set_metadata: {}, namespace: "")
|
46
52
|
inputs = {
|
47
|
-
|
53
|
+
id: id
|
48
54
|
}
|
49
55
|
inputs["values"] = values unless values.empty?
|
50
56
|
inputs["sparseValues"] = sparse_values unless sparse_values[:indices].empty? || sparse_values[:values].empty?
|
@@ -52,7 +58,7 @@ module Pinecone
|
|
52
58
|
inputs["namespace"] = namespace unless namespace.empty?
|
53
59
|
|
54
60
|
payload = options.merge(body: inputs.to_json)
|
55
|
-
self.class.post(
|
61
|
+
self.class.post("#{@base_uri}/vectors/update", payload)
|
56
62
|
end
|
57
63
|
|
58
64
|
def describe_index_stats(filter: {})
|
@@ -61,13 +67,12 @@ module Pinecone
|
|
61
67
|
else
|
62
68
|
options.merge(body: {filter: filter}.to_json)
|
63
69
|
end
|
64
|
-
self.class.post(
|
70
|
+
self.class.post("#{@base_uri}/describe_index_stats", payload)
|
65
71
|
end
|
66
72
|
|
67
|
-
|
68
73
|
def options
|
69
74
|
{
|
70
|
-
headers: @headers
|
75
|
+
headers: @headers
|
71
76
|
}
|
72
77
|
end
|
73
78
|
|
@@ -77,8 +82,8 @@ module Pinecone
|
|
77
82
|
def set_base_uri(index_name)
|
78
83
|
index_description = Pinecone::Index.new.describe(index_name)
|
79
84
|
raise Pinecone::IndexNotFoundError, "Index #{index_name} does not exist" if index_description.code != 200
|
80
|
-
uri = index_description.parsed_response["
|
85
|
+
uri = index_description.parsed_response["host"]
|
81
86
|
"https://#{uri}"
|
82
87
|
end
|
83
88
|
end
|
84
|
-
end
|
89
|
+
end
|
data/lib/pinecone/version.rb
CHANGED
@@ -1,3 +1,3 @@
|
|
1
1
|
module Pinecone
|
2
|
-
VERSION = "0.1
|
3
|
-
end
|
2
|
+
VERSION = "1.0.1".freeze
|
3
|
+
end
|
data/lib/pinecone.rb
CHANGED
@@ -1,5 +1,6 @@
|
|
1
1
|
require "httparty"
|
2
2
|
|
3
|
+
require "pinecone/response_parser"
|
3
4
|
require "pinecone/client"
|
4
5
|
require "pinecone/index"
|
5
6
|
require "pinecone/vector"
|
@@ -8,14 +9,16 @@ require "pinecone/version"
|
|
8
9
|
|
9
10
|
module Pinecone
|
10
11
|
class ConfigurationError < StandardError; end
|
12
|
+
|
11
13
|
class IndexNotFoundError < StandardError; end
|
14
|
+
|
12
15
|
class Configuration
|
13
16
|
attr_writer :api_key, :base_uri, :environment
|
14
17
|
|
15
18
|
def initialize
|
16
|
-
@api_key
|
19
|
+
@api_key = nil
|
17
20
|
@environment = nil
|
18
|
-
@base_uri
|
21
|
+
@base_uri = nil
|
19
22
|
end
|
20
23
|
|
21
24
|
def api_key
|
@@ -48,4 +51,4 @@ module Pinecone
|
|
48
51
|
def self.configure
|
49
52
|
yield(configuration)
|
50
53
|
end
|
51
|
-
end
|
54
|
+
end
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: pinecone
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.1
|
4
|
+
version: 1.0.1
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Scott Carleton
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date:
|
11
|
+
date: 2024-01-29 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: httparty
|
@@ -30,126 +30,28 @@ dependencies:
|
|
30
30
|
requirements:
|
31
31
|
- - "~>"
|
32
32
|
- !ruby/object:Gem::Version
|
33
|
-
version: 1.
|
33
|
+
version: 1.6.0
|
34
34
|
type: :runtime
|
35
35
|
prerelease: false
|
36
36
|
version_requirements: !ruby/object:Gem::Requirement
|
37
37
|
requirements:
|
38
38
|
- - "~>"
|
39
39
|
- !ruby/object:Gem::Version
|
40
|
-
version: 1.
|
40
|
+
version: 1.6.0
|
41
41
|
- !ruby/object:Gem::Dependency
|
42
42
|
name: dry-validation
|
43
43
|
requirement: !ruby/object:Gem::Requirement
|
44
44
|
requirements:
|
45
45
|
- - "~>"
|
46
46
|
- !ruby/object:Gem::Version
|
47
|
-
version: 1.
|
47
|
+
version: 1.10.0
|
48
48
|
type: :runtime
|
49
49
|
prerelease: false
|
50
50
|
version_requirements: !ruby/object:Gem::Requirement
|
51
51
|
requirements:
|
52
52
|
- - "~>"
|
53
53
|
- !ruby/object:Gem::Version
|
54
|
-
version: 1.
|
55
|
-
- !ruby/object:Gem::Dependency
|
56
|
-
name: dotenv
|
57
|
-
requirement: !ruby/object:Gem::Requirement
|
58
|
-
requirements:
|
59
|
-
- - "~>"
|
60
|
-
- !ruby/object:Gem::Version
|
61
|
-
version: '2.8'
|
62
|
-
type: :development
|
63
|
-
prerelease: false
|
64
|
-
version_requirements: !ruby/object:Gem::Requirement
|
65
|
-
requirements:
|
66
|
-
- - "~>"
|
67
|
-
- !ruby/object:Gem::Version
|
68
|
-
version: '2.8'
|
69
|
-
- !ruby/object:Gem::Dependency
|
70
|
-
name: awesome_print
|
71
|
-
requirement: !ruby/object:Gem::Requirement
|
72
|
-
requirements:
|
73
|
-
- - "~>"
|
74
|
-
- !ruby/object:Gem::Version
|
75
|
-
version: '1.9'
|
76
|
-
type: :development
|
77
|
-
prerelease: false
|
78
|
-
version_requirements: !ruby/object:Gem::Requirement
|
79
|
-
requirements:
|
80
|
-
- - "~>"
|
81
|
-
- !ruby/object:Gem::Version
|
82
|
-
version: '1.9'
|
83
|
-
- !ruby/object:Gem::Dependency
|
84
|
-
name: rake
|
85
|
-
requirement: !ruby/object:Gem::Requirement
|
86
|
-
requirements:
|
87
|
-
- - "~>"
|
88
|
-
- !ruby/object:Gem::Version
|
89
|
-
version: '13.0'
|
90
|
-
type: :development
|
91
|
-
prerelease: false
|
92
|
-
version_requirements: !ruby/object:Gem::Requirement
|
93
|
-
requirements:
|
94
|
-
- - "~>"
|
95
|
-
- !ruby/object:Gem::Version
|
96
|
-
version: '13.0'
|
97
|
-
- !ruby/object:Gem::Dependency
|
98
|
-
name: debug
|
99
|
-
requirement: !ruby/object:Gem::Requirement
|
100
|
-
requirements:
|
101
|
-
- - "~>"
|
102
|
-
- !ruby/object:Gem::Version
|
103
|
-
version: '1.7'
|
104
|
-
type: :development
|
105
|
-
prerelease: false
|
106
|
-
version_requirements: !ruby/object:Gem::Requirement
|
107
|
-
requirements:
|
108
|
-
- - "~>"
|
109
|
-
- !ruby/object:Gem::Version
|
110
|
-
version: '1.7'
|
111
|
-
- !ruby/object:Gem::Dependency
|
112
|
-
name: rspec
|
113
|
-
requirement: !ruby/object:Gem::Requirement
|
114
|
-
requirements:
|
115
|
-
- - "~>"
|
116
|
-
- !ruby/object:Gem::Version
|
117
|
-
version: '3.12'
|
118
|
-
type: :development
|
119
|
-
prerelease: false
|
120
|
-
version_requirements: !ruby/object:Gem::Requirement
|
121
|
-
requirements:
|
122
|
-
- - "~>"
|
123
|
-
- !ruby/object:Gem::Version
|
124
|
-
version: '3.12'
|
125
|
-
- !ruby/object:Gem::Dependency
|
126
|
-
name: webmock
|
127
|
-
requirement: !ruby/object:Gem::Requirement
|
128
|
-
requirements:
|
129
|
-
- - "~>"
|
130
|
-
- !ruby/object:Gem::Version
|
131
|
-
version: '3.14'
|
132
|
-
type: :development
|
133
|
-
prerelease: false
|
134
|
-
version_requirements: !ruby/object:Gem::Requirement
|
135
|
-
requirements:
|
136
|
-
- - "~>"
|
137
|
-
- !ruby/object:Gem::Version
|
138
|
-
version: '3.14'
|
139
|
-
- !ruby/object:Gem::Dependency
|
140
|
-
name: vcr
|
141
|
-
requirement: !ruby/object:Gem::Requirement
|
142
|
-
requirements:
|
143
|
-
- - "~>"
|
144
|
-
- !ruby/object:Gem::Version
|
145
|
-
version: '6.1'
|
146
|
-
type: :development
|
147
|
-
prerelease: false
|
148
|
-
version_requirements: !ruby/object:Gem::Requirement
|
149
|
-
requirements:
|
150
|
-
- - "~>"
|
151
|
-
- !ruby/object:Gem::Version
|
152
|
-
version: '6.1'
|
54
|
+
version: 1.10.0
|
153
55
|
description: Ruby client library which includes index and vector operations to upload
|
154
56
|
embeddings into Pinecone and do similarity searches on them.
|
155
57
|
email: scott@extrayarn.com
|
@@ -161,6 +63,7 @@ files:
|
|
161
63
|
- lib/pinecone/client.rb
|
162
64
|
- lib/pinecone/collection.rb
|
163
65
|
- lib/pinecone/index.rb
|
66
|
+
- lib/pinecone/response_parser.rb
|
164
67
|
- lib/pinecone/vector.rb
|
165
68
|
- lib/pinecone/vector/filter.rb
|
166
69
|
- lib/pinecone/vector/query.rb
|
@@ -186,7 +89,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
186
89
|
- !ruby/object:Gem::Version
|
187
90
|
version: '0'
|
188
91
|
requirements: []
|
189
|
-
rubygems_version: 3.4.
|
92
|
+
rubygems_version: 3.4.19
|
190
93
|
signing_key:
|
191
94
|
specification_version: 4
|
192
95
|
summary: Ruby client library for Pinecone Vector DB
|