trieve_ruby_client 0.5.7 → 0.6.2

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.
Files changed (159) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +16 -20
  3. data/docs/AddChunkToGroupData.md +4 -2
  4. data/docs/AuthApi.md +12 -6
  5. data/docs/BookmarkData.md +1 -1
  6. data/docs/ChunkApi.md +8 -8
  7. data/docs/ChunkGroup.md +4 -0
  8. data/docs/ChunkGroupApi.md +25 -25
  9. data/docs/ChunkMetadataWithScore.md +44 -0
  10. data/docs/CreateChunkGroupData.md +5 -1
  11. data/docs/DatasetApi.md +6 -6
  12. data/docs/EventsApi.md +1 -1
  13. data/docs/FileApi.md +2 -2
  14. data/docs/GetEventsData.md +1 -1
  15. data/docs/GroupScoreChunk.md +22 -0
  16. data/docs/GroupScoreSlimChunks.md +20 -0
  17. data/docs/RecommendChunksRequest.md +3 -1
  18. data/docs/RecommendGroupChunksRequest.md +34 -0
  19. data/docs/ScoreChunkDTO.md +1 -1
  20. data/docs/SearchChunkData.md +1 -3
  21. data/docs/SearchOverGroupsData.md +3 -5
  22. data/docs/SearchOverGroupsResults.md +20 -0
  23. data/docs/SearchOverGroupsSlimResults.md +20 -0
  24. data/docs/SearchWithinGroupData.md +1 -3
  25. data/docs/SearchWithinGroupResults.md +22 -0
  26. data/docs/SearchWithinGroupSlimResults.md +22 -0
  27. data/docs/SlimChunkMetadataWithScore.md +38 -0
  28. data/docs/UpdateChunkGroupData.md +4 -0
  29. data/docs/UpdateGroupByTrackingIDData.md +4 -0
  30. data/docs/UserApi.md +2 -2
  31. data/lib/trieve_ruby_client/api/auth_api.rb +13 -11
  32. data/lib/trieve_ruby_client/api/chunk_api.rb +7 -7
  33. data/lib/trieve_ruby_client/api/chunk_group_api.rb +27 -27
  34. data/lib/trieve_ruby_client/api/dataset_api.rb +10 -10
  35. data/lib/trieve_ruby_client/api/events_api.rb +3 -3
  36. data/lib/trieve_ruby_client/api/file_api.rb +5 -5
  37. data/lib/trieve_ruby_client/api/health_api.rb +1 -1
  38. data/lib/trieve_ruby_client/api/invitation_api.rb +1 -1
  39. data/lib/trieve_ruby_client/api/message_api.rb +1 -1
  40. data/lib/trieve_ruby_client/api/organization_api.rb +1 -1
  41. data/lib/trieve_ruby_client/api/stripe_api.rb +1 -1
  42. data/lib/trieve_ruby_client/api/topic_api.rb +1 -1
  43. data/lib/trieve_ruby_client/api/user_api.rb +3 -3
  44. data/lib/trieve_ruby_client/api_client.rb +1 -1
  45. data/lib/trieve_ruby_client/api_error.rb +1 -1
  46. data/lib/trieve_ruby_client/configuration.rb +1 -1
  47. data/lib/trieve_ruby_client/models/add_chunk_to_group_data.rb +17 -12
  48. data/lib/trieve_ruby_client/models/api_key_dto.rb +1 -1
  49. data/lib/trieve_ruby_client/models/auth_query.rb +1 -1
  50. data/lib/trieve_ruby_client/models/batch_queued_chunk_response.rb +1 -1
  51. data/lib/trieve_ruby_client/models/bookmark_data.rb +2 -2
  52. data/lib/trieve_ruby_client/models/bookmark_group_result.rb +1 -1
  53. data/lib/trieve_ruby_client/models/chat_message_proxy.rb +1 -1
  54. data/lib/trieve_ruby_client/models/chunk_data.rb +1 -1
  55. data/lib/trieve_ruby_client/models/chunk_filter.rb +1 -1
  56. data/lib/trieve_ruby_client/models/chunk_group.rb +22 -2
  57. data/lib/trieve_ruby_client/models/chunk_group_and_file.rb +1 -1
  58. data/lib/trieve_ruby_client/models/chunk_metadata.rb +1 -1
  59. data/lib/trieve_ruby_client/models/chunk_metadata_with_file_data.rb +1 -1
  60. data/lib/trieve_ruby_client/models/chunk_metadata_with_score.rb +387 -0
  61. data/lib/trieve_ruby_client/models/client_dataset_configuration.rb +1 -1
  62. data/lib/trieve_ruby_client/models/create_chunk_data.rb +1 -1
  63. data/lib/trieve_ruby_client/models/create_chunk_group_data.rb +27 -9
  64. data/lib/trieve_ruby_client/models/create_dataset_request.rb +1 -1
  65. data/lib/trieve_ruby_client/models/create_message_data.rb +1 -1
  66. data/lib/trieve_ruby_client/models/create_organization_data.rb +1 -1
  67. data/lib/trieve_ruby_client/models/create_topic_data.rb +1 -1
  68. data/lib/trieve_ruby_client/models/dataset.rb +1 -1
  69. data/lib/trieve_ruby_client/models/dataset_and_usage.rb +1 -1
  70. data/lib/trieve_ruby_client/models/dataset_dto.rb +1 -1
  71. data/lib/trieve_ruby_client/models/dataset_usage_count.rb +1 -1
  72. data/lib/trieve_ruby_client/models/delete_topic_data.rb +1 -1
  73. data/lib/trieve_ruby_client/models/delete_user_api_key_request.rb +1 -1
  74. data/lib/trieve_ruby_client/models/edit_message_data.rb +1 -1
  75. data/lib/trieve_ruby_client/models/error_response_body.rb +1 -1
  76. data/lib/trieve_ruby_client/models/event.rb +1 -1
  77. data/lib/trieve_ruby_client/models/event_return.rb +1 -1
  78. data/lib/trieve_ruby_client/models/field_condition.rb +1 -1
  79. data/lib/trieve_ruby_client/models/file.rb +1 -1
  80. data/lib/trieve_ruby_client/models/file_dto.rb +1 -1
  81. data/lib/trieve_ruby_client/models/generate_chunks_request.rb +1 -1
  82. data/lib/trieve_ruby_client/models/get_events_data.rb +2 -2
  83. data/lib/trieve_ruby_client/models/get_groups_for_chunks_data.rb +1 -1
  84. data/lib/trieve_ruby_client/models/group_data.rb +1 -1
  85. data/lib/trieve_ruby_client/models/group_score_chunk.rb +249 -0
  86. data/lib/trieve_ruby_client/models/group_score_chunk_dto.rb +1 -1
  87. data/lib/trieve_ruby_client/models/group_score_slim_chunks.rb +239 -0
  88. data/lib/trieve_ruby_client/models/group_slim_chunks_dto.rb +1 -1
  89. data/lib/trieve_ruby_client/models/invitation_data.rb +1 -1
  90. data/lib/trieve_ruby_client/models/match_condition.rb +1 -1
  91. data/lib/trieve_ruby_client/models/message.rb +1 -1
  92. data/lib/trieve_ruby_client/models/organization.rb +1 -1
  93. data/lib/trieve_ruby_client/models/organization_usage_count.rb +1 -1
  94. data/lib/trieve_ruby_client/models/range.rb +1 -1
  95. data/lib/trieve_ruby_client/models/range_condition.rb +1 -1
  96. data/lib/trieve_ruby_client/models/recommend_chunks_request.rb +17 -6
  97. data/lib/trieve_ruby_client/models/recommend_chunks_response_types.rb +1 -1
  98. data/lib/trieve_ruby_client/models/recommend_group_chunk_response_types.rb +1 -1
  99. data/lib/trieve_ruby_client/models/recommend_group_chunks_request.rb +341 -0
  100. data/lib/trieve_ruby_client/models/regenerate_message_data.rb +1 -1
  101. data/lib/trieve_ruby_client/models/return_queued_chunk.rb +1 -1
  102. data/lib/trieve_ruby_client/models/score_chunk_dto.rb +2 -2
  103. data/lib/trieve_ruby_client/models/score_slim_chunks.rb +1 -1
  104. data/lib/trieve_ruby_client/models/search_chunk_data.rb +3 -14
  105. data/lib/trieve_ruby_client/models/search_chunk_query_response_body.rb +1 -1
  106. data/lib/trieve_ruby_client/models/search_chunk_response_types.rb +1 -1
  107. data/lib/trieve_ruby_client/models/search_group_slim_chunks_result.rb +1 -1
  108. data/lib/trieve_ruby_client/models/search_groups_result.rb +1 -1
  109. data/lib/trieve_ruby_client/models/search_over_groups_data.rb +5 -15
  110. data/lib/trieve_ruby_client/models/search_over_groups_response_body.rb +1 -1
  111. data/lib/trieve_ruby_client/models/search_over_groups_response_types.rb +1 -1
  112. data/lib/trieve_ruby_client/models/search_over_groups_results.rb +239 -0
  113. data/lib/trieve_ruby_client/models/search_over_groups_slim_chunks_response_body.rb +1 -1
  114. data/lib/trieve_ruby_client/models/search_over_groups_slim_results.rb +239 -0
  115. data/lib/trieve_ruby_client/models/search_slim_chunk_query_response_body.rb +1 -1
  116. data/lib/trieve_ruby_client/models/search_within_group_data.rb +3 -14
  117. data/lib/trieve_ruby_client/models/search_within_group_response_types.rb +1 -1
  118. data/lib/trieve_ruby_client/models/search_within_group_results.rb +255 -0
  119. data/lib/trieve_ruby_client/models/search_within_group_slim_results.rb +255 -0
  120. data/lib/trieve_ruby_client/models/set_user_api_key_request.rb +1 -1
  121. data/lib/trieve_ruby_client/models/set_user_api_key_response.rb +1 -1
  122. data/lib/trieve_ruby_client/models/single_queued_chunk_response.rb +1 -1
  123. data/lib/trieve_ruby_client/models/slim_chunk_metadata.rb +1 -1
  124. data/lib/trieve_ruby_client/models/slim_chunk_metadata_with_score.rb +345 -0
  125. data/lib/trieve_ruby_client/models/slim_group.rb +1 -1
  126. data/lib/trieve_ruby_client/models/slim_user.rb +1 -1
  127. data/lib/trieve_ruby_client/models/stripe_plan.rb +1 -1
  128. data/lib/trieve_ruby_client/models/suggested_queries_request.rb +1 -1
  129. data/lib/trieve_ruby_client/models/suggested_queries_response.rb +1 -1
  130. data/lib/trieve_ruby_client/models/topic.rb +1 -1
  131. data/lib/trieve_ruby_client/models/update_chunk_by_tracking_id_data.rb +1 -1
  132. data/lib/trieve_ruby_client/models/update_chunk_data.rb +1 -1
  133. data/lib/trieve_ruby_client/models/update_chunk_group_data.rb +26 -2
  134. data/lib/trieve_ruby_client/models/update_dataset_request.rb +1 -1
  135. data/lib/trieve_ruby_client/models/update_group_by_tracking_id_data.rb +26 -2
  136. data/lib/trieve_ruby_client/models/update_organization_data.rb +1 -1
  137. data/lib/trieve_ruby_client/models/update_topic_data.rb +1 -1
  138. data/lib/trieve_ruby_client/models/update_user_data.rb +1 -1
  139. data/lib/trieve_ruby_client/models/upload_file_data.rb +1 -1
  140. data/lib/trieve_ruby_client/models/upload_file_result.rb +1 -1
  141. data/lib/trieve_ruby_client/models/user_organization.rb +1 -1
  142. data/lib/trieve_ruby_client/version.rb +2 -2
  143. data/lib/trieve_ruby_client.rb +10 -14
  144. data/openapi-generator.yaml +1 -1
  145. data/openapi.json +386 -325
  146. data/spec/models/chunk_metadata_with_score_spec.rb +114 -0
  147. data/spec/models/group_score_chunk_spec.rb +48 -0
  148. data/spec/models/group_score_slim_chunks_spec.rb +42 -0
  149. data/spec/models/recommend_group_chunks_request_spec.rb +84 -0
  150. data/spec/models/search_over_groups_results_spec.rb +42 -0
  151. data/spec/models/search_over_groups_slim_results_spec.rb +42 -0
  152. data/spec/models/search_within_group_results_spec.rb +48 -0
  153. data/spec/models/search_within_group_slim_results_spec.rb +48 -0
  154. data/spec/models/slim_chunk_metadata_with_score_spec.rb +96 -0
  155. data/spec/spec_helper.rb +1 -1
  156. data/trieve_ruby_client-0.5.7.gem +0 -0
  157. data/trieve_ruby_client-0.6.0.gem +0 -0
  158. data/trieve_ruby_client.gemspec +1 -1
  159. metadata +40 -2
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
5
5
 
6
- The version of the OpenAPI document: 0.5.7
6
+ The version of the OpenAPI document: 0.6.2
7
7
  Contact: developers@trieve.ai
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.4.0
@@ -20,6 +20,7 @@ module TrieveRubyClient
20
20
  # Set get_collisions to true to get the collisions for each chunk. This will only apply if environment variable COLLISIONS_ENABLED is set to true.
21
21
  attr_accessor :get_collisions
22
22
 
23
+ # Group_size is the number of chunks to fetch for each group. The default is 3. If a group has less than group_size chunks, all chunks will be returned. If this is set to a large number, we recommend setting slim_chunks to true to avoid returning the content and chunk_html of the chunks so as to lower the amount of time required for content download and serialization.
23
24
  attr_accessor :group_size
24
25
 
25
26
  # Set highlight_delimiters to a list of strings to use as delimiters for highlighting. If not specified, this defaults to [\"?\", \",\", \".\", \"!\"].
@@ -28,18 +29,15 @@ module TrieveRubyClient
28
29
  # Set highlight_results to true to highlight the results. If not specified, this defaults to true.
29
30
  attr_accessor :highlight_results
30
31
 
31
- # Page of chunks to fetch. Each page is 10 chunks. Support for custom page size is coming soon.
32
+ # Page of group results to fetch. Page is 1-indexed.
32
33
  attr_accessor :page
33
34
 
34
- # Page size is the number of chunks to fetch. This can be used to fetch more than 10 chunks at a time.
35
+ # Page size is the number of group results to fetch. The default is 10.
35
36
  attr_accessor :page_size
36
37
 
37
38
  # Query is the search query. This can be any string. The query will be used to create an embedding vector and/or SPLADE vector which will be used to find the result set.
38
39
  attr_accessor :query
39
40
 
40
- # Turn on quote words and negated words to search for exact phrases and exclude words from the search results. Default is false.
41
- attr_accessor :quote_negated_words
42
-
43
41
  # Set score_threshold to a float to filter out chunks with a score below the threshold.
44
42
  attr_accessor :score_threshold
45
43
 
@@ -60,7 +58,6 @@ module TrieveRubyClient
60
58
  :'page' => :'page',
61
59
  :'page_size' => :'page_size',
62
60
  :'query' => :'query',
63
- :'quote_negated_words' => :'quote_negated_words',
64
61
  :'score_threshold' => :'score_threshold',
65
62
  :'search_type' => :'search_type',
66
63
  :'slim_chunks' => :'slim_chunks'
@@ -83,7 +80,6 @@ module TrieveRubyClient
83
80
  :'page' => :'Integer',
84
81
  :'page_size' => :'Integer',
85
82
  :'query' => :'String',
86
- :'quote_negated_words' => :'Boolean',
87
83
  :'score_threshold' => :'Float',
88
84
  :'search_type' => :'String',
89
85
  :'slim_chunks' => :'Boolean'
@@ -100,7 +96,6 @@ module TrieveRubyClient
100
96
  :'highlight_results',
101
97
  :'page',
102
98
  :'page_size',
103
- :'quote_negated_words',
104
99
  :'score_threshold',
105
100
  :'slim_chunks'
106
101
  ])
@@ -157,10 +152,6 @@ module TrieveRubyClient
157
152
  self.query = nil
158
153
  end
159
154
 
160
- if attributes.key?(:'quote_negated_words')
161
- self.quote_negated_words = attributes[:'quote_negated_words']
162
- end
163
-
164
155
  if attributes.key?(:'score_threshold')
165
156
  self.score_threshold = attributes[:'score_threshold']
166
157
  end
@@ -259,7 +250,6 @@ module TrieveRubyClient
259
250
  page == o.page &&
260
251
  page_size == o.page_size &&
261
252
  query == o.query &&
262
- quote_negated_words == o.quote_negated_words &&
263
253
  score_threshold == o.score_threshold &&
264
254
  search_type == o.search_type &&
265
255
  slim_chunks == o.slim_chunks
@@ -274,7 +264,7 @@ module TrieveRubyClient
274
264
  # Calculates hash code according to all attributes.
275
265
  # @return [Integer] Hash code
276
266
  def hash
277
- [filters, get_collisions, group_size, highlight_delimiters, highlight_results, page, page_size, query, quote_negated_words, score_threshold, search_type, slim_chunks].hash
267
+ [filters, get_collisions, group_size, highlight_delimiters, highlight_results, page, page_size, query, score_threshold, search_type, slim_chunks].hash
278
268
  end
279
269
 
280
270
  # Builds the object from hash
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
5
5
 
6
- The version of the OpenAPI document: 0.5.7
6
+ The version of the OpenAPI document: 0.6.0
7
7
  Contact: developers@trieve.ai
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.4.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
5
5
 
6
- The version of the OpenAPI document: 0.5.7
6
+ The version of the OpenAPI document: 0.6.0
7
7
  Contact: developers@trieve.ai
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.4.0
@@ -0,0 +1,239 @@
1
+ =begin
2
+ #Trieve API
3
+
4
+ #Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
5
+
6
+ The version of the OpenAPI document: 0.6.2
7
+ Contact: developers@trieve.ai
8
+ Generated by: https://openapi-generator.tech
9
+ Generator version: 7.4.0
10
+
11
+ =end
12
+
13
+ require 'date'
14
+ require 'time'
15
+
16
+ module TrieveRubyClient
17
+ class SearchOverGroupsResults
18
+ attr_accessor :group_chunks
19
+
20
+ attr_accessor :total_chunk_pages
21
+
22
+ # Attribute mapping from ruby-style variable name to JSON key.
23
+ def self.attribute_map
24
+ {
25
+ :'group_chunks' => :'group_chunks',
26
+ :'total_chunk_pages' => :'total_chunk_pages'
27
+ }
28
+ end
29
+
30
+ # Returns all the JSON keys this model knows about
31
+ def self.acceptable_attributes
32
+ attribute_map.values
33
+ end
34
+
35
+ # Attribute type mapping.
36
+ def self.openapi_types
37
+ {
38
+ :'group_chunks' => :'Array<GroupScoreChunk>',
39
+ :'total_chunk_pages' => :'Integer'
40
+ }
41
+ end
42
+
43
+ # List of attributes with nullable: true
44
+ def self.openapi_nullable
45
+ Set.new([
46
+ ])
47
+ end
48
+
49
+ # Initializes the object
50
+ # @param [Hash] attributes Model attributes in the form of hash
51
+ def initialize(attributes = {})
52
+ if (!attributes.is_a?(Hash))
53
+ fail ArgumentError, "The input argument (attributes) must be a hash in `TrieveRubyClient::SearchOverGroupsResults` initialize method"
54
+ end
55
+
56
+ # check to see if the attribute exists and convert string to symbol for hash key
57
+ attributes = attributes.each_with_object({}) { |(k, v), h|
58
+ if (!self.class.attribute_map.key?(k.to_sym))
59
+ fail ArgumentError, "`#{k}` is not a valid attribute in `TrieveRubyClient::SearchOverGroupsResults`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
60
+ end
61
+ h[k.to_sym] = v
62
+ }
63
+
64
+ if attributes.key?(:'group_chunks')
65
+ if (value = attributes[:'group_chunks']).is_a?(Array)
66
+ self.group_chunks = value
67
+ end
68
+ else
69
+ self.group_chunks = nil
70
+ end
71
+
72
+ if attributes.key?(:'total_chunk_pages')
73
+ self.total_chunk_pages = attributes[:'total_chunk_pages']
74
+ else
75
+ self.total_chunk_pages = nil
76
+ end
77
+ end
78
+
79
+ # Show invalid properties with the reasons. Usually used together with valid?
80
+ # @return Array for valid properties with the reasons
81
+ def list_invalid_properties
82
+ warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
83
+ invalid_properties = Array.new
84
+ if @group_chunks.nil?
85
+ invalid_properties.push('invalid value for "group_chunks", group_chunks cannot be nil.')
86
+ end
87
+
88
+ if @total_chunk_pages.nil?
89
+ invalid_properties.push('invalid value for "total_chunk_pages", total_chunk_pages cannot be nil.')
90
+ end
91
+
92
+ invalid_properties
93
+ end
94
+
95
+ # Check to see if the all the properties in the model are valid
96
+ # @return true if the model is valid
97
+ def valid?
98
+ warn '[DEPRECATED] the `valid?` method is obsolete'
99
+ return false if @group_chunks.nil?
100
+ return false if @total_chunk_pages.nil?
101
+ true
102
+ end
103
+
104
+ # Checks equality by comparing each attribute.
105
+ # @param [Object] Object to be compared
106
+ def ==(o)
107
+ return true if self.equal?(o)
108
+ self.class == o.class &&
109
+ group_chunks == o.group_chunks &&
110
+ total_chunk_pages == o.total_chunk_pages
111
+ end
112
+
113
+ # @see the `==` method
114
+ # @param [Object] Object to be compared
115
+ def eql?(o)
116
+ self == o
117
+ end
118
+
119
+ # Calculates hash code according to all attributes.
120
+ # @return [Integer] Hash code
121
+ def hash
122
+ [group_chunks, total_chunk_pages].hash
123
+ end
124
+
125
+ # Builds the object from hash
126
+ # @param [Hash] attributes Model attributes in the form of hash
127
+ # @return [Object] Returns the model itself
128
+ def self.build_from_hash(attributes)
129
+ return nil unless attributes.is_a?(Hash)
130
+ attributes = attributes.transform_keys(&:to_sym)
131
+ transformed_hash = {}
132
+ openapi_types.each_pair do |key, type|
133
+ if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
134
+ transformed_hash["#{key}"] = nil
135
+ elsif type =~ /\AArray<(.*)>/i
136
+ # check to ensure the input is an array given that the attribute
137
+ # is documented as an array but the input is not
138
+ if attributes[attribute_map[key]].is_a?(Array)
139
+ transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
140
+ end
141
+ elsif !attributes[attribute_map[key]].nil?
142
+ transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
143
+ end
144
+ end
145
+ new(transformed_hash)
146
+ end
147
+
148
+ # Deserializes the data based on type
149
+ # @param string type Data type
150
+ # @param string value Value to be deserialized
151
+ # @return [Object] Deserialized data
152
+ def self._deserialize(type, value)
153
+ case type.to_sym
154
+ when :Time
155
+ Time.parse(value)
156
+ when :Date
157
+ Date.parse(value)
158
+ when :String
159
+ value.to_s
160
+ when :Integer
161
+ value.to_i
162
+ when :Float
163
+ value.to_f
164
+ when :Boolean
165
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
166
+ true
167
+ else
168
+ false
169
+ end
170
+ when :Object
171
+ # generic object (usually a Hash), return directly
172
+ value
173
+ when /\AArray<(?<inner_type>.+)>\z/
174
+ inner_type = Regexp.last_match[:inner_type]
175
+ value.map { |v| _deserialize(inner_type, v) }
176
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
177
+ k_type = Regexp.last_match[:k_type]
178
+ v_type = Regexp.last_match[:v_type]
179
+ {}.tap do |hash|
180
+ value.each do |k, v|
181
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
182
+ end
183
+ end
184
+ else # model
185
+ # models (e.g. Pet) or oneOf
186
+ klass = TrieveRubyClient.const_get(type)
187
+ klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
188
+ end
189
+ end
190
+
191
+ # Returns the string representation of the object
192
+ # @return [String] String presentation of the object
193
+ def to_s
194
+ to_hash.to_s
195
+ end
196
+
197
+ # to_body is an alias to to_hash (backward compatibility)
198
+ # @return [Hash] Returns the object in the form of hash
199
+ def to_body
200
+ to_hash
201
+ end
202
+
203
+ # Returns the object in the form of hash
204
+ # @return [Hash] Returns the object in the form of hash
205
+ def to_hash
206
+ hash = {}
207
+ self.class.attribute_map.each_pair do |attr, param|
208
+ value = self.send(attr)
209
+ if value.nil?
210
+ is_nullable = self.class.openapi_nullable.include?(attr)
211
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
212
+ end
213
+
214
+ hash[param] = _to_hash(value)
215
+ end
216
+ hash
217
+ end
218
+
219
+ # Outputs non-array value in the form of hash
220
+ # For object, use to_hash. Otherwise, just return the value
221
+ # @param [Object] value Any valid value
222
+ # @return [Hash] Returns the value in the form of hash
223
+ def _to_hash(value)
224
+ if value.is_a?(Array)
225
+ value.compact.map { |v| _to_hash(v) }
226
+ elsif value.is_a?(Hash)
227
+ {}.tap do |hash|
228
+ value.each { |k, v| hash[k] = _to_hash(v) }
229
+ end
230
+ elsif value.respond_to? :to_hash
231
+ value.to_hash
232
+ else
233
+ value
234
+ end
235
+ end
236
+
237
+ end
238
+
239
+ end
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
5
5
 
6
- The version of the OpenAPI document: 0.5.7
6
+ The version of the OpenAPI document: 0.6.0
7
7
  Contact: developers@trieve.ai
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.4.0
@@ -0,0 +1,239 @@
1
+ =begin
2
+ #Trieve API
3
+
4
+ #Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
5
+
6
+ The version of the OpenAPI document: 0.6.2
7
+ Contact: developers@trieve.ai
8
+ Generated by: https://openapi-generator.tech
9
+ Generator version: 7.4.0
10
+
11
+ =end
12
+
13
+ require 'date'
14
+ require 'time'
15
+
16
+ module TrieveRubyClient
17
+ class SearchOverGroupsSlimResults
18
+ attr_accessor :group_chunks
19
+
20
+ attr_accessor :total_chunk_pages
21
+
22
+ # Attribute mapping from ruby-style variable name to JSON key.
23
+ def self.attribute_map
24
+ {
25
+ :'group_chunks' => :'group_chunks',
26
+ :'total_chunk_pages' => :'total_chunk_pages'
27
+ }
28
+ end
29
+
30
+ # Returns all the JSON keys this model knows about
31
+ def self.acceptable_attributes
32
+ attribute_map.values
33
+ end
34
+
35
+ # Attribute type mapping.
36
+ def self.openapi_types
37
+ {
38
+ :'group_chunks' => :'Array<GroupScoreSlimChunks>',
39
+ :'total_chunk_pages' => :'Integer'
40
+ }
41
+ end
42
+
43
+ # List of attributes with nullable: true
44
+ def self.openapi_nullable
45
+ Set.new([
46
+ ])
47
+ end
48
+
49
+ # Initializes the object
50
+ # @param [Hash] attributes Model attributes in the form of hash
51
+ def initialize(attributes = {})
52
+ if (!attributes.is_a?(Hash))
53
+ fail ArgumentError, "The input argument (attributes) must be a hash in `TrieveRubyClient::SearchOverGroupsSlimResults` initialize method"
54
+ end
55
+
56
+ # check to see if the attribute exists and convert string to symbol for hash key
57
+ attributes = attributes.each_with_object({}) { |(k, v), h|
58
+ if (!self.class.attribute_map.key?(k.to_sym))
59
+ fail ArgumentError, "`#{k}` is not a valid attribute in `TrieveRubyClient::SearchOverGroupsSlimResults`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
60
+ end
61
+ h[k.to_sym] = v
62
+ }
63
+
64
+ if attributes.key?(:'group_chunks')
65
+ if (value = attributes[:'group_chunks']).is_a?(Array)
66
+ self.group_chunks = value
67
+ end
68
+ else
69
+ self.group_chunks = nil
70
+ end
71
+
72
+ if attributes.key?(:'total_chunk_pages')
73
+ self.total_chunk_pages = attributes[:'total_chunk_pages']
74
+ else
75
+ self.total_chunk_pages = nil
76
+ end
77
+ end
78
+
79
+ # Show invalid properties with the reasons. Usually used together with valid?
80
+ # @return Array for valid properties with the reasons
81
+ def list_invalid_properties
82
+ warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
83
+ invalid_properties = Array.new
84
+ if @group_chunks.nil?
85
+ invalid_properties.push('invalid value for "group_chunks", group_chunks cannot be nil.')
86
+ end
87
+
88
+ if @total_chunk_pages.nil?
89
+ invalid_properties.push('invalid value for "total_chunk_pages", total_chunk_pages cannot be nil.')
90
+ end
91
+
92
+ invalid_properties
93
+ end
94
+
95
+ # Check to see if the all the properties in the model are valid
96
+ # @return true if the model is valid
97
+ def valid?
98
+ warn '[DEPRECATED] the `valid?` method is obsolete'
99
+ return false if @group_chunks.nil?
100
+ return false if @total_chunk_pages.nil?
101
+ true
102
+ end
103
+
104
+ # Checks equality by comparing each attribute.
105
+ # @param [Object] Object to be compared
106
+ def ==(o)
107
+ return true if self.equal?(o)
108
+ self.class == o.class &&
109
+ group_chunks == o.group_chunks &&
110
+ total_chunk_pages == o.total_chunk_pages
111
+ end
112
+
113
+ # @see the `==` method
114
+ # @param [Object] Object to be compared
115
+ def eql?(o)
116
+ self == o
117
+ end
118
+
119
+ # Calculates hash code according to all attributes.
120
+ # @return [Integer] Hash code
121
+ def hash
122
+ [group_chunks, total_chunk_pages].hash
123
+ end
124
+
125
+ # Builds the object from hash
126
+ # @param [Hash] attributes Model attributes in the form of hash
127
+ # @return [Object] Returns the model itself
128
+ def self.build_from_hash(attributes)
129
+ return nil unless attributes.is_a?(Hash)
130
+ attributes = attributes.transform_keys(&:to_sym)
131
+ transformed_hash = {}
132
+ openapi_types.each_pair do |key, type|
133
+ if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
134
+ transformed_hash["#{key}"] = nil
135
+ elsif type =~ /\AArray<(.*)>/i
136
+ # check to ensure the input is an array given that the attribute
137
+ # is documented as an array but the input is not
138
+ if attributes[attribute_map[key]].is_a?(Array)
139
+ transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
140
+ end
141
+ elsif !attributes[attribute_map[key]].nil?
142
+ transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
143
+ end
144
+ end
145
+ new(transformed_hash)
146
+ end
147
+
148
+ # Deserializes the data based on type
149
+ # @param string type Data type
150
+ # @param string value Value to be deserialized
151
+ # @return [Object] Deserialized data
152
+ def self._deserialize(type, value)
153
+ case type.to_sym
154
+ when :Time
155
+ Time.parse(value)
156
+ when :Date
157
+ Date.parse(value)
158
+ when :String
159
+ value.to_s
160
+ when :Integer
161
+ value.to_i
162
+ when :Float
163
+ value.to_f
164
+ when :Boolean
165
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
166
+ true
167
+ else
168
+ false
169
+ end
170
+ when :Object
171
+ # generic object (usually a Hash), return directly
172
+ value
173
+ when /\AArray<(?<inner_type>.+)>\z/
174
+ inner_type = Regexp.last_match[:inner_type]
175
+ value.map { |v| _deserialize(inner_type, v) }
176
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
177
+ k_type = Regexp.last_match[:k_type]
178
+ v_type = Regexp.last_match[:v_type]
179
+ {}.tap do |hash|
180
+ value.each do |k, v|
181
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
182
+ end
183
+ end
184
+ else # model
185
+ # models (e.g. Pet) or oneOf
186
+ klass = TrieveRubyClient.const_get(type)
187
+ klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
188
+ end
189
+ end
190
+
191
+ # Returns the string representation of the object
192
+ # @return [String] String presentation of the object
193
+ def to_s
194
+ to_hash.to_s
195
+ end
196
+
197
+ # to_body is an alias to to_hash (backward compatibility)
198
+ # @return [Hash] Returns the object in the form of hash
199
+ def to_body
200
+ to_hash
201
+ end
202
+
203
+ # Returns the object in the form of hash
204
+ # @return [Hash] Returns the object in the form of hash
205
+ def to_hash
206
+ hash = {}
207
+ self.class.attribute_map.each_pair do |attr, param|
208
+ value = self.send(attr)
209
+ if value.nil?
210
+ is_nullable = self.class.openapi_nullable.include?(attr)
211
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
212
+ end
213
+
214
+ hash[param] = _to_hash(value)
215
+ end
216
+ hash
217
+ end
218
+
219
+ # Outputs non-array value in the form of hash
220
+ # For object, use to_hash. Otherwise, just return the value
221
+ # @param [Object] value Any valid value
222
+ # @return [Hash] Returns the value in the form of hash
223
+ def _to_hash(value)
224
+ if value.is_a?(Array)
225
+ value.compact.map { |v| _to_hash(v) }
226
+ elsif value.is_a?(Hash)
227
+ {}.tap do |hash|
228
+ value.each { |k, v| hash[k] = _to_hash(v) }
229
+ end
230
+ elsif value.respond_to? :to_hash
231
+ value.to_hash
232
+ else
233
+ value
234
+ end
235
+ end
236
+
237
+ end
238
+
239
+ end
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
5
5
 
6
- The version of the OpenAPI document: 0.5.7
6
+ The version of the OpenAPI document: 0.6.2
7
7
  Contact: developers@trieve.ai
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.4.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
5
5
 
6
- The version of the OpenAPI document: 0.5.7
6
+ The version of the OpenAPI document: 0.6.2
7
7
  Contact: developers@trieve.ai
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.4.0
@@ -32,7 +32,7 @@ module TrieveRubyClient
32
32
  # Set highlight_results to true to highlight the results. If not specified, this defaults to true.
33
33
  attr_accessor :highlight_results
34
34
 
35
- # The page of chunks to fetch. Each page is 10 chunks. Support for custom page size is coming soon.
35
+ # The page of chunks to fetch. Page is 1-indexed.
36
36
  attr_accessor :page
37
37
 
38
38
  # The page size is the number of chunks to fetch. This can be used to fetch more than 10 chunks at a time.
@@ -41,9 +41,6 @@ module TrieveRubyClient
41
41
  # The query is the search query. This can be any string. The query will be used to create an embedding vector and/or SPLADE vector which will be used to find the result set.
42
42
  attr_accessor :query
43
43
 
44
- # Turn on quote words and negated words to search for exact phrases and exclude words from the search results. Default is false.
45
- attr_accessor :quote_negated_words
46
-
47
44
  # Set score_threshold to a float to filter out chunks with a score below the threshold.
48
45
  attr_accessor :score_threshold
49
46
 
@@ -68,7 +65,6 @@ module TrieveRubyClient
68
65
  :'page' => :'page',
69
66
  :'page_size' => :'page_size',
70
67
  :'query' => :'query',
71
- :'quote_negated_words' => :'quote_negated_words',
72
68
  :'score_threshold' => :'score_threshold',
73
69
  :'search_type' => :'search_type',
74
70
  :'slim_chunks' => :'slim_chunks',
@@ -93,7 +89,6 @@ module TrieveRubyClient
93
89
  :'page' => :'Integer',
94
90
  :'page_size' => :'Integer',
95
91
  :'query' => :'String',
96
- :'quote_negated_words' => :'Boolean',
97
92
  :'score_threshold' => :'Float',
98
93
  :'search_type' => :'String',
99
94
  :'slim_chunks' => :'Boolean',
@@ -112,7 +107,6 @@ module TrieveRubyClient
112
107
  :'highlight_results',
113
108
  :'page',
114
109
  :'page_size',
115
- :'quote_negated_words',
116
110
  :'score_threshold',
117
111
  :'slim_chunks',
118
112
  :'use_weights'
@@ -174,10 +168,6 @@ module TrieveRubyClient
174
168
  self.query = nil
175
169
  end
176
170
 
177
- if attributes.key?(:'quote_negated_words')
178
- self.quote_negated_words = attributes[:'quote_negated_words']
179
- end
180
-
181
171
  if attributes.key?(:'score_threshold')
182
172
  self.score_threshold = attributes[:'score_threshold']
183
173
  end
@@ -266,7 +256,6 @@ module TrieveRubyClient
266
256
  page == o.page &&
267
257
  page_size == o.page_size &&
268
258
  query == o.query &&
269
- quote_negated_words == o.quote_negated_words &&
270
259
  score_threshold == o.score_threshold &&
271
260
  search_type == o.search_type &&
272
261
  slim_chunks == o.slim_chunks &&
@@ -282,7 +271,7 @@ module TrieveRubyClient
282
271
  # Calculates hash code according to all attributes.
283
272
  # @return [Integer] Hash code
284
273
  def hash
285
- [date_bias, filters, group_id, group_tracking_id, highlight_delimiters, highlight_results, page, page_size, query, quote_negated_words, score_threshold, search_type, slim_chunks, use_weights].hash
274
+ [date_bias, filters, group_id, group_tracking_id, highlight_delimiters, highlight_results, page, page_size, query, score_threshold, search_type, slim_chunks, use_weights].hash
286
275
  end
287
276
 
288
277
  # Builds the object from hash
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
5
5
 
6
- The version of the OpenAPI document: 0.5.7
6
+ The version of the OpenAPI document: 0.6.0
7
7
  Contact: developers@trieve.ai
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.4.0