typesense 4.1.0 → 5.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.github/workflows/tests.yml +2 -2
- data/.rubocop.yml +9 -1
- data/Gemfile +3 -7
- data/README.md +42 -0
- data/docker-compose.yml +1 -1
- data/flake.lock +61 -0
- data/flake.nix +56 -0
- data/lib/typesense/alias.rb +12 -0
- data/lib/typesense/aliases.rb +20 -0
- data/lib/typesense/analytics.rb +23 -0
- data/lib/typesense/analytics_events.rb +31 -0
- data/lib/typesense/analytics_events_v1.rb +27 -0
- data/lib/typesense/analytics_rule.rb +23 -0
- data/lib/typesense/analytics_rule_v1.rb +36 -0
- data/lib/typesense/analytics_rules.rb +37 -12
- data/lib/typesense/analytics_rules_v1.rb +50 -0
- data/lib/typesense/analytics_v1.rb +39 -0
- data/lib/typesense/api_call.rb +72 -5
- data/lib/typesense/client.rb +182 -2
- data/lib/typesense/collection.rb +56 -1
- data/lib/typesense/collections.rb +20 -0
- data/lib/typesense/configuration.rb +18 -4
- data/lib/typesense/curation_set.rb +60 -0
- data/lib/typesense/curation_set_item.rb +47 -0
- data/lib/typesense/curation_set_items.rb +39 -0
- data/lib/typesense/curation_sets.rb +43 -0
- data/lib/typesense/debug.rb +6 -0
- data/lib/typesense/document.rb +18 -0
- data/lib/typesense/documents.rb +62 -0
- data/lib/typesense/health.rb +6 -0
- data/lib/typesense/key.rb +12 -0
- data/lib/typesense/keys.rb +26 -0
- data/lib/typesense/metrics.rb +6 -0
- data/lib/typesense/multi_search.rb +8 -0
- data/lib/typesense/nl_search_model.rb +18 -0
- data/lib/typesense/nl_search_models.rb +20 -0
- data/lib/typesense/operations.rb +6 -0
- data/lib/typesense/override.rb +12 -0
- data/lib/typesense/overrides.rb +20 -0
- data/lib/typesense/preset.rb +12 -0
- data/lib/typesense/presets.rb +20 -0
- data/lib/typesense/stats.rb +6 -0
- data/lib/typesense/stemming.rb +11 -0
- data/lib/typesense/stemming_dictionaries.rb +20 -0
- data/lib/typesense/stemming_dictionary.rb +6 -0
- data/lib/typesense/synonym.rb +13 -0
- data/lib/typesense/synonym_set.rb +60 -0
- data/lib/typesense/synonym_set_item.rb +47 -0
- data/lib/typesense/synonym_set_items.rb +39 -0
- data/lib/typesense/synonym_sets.rb +50 -0
- data/lib/typesense/synonyms.rb +21 -0
- data/lib/typesense/version.rb +1 -1
- data/lib/typesense.rb +13 -0
- data/typesense.gemspec +5 -5
- metadata +57 -11
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Typesense
|
|
4
|
+
class SynonymSetItem
|
|
5
|
+
def initialize(synonym_set_name, item_id, api_call)
|
|
6
|
+
@synonym_set_name = synonym_set_name
|
|
7
|
+
@item_id = item_id
|
|
8
|
+
@api_call = api_call
|
|
9
|
+
end
|
|
10
|
+
|
|
11
|
+
# Retrieve a specific synonym item by its id
|
|
12
|
+
#
|
|
13
|
+
# @example
|
|
14
|
+
# client.synonym_sets['my-set'].items['smart-phone-synonyms'].retrieve
|
|
15
|
+
#
|
|
16
|
+
# @see https://typesense.org/docs/latest/api/synonyms.html
|
|
17
|
+
def retrieve
|
|
18
|
+
@api_call.get(endpoint_path)
|
|
19
|
+
end
|
|
20
|
+
|
|
21
|
+
# Create or update a synonym item with the given id
|
|
22
|
+
#
|
|
23
|
+
# @example
|
|
24
|
+
# client.synonym_sets['my-set'].items['smart-phone-synonyms'].upsert('synonyms' => ['smart phone', 'iphone'])
|
|
25
|
+
#
|
|
26
|
+
# @see https://typesense.org/docs/latest/api/synonyms.html
|
|
27
|
+
def upsert(params)
|
|
28
|
+
@api_call.put(endpoint_path, params)
|
|
29
|
+
end
|
|
30
|
+
|
|
31
|
+
# Delete a specific synonym item by its id
|
|
32
|
+
#
|
|
33
|
+
# @example
|
|
34
|
+
# client.synonym_sets['my-set'].items['smart-phone-synonyms'].delete
|
|
35
|
+
#
|
|
36
|
+
# @see https://typesense.org/docs/latest/api/synonyms.html
|
|
37
|
+
def delete
|
|
38
|
+
@api_call.delete(endpoint_path)
|
|
39
|
+
end
|
|
40
|
+
|
|
41
|
+
private
|
|
42
|
+
|
|
43
|
+
def endpoint_path
|
|
44
|
+
"#{SynonymSets::RESOURCE_PATH}/#{URI.encode_www_form_component(@synonym_set_name)}/items/#{URI.encode_www_form_component(@item_id)}"
|
|
45
|
+
end
|
|
46
|
+
end
|
|
47
|
+
end
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Typesense
|
|
4
|
+
class SynonymSetItems
|
|
5
|
+
def initialize(synonym_set_name, api_call)
|
|
6
|
+
@synonym_set_name = synonym_set_name
|
|
7
|
+
@api_call = api_call
|
|
8
|
+
@items = {}
|
|
9
|
+
end
|
|
10
|
+
|
|
11
|
+
# Retrieve all synonym items in a set
|
|
12
|
+
#
|
|
13
|
+
# @example
|
|
14
|
+
# client.synonym_sets['my-set'].items.retrieve
|
|
15
|
+
#
|
|
16
|
+
# @see https://typesense.org/docs/latest/api/synonyms.html
|
|
17
|
+
def retrieve
|
|
18
|
+
@api_call.get(endpoint_path)
|
|
19
|
+
end
|
|
20
|
+
|
|
21
|
+
# Access an individual synonym item by ID within this synonym set.
|
|
22
|
+
#
|
|
23
|
+
# @example
|
|
24
|
+
# client.synonym_sets['my-set'].items['smart-phone-synonyms'].retrieve
|
|
25
|
+
#
|
|
26
|
+
# @see https://typesense.org/docs/latest/api/synonyms.html
|
|
27
|
+
#
|
|
28
|
+
# @return [SynonymSetItem]
|
|
29
|
+
def [](item_id)
|
|
30
|
+
@items[item_id] ||= SynonymSetItem.new(@synonym_set_name, item_id, @api_call)
|
|
31
|
+
end
|
|
32
|
+
|
|
33
|
+
private
|
|
34
|
+
|
|
35
|
+
def endpoint_path
|
|
36
|
+
"#{SynonymSets::RESOURCE_PATH}/#{URI.encode_www_form_component(@synonym_set_name)}/items"
|
|
37
|
+
end
|
|
38
|
+
end
|
|
39
|
+
end
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Typesense
|
|
4
|
+
class SynonymSets
|
|
5
|
+
RESOURCE_PATH = '/synonym_sets'
|
|
6
|
+
|
|
7
|
+
def initialize(api_call)
|
|
8
|
+
@api_call = api_call
|
|
9
|
+
@synonym_sets = {}
|
|
10
|
+
end
|
|
11
|
+
|
|
12
|
+
# Create or update a synonym set with the given name
|
|
13
|
+
#
|
|
14
|
+
# @example
|
|
15
|
+
# client.synonym_sets.upsert('my-set', 'items' => [{ 'id' => 'syn-1', 'synonyms' => ['nyc', 'new york'] }])
|
|
16
|
+
#
|
|
17
|
+
# @see https://typesense.org/docs/latest/api/synonyms.html
|
|
18
|
+
def upsert(synonym_set_name, params)
|
|
19
|
+
@api_call.put(endpoint_path(synonym_set_name), params)
|
|
20
|
+
end
|
|
21
|
+
|
|
22
|
+
# Retrieve all synonym sets
|
|
23
|
+
#
|
|
24
|
+
# @example
|
|
25
|
+
# client.synonym_sets.retrieve
|
|
26
|
+
#
|
|
27
|
+
# @see https://typesense.org/docs/latest/api/synonyms.html
|
|
28
|
+
def retrieve
|
|
29
|
+
@api_call.get(endpoint_path)
|
|
30
|
+
end
|
|
31
|
+
|
|
32
|
+
# Access an individual synonym set by name.
|
|
33
|
+
#
|
|
34
|
+
# @example
|
|
35
|
+
# client.synonym_sets['my-set'].retrieve
|
|
36
|
+
#
|
|
37
|
+
# @see https://typesense.org/docs/latest/api/synonyms.html
|
|
38
|
+
#
|
|
39
|
+
# @return [SynonymSet]
|
|
40
|
+
def [](synonym_set_name)
|
|
41
|
+
@synonym_sets[synonym_set_name] ||= SynonymSet.new(synonym_set_name, @api_call)
|
|
42
|
+
end
|
|
43
|
+
|
|
44
|
+
private
|
|
45
|
+
|
|
46
|
+
def endpoint_path(operation = nil)
|
|
47
|
+
"#{RESOURCE_PATH}#{"/#{URI.encode_www_form_component(operation)}" unless operation.nil?}"
|
|
48
|
+
end
|
|
49
|
+
end
|
|
50
|
+
end
|
data/lib/typesense/synonyms.rb
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
# frozen_string_literal: true
|
|
2
2
|
|
|
3
3
|
module Typesense
|
|
4
|
+
# @deprecated Deprecated starting with Typesense Server v30. Please migrate to `client.synonym_sets` (new Synonym Sets APIs).
|
|
4
5
|
class Synonyms
|
|
5
6
|
RESOURCE_PATH = '/synonyms'
|
|
6
7
|
|
|
@@ -10,14 +11,34 @@ module Typesense
|
|
|
10
11
|
@synonyms = {}
|
|
11
12
|
end
|
|
12
13
|
|
|
14
|
+
# Create or update a synonym (legacy v1) on this collection.
|
|
15
|
+
#
|
|
16
|
+
# @example
|
|
17
|
+
# client.collections['products'].synonyms.upsert('syn-1', 'synonyms' => ['nyc', 'new york'])
|
|
18
|
+
#
|
|
19
|
+
# @see https://typesense.org/docs/29.0/api/synonyms.html
|
|
13
20
|
def upsert(synonym_id, params)
|
|
14
21
|
@api_call.put(endpoint_path(synonym_id), params)
|
|
15
22
|
end
|
|
16
23
|
|
|
24
|
+
# Retrieve all synonyms (legacy v1) on this collection.
|
|
25
|
+
#
|
|
26
|
+
# @example
|
|
27
|
+
# client.collections['products'].synonyms.retrieve
|
|
28
|
+
#
|
|
29
|
+
# @see https://typesense.org/docs/29.0/api/synonyms.html
|
|
17
30
|
def retrieve
|
|
18
31
|
@api_call.get(endpoint_path)
|
|
19
32
|
end
|
|
20
33
|
|
|
34
|
+
# Access an individual synonym by ID within this collection.
|
|
35
|
+
#
|
|
36
|
+
# @example
|
|
37
|
+
# client.collections['products'].synonyms['syn-1'].retrieve
|
|
38
|
+
#
|
|
39
|
+
# @see https://typesense.org/docs/29.0/api/synonyms.html
|
|
40
|
+
#
|
|
41
|
+
# @return [Synonym]
|
|
21
42
|
def [](synonym_id)
|
|
22
43
|
@synonyms[synonym_id] ||= Synonym.new(@collection_name, synonym_id, @api_call)
|
|
23
44
|
end
|
data/lib/typesense/version.rb
CHANGED
data/lib/typesense.rb
CHANGED
|
@@ -16,14 +16,23 @@ require_relative 'typesense/overrides'
|
|
|
16
16
|
require_relative 'typesense/override'
|
|
17
17
|
require_relative 'typesense/synonyms'
|
|
18
18
|
require_relative 'typesense/synonym'
|
|
19
|
+
require_relative 'typesense/synonym_sets'
|
|
20
|
+
require_relative 'typesense/synonym_set'
|
|
21
|
+
require_relative 'typesense/synonym_set_items'
|
|
22
|
+
require_relative 'typesense/synonym_set_item'
|
|
19
23
|
require_relative 'typesense/aliases'
|
|
20
24
|
require_relative 'typesense/alias'
|
|
21
25
|
require_relative 'typesense/keys'
|
|
22
26
|
require_relative 'typesense/key'
|
|
23
27
|
require_relative 'typesense/multi_search'
|
|
24
28
|
require_relative 'typesense/analytics'
|
|
29
|
+
require_relative 'typesense/analytics_events'
|
|
25
30
|
require_relative 'typesense/analytics_rules'
|
|
26
31
|
require_relative 'typesense/analytics_rule'
|
|
32
|
+
require_relative 'typesense/analytics_v1'
|
|
33
|
+
require_relative 'typesense/analytics_events_v1'
|
|
34
|
+
require_relative 'typesense/analytics_rules_v1'
|
|
35
|
+
require_relative 'typesense/analytics_rule_v1'
|
|
27
36
|
require_relative 'typesense/presets'
|
|
28
37
|
require_relative 'typesense/preset'
|
|
29
38
|
require_relative 'typesense/debug'
|
|
@@ -37,3 +46,7 @@ require_relative 'typesense/stemming_dictionaries'
|
|
|
37
46
|
require_relative 'typesense/stemming_dictionary'
|
|
38
47
|
require_relative 'typesense/nl_search_models'
|
|
39
48
|
require_relative 'typesense/nl_search_model'
|
|
49
|
+
require_relative 'typesense/curation_sets'
|
|
50
|
+
require_relative 'typesense/curation_set'
|
|
51
|
+
require_relative 'typesense/curation_set_items'
|
|
52
|
+
require_relative 'typesense/curation_set_item'
|
data/typesense.gemspec
CHANGED
|
@@ -15,9 +15,7 @@ Gem::Specification.new do |spec|
|
|
|
15
15
|
spec.homepage = 'https://typesense.org'
|
|
16
16
|
spec.license = 'Apache-2.0'
|
|
17
17
|
|
|
18
|
-
|
|
19
|
-
spec.required_ruby_version = '>= 2.7'
|
|
20
|
-
# rubocop:enable Gemspec/RequiredRubyVersion, Lint/RedundantCopDisableDirective
|
|
18
|
+
spec.required_ruby_version = '>= 3.0'
|
|
21
19
|
|
|
22
20
|
spec.files = `git ls-files -z`.split("\x0").reject do |f|
|
|
23
21
|
f.match(%r{^(test|spec|features)/})
|
|
@@ -26,8 +24,10 @@ Gem::Specification.new do |spec|
|
|
|
26
24
|
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
|
|
27
25
|
spec.require_paths = ['lib']
|
|
28
26
|
|
|
29
|
-
spec.add_dependency 'base64', '~> 0.2
|
|
27
|
+
spec.add_dependency 'base64', '~> 0.2'
|
|
30
28
|
spec.add_dependency 'faraday', '~> 2.8'
|
|
31
|
-
spec.add_dependency '
|
|
29
|
+
spec.add_dependency 'faraday-net_http_persistent', '~> 2.0'
|
|
30
|
+
spec.add_dependency 'json', '>= 2.9', '< 4'
|
|
31
|
+
spec.add_dependency 'net-http-persistent', '~> 4.0'
|
|
32
32
|
spec.metadata['rubygems_mfa_required'] = 'true'
|
|
33
33
|
end
|
metadata
CHANGED
|
@@ -1,14 +1,13 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: typesense
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version:
|
|
4
|
+
version: 5.1.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Typesense, Inc.
|
|
8
|
-
autorequire:
|
|
9
8
|
bindir: exe
|
|
10
9
|
cert_chain: []
|
|
11
|
-
date:
|
|
10
|
+
date: 1980-01-01 00:00:00.000000000 Z
|
|
12
11
|
dependencies:
|
|
13
12
|
- !ruby/object:Gem::Dependency
|
|
14
13
|
name: base64
|
|
@@ -16,14 +15,14 @@ dependencies:
|
|
|
16
15
|
requirements:
|
|
17
16
|
- - "~>"
|
|
18
17
|
- !ruby/object:Gem::Version
|
|
19
|
-
version: 0.2
|
|
18
|
+
version: '0.2'
|
|
20
19
|
type: :runtime
|
|
21
20
|
prerelease: false
|
|
22
21
|
version_requirements: !ruby/object:Gem::Requirement
|
|
23
22
|
requirements:
|
|
24
23
|
- - "~>"
|
|
25
24
|
- !ruby/object:Gem::Version
|
|
26
|
-
version: 0.2
|
|
25
|
+
version: '0.2'
|
|
27
26
|
- !ruby/object:Gem::Dependency
|
|
28
27
|
name: faraday
|
|
29
28
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -39,19 +38,53 @@ dependencies:
|
|
|
39
38
|
- !ruby/object:Gem::Version
|
|
40
39
|
version: '2.8'
|
|
41
40
|
- !ruby/object:Gem::Dependency
|
|
42
|
-
name:
|
|
41
|
+
name: faraday-net_http_persistent
|
|
43
42
|
requirement: !ruby/object:Gem::Requirement
|
|
44
43
|
requirements:
|
|
45
44
|
- - "~>"
|
|
46
45
|
- !ruby/object:Gem::Version
|
|
47
|
-
version: '2.
|
|
46
|
+
version: '2.0'
|
|
48
47
|
type: :runtime
|
|
49
48
|
prerelease: false
|
|
50
49
|
version_requirements: !ruby/object:Gem::Requirement
|
|
51
50
|
requirements:
|
|
52
51
|
- - "~>"
|
|
52
|
+
- !ruby/object:Gem::Version
|
|
53
|
+
version: '2.0'
|
|
54
|
+
- !ruby/object:Gem::Dependency
|
|
55
|
+
name: json
|
|
56
|
+
requirement: !ruby/object:Gem::Requirement
|
|
57
|
+
requirements:
|
|
58
|
+
- - ">="
|
|
59
|
+
- !ruby/object:Gem::Version
|
|
60
|
+
version: '2.9'
|
|
61
|
+
- - "<"
|
|
62
|
+
- !ruby/object:Gem::Version
|
|
63
|
+
version: '4'
|
|
64
|
+
type: :runtime
|
|
65
|
+
prerelease: false
|
|
66
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
67
|
+
requirements:
|
|
68
|
+
- - ">="
|
|
53
69
|
- !ruby/object:Gem::Version
|
|
54
70
|
version: '2.9'
|
|
71
|
+
- - "<"
|
|
72
|
+
- !ruby/object:Gem::Version
|
|
73
|
+
version: '4'
|
|
74
|
+
- !ruby/object:Gem::Dependency
|
|
75
|
+
name: net-http-persistent
|
|
76
|
+
requirement: !ruby/object:Gem::Requirement
|
|
77
|
+
requirements:
|
|
78
|
+
- - "~>"
|
|
79
|
+
- !ruby/object:Gem::Version
|
|
80
|
+
version: '4.0'
|
|
81
|
+
type: :runtime
|
|
82
|
+
prerelease: false
|
|
83
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
84
|
+
requirements:
|
|
85
|
+
- - "~>"
|
|
86
|
+
- !ruby/object:Gem::Version
|
|
87
|
+
version: '4.0'
|
|
55
88
|
description: Typesense is an open source search engine for building a delightful search
|
|
56
89
|
experience.
|
|
57
90
|
email:
|
|
@@ -80,17 +113,28 @@ files:
|
|
|
80
113
|
- examples/overrides.rb
|
|
81
114
|
- examples/search.rb
|
|
82
115
|
- examples/synonyms.rb
|
|
116
|
+
- flake.lock
|
|
117
|
+
- flake.nix
|
|
83
118
|
- lib/typesense.rb
|
|
84
119
|
- lib/typesense/alias.rb
|
|
85
120
|
- lib/typesense/aliases.rb
|
|
86
121
|
- lib/typesense/analytics.rb
|
|
122
|
+
- lib/typesense/analytics_events.rb
|
|
123
|
+
- lib/typesense/analytics_events_v1.rb
|
|
87
124
|
- lib/typesense/analytics_rule.rb
|
|
125
|
+
- lib/typesense/analytics_rule_v1.rb
|
|
88
126
|
- lib/typesense/analytics_rules.rb
|
|
127
|
+
- lib/typesense/analytics_rules_v1.rb
|
|
128
|
+
- lib/typesense/analytics_v1.rb
|
|
89
129
|
- lib/typesense/api_call.rb
|
|
90
130
|
- lib/typesense/client.rb
|
|
91
131
|
- lib/typesense/collection.rb
|
|
92
132
|
- lib/typesense/collections.rb
|
|
93
133
|
- lib/typesense/configuration.rb
|
|
134
|
+
- lib/typesense/curation_set.rb
|
|
135
|
+
- lib/typesense/curation_set_item.rb
|
|
136
|
+
- lib/typesense/curation_set_items.rb
|
|
137
|
+
- lib/typesense/curation_sets.rb
|
|
94
138
|
- lib/typesense/debug.rb
|
|
95
139
|
- lib/typesense/document.rb
|
|
96
140
|
- lib/typesense/documents.rb
|
|
@@ -112,6 +156,10 @@ files:
|
|
|
112
156
|
- lib/typesense/stemming_dictionaries.rb
|
|
113
157
|
- lib/typesense/stemming_dictionary.rb
|
|
114
158
|
- lib/typesense/synonym.rb
|
|
159
|
+
- lib/typesense/synonym_set.rb
|
|
160
|
+
- lib/typesense/synonym_set_item.rb
|
|
161
|
+
- lib/typesense/synonym_set_items.rb
|
|
162
|
+
- lib/typesense/synonym_sets.rb
|
|
115
163
|
- lib/typesense/synonyms.rb
|
|
116
164
|
- lib/typesense/version.rb
|
|
117
165
|
- typesense.gemspec
|
|
@@ -120,7 +168,6 @@ licenses:
|
|
|
120
168
|
- Apache-2.0
|
|
121
169
|
metadata:
|
|
122
170
|
rubygems_mfa_required: 'true'
|
|
123
|
-
post_install_message:
|
|
124
171
|
rdoc_options: []
|
|
125
172
|
require_paths:
|
|
126
173
|
- lib
|
|
@@ -128,15 +175,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
|
128
175
|
requirements:
|
|
129
176
|
- - ">="
|
|
130
177
|
- !ruby/object:Gem::Version
|
|
131
|
-
version: '
|
|
178
|
+
version: '3.0'
|
|
132
179
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
|
133
180
|
requirements:
|
|
134
181
|
- - ">="
|
|
135
182
|
- !ruby/object:Gem::Version
|
|
136
183
|
version: '0'
|
|
137
184
|
requirements: []
|
|
138
|
-
rubygems_version: 3.
|
|
139
|
-
signing_key:
|
|
185
|
+
rubygems_version: 3.7.2
|
|
140
186
|
specification_version: 4
|
|
141
187
|
summary: Ruby Library for Typesense
|
|
142
188
|
test_files: []
|