trieve_ruby_client 0.8.0 → 0.10.7

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 (229) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +39 -30
  3. data/docs/ApiKeyRespBody.md +32 -0
  4. data/docs/AutocompleteData.md +42 -0
  5. data/docs/AutocompleteReqPayload.md +50 -0
  6. data/docs/BoostPhrase.md +20 -0
  7. data/docs/ChunkApi.md +140 -66
  8. data/docs/ChunkData.md +2 -0
  9. data/docs/ChunkFilter.md +3 -3
  10. data/docs/ChunkGroup.md +1 -1
  11. data/docs/ChunkGroupApi.md +35 -33
  12. data/docs/ChunkMetadata.md +5 -3
  13. data/docs/ChunkMetadataStringTagSet.md +46 -0
  14. data/docs/ChunkMetadataTypes.md +51 -0
  15. data/docs/ChunkMetadataWithScore.md +0 -2
  16. data/docs/ChunkReqPayload.md +50 -0
  17. data/docs/ClientDatasetConfiguration.md +0 -2
  18. data/docs/ConditionType.md +49 -0
  19. data/docs/ContentChunkMetadata.md +32 -0
  20. data/docs/CreateChunkGroupReqPayload.md +28 -0
  21. data/docs/CreateChunkReqPayloadEnum.md +49 -0
  22. data/docs/CreateDatasetRequest.md +2 -2
  23. data/docs/CreateMessageData.md +2 -2
  24. data/docs/CreateMessageReqPayload.md +42 -0
  25. data/docs/CreateTopicReqPayload.md +22 -0
  26. data/docs/Dataset.md +2 -0
  27. data/docs/DatasetApi.md +236 -12
  28. data/docs/DateRange.md +24 -0
  29. data/docs/EditMessageReqPayload.md +44 -0
  30. data/docs/FieldCondition.md +2 -0
  31. data/docs/File.md +1 -1
  32. data/docs/FileApi.md +7 -7
  33. data/docs/GenerateChunksRequest.md +2 -0
  34. data/docs/GetDatasetsPagination.md +20 -0
  35. data/docs/GroupScoreSlimChunks.md +4 -0
  36. data/docs/HasIDCondition.md +20 -0
  37. data/docs/InvitationApi.md +1 -1
  38. data/docs/MatchCondition.md +3 -1
  39. data/docs/MessageApi.md +42 -42
  40. data/docs/Organization.md +2 -0
  41. data/docs/OrganizationApi.md +24 -25
  42. data/docs/RangeCondition.md +1 -3
  43. data/docs/RecommendChunksRequest.md +1 -1
  44. data/docs/RecommendGroupChunksRequest.md +1 -1
  45. data/docs/RegenerateMessageReqPayload.md +40 -0
  46. data/docs/RemoveChunkFromGroupReqPayload.md +18 -0
  47. data/docs/ScoreChunkDTO.md +3 -1
  48. data/docs/SearchChunkData.md +12 -6
  49. data/docs/SearchChunksReqPayload.md +54 -0
  50. data/docs/SearchOverGroupsData.md +12 -4
  51. data/docs/SearchWithinGroupData.md +16 -6
  52. data/docs/SetUserApiKeyRequest.md +4 -0
  53. data/docs/SlimChunkMetadata.md +4 -0
  54. data/docs/SuggestedQueriesReqPayload.md +18 -0
  55. data/docs/TopicApi.md +16 -16
  56. data/docs/UpdateChunkData.md +2 -0
  57. data/docs/UpdateChunkReqPayload.md +46 -0
  58. data/docs/UpdateDatasetRequest.md +2 -0
  59. data/docs/UpdateGroupByTrackingIDReqPayload.md +26 -0
  60. data/docs/UpdateTopicReqPayload.md +20 -0
  61. data/docs/UpdateUserOrgRoleData.md +1 -1
  62. data/docs/UploadFileReqPayload.md +40 -0
  63. data/docs/UserApi.md +7 -8
  64. data/lib/trieve_ruby_client/api/auth_api.rb +1 -1
  65. data/lib/trieve_ruby_client/api/chunk_api.rb +158 -83
  66. data/lib/trieve_ruby_client/api/chunk_group_api.rb +58 -51
  67. data/lib/trieve_ruby_client/api/dataset_api.rb +224 -15
  68. data/lib/trieve_ruby_client/api/events_api.rb +1 -1
  69. data/lib/trieve_ruby_client/api/file_api.rb +12 -12
  70. data/lib/trieve_ruby_client/api/health_api.rb +1 -1
  71. data/lib/trieve_ruby_client/api/invitation_api.rb +3 -3
  72. data/lib/trieve_ruby_client/api/message_api.rb +50 -50
  73. data/lib/trieve_ruby_client/api/organization_api.rb +27 -27
  74. data/lib/trieve_ruby_client/api/stripe_api.rb +1 -1
  75. data/lib/trieve_ruby_client/api/topic_api.rb +27 -27
  76. data/lib/trieve_ruby_client/api/user_api.rb +8 -8
  77. data/lib/trieve_ruby_client/api_client.rb +1 -1
  78. data/lib/trieve_ruby_client/api_error.rb +1 -1
  79. data/lib/trieve_ruby_client/configuration.rb +1 -1
  80. data/lib/trieve_ruby_client/models/add_chunk_to_group_data.rb +1 -1
  81. data/lib/trieve_ruby_client/models/api_key_dto.rb +1 -1
  82. data/lib/trieve_ruby_client/models/api_key_resp_body.rb +325 -0
  83. data/lib/trieve_ruby_client/models/auth_query.rb +1 -1
  84. data/lib/trieve_ruby_client/models/autocomplete_data.rb +378 -0
  85. data/lib/trieve_ruby_client/models/autocomplete_req_payload.rb +467 -0
  86. data/lib/trieve_ruby_client/models/batch_queued_chunk_response.rb +1 -1
  87. data/lib/trieve_ruby_client/models/bookmark_data.rb +1 -1
  88. data/lib/trieve_ruby_client/models/bookmark_group_result.rb +1 -1
  89. data/lib/trieve_ruby_client/models/boost_phrase.rb +240 -0
  90. data/lib/trieve_ruby_client/models/chat_message_proxy.rb +1 -1
  91. data/lib/trieve_ruby_client/models/chunk_data.rb +15 -2
  92. data/lib/trieve_ruby_client/models/chunk_filter.rb +4 -4
  93. data/lib/trieve_ruby_client/models/chunk_group.rb +5 -3
  94. data/lib/trieve_ruby_client/models/chunk_group_and_file.rb +1 -1
  95. data/lib/trieve_ruby_client/models/chunk_metadata.rb +28 -20
  96. data/lib/trieve_ruby_client/models/chunk_metadata_string_tag_set.rb +387 -0
  97. data/lib/trieve_ruby_client/models/chunk_metadata_types.rb +106 -0
  98. data/lib/trieve_ruby_client/models/chunk_metadata_with_score.rb +2 -18
  99. data/lib/trieve_ruby_client/models/chunk_req_payload.rb +400 -0
  100. data/lib/trieve_ruby_client/models/client_dataset_configuration.rb +2 -18
  101. data/lib/trieve_ruby_client/models/condition_type.rb +105 -0
  102. data/lib/trieve_ruby_client/models/content_chunk_metadata.rb +299 -0
  103. data/lib/trieve_ruby_client/models/create_chunk_data.rb +1 -1
  104. data/lib/trieve_ruby_client/models/create_chunk_group_data.rb +1 -1
  105. data/lib/trieve_ruby_client/models/create_chunk_group_req_payload.rb +273 -0
  106. data/lib/trieve_ruby_client/models/create_chunk_req_payload_enum.rb +105 -0
  107. data/lib/trieve_ruby_client/models/create_dataset_request.rb +3 -3
  108. data/lib/trieve_ruby_client/models/create_message_data.rb +13 -13
  109. data/lib/trieve_ruby_client/models/create_message_req_payload.rb +378 -0
  110. data/lib/trieve_ruby_client/models/create_organization_data.rb +1 -1
  111. data/lib/trieve_ruby_client/models/create_topic_data.rb +1 -1
  112. data/lib/trieve_ruby_client/models/create_topic_req_payload.rb +244 -0
  113. data/lib/trieve_ruby_client/models/dataset.rb +18 -2
  114. data/lib/trieve_ruby_client/models/dataset_and_usage.rb +1 -1
  115. data/lib/trieve_ruby_client/models/dataset_dto.rb +1 -1
  116. data/lib/trieve_ruby_client/models/dataset_usage_count.rb +1 -1
  117. data/lib/trieve_ruby_client/models/date_range.rb +245 -0
  118. data/lib/trieve_ruby_client/models/delete_topic_data.rb +1 -1
  119. data/lib/trieve_ruby_client/models/delete_user_api_key_request.rb +1 -1
  120. data/lib/trieve_ruby_client/models/edit_message_data.rb +1 -1
  121. data/lib/trieve_ruby_client/models/edit_message_req_payload.rb +395 -0
  122. data/lib/trieve_ruby_client/models/error_response_body.rb +1 -1
  123. data/lib/trieve_ruby_client/models/event.rb +1 -1
  124. data/lib/trieve_ruby_client/models/event_return.rb +1 -1
  125. data/lib/trieve_ruby_client/models/field_condition.rb +12 -2
  126. data/lib/trieve_ruby_client/models/file.rb +5 -3
  127. data/lib/trieve_ruby_client/models/file_dto.rb +1 -1
  128. data/lib/trieve_ruby_client/models/generate_chunks_request.rb +13 -2
  129. data/lib/trieve_ruby_client/models/geo_info.rb +1 -1
  130. data/lib/trieve_ruby_client/models/geo_types.rb +1 -1
  131. data/lib/trieve_ruby_client/models/get_chunks_data.rb +1 -1
  132. data/lib/trieve_ruby_client/models/get_datasets_pagination.rb +225 -0
  133. data/lib/trieve_ruby_client/models/get_events_data.rb +1 -1
  134. data/lib/trieve_ruby_client/models/get_groups_for_chunks_data.rb +1 -1
  135. data/lib/trieve_ruby_client/models/get_tracking_chunks_data.rb +1 -1
  136. data/lib/trieve_ruby_client/models/group_data.rb +1 -1
  137. data/lib/trieve_ruby_client/models/group_score_chunk.rb +1 -1
  138. data/lib/trieve_ruby_client/models/group_score_slim_chunks.rb +22 -2
  139. data/lib/trieve_ruby_client/models/has_id_condition.rb +229 -0
  140. data/lib/trieve_ruby_client/models/invitation_data.rb +1 -1
  141. data/lib/trieve_ruby_client/models/location_bounding_box.rb +1 -1
  142. data/lib/trieve_ruby_client/models/location_polygon.rb +1 -1
  143. data/lib/trieve_ruby_client/models/location_radius.rb +1 -1
  144. data/lib/trieve_ruby_client/models/match_condition.rb +2 -1
  145. data/lib/trieve_ruby_client/models/message.rb +1 -1
  146. data/lib/trieve_ruby_client/models/organization.rb +18 -2
  147. data/lib/trieve_ruby_client/models/organization_usage_count.rb +1 -1
  148. data/lib/trieve_ruby_client/models/range.rb +1 -1
  149. data/lib/trieve_ruby_client/models/range_condition.rb +2 -3
  150. data/lib/trieve_ruby_client/models/recommend_chunks_request.rb +2 -2
  151. data/lib/trieve_ruby_client/models/recommend_group_chunks_request.rb +2 -2
  152. data/lib/trieve_ruby_client/models/regenerate_message_data.rb +1 -1
  153. data/lib/trieve_ruby_client/models/regenerate_message_req_payload.rb +361 -0
  154. data/lib/trieve_ruby_client/models/remove_chunk_from_group_req_payload.rb +222 -0
  155. data/lib/trieve_ruby_client/models/return_queued_chunk.rb +1 -1
  156. data/lib/trieve_ruby_client/models/score_chunk_dto.rb +15 -3
  157. data/lib/trieve_ruby_client/models/score_slim_chunks.rb +1 -1
  158. data/lib/trieve_ruby_client/models/search_chunk_data.rb +49 -14
  159. data/lib/trieve_ruby_client/models/search_chunk_query_response_body.rb +1 -1
  160. data/lib/trieve_ruby_client/models/search_chunks_req_payload.rb +504 -0
  161. data/lib/trieve_ruby_client/models/search_over_groups_data.rb +95 -6
  162. data/lib/trieve_ruby_client/models/search_over_groups_results.rb +1 -1
  163. data/lib/trieve_ruby_client/models/search_over_groups_slim_results.rb +1 -1
  164. data/lib/trieve_ruby_client/models/search_slim_chunk_query_response_body.rb +1 -1
  165. data/lib/trieve_ruby_client/models/search_within_group_data.rb +119 -17
  166. data/lib/trieve_ruby_client/models/search_within_group_results.rb +1 -1
  167. data/lib/trieve_ruby_client/models/search_within_group_slim_results.rb +1 -1
  168. data/lib/trieve_ruby_client/models/set_user_api_key_request.rb +28 -2
  169. data/lib/trieve_ruby_client/models/set_user_api_key_response.rb +1 -1
  170. data/lib/trieve_ruby_client/models/single_queued_chunk_response.rb +1 -1
  171. data/lib/trieve_ruby_client/models/slim_chunk_metadata.rb +24 -2
  172. data/lib/trieve_ruby_client/models/slim_chunk_metadata_with_score.rb +1 -1
  173. data/lib/trieve_ruby_client/models/slim_group.rb +1 -1
  174. data/lib/trieve_ruby_client/models/slim_user.rb +1 -1
  175. data/lib/trieve_ruby_client/models/stripe_plan.rb +1 -1
  176. data/lib/trieve_ruby_client/models/suggested_queries_req_payload.rb +222 -0
  177. data/lib/trieve_ruby_client/models/suggested_queries_request.rb +1 -1
  178. data/lib/trieve_ruby_client/models/suggested_queries_response.rb +1 -1
  179. data/lib/trieve_ruby_client/models/topic.rb +1 -1
  180. data/lib/trieve_ruby_client/models/update_chunk_by_tracking_id_data.rb +1 -1
  181. data/lib/trieve_ruby_client/models/update_chunk_data.rb +15 -2
  182. data/lib/trieve_ruby_client/models/update_chunk_group_data.rb +1 -1
  183. data/lib/trieve_ruby_client/models/update_chunk_req_payload.rb +376 -0
  184. data/lib/trieve_ruby_client/models/update_dataset_request.rb +13 -2
  185. data/lib/trieve_ruby_client/models/update_group_by_tracking_id_data.rb +1 -1
  186. data/lib/trieve_ruby_client/models/update_group_by_tracking_id_req_payload.rb +268 -0
  187. data/lib/trieve_ruby_client/models/update_organization_data.rb +1 -1
  188. data/lib/trieve_ruby_client/models/update_topic_data.rb +1 -1
  189. data/lib/trieve_ruby_client/models/update_topic_req_payload.rb +239 -0
  190. data/lib/trieve_ruby_client/models/update_user_org_role_data.rb +2 -2
  191. data/lib/trieve_ruby_client/models/upload_file_data.rb +1 -1
  192. data/lib/trieve_ruby_client/models/upload_file_req_payload.rb +368 -0
  193. data/lib/trieve_ruby_client/models/upload_file_result.rb +1 -1
  194. data/lib/trieve_ruby_client/models/user_organization.rb +1 -1
  195. data/lib/trieve_ruby_client/version.rb +2 -2
  196. data/lib/trieve_ruby_client.rb +25 -20
  197. data/openapi-generator.yaml +1 -1
  198. data/openapi.json +1 -7784
  199. data/spec/models/api_key_resp_body_spec.rb +78 -0
  200. data/spec/models/autocomplete_data_spec.rb +108 -0
  201. data/spec/models/autocomplete_req_payload_spec.rb +132 -0
  202. data/spec/models/boost_phrase_spec.rb +42 -0
  203. data/spec/models/chunk_metadata_string_tag_set_spec.rb +120 -0
  204. data/spec/models/chunk_metadata_types_spec.rb +32 -0
  205. data/spec/models/chunk_req_payload_spec.rb +132 -0
  206. data/spec/models/condition_type_spec.rb +32 -0
  207. data/spec/models/content_chunk_metadata_spec.rb +72 -0
  208. data/spec/models/create_chunk_group_req_payload_spec.rb +66 -0
  209. data/spec/models/create_chunk_req_payload_enum_spec.rb +32 -0
  210. data/spec/models/create_message_req_payload_spec.rb +108 -0
  211. data/spec/models/create_topic_req_payload_spec.rb +48 -0
  212. data/spec/models/date_range_spec.rb +54 -0
  213. data/spec/models/edit_message_req_payload_spec.rb +114 -0
  214. data/spec/models/get_datasets_pagination_spec.rb +42 -0
  215. data/spec/models/has_id_condition_spec.rb +42 -0
  216. data/spec/models/regenerate_message_req_payload_spec.rb +102 -0
  217. data/spec/models/remove_chunk_from_group_req_payload_spec.rb +36 -0
  218. data/spec/models/search_chunks_req_payload_spec.rb +144 -0
  219. data/spec/models/suggested_queries_req_payload_spec.rb +36 -0
  220. data/spec/models/update_chunk_req_payload_spec.rb +120 -0
  221. data/spec/models/update_group_by_tracking_id_req_payload_spec.rb +60 -0
  222. data/spec/models/update_topic_req_payload_spec.rb +42 -0
  223. data/spec/models/upload_file_req_payload_spec.rb +102 -0
  224. data/spec/spec_helper.rb +1 -1
  225. data/trieve_ruby_client-0.8.0.gem +0 -0
  226. data/trieve_ruby_client-0.8.2.gem +0 -0
  227. data/trieve_ruby_client-0.8.5.gem +0 -0
  228. data/trieve_ruby_client.gemspec +1 -1
  229. metadata +105 -2
@@ -0,0 +1,299 @@
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.10.7
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 ContentChunkMetadata
18
+ attr_accessor :chunk_html
19
+
20
+ attr_accessor :id
21
+
22
+ attr_accessor :image_urls
23
+
24
+ attr_accessor :num_value
25
+
26
+ attr_accessor :qdrant_point_id
27
+
28
+ attr_accessor :time_stamp
29
+
30
+ attr_accessor :tracking_id
31
+
32
+ attr_accessor :weight
33
+
34
+ # Attribute mapping from ruby-style variable name to JSON key.
35
+ def self.attribute_map
36
+ {
37
+ :'chunk_html' => :'chunk_html',
38
+ :'id' => :'id',
39
+ :'image_urls' => :'image_urls',
40
+ :'num_value' => :'num_value',
41
+ :'qdrant_point_id' => :'qdrant_point_id',
42
+ :'time_stamp' => :'time_stamp',
43
+ :'tracking_id' => :'tracking_id',
44
+ :'weight' => :'weight'
45
+ }
46
+ end
47
+
48
+ # Returns all the JSON keys this model knows about
49
+ def self.acceptable_attributes
50
+ attribute_map.values
51
+ end
52
+
53
+ # Attribute type mapping.
54
+ def self.openapi_types
55
+ {
56
+ :'chunk_html' => :'String',
57
+ :'id' => :'String',
58
+ :'image_urls' => :'Array<String>',
59
+ :'num_value' => :'Float',
60
+ :'qdrant_point_id' => :'String',
61
+ :'time_stamp' => :'Time',
62
+ :'tracking_id' => :'String',
63
+ :'weight' => :'Float'
64
+ }
65
+ end
66
+
67
+ # List of attributes with nullable: true
68
+ def self.openapi_nullable
69
+ Set.new([
70
+ :'chunk_html',
71
+ :'image_urls',
72
+ :'num_value',
73
+ :'qdrant_point_id',
74
+ :'time_stamp',
75
+ :'tracking_id',
76
+ ])
77
+ end
78
+
79
+ # Initializes the object
80
+ # @param [Hash] attributes Model attributes in the form of hash
81
+ def initialize(attributes = {})
82
+ if (!attributes.is_a?(Hash))
83
+ fail ArgumentError, "The input argument (attributes) must be a hash in `TrieveRubyClient::ContentChunkMetadata` initialize method"
84
+ end
85
+
86
+ # check to see if the attribute exists and convert string to symbol for hash key
87
+ attributes = attributes.each_with_object({}) { |(k, v), h|
88
+ if (!self.class.attribute_map.key?(k.to_sym))
89
+ fail ArgumentError, "`#{k}` is not a valid attribute in `TrieveRubyClient::ContentChunkMetadata`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
90
+ end
91
+ h[k.to_sym] = v
92
+ }
93
+
94
+ if attributes.key?(:'chunk_html')
95
+ self.chunk_html = attributes[:'chunk_html']
96
+ end
97
+
98
+ if attributes.key?(:'id')
99
+ self.id = attributes[:'id']
100
+ else
101
+ self.id = nil
102
+ end
103
+
104
+ if attributes.key?(:'image_urls')
105
+ if (value = attributes[:'image_urls']).is_a?(Array)
106
+ self.image_urls = value
107
+ end
108
+ end
109
+
110
+ if attributes.key?(:'num_value')
111
+ self.num_value = attributes[:'num_value']
112
+ end
113
+
114
+ if attributes.key?(:'qdrant_point_id')
115
+ self.qdrant_point_id = attributes[:'qdrant_point_id']
116
+ end
117
+
118
+ if attributes.key?(:'time_stamp')
119
+ self.time_stamp = attributes[:'time_stamp']
120
+ end
121
+
122
+ if attributes.key?(:'tracking_id')
123
+ self.tracking_id = attributes[:'tracking_id']
124
+ end
125
+
126
+ if attributes.key?(:'weight')
127
+ self.weight = attributes[:'weight']
128
+ else
129
+ self.weight = nil
130
+ end
131
+ end
132
+
133
+ # Show invalid properties with the reasons. Usually used together with valid?
134
+ # @return Array for valid properties with the reasons
135
+ def list_invalid_properties
136
+ warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
137
+ invalid_properties = Array.new
138
+ if @id.nil?
139
+ invalid_properties.push('invalid value for "id", id cannot be nil.')
140
+ end
141
+
142
+ if @weight.nil?
143
+ invalid_properties.push('invalid value for "weight", weight cannot be nil.')
144
+ end
145
+
146
+ invalid_properties
147
+ end
148
+
149
+ # Check to see if the all the properties in the model are valid
150
+ # @return true if the model is valid
151
+ def valid?
152
+ warn '[DEPRECATED] the `valid?` method is obsolete'
153
+ return false if @id.nil?
154
+ return false if @weight.nil?
155
+ true
156
+ end
157
+
158
+ # Checks equality by comparing each attribute.
159
+ # @param [Object] Object to be compared
160
+ def ==(o)
161
+ return true if self.equal?(o)
162
+ self.class == o.class &&
163
+ chunk_html == o.chunk_html &&
164
+ id == o.id &&
165
+ image_urls == o.image_urls &&
166
+ num_value == o.num_value &&
167
+ qdrant_point_id == o.qdrant_point_id &&
168
+ time_stamp == o.time_stamp &&
169
+ tracking_id == o.tracking_id &&
170
+ weight == o.weight
171
+ end
172
+
173
+ # @see the `==` method
174
+ # @param [Object] Object to be compared
175
+ def eql?(o)
176
+ self == o
177
+ end
178
+
179
+ # Calculates hash code according to all attributes.
180
+ # @return [Integer] Hash code
181
+ def hash
182
+ [chunk_html, id, image_urls, num_value, qdrant_point_id, time_stamp, tracking_id, weight].hash
183
+ end
184
+
185
+ # Builds the object from hash
186
+ # @param [Hash] attributes Model attributes in the form of hash
187
+ # @return [Object] Returns the model itself
188
+ def self.build_from_hash(attributes)
189
+ return nil unless attributes.is_a?(Hash)
190
+ attributes = attributes.transform_keys(&:to_sym)
191
+ transformed_hash = {}
192
+ openapi_types.each_pair do |key, type|
193
+ if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
194
+ transformed_hash["#{key}"] = nil
195
+ elsif type =~ /\AArray<(.*)>/i
196
+ # check to ensure the input is an array given that the attribute
197
+ # is documented as an array but the input is not
198
+ if attributes[attribute_map[key]].is_a?(Array)
199
+ transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
200
+ end
201
+ elsif !attributes[attribute_map[key]].nil?
202
+ transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
203
+ end
204
+ end
205
+ new(transformed_hash)
206
+ end
207
+
208
+ # Deserializes the data based on type
209
+ # @param string type Data type
210
+ # @param string value Value to be deserialized
211
+ # @return [Object] Deserialized data
212
+ def self._deserialize(type, value)
213
+ case type.to_sym
214
+ when :Time
215
+ Time.parse(value)
216
+ when :Date
217
+ Date.parse(value)
218
+ when :String
219
+ value.to_s
220
+ when :Integer
221
+ value.to_i
222
+ when :Float
223
+ value.to_f
224
+ when :Boolean
225
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
226
+ true
227
+ else
228
+ false
229
+ end
230
+ when :Object
231
+ # generic object (usually a Hash), return directly
232
+ value
233
+ when /\AArray<(?<inner_type>.+)>\z/
234
+ inner_type = Regexp.last_match[:inner_type]
235
+ value.map { |v| _deserialize(inner_type, v) }
236
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
237
+ k_type = Regexp.last_match[:k_type]
238
+ v_type = Regexp.last_match[:v_type]
239
+ {}.tap do |hash|
240
+ value.each do |k, v|
241
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
242
+ end
243
+ end
244
+ else # model
245
+ # models (e.g. Pet) or oneOf
246
+ klass = TrieveRubyClient.const_get(type)
247
+ klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
248
+ end
249
+ end
250
+
251
+ # Returns the string representation of the object
252
+ # @return [String] String presentation of the object
253
+ def to_s
254
+ to_hash.to_s
255
+ end
256
+
257
+ # to_body is an alias to to_hash (backward compatibility)
258
+ # @return [Hash] Returns the object in the form of hash
259
+ def to_body
260
+ to_hash
261
+ end
262
+
263
+ # Returns the object in the form of hash
264
+ # @return [Hash] Returns the object in the form of hash
265
+ def to_hash
266
+ hash = {}
267
+ self.class.attribute_map.each_pair do |attr, param|
268
+ value = self.send(attr)
269
+ if value.nil?
270
+ is_nullable = self.class.openapi_nullable.include?(attr)
271
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
272
+ end
273
+
274
+ hash[param] = _to_hash(value)
275
+ end
276
+ hash
277
+ end
278
+
279
+ # Outputs non-array value in the form of hash
280
+ # For object, use to_hash. Otherwise, just return the value
281
+ # @param [Object] value Any valid value
282
+ # @return [Hash] Returns the value in the form of hash
283
+ def _to_hash(value)
284
+ if value.is_a?(Array)
285
+ value.compact.map { |v| _to_hash(v) }
286
+ elsif value.is_a?(Hash)
287
+ {}.tap do |hash|
288
+ value.each { |k, v| hash[k] = _to_hash(v) }
289
+ end
290
+ elsif value.respond_to? :to_hash
291
+ value.to_hash
292
+ else
293
+ value
294
+ end
295
+ end
296
+
297
+ end
298
+
299
+ 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.8.0
6
+ The version of the OpenAPI document: 0.8.5
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.8.0
6
+ The version of the OpenAPI document: 0.8.5
7
7
  Contact: developers@trieve.ai
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.4.0
@@ -0,0 +1,273 @@
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.10.7
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 CreateChunkGroupReqPayload
18
+ # Description to assign to the chunk_group. Convenience field for you to avoid having to remember what the group is for.
19
+ attr_accessor :description
20
+
21
+ # Optional metadata to assign to the chunk_group. This is a JSON object that can store any additional information you want to associate with the chunks inside of the chunk_group.
22
+ attr_accessor :metadata
23
+
24
+ # Name to assign to the chunk_group. Does not need to be unique.
25
+ attr_accessor :name
26
+
27
+ # Optional tags to assign to the chunk_group. This is a list of strings that can be used to categorize the chunks inside the chunk_group.
28
+ attr_accessor :tag_set
29
+
30
+ # Optional tracking id to assign to the chunk_group. This is a unique identifier for the chunk_group.
31
+ attr_accessor :tracking_id
32
+
33
+ # Upsert when a chunk_group with the same tracking_id exists. By default this is false, and the request will fail if a chunk_group with the same tracking_id exists. If this is true, the chunk_group will be updated if a chunk_group with the same tracking_id exists.
34
+ attr_accessor :upsert_by_tracking_id
35
+
36
+ # Attribute mapping from ruby-style variable name to JSON key.
37
+ def self.attribute_map
38
+ {
39
+ :'description' => :'description',
40
+ :'metadata' => :'metadata',
41
+ :'name' => :'name',
42
+ :'tag_set' => :'tag_set',
43
+ :'tracking_id' => :'tracking_id',
44
+ :'upsert_by_tracking_id' => :'upsert_by_tracking_id'
45
+ }
46
+ end
47
+
48
+ # Returns all the JSON keys this model knows about
49
+ def self.acceptable_attributes
50
+ attribute_map.values
51
+ end
52
+
53
+ # Attribute type mapping.
54
+ def self.openapi_types
55
+ {
56
+ :'description' => :'String',
57
+ :'metadata' => :'Object',
58
+ :'name' => :'String',
59
+ :'tag_set' => :'Array<String>',
60
+ :'tracking_id' => :'String',
61
+ :'upsert_by_tracking_id' => :'Boolean'
62
+ }
63
+ end
64
+
65
+ # List of attributes with nullable: true
66
+ def self.openapi_nullable
67
+ Set.new([
68
+ :'description',
69
+ :'metadata',
70
+ :'name',
71
+ :'tag_set',
72
+ :'tracking_id',
73
+ :'upsert_by_tracking_id'
74
+ ])
75
+ end
76
+
77
+ # Initializes the object
78
+ # @param [Hash] attributes Model attributes in the form of hash
79
+ def initialize(attributes = {})
80
+ if (!attributes.is_a?(Hash))
81
+ fail ArgumentError, "The input argument (attributes) must be a hash in `TrieveRubyClient::CreateChunkGroupReqPayload` initialize method"
82
+ end
83
+
84
+ # check to see if the attribute exists and convert string to symbol for hash key
85
+ attributes = attributes.each_with_object({}) { |(k, v), h|
86
+ if (!self.class.attribute_map.key?(k.to_sym))
87
+ fail ArgumentError, "`#{k}` is not a valid attribute in `TrieveRubyClient::CreateChunkGroupReqPayload`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
88
+ end
89
+ h[k.to_sym] = v
90
+ }
91
+
92
+ if attributes.key?(:'description')
93
+ self.description = attributes[:'description']
94
+ end
95
+
96
+ if attributes.key?(:'metadata')
97
+ self.metadata = attributes[:'metadata']
98
+ end
99
+
100
+ if attributes.key?(:'name')
101
+ self.name = attributes[:'name']
102
+ end
103
+
104
+ if attributes.key?(:'tag_set')
105
+ if (value = attributes[:'tag_set']).is_a?(Array)
106
+ self.tag_set = value
107
+ end
108
+ end
109
+
110
+ if attributes.key?(:'tracking_id')
111
+ self.tracking_id = attributes[:'tracking_id']
112
+ end
113
+
114
+ if attributes.key?(:'upsert_by_tracking_id')
115
+ self.upsert_by_tracking_id = attributes[:'upsert_by_tracking_id']
116
+ end
117
+ end
118
+
119
+ # Show invalid properties with the reasons. Usually used together with valid?
120
+ # @return Array for valid properties with the reasons
121
+ def list_invalid_properties
122
+ warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
123
+ invalid_properties = Array.new
124
+ invalid_properties
125
+ end
126
+
127
+ # Check to see if the all the properties in the model are valid
128
+ # @return true if the model is valid
129
+ def valid?
130
+ warn '[DEPRECATED] the `valid?` method is obsolete'
131
+ true
132
+ end
133
+
134
+ # Checks equality by comparing each attribute.
135
+ # @param [Object] Object to be compared
136
+ def ==(o)
137
+ return true if self.equal?(o)
138
+ self.class == o.class &&
139
+ description == o.description &&
140
+ metadata == o.metadata &&
141
+ name == o.name &&
142
+ tag_set == o.tag_set &&
143
+ tracking_id == o.tracking_id &&
144
+ upsert_by_tracking_id == o.upsert_by_tracking_id
145
+ end
146
+
147
+ # @see the `==` method
148
+ # @param [Object] Object to be compared
149
+ def eql?(o)
150
+ self == o
151
+ end
152
+
153
+ # Calculates hash code according to all attributes.
154
+ # @return [Integer] Hash code
155
+ def hash
156
+ [description, metadata, name, tag_set, tracking_id, upsert_by_tracking_id].hash
157
+ end
158
+
159
+ # Builds the object from hash
160
+ # @param [Hash] attributes Model attributes in the form of hash
161
+ # @return [Object] Returns the model itself
162
+ def self.build_from_hash(attributes)
163
+ return nil unless attributes.is_a?(Hash)
164
+ attributes = attributes.transform_keys(&:to_sym)
165
+ transformed_hash = {}
166
+ openapi_types.each_pair do |key, type|
167
+ if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
168
+ transformed_hash["#{key}"] = nil
169
+ elsif type =~ /\AArray<(.*)>/i
170
+ # check to ensure the input is an array given that the attribute
171
+ # is documented as an array but the input is not
172
+ if attributes[attribute_map[key]].is_a?(Array)
173
+ transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
174
+ end
175
+ elsif !attributes[attribute_map[key]].nil?
176
+ transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
177
+ end
178
+ end
179
+ new(transformed_hash)
180
+ end
181
+
182
+ # Deserializes the data based on type
183
+ # @param string type Data type
184
+ # @param string value Value to be deserialized
185
+ # @return [Object] Deserialized data
186
+ def self._deserialize(type, value)
187
+ case type.to_sym
188
+ when :Time
189
+ Time.parse(value)
190
+ when :Date
191
+ Date.parse(value)
192
+ when :String
193
+ value.to_s
194
+ when :Integer
195
+ value.to_i
196
+ when :Float
197
+ value.to_f
198
+ when :Boolean
199
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
200
+ true
201
+ else
202
+ false
203
+ end
204
+ when :Object
205
+ # generic object (usually a Hash), return directly
206
+ value
207
+ when /\AArray<(?<inner_type>.+)>\z/
208
+ inner_type = Regexp.last_match[:inner_type]
209
+ value.map { |v| _deserialize(inner_type, v) }
210
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
211
+ k_type = Regexp.last_match[:k_type]
212
+ v_type = Regexp.last_match[:v_type]
213
+ {}.tap do |hash|
214
+ value.each do |k, v|
215
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
216
+ end
217
+ end
218
+ else # model
219
+ # models (e.g. Pet) or oneOf
220
+ klass = TrieveRubyClient.const_get(type)
221
+ klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
222
+ end
223
+ end
224
+
225
+ # Returns the string representation of the object
226
+ # @return [String] String presentation of the object
227
+ def to_s
228
+ to_hash.to_s
229
+ end
230
+
231
+ # to_body is an alias to to_hash (backward compatibility)
232
+ # @return [Hash] Returns the object in the form of hash
233
+ def to_body
234
+ to_hash
235
+ end
236
+
237
+ # Returns the object in the form of hash
238
+ # @return [Hash] Returns the object in the form of hash
239
+ def to_hash
240
+ hash = {}
241
+ self.class.attribute_map.each_pair do |attr, param|
242
+ value = self.send(attr)
243
+ if value.nil?
244
+ is_nullable = self.class.openapi_nullable.include?(attr)
245
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
246
+ end
247
+
248
+ hash[param] = _to_hash(value)
249
+ end
250
+ hash
251
+ end
252
+
253
+ # Outputs non-array value in the form of hash
254
+ # For object, use to_hash. Otherwise, just return the value
255
+ # @param [Object] value Any valid value
256
+ # @return [Hash] Returns the value in the form of hash
257
+ def _to_hash(value)
258
+ if value.is_a?(Array)
259
+ value.compact.map { |v| _to_hash(v) }
260
+ elsif value.is_a?(Hash)
261
+ {}.tap do |hash|
262
+ value.each { |k, v| hash[k] = _to_hash(v) }
263
+ end
264
+ elsif value.respond_to? :to_hash
265
+ value.to_hash
266
+ else
267
+ value
268
+ end
269
+ end
270
+
271
+ end
272
+
273
+ end
@@ -0,0 +1,105 @@
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.10.7
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
+ module CreateChunkReqPayloadEnum
18
+ class << self
19
+ # List of class defined in oneOf (OpenAPI v3)
20
+ def openapi_one_of
21
+ [
22
+ :'Array<ChunkReqPayload>',
23
+ :'ChunkReqPayload'
24
+ ]
25
+ end
26
+
27
+ # Builds the object
28
+ # @param [Mixed] Data to be matched against the list of oneOf items
29
+ # @return [Object] Returns the model or the data itself
30
+ def build(data)
31
+ # Go through the list of oneOf items and attempt to identify the appropriate one.
32
+ # Note:
33
+ # - We do not attempt to check whether exactly one item matches.
34
+ # - No advanced validation of types in some cases (e.g. "x: { type: string }" will happily match { x: 123 })
35
+ # due to the way the deserialization is made in the base_object template (it just casts without verifying).
36
+ # - TODO: scalar values are de facto behaving as if they were nullable.
37
+ # - TODO: logging when debugging is set.
38
+ openapi_one_of.each do |klass|
39
+ begin
40
+ next if klass == :AnyType # "nullable: true"
41
+ typed_data = find_and_cast_into_type(klass, data)
42
+ return typed_data if typed_data
43
+ rescue # rescue all errors so we keep iterating even if the current item lookup raises
44
+ end
45
+ end
46
+
47
+ openapi_one_of.include?(:AnyType) ? data : nil
48
+ end
49
+
50
+ private
51
+
52
+ SchemaMismatchError = Class.new(StandardError)
53
+
54
+ # Note: 'File' is missing here because in the regular case we get the data _after_ a call to JSON.parse.
55
+ def find_and_cast_into_type(klass, data)
56
+ return if data.nil?
57
+
58
+ case klass.to_s
59
+ when 'Boolean'
60
+ return data if data.instance_of?(TrueClass) || data.instance_of?(FalseClass)
61
+ when 'Float'
62
+ return data if data.instance_of?(Float)
63
+ when 'Integer'
64
+ return data if data.instance_of?(Integer)
65
+ when 'Time'
66
+ return Time.parse(data)
67
+ when 'Date'
68
+ return Date.parse(data)
69
+ when 'String'
70
+ return data if data.instance_of?(String)
71
+ when 'Object' # "type: object"
72
+ return data if data.instance_of?(Hash)
73
+ when /\AArray<(?<sub_type>.+)>\z/ # "type: array"
74
+ if data.instance_of?(Array)
75
+ sub_type = Regexp.last_match[:sub_type]
76
+ return data.map { |item| find_and_cast_into_type(sub_type, item) }
77
+ end
78
+ when /\AHash<String, (?<sub_type>.+)>\z/ # "type: object" with "additionalProperties: { ... }"
79
+ if data.instance_of?(Hash) && data.keys.all? { |k| k.instance_of?(Symbol) || k.instance_of?(String) }
80
+ sub_type = Regexp.last_match[:sub_type]
81
+ return data.each_with_object({}) { |(k, v), hsh| hsh[k] = find_and_cast_into_type(sub_type, v) }
82
+ end
83
+ else # model
84
+ const = TrieveRubyClient.const_get(klass)
85
+ if const
86
+ if const.respond_to?(:openapi_one_of) # nested oneOf model
87
+ model = const.build(data)
88
+ return model if model
89
+ else
90
+ # raise if data contains keys that are not known to the model
91
+ raise if const.respond_to?(:acceptable_attributes) && !(data.keys - const.acceptable_attributes).empty?
92
+ model = const.build_from_hash(data)
93
+ return model if model
94
+ end
95
+ end
96
+ end
97
+
98
+ raise # if no match by now, raise
99
+ rescue
100
+ raise SchemaMismatchError, "#{data} doesn't match the #{klass} type"
101
+ end
102
+ end
103
+ end
104
+
105
+ end