trieve_ruby_client 0.8.2 → 0.11.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.
Files changed (498) hide show
  1. checksums.yaml +4 -4
  2. data/GENERATE_COMMAND.txt +2 -0
  3. data/README.md +153 -41
  4. data/docs/APIVersion.md +15 -0
  5. data/docs/AnalyticsApi.md +303 -0
  6. data/docs/ApiKeyRespBody.md +32 -0
  7. data/docs/AuthApi.md +4 -4
  8. data/docs/AutocompleteData.md +42 -0
  9. data/docs/AutocompleteReqPayload.md +54 -0
  10. data/docs/BookmarkGroupResponse.md +49 -0
  11. data/docs/BookmarkGroupResult.md +1 -1
  12. data/docs/BoostPhrase.md +20 -0
  13. data/docs/ChatMessageProxy.md +1 -1
  14. data/docs/ChunkApi.md +269 -93
  15. data/docs/ChunkData.md +3 -1
  16. data/docs/ChunkFilter.md +5 -3
  17. data/docs/ChunkGroup.md +1 -1
  18. data/docs/ChunkGroupAndFileId.md +36 -0
  19. data/docs/ChunkGroupApi.md +136 -114
  20. data/docs/ChunkMetadata.md +6 -2
  21. data/docs/ChunkMetadataStringTagSet.md +46 -0
  22. data/docs/ChunkMetadataTypes.md +51 -0
  23. data/docs/ChunkMetadataWithScore.md +1 -1
  24. data/docs/ChunkReqPayload.md +50 -0
  25. data/docs/ChunkReturnTypes.md +49 -0
  26. data/docs/ClientDatasetConfiguration.md +0 -2
  27. data/docs/ClusterAnalytics.md +63 -0
  28. data/docs/ClusterAnalyticsFilter.md +18 -0
  29. data/docs/ClusterAnalyticsResponse.md +49 -0
  30. data/docs/ClusterQueries.md +22 -0
  31. data/docs/ClusterTopics.md +20 -0
  32. data/docs/ConditionType.md +49 -0
  33. data/docs/ContentChunkMetadata.md +32 -0
  34. data/docs/CountChunkQueryResponseBody.md +18 -0
  35. data/docs/CountChunksReqPayload.md +26 -0
  36. data/docs/CountQueries.md +20 -0
  37. data/docs/CreateChunkGroupReqPayload.md +28 -0
  38. data/docs/CreateChunkReqPayloadEnum.md +49 -0
  39. data/docs/CreateDatasetRequest.md +2 -2
  40. data/docs/CreateMessageData.md +2 -2
  41. data/docs/CreateMessageReqPayload.md +52 -0
  42. data/docs/CreateSetupCheckoutSessionResPayload.md +18 -0
  43. data/docs/CreateTopicReqPayload.md +22 -0
  44. data/docs/Dataset.md +2 -2
  45. data/docs/DatasetAnalytics.md +28 -0
  46. data/docs/DatasetApi.md +184 -32
  47. data/docs/DatasetDTO.md +0 -2
  48. data/docs/DateRange.md +24 -0
  49. data/docs/DeprecatedSearchOverGroupsResponseBody.md +20 -0
  50. data/docs/DistancePhrase.md +20 -0
  51. data/docs/EditMessageReqPayload.md +54 -0
  52. data/docs/Event.md +3 -5
  53. data/docs/EventTypeRequest.md +15 -0
  54. data/docs/EventsApi.md +1 -1
  55. data/docs/FieldCondition.md +2 -0
  56. data/docs/File.md +1 -1
  57. data/docs/FileApi.md +10 -10
  58. data/docs/GenerateChunksRequest.md +13 -1
  59. data/docs/GeoInfoWithBias.md +20 -0
  60. data/docs/GetChunksForGroupsResponse.md +22 -0
  61. data/docs/GetDatasetsPagination.md +20 -0
  62. data/docs/GetEventsData.md +1 -1
  63. data/docs/Granularity.md +15 -0
  64. data/docs/GroupData.md +1 -1
  65. data/docs/GroupScoreChunk.md +14 -0
  66. data/docs/GroupsBookmarkQueryResult.md +22 -0
  67. data/docs/HasIDCondition.md +20 -0
  68. data/docs/HeadQueries.md +20 -0
  69. data/docs/HeadQueries1.md +22 -0
  70. data/docs/HeadQueryResponse.md +18 -0
  71. data/docs/HealthApi.md +1 -1
  72. data/docs/InvitationApi.md +1 -1
  73. data/docs/LatencyGraph.md +22 -0
  74. data/docs/LatencyGraphResponse.md +18 -0
  75. data/docs/LowConfidenceQueries.md +24 -0
  76. data/docs/LowConfidenceRecommendations.md +24 -0
  77. data/docs/MatchCondition.md +3 -1
  78. data/docs/MessageApi.md +43 -43
  79. data/docs/MetricsApi.md +76 -0
  80. data/docs/NewChunkMetadataTypes.md +51 -0
  81. data/docs/NoResultQueries.md +22 -0
  82. data/docs/Organization.md +2 -0
  83. data/docs/OrganizationApi.md +27 -28
  84. data/docs/QueryCountResponse.md +18 -0
  85. data/docs/QueryDetails.md +20 -0
  86. data/docs/RAGAnalytics.md +63 -0
  87. data/docs/RAGAnalyticsFilter.md +20 -0
  88. data/docs/RAGAnalyticsResponse.md +49 -0
  89. data/docs/RAGQueries.md +26 -0
  90. data/docs/RAGUsage.md +20 -0
  91. data/docs/RAGUsageResponse.md +18 -0
  92. data/docs/RPSGraph.md +22 -0
  93. data/docs/RPSGraphResponse.md +18 -0
  94. data/docs/RagQueryEvent.md +30 -0
  95. data/docs/RagQueryResponse.md +18 -0
  96. data/docs/RagTypes.md +15 -0
  97. data/docs/RangeCondition.md +1 -3
  98. data/docs/RecommendChunksRequest.md +2 -2
  99. data/docs/RecommendChunksResponseBody.md +18 -0
  100. data/docs/RecommendGroupChunksRequest.md +2 -2
  101. data/docs/RecommendGroupsResponse.md +49 -0
  102. data/docs/RecommendGroupsResponseBody.md +18 -0
  103. data/docs/RecommendResponseTypes.md +49 -0
  104. data/docs/RecommendType.md +15 -0
  105. data/docs/RecommendationAnalytics.md +63 -0
  106. data/docs/RecommendationAnalyticsFilter.md +20 -0
  107. data/docs/RecommendationAnalyticsResponse.md +47 -0
  108. data/docs/RecommendationEvent.md +38 -0
  109. data/docs/RecommendationQueries.md +26 -0
  110. data/docs/RecommendationStrategy.md +15 -0
  111. data/docs/RecommendationType.md +15 -0
  112. data/docs/RecommendationsEventResponse.md +18 -0
  113. data/docs/RegenerateMessageReqPayload.md +48 -0
  114. data/docs/RemoveChunkFromGroupReqPayload.md +18 -0
  115. data/docs/RoleProxy.md +15 -0
  116. data/docs/ScoreChunk.md +22 -0
  117. data/docs/ScoreChunkDTO.md +3 -1
  118. data/docs/SearchAnalytics.md +77 -0
  119. data/docs/SearchAnalyticsFilter.md +22 -0
  120. data/docs/SearchAnalyticsResponse.md +59 -0
  121. data/docs/SearchChunkData.md +9 -3
  122. data/docs/SearchChunksReqPayload.md +56 -0
  123. data/docs/SearchClusterResponse.md +18 -0
  124. data/docs/SearchClusterTopics.md +28 -0
  125. data/docs/SearchGroupResponseTypes.md +49 -0
  126. data/docs/SearchLatencyGraph.md +20 -0
  127. data/docs/SearchMethod.md +15 -0
  128. data/docs/SearchMetrics.md +20 -0
  129. data/docs/SearchOverGroupsData.md +12 -6
  130. data/docs/SearchOverGroupsResponseBody.md +4 -4
  131. data/docs/SearchOverGroupsResponseTypes.md +4 -4
  132. data/docs/SearchOverGroupsResults.md +6 -4
  133. data/docs/SearchQueries.md +26 -0
  134. data/docs/SearchQueryEvent.md +34 -0
  135. data/docs/SearchQueryResponse.md +18 -0
  136. data/docs/SearchRPSGraph.md +20 -0
  137. data/docs/SearchResponseBody.md +20 -0
  138. data/docs/SearchResponseTypes.md +49 -0
  139. data/docs/SearchResultType.md +49 -0
  140. data/docs/SearchType.md +15 -0
  141. data/docs/SearchTypeCount.md +22 -0
  142. data/docs/SearchWithinGroupData.md +18 -4
  143. data/docs/SearchWithinGroupResponseBody.md +20 -0
  144. data/docs/SearchWithinGroupResults.md +1 -1
  145. data/docs/SetUserApiKeyRequest.md +4 -0
  146. data/docs/SlimChunkMetadata.md +5 -1
  147. data/docs/SlimChunkMetadataWithArrayTagSet.md +44 -0
  148. data/docs/SlimChunkMetadataWithScore.md +1 -1
  149. data/docs/SortBy.md +15 -0
  150. data/docs/SortOrder.md +15 -0
  151. data/docs/StripeApi.md +134 -4
  152. data/docs/StripeInvoice.md +28 -0
  153. data/docs/SuggestedQueriesReqPayload.md +18 -0
  154. data/docs/TopicApi.md +16 -16
  155. data/docs/UpdateChunkData.md +2 -0
  156. data/docs/UpdateChunkGroupData.md +3 -1
  157. data/docs/UpdateChunkReqPayload.md +48 -0
  158. data/docs/UpdateDatasetRequest.md +2 -0
  159. data/docs/UpdateGroupByTrackingIDReqPayload.md +26 -0
  160. data/docs/UpdateTopicReqPayload.md +20 -0
  161. data/docs/UpdateUserOrgRoleData.md +1 -1
  162. data/docs/UploadFileReqPayload.md +40 -0
  163. data/docs/UserApi.md +9 -10
  164. data/lib/trieve_ruby_client/api/analytics_api.rb +322 -0
  165. data/lib/trieve_ruby_client/api/auth_api.rb +9 -9
  166. data/lib/trieve_ruby_client/api/chunk_api.rb +274 -103
  167. data/lib/trieve_ruby_client/api/chunk_group_api.rb +161 -139
  168. data/lib/trieve_ruby_client/api/dataset_api.rb +183 -38
  169. data/lib/trieve_ruby_client/api/events_api.rb +3 -3
  170. data/lib/trieve_ruby_client/api/file_api.rb +18 -18
  171. data/lib/trieve_ruby_client/api/health_api.rb +3 -3
  172. data/lib/trieve_ruby_client/api/invitation_api.rb +3 -3
  173. data/lib/trieve_ruby_client/api/message_api.rb +52 -52
  174. data/lib/trieve_ruby_client/api/metrics_api.rb +79 -0
  175. data/lib/trieve_ruby_client/api/organization_api.rb +33 -33
  176. data/lib/trieve_ruby_client/api/stripe_api.rb +135 -9
  177. data/lib/trieve_ruby_client/api/topic_api.rb +27 -27
  178. data/lib/trieve_ruby_client/api/user_api.rb +12 -12
  179. data/lib/trieve_ruby_client/api_client.rb +1 -1
  180. data/lib/trieve_ruby_client/api_error.rb +1 -1
  181. data/lib/trieve_ruby_client/configuration.rb +8 -1
  182. data/lib/trieve_ruby_client/models/add_chunk_to_group_data.rb +1 -1
  183. data/lib/trieve_ruby_client/models/api_key_dto.rb +1 -1
  184. data/lib/trieve_ruby_client/models/api_key_resp_body.rb +325 -0
  185. data/lib/trieve_ruby_client/models/api_version.rb +40 -0
  186. data/lib/trieve_ruby_client/models/auth_query.rb +1 -1
  187. data/lib/trieve_ruby_client/models/autocomplete_data.rb +378 -0
  188. data/lib/trieve_ruby_client/models/autocomplete_req_payload.rb +509 -0
  189. data/lib/trieve_ruby_client/models/batch_queued_chunk_response.rb +1 -1
  190. data/lib/trieve_ruby_client/models/bookmark_data.rb +1 -1
  191. data/lib/trieve_ruby_client/models/bookmark_group_response.rb +105 -0
  192. data/lib/trieve_ruby_client/models/bookmark_group_result.rb +2 -2
  193. data/lib/trieve_ruby_client/models/boost_phrase.rb +240 -0
  194. data/lib/trieve_ruby_client/models/chat_message_proxy.rb +24 -2
  195. data/lib/trieve_ruby_client/models/chunk_data.rb +16 -9
  196. data/lib/trieve_ruby_client/models/chunk_filter.rb +16 -5
  197. data/lib/trieve_ruby_client/models/chunk_group.rb +5 -3
  198. data/lib/trieve_ruby_client/models/chunk_group_and_file.rb +1 -1
  199. data/lib/trieve_ruby_client/models/chunk_group_and_file_id.rb +343 -0
  200. data/lib/trieve_ruby_client/models/chunk_metadata.rb +35 -5
  201. data/lib/trieve_ruby_client/models/chunk_metadata_string_tag_set.rb +393 -0
  202. data/lib/trieve_ruby_client/models/chunk_metadata_types.rb +106 -0
  203. data/lib/trieve_ruby_client/models/chunk_metadata_with_score.rb +8 -2
  204. data/lib/trieve_ruby_client/models/chunk_req_payload.rb +397 -0
  205. data/lib/trieve_ruby_client/models/chunk_return_types.rb +105 -0
  206. data/lib/trieve_ruby_client/models/client_dataset_configuration.rb +2 -18
  207. data/lib/trieve_ruby_client/models/cluster_analytics.rb +43 -0
  208. data/lib/trieve_ruby_client/models/cluster_analytics_filter.rb +215 -0
  209. data/lib/trieve_ruby_client/models/cluster_analytics_response.rb +105 -0
  210. data/lib/trieve_ruby_client/models/cluster_queries.rb +296 -0
  211. data/lib/trieve_ruby_client/models/cluster_topics.rb +265 -0
  212. data/lib/trieve_ruby_client/models/condition_type.rb +105 -0
  213. data/lib/trieve_ruby_client/models/content_chunk_metadata.rb +305 -0
  214. data/lib/trieve_ruby_client/models/count_chunk_query_response_body.rb +240 -0
  215. data/lib/trieve_ruby_client/models/count_chunks_req_payload.rb +307 -0
  216. data/lib/trieve_ruby_client/models/count_queries.rb +265 -0
  217. data/lib/trieve_ruby_client/models/create_chunk_data.rb +1 -1
  218. data/lib/trieve_ruby_client/models/create_chunk_group_data.rb +1 -1
  219. data/lib/trieve_ruby_client/models/create_chunk_group_req_payload.rb +273 -0
  220. data/lib/trieve_ruby_client/models/create_chunk_req_payload_enum.rb +105 -0
  221. data/lib/trieve_ruby_client/models/create_dataset_request.rb +3 -3
  222. data/lib/trieve_ruby_client/models/create_message_data.rb +13 -13
  223. data/lib/trieve_ruby_client/models/create_message_req_payload.rb +469 -0
  224. data/lib/trieve_ruby_client/models/create_organization_data.rb +1 -1
  225. data/lib/trieve_ruby_client/models/create_setup_checkout_session_res_payload.rb +221 -0
  226. data/lib/trieve_ruby_client/models/create_topic_data.rb +1 -1
  227. data/lib/trieve_ruby_client/models/create_topic_req_payload.rb +244 -0
  228. data/lib/trieve_ruby_client/models/dataset.rb +18 -14
  229. data/lib/trieve_ruby_client/models/dataset_analytics.rb +301 -0
  230. data/lib/trieve_ruby_client/models/dataset_and_usage.rb +1 -1
  231. data/lib/trieve_ruby_client/models/dataset_dto.rb +2 -14
  232. data/lib/trieve_ruby_client/models/dataset_usage_count.rb +1 -1
  233. data/lib/trieve_ruby_client/models/date_range.rb +245 -0
  234. data/lib/trieve_ruby_client/models/delete_topic_data.rb +1 -1
  235. data/lib/trieve_ruby_client/models/delete_user_api_key_request.rb +1 -1
  236. data/lib/trieve_ruby_client/models/deprecated_search_over_groups_response_body.rb +239 -0
  237. data/lib/trieve_ruby_client/models/distance_phrase.rb +240 -0
  238. data/lib/trieve_ruby_client/models/edit_message_data.rb +1 -1
  239. data/lib/trieve_ruby_client/models/edit_message_req_payload.rb +486 -0
  240. data/lib/trieve_ruby_client/models/error_response_body.rb +1 -1
  241. data/lib/trieve_ruby_client/models/event.rb +12 -24
  242. data/lib/trieve_ruby_client/models/event_return.rb +1 -1
  243. data/lib/trieve_ruby_client/models/event_type_request.rb +49 -0
  244. data/lib/trieve_ruby_client/models/field_condition.rb +12 -2
  245. data/lib/trieve_ruby_client/models/file.rb +5 -3
  246. data/lib/trieve_ruby_client/models/file_dto.rb +1 -1
  247. data/lib/trieve_ruby_client/models/generate_chunks_request.rb +89 -6
  248. data/lib/trieve_ruby_client/models/geo_info.rb +1 -1
  249. data/lib/trieve_ruby_client/models/geo_info_with_bias.rb +237 -0
  250. data/lib/trieve_ruby_client/models/geo_types.rb +1 -1
  251. data/lib/trieve_ruby_client/models/get_chunks_data.rb +1 -1
  252. data/lib/trieve_ruby_client/models/get_chunks_for_groups_response.rb +274 -0
  253. data/lib/trieve_ruby_client/models/get_datasets_pagination.rb +225 -0
  254. data/lib/trieve_ruby_client/models/get_events_data.rb +2 -2
  255. data/lib/trieve_ruby_client/models/get_groups_for_chunks_data.rb +1 -1
  256. data/lib/trieve_ruby_client/models/get_tracking_chunks_data.rb +1 -1
  257. data/lib/trieve_ruby_client/models/granularity.rb +42 -0
  258. data/lib/trieve_ruby_client/models/group_data.rb +2 -2
  259. data/lib/trieve_ruby_client/models/group_score_chunk.rb +92 -2
  260. data/lib/trieve_ruby_client/models/groups_bookmark_query_result.rb +274 -0
  261. data/lib/trieve_ruby_client/models/has_id_condition.rb +229 -0
  262. data/lib/trieve_ruby_client/models/head_queries.rb +237 -0
  263. data/lib/trieve_ruby_client/models/head_queries1.rb +290 -0
  264. data/lib/trieve_ruby_client/models/head_query_response.rb +223 -0
  265. data/lib/trieve_ruby_client/models/invitation_data.rb +1 -1
  266. data/lib/trieve_ruby_client/models/latency_graph.rb +275 -0
  267. data/lib/trieve_ruby_client/models/latency_graph_response.rb +223 -0
  268. data/lib/trieve_ruby_client/models/location_bounding_box.rb +1 -1
  269. data/lib/trieve_ruby_client/models/location_polygon.rb +1 -1
  270. data/lib/trieve_ruby_client/models/location_radius.rb +1 -1
  271. data/lib/trieve_ruby_client/models/low_confidence_queries.rb +300 -0
  272. data/lib/trieve_ruby_client/models/low_confidence_recommendations.rb +300 -0
  273. data/lib/trieve_ruby_client/models/match_condition.rb +2 -1
  274. data/lib/trieve_ruby_client/models/message.rb +1 -1
  275. data/lib/trieve_ruby_client/models/new_chunk_metadata_types.rb +106 -0
  276. data/lib/trieve_ruby_client/models/no_result_queries.rb +290 -0
  277. data/lib/trieve_ruby_client/models/organization.rb +18 -2
  278. data/lib/trieve_ruby_client/models/organization_usage_count.rb +1 -1
  279. data/lib/trieve_ruby_client/models/query_count_response.rb +223 -0
  280. data/lib/trieve_ruby_client/models/query_details.rb +271 -0
  281. data/lib/trieve_ruby_client/models/rag_analytics.rb +43 -0
  282. data/lib/trieve_ruby_client/models/rag_analytics_filter.rb +247 -0
  283. data/lib/trieve_ruby_client/models/rag_analytics_response.rb +105 -0
  284. data/lib/trieve_ruby_client/models/rag_queries.rb +310 -0
  285. data/lib/trieve_ruby_client/models/rag_query_event.rb +319 -0
  286. data/lib/trieve_ruby_client/models/rag_query_response.rb +223 -0
  287. data/lib/trieve_ruby_client/models/rag_types.rb +40 -0
  288. data/lib/trieve_ruby_client/models/rag_usage.rb +265 -0
  289. data/lib/trieve_ruby_client/models/rag_usage_response.rb +240 -0
  290. data/lib/trieve_ruby_client/models/range.rb +1 -1
  291. data/lib/trieve_ruby_client/models/range_condition.rb +2 -3
  292. data/lib/trieve_ruby_client/models/recommend_chunks_request.rb +25 -5
  293. data/lib/trieve_ruby_client/models/recommend_chunks_response_body.rb +223 -0
  294. data/lib/trieve_ruby_client/models/recommend_group_chunks_request.rb +25 -5
  295. data/lib/trieve_ruby_client/models/recommend_groups_response.rb +105 -0
  296. data/lib/trieve_ruby_client/models/recommend_groups_response_body.rb +223 -0
  297. data/lib/trieve_ruby_client/models/recommend_response_types.rb +105 -0
  298. data/lib/trieve_ruby_client/models/recommend_type.rb +40 -0
  299. data/lib/trieve_ruby_client/models/recommendation_analytics.rb +43 -0
  300. data/lib/trieve_ruby_client/models/recommendation_analytics_filter.rb +247 -0
  301. data/lib/trieve_ruby_client/models/recommendation_analytics_response.rb +104 -0
  302. data/lib/trieve_ruby_client/models/recommendation_event.rb +391 -0
  303. data/lib/trieve_ruby_client/models/recommendation_queries.rb +310 -0
  304. data/lib/trieve_ruby_client/models/recommendation_strategy.rb +40 -0
  305. data/lib/trieve_ruby_client/models/recommendation_type.rb +40 -0
  306. data/lib/trieve_ruby_client/models/recommendations_event_response.rb +223 -0
  307. data/lib/trieve_ruby_client/models/regenerate_message_data.rb +1 -1
  308. data/lib/trieve_ruby_client/models/regenerate_message_req_payload.rb +441 -0
  309. data/lib/trieve_ruby_client/models/remove_chunk_from_group_req_payload.rb +222 -0
  310. data/lib/trieve_ruby_client/models/return_queued_chunk.rb +1 -1
  311. data/lib/trieve_ruby_client/models/role_proxy.rb +41 -0
  312. data/lib/trieve_ruby_client/models/rps_graph.rb +275 -0
  313. data/lib/trieve_ruby_client/models/rps_graph_response.rb +223 -0
  314. data/lib/trieve_ruby_client/models/score_chunk.rb +249 -0
  315. data/lib/trieve_ruby_client/models/score_chunk_dto.rb +15 -3
  316. data/lib/trieve_ruby_client/models/search_analytics.rb +50 -0
  317. data/lib/trieve_ruby_client/models/search_analytics_filter.rb +257 -0
  318. data/lib/trieve_ruby_client/models/search_analytics_response.rb +110 -0
  319. data/lib/trieve_ruby_client/models/search_chunk_data.rb +40 -5
  320. data/lib/trieve_ruby_client/models/search_chunk_query_response_body.rb +1 -1
  321. data/lib/trieve_ruby_client/models/search_chunks_req_payload.rb +535 -0
  322. data/lib/trieve_ruby_client/models/search_cluster_response.rb +223 -0
  323. data/lib/trieve_ruby_client/models/search_cluster_topics.rb +301 -0
  324. data/lib/trieve_ruby_client/models/search_group_response_types.rb +105 -0
  325. data/lib/trieve_ruby_client/models/search_latency_graph.rb +237 -0
  326. data/lib/trieve_ruby_client/models/search_method.rb +42 -0
  327. data/lib/trieve_ruby_client/models/search_metrics.rb +265 -0
  328. data/lib/trieve_ruby_client/models/search_over_groups_data.rb +117 -18
  329. data/lib/trieve_ruby_client/models/search_over_groups_response_body.rb +23 -23
  330. data/lib/trieve_ruby_client/models/search_over_groups_response_types.rb +3 -3
  331. data/lib/trieve_ruby_client/models/search_over_groups_results.rb +33 -23
  332. data/lib/trieve_ruby_client/models/search_queries.rb +310 -0
  333. data/lib/trieve_ruby_client/models/search_query_event.rb +351 -0
  334. data/lib/trieve_ruby_client/models/search_query_response.rb +223 -0
  335. data/lib/trieve_ruby_client/models/search_response_body.rb +239 -0
  336. data/lib/trieve_ruby_client/models/search_response_types.rb +105 -0
  337. data/lib/trieve_ruby_client/models/search_result_type.rb +105 -0
  338. data/lib/trieve_ruby_client/models/search_rps_graph.rb +237 -0
  339. data/lib/trieve_ruby_client/models/search_type.rb +42 -0
  340. data/lib/trieve_ruby_client/models/search_type_count.rb +253 -0
  341. data/lib/trieve_ruby_client/models/search_within_group_data.rb +151 -7
  342. data/lib/trieve_ruby_client/models/search_within_group_response_body.rb +239 -0
  343. data/lib/trieve_ruby_client/models/search_within_group_results.rb +2 -2
  344. data/lib/trieve_ruby_client/models/set_user_api_key_request.rb +28 -2
  345. data/lib/trieve_ruby_client/models/set_user_api_key_response.rb +1 -1
  346. data/lib/trieve_ruby_client/models/single_queued_chunk_response.rb +1 -1
  347. data/lib/trieve_ruby_client/models/slim_chunk_metadata.rb +31 -3
  348. data/lib/trieve_ruby_client/models/slim_chunk_metadata_with_array_tag_set.rb +385 -0
  349. data/lib/trieve_ruby_client/models/slim_chunk_metadata_with_score.rb +8 -2
  350. data/lib/trieve_ruby_client/models/slim_group.rb +1 -1
  351. data/lib/trieve_ruby_client/models/slim_user.rb +1 -1
  352. data/lib/trieve_ruby_client/models/sort_by.rb +41 -0
  353. data/lib/trieve_ruby_client/models/sort_order.rb +40 -0
  354. data/lib/trieve_ruby_client/models/stripe_invoice.rb +301 -0
  355. data/lib/trieve_ruby_client/models/stripe_plan.rb +1 -1
  356. data/lib/trieve_ruby_client/models/suggested_queries_req_payload.rb +222 -0
  357. data/lib/trieve_ruby_client/models/suggested_queries_request.rb +1 -1
  358. data/lib/trieve_ruby_client/models/suggested_queries_response.rb +1 -1
  359. data/lib/trieve_ruby_client/models/topic.rb +1 -1
  360. data/lib/trieve_ruby_client/models/update_chunk_by_tracking_id_data.rb +1 -1
  361. data/lib/trieve_ruby_client/models/update_chunk_data.rb +15 -2
  362. data/lib/trieve_ruby_client/models/update_chunk_group_data.rb +17 -6
  363. data/lib/trieve_ruby_client/models/update_chunk_req_payload.rb +386 -0
  364. data/lib/trieve_ruby_client/models/update_dataset_request.rb +13 -2
  365. data/lib/trieve_ruby_client/models/update_group_by_tracking_id_data.rb +1 -1
  366. data/lib/trieve_ruby_client/models/update_group_by_tracking_id_req_payload.rb +268 -0
  367. data/lib/trieve_ruby_client/models/update_organization_data.rb +1 -1
  368. data/lib/trieve_ruby_client/models/update_topic_data.rb +1 -1
  369. data/lib/trieve_ruby_client/models/update_topic_req_payload.rb +239 -0
  370. data/lib/trieve_ruby_client/models/update_user_org_role_data.rb +2 -2
  371. data/lib/trieve_ruby_client/models/upload_file_data.rb +1 -1
  372. data/lib/trieve_ruby_client/models/upload_file_req_payload.rb +368 -0
  373. data/lib/trieve_ruby_client/models/upload_file_result.rb +1 -1
  374. data/lib/trieve_ruby_client/models/user_organization.rb +1 -1
  375. data/lib/trieve_ruby_client/version.rb +2 -2
  376. data/lib/trieve_ruby_client.rb +110 -24
  377. data/openapi-generator.yaml +2 -2
  378. data/openapi.json +4491 -1230
  379. data/spec/api/analytics_api_spec.rb +87 -0
  380. data/spec/api/metrics_api_spec.rb +46 -0
  381. data/spec/models/api_key_resp_body_spec.rb +78 -0
  382. data/spec/models/api_version_spec.rb +30 -0
  383. data/spec/models/autocomplete_data_spec.rb +108 -0
  384. data/spec/models/autocomplete_req_payload_spec.rb +132 -0
  385. data/spec/models/bookmark_group_response_spec.rb +32 -0
  386. data/spec/models/boost_phrase_spec.rb +42 -0
  387. data/spec/models/chunk_group_and_file_id_spec.rb +90 -0
  388. data/spec/models/chunk_metadata_string_tag_set_spec.rb +120 -0
  389. data/spec/models/chunk_metadata_types_spec.rb +32 -0
  390. data/spec/models/chunk_req_payload_spec.rb +132 -0
  391. data/spec/models/chunk_return_types_spec.rb +32 -0
  392. data/spec/models/cluster_analytics_filter_spec.rb +36 -0
  393. data/spec/models/cluster_analytics_response_spec.rb +32 -0
  394. data/spec/models/cluster_analytics_spec.rb +38 -0
  395. data/spec/models/cluster_queries_spec.rb +52 -0
  396. data/spec/models/cluster_topics_spec.rb +46 -0
  397. data/spec/models/condition_type_spec.rb +32 -0
  398. data/spec/models/content_chunk_metadata_spec.rb +72 -0
  399. data/spec/models/count_chunk_query_response_body_spec.rb +36 -0
  400. data/spec/models/count_chunks_req_payload_spec.rb +60 -0
  401. data/spec/models/count_queries_spec.rb +46 -0
  402. data/spec/models/create_chunk_group_req_payload_spec.rb +66 -0
  403. data/spec/models/create_chunk_req_payload_enum_spec.rb +32 -0
  404. data/spec/models/create_message_req_payload_spec.rb +108 -0
  405. data/spec/models/create_setup_checkout_session_res_payload_spec.rb +36 -0
  406. data/spec/models/create_topic_req_payload_spec.rb +48 -0
  407. data/spec/models/dataset_analytics_spec.rb +66 -0
  408. data/spec/models/date_range_spec.rb +54 -0
  409. data/spec/models/deprecated_search_over_groups_response_body_spec.rb +42 -0
  410. data/spec/models/distance_phrase_spec.rb +42 -0
  411. data/spec/models/edit_message_req_payload_spec.rb +114 -0
  412. data/spec/models/event_type_request_spec.rb +30 -0
  413. data/spec/models/geo_info_with_bias_spec.rb +42 -0
  414. data/spec/models/get_chunks_for_groups_response_spec.rb +48 -0
  415. data/spec/models/get_datasets_pagination_spec.rb +42 -0
  416. data/spec/models/granularity_spec.rb +30 -0
  417. data/spec/models/groups_bookmark_query_result_spec.rb +48 -0
  418. data/spec/models/has_id_condition_spec.rb +42 -0
  419. data/spec/models/head_queries1_spec.rb +52 -0
  420. data/spec/models/head_queries_spec.rb +42 -0
  421. data/spec/models/head_query_response_spec.rb +36 -0
  422. data/spec/models/latency_graph_response_spec.rb +36 -0
  423. data/spec/models/latency_graph_spec.rb +52 -0
  424. data/spec/models/low_confidence_queries_spec.rb +58 -0
  425. data/spec/models/low_confidence_recommendations_spec.rb +58 -0
  426. data/spec/models/new_chunk_metadata_types_spec.rb +32 -0
  427. data/spec/models/no_result_queries_spec.rb +52 -0
  428. data/spec/models/query_count_response_spec.rb +36 -0
  429. data/spec/models/query_details_spec.rb +46 -0
  430. data/spec/models/rag_analytics_filter_spec.rb +42 -0
  431. data/spec/models/rag_analytics_response_spec.rb +32 -0
  432. data/spec/models/rag_analytics_spec.rb +38 -0
  433. data/spec/models/rag_queries_spec.rb +64 -0
  434. data/spec/models/rag_query_event_spec.rb +72 -0
  435. data/spec/models/rag_query_response_spec.rb +36 -0
  436. data/spec/models/rag_types_spec.rb +30 -0
  437. data/spec/models/rag_usage_response_spec.rb +36 -0
  438. data/spec/models/rag_usage_spec.rb +46 -0
  439. data/spec/models/recommend_chunks_response_body_spec.rb +36 -0
  440. data/spec/models/recommend_groups_response_body_spec.rb +36 -0
  441. data/spec/models/recommend_groups_response_spec.rb +32 -0
  442. data/spec/models/recommend_response_types_spec.rb +32 -0
  443. data/spec/models/recommend_type_spec.rb +30 -0
  444. data/spec/models/recommendation_analytics_filter_spec.rb +42 -0
  445. data/spec/models/recommendation_analytics_response_spec.rb +32 -0
  446. data/spec/models/recommendation_analytics_spec.rb +38 -0
  447. data/spec/models/recommendation_event_spec.rb +96 -0
  448. data/spec/models/recommendation_queries_spec.rb +64 -0
  449. data/spec/models/recommendation_strategy_spec.rb +30 -0
  450. data/spec/models/recommendation_type_spec.rb +30 -0
  451. data/spec/models/recommendations_event_response_spec.rb +36 -0
  452. data/spec/models/regenerate_message_req_payload_spec.rb +102 -0
  453. data/spec/models/remove_chunk_from_group_req_payload_spec.rb +36 -0
  454. data/spec/models/role_proxy_spec.rb +30 -0
  455. data/spec/models/rps_graph_response_spec.rb +36 -0
  456. data/spec/models/rps_graph_spec.rb +52 -0
  457. data/spec/models/score_chunk_spec.rb +48 -0
  458. data/spec/models/search_analytics_filter_spec.rb +48 -0
  459. data/spec/models/search_analytics_response_spec.rb +32 -0
  460. data/spec/models/search_analytics_spec.rb +38 -0
  461. data/spec/models/search_chunks_req_payload_spec.rb +144 -0
  462. data/spec/models/search_cluster_response_spec.rb +36 -0
  463. data/spec/models/search_cluster_topics_spec.rb +66 -0
  464. data/spec/models/search_group_response_types_spec.rb +32 -0
  465. data/spec/models/search_latency_graph_spec.rb +42 -0
  466. data/spec/models/search_method_spec.rb +30 -0
  467. data/spec/models/search_metrics_spec.rb +46 -0
  468. data/spec/models/search_queries_spec.rb +64 -0
  469. data/spec/models/search_query_event_spec.rb +84 -0
  470. data/spec/models/search_query_response_spec.rb +36 -0
  471. data/spec/models/search_response_body_spec.rb +42 -0
  472. data/spec/models/search_response_types_spec.rb +32 -0
  473. data/spec/models/search_result_type_spec.rb +32 -0
  474. data/spec/models/search_rps_graph_spec.rb +42 -0
  475. data/spec/models/search_type_count_spec.rb +48 -0
  476. data/spec/models/search_type_spec.rb +30 -0
  477. data/spec/models/search_within_group_response_body_spec.rb +42 -0
  478. data/spec/models/slim_chunk_metadata_with_array_tag_set_spec.rb +114 -0
  479. data/spec/models/sort_by_spec.rb +30 -0
  480. data/spec/models/sort_order_spec.rb +30 -0
  481. data/spec/models/stripe_invoice_spec.rb +66 -0
  482. data/spec/models/suggested_queries_req_payload_spec.rb +36 -0
  483. data/spec/models/update_chunk_req_payload_spec.rb +120 -0
  484. data/spec/models/update_group_by_tracking_id_req_payload_spec.rb +60 -0
  485. data/spec/models/update_topic_req_payload_spec.rb +42 -0
  486. data/spec/models/upload_file_req_payload_spec.rb +102 -0
  487. data/spec/spec_helper.rb +1 -1
  488. data/trieve_ruby_client.gemspec +1 -1
  489. metadata +534 -111
  490. data/trieve_ruby_client-0.5.0.gem +0 -0
  491. data/trieve_ruby_client-0.5.7.gem +0 -0
  492. data/trieve_ruby_client-0.6.0.gem +0 -0
  493. data/trieve_ruby_client-0.6.2.gem +0 -0
  494. data/trieve_ruby_client-0.6.7.gem +0 -0
  495. data/trieve_ruby_client-0.6.9.gem +0 -0
  496. data/trieve_ruby_client-0.7.2.gem +0 -0
  497. data/trieve_ruby_client-0.7.6.gem +0 -0
  498. data/trieve_ruby_client-0.8.0.gem +0 -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.2
6
+ The version of the OpenAPI document: 0.11.0
7
7
  Contact: developers@trieve.ai
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.4.0
@@ -15,20 +15,41 @@ require 'time'
15
15
 
16
16
  module TrieveRubyClient
17
17
  class GroupScoreChunk
18
+ attr_accessor :file_id
19
+
20
+ attr_accessor :group_created_at
21
+
22
+ attr_accessor :group_dataset_id
23
+
24
+ attr_accessor :group_description
25
+
18
26
  attr_accessor :group_id
19
27
 
28
+ attr_accessor :group_metadata
29
+
20
30
  attr_accessor :group_name
21
31
 
32
+ attr_accessor :group_tag_set
33
+
22
34
  attr_accessor :group_tracking_id
23
35
 
36
+ attr_accessor :group_updated_at
37
+
24
38
  attr_accessor :metadata
25
39
 
26
40
  # Attribute mapping from ruby-style variable name to JSON key.
27
41
  def self.attribute_map
28
42
  {
43
+ :'file_id' => :'file_id',
44
+ :'group_created_at' => :'group_created_at',
45
+ :'group_dataset_id' => :'group_dataset_id',
46
+ :'group_description' => :'group_description',
29
47
  :'group_id' => :'group_id',
48
+ :'group_metadata' => :'group_metadata',
30
49
  :'group_name' => :'group_name',
50
+ :'group_tag_set' => :'group_tag_set',
31
51
  :'group_tracking_id' => :'group_tracking_id',
52
+ :'group_updated_at' => :'group_updated_at',
32
53
  :'metadata' => :'metadata'
33
54
  }
34
55
  end
@@ -41,9 +62,16 @@ module TrieveRubyClient
41
62
  # Attribute type mapping.
42
63
  def self.openapi_types
43
64
  {
65
+ :'file_id' => :'String',
66
+ :'group_created_at' => :'Time',
67
+ :'group_dataset_id' => :'String',
68
+ :'group_description' => :'String',
44
69
  :'group_id' => :'String',
70
+ :'group_metadata' => :'Object',
45
71
  :'group_name' => :'String',
72
+ :'group_tag_set' => :'Array<String>',
46
73
  :'group_tracking_id' => :'String',
74
+ :'group_updated_at' => :'Time',
47
75
  :'metadata' => :'Array<ScoreChunkDTO>'
48
76
  }
49
77
  end
@@ -51,7 +79,11 @@ module TrieveRubyClient
51
79
  # List of attributes with nullable: true
52
80
  def self.openapi_nullable
53
81
  Set.new([
82
+ :'file_id',
83
+ :'group_description',
84
+ :'group_metadata',
54
85
  :'group_name',
86
+ :'group_tag_set',
55
87
  :'group_tracking_id',
56
88
  ])
57
89
  end
@@ -71,20 +103,56 @@ module TrieveRubyClient
71
103
  h[k.to_sym] = v
72
104
  }
73
105
 
106
+ if attributes.key?(:'file_id')
107
+ self.file_id = attributes[:'file_id']
108
+ end
109
+
110
+ if attributes.key?(:'group_created_at')
111
+ self.group_created_at = attributes[:'group_created_at']
112
+ else
113
+ self.group_created_at = nil
114
+ end
115
+
116
+ if attributes.key?(:'group_dataset_id')
117
+ self.group_dataset_id = attributes[:'group_dataset_id']
118
+ else
119
+ self.group_dataset_id = nil
120
+ end
121
+
122
+ if attributes.key?(:'group_description')
123
+ self.group_description = attributes[:'group_description']
124
+ end
125
+
74
126
  if attributes.key?(:'group_id')
75
127
  self.group_id = attributes[:'group_id']
76
128
  else
77
129
  self.group_id = nil
78
130
  end
79
131
 
132
+ if attributes.key?(:'group_metadata')
133
+ self.group_metadata = attributes[:'group_metadata']
134
+ end
135
+
80
136
  if attributes.key?(:'group_name')
81
137
  self.group_name = attributes[:'group_name']
82
138
  end
83
139
 
140
+ if attributes.key?(:'group_tag_set')
141
+ if (value = attributes[:'group_tag_set']).is_a?(Array)
142
+ self.group_tag_set = value
143
+ end
144
+ end
145
+
84
146
  if attributes.key?(:'group_tracking_id')
85
147
  self.group_tracking_id = attributes[:'group_tracking_id']
86
148
  end
87
149
 
150
+ if attributes.key?(:'group_updated_at')
151
+ self.group_updated_at = attributes[:'group_updated_at']
152
+ else
153
+ self.group_updated_at = nil
154
+ end
155
+
88
156
  if attributes.key?(:'metadata')
89
157
  if (value = attributes[:'metadata']).is_a?(Array)
90
158
  self.metadata = value
@@ -99,10 +167,22 @@ module TrieveRubyClient
99
167
  def list_invalid_properties
100
168
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
101
169
  invalid_properties = Array.new
170
+ if @group_created_at.nil?
171
+ invalid_properties.push('invalid value for "group_created_at", group_created_at cannot be nil.')
172
+ end
173
+
174
+ if @group_dataset_id.nil?
175
+ invalid_properties.push('invalid value for "group_dataset_id", group_dataset_id cannot be nil.')
176
+ end
177
+
102
178
  if @group_id.nil?
103
179
  invalid_properties.push('invalid value for "group_id", group_id cannot be nil.')
104
180
  end
105
181
 
182
+ if @group_updated_at.nil?
183
+ invalid_properties.push('invalid value for "group_updated_at", group_updated_at cannot be nil.')
184
+ end
185
+
106
186
  if @metadata.nil?
107
187
  invalid_properties.push('invalid value for "metadata", metadata cannot be nil.')
108
188
  end
@@ -114,7 +194,10 @@ module TrieveRubyClient
114
194
  # @return true if the model is valid
115
195
  def valid?
116
196
  warn '[DEPRECATED] the `valid?` method is obsolete'
197
+ return false if @group_created_at.nil?
198
+ return false if @group_dataset_id.nil?
117
199
  return false if @group_id.nil?
200
+ return false if @group_updated_at.nil?
118
201
  return false if @metadata.nil?
119
202
  true
120
203
  end
@@ -124,9 +207,16 @@ module TrieveRubyClient
124
207
  def ==(o)
125
208
  return true if self.equal?(o)
126
209
  self.class == o.class &&
210
+ file_id == o.file_id &&
211
+ group_created_at == o.group_created_at &&
212
+ group_dataset_id == o.group_dataset_id &&
213
+ group_description == o.group_description &&
127
214
  group_id == o.group_id &&
215
+ group_metadata == o.group_metadata &&
128
216
  group_name == o.group_name &&
217
+ group_tag_set == o.group_tag_set &&
129
218
  group_tracking_id == o.group_tracking_id &&
219
+ group_updated_at == o.group_updated_at &&
130
220
  metadata == o.metadata
131
221
  end
132
222
 
@@ -139,7 +229,7 @@ module TrieveRubyClient
139
229
  # Calculates hash code according to all attributes.
140
230
  # @return [Integer] Hash code
141
231
  def hash
142
- [group_id, group_name, group_tracking_id, metadata].hash
232
+ [file_id, group_created_at, group_dataset_id, group_description, group_id, group_metadata, group_name, group_tag_set, group_tracking_id, group_updated_at, metadata].hash
143
233
  end
144
234
 
145
235
  # Builds the object from hash
@@ -0,0 +1,274 @@
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.11.0
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 GroupsBookmarkQueryResult
18
+ attr_accessor :chunks
19
+
20
+ attr_accessor :group
21
+
22
+ attr_accessor :total_pages
23
+
24
+ # Attribute mapping from ruby-style variable name to JSON key.
25
+ def self.attribute_map
26
+ {
27
+ :'chunks' => :'chunks',
28
+ :'group' => :'group',
29
+ :'total_pages' => :'total_pages'
30
+ }
31
+ end
32
+
33
+ # Returns all the JSON keys this model knows about
34
+ def self.acceptable_attributes
35
+ attribute_map.values
36
+ end
37
+
38
+ # Attribute type mapping.
39
+ def self.openapi_types
40
+ {
41
+ :'chunks' => :'Array<ChunkMetadataStringTagSet>',
42
+ :'group' => :'ChunkGroupAndFileId',
43
+ :'total_pages' => :'Integer'
44
+ }
45
+ end
46
+
47
+ # List of attributes with nullable: true
48
+ def self.openapi_nullable
49
+ Set.new([
50
+ ])
51
+ end
52
+
53
+ # Initializes the object
54
+ # @param [Hash] attributes Model attributes in the form of hash
55
+ def initialize(attributes = {})
56
+ if (!attributes.is_a?(Hash))
57
+ fail ArgumentError, "The input argument (attributes) must be a hash in `TrieveRubyClient::GroupsBookmarkQueryResult` initialize method"
58
+ end
59
+
60
+ # check to see if the attribute exists and convert string to symbol for hash key
61
+ attributes = attributes.each_with_object({}) { |(k, v), h|
62
+ if (!self.class.attribute_map.key?(k.to_sym))
63
+ fail ArgumentError, "`#{k}` is not a valid attribute in `TrieveRubyClient::GroupsBookmarkQueryResult`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
64
+ end
65
+ h[k.to_sym] = v
66
+ }
67
+
68
+ if attributes.key?(:'chunks')
69
+ if (value = attributes[:'chunks']).is_a?(Array)
70
+ self.chunks = value
71
+ end
72
+ else
73
+ self.chunks = nil
74
+ end
75
+
76
+ if attributes.key?(:'group')
77
+ self.group = attributes[:'group']
78
+ else
79
+ self.group = nil
80
+ end
81
+
82
+ if attributes.key?(:'total_pages')
83
+ self.total_pages = attributes[:'total_pages']
84
+ else
85
+ self.total_pages = nil
86
+ end
87
+ end
88
+
89
+ # Show invalid properties with the reasons. Usually used together with valid?
90
+ # @return Array for valid properties with the reasons
91
+ def list_invalid_properties
92
+ warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
93
+ invalid_properties = Array.new
94
+ if @chunks.nil?
95
+ invalid_properties.push('invalid value for "chunks", chunks cannot be nil.')
96
+ end
97
+
98
+ if @group.nil?
99
+ invalid_properties.push('invalid value for "group", group cannot be nil.')
100
+ end
101
+
102
+ if @total_pages.nil?
103
+ invalid_properties.push('invalid value for "total_pages", total_pages cannot be nil.')
104
+ end
105
+
106
+ if @total_pages < 0
107
+ invalid_properties.push('invalid value for "total_pages", must be greater than or equal to 0.')
108
+ end
109
+
110
+ invalid_properties
111
+ end
112
+
113
+ # Check to see if the all the properties in the model are valid
114
+ # @return true if the model is valid
115
+ def valid?
116
+ warn '[DEPRECATED] the `valid?` method is obsolete'
117
+ return false if @chunks.nil?
118
+ return false if @group.nil?
119
+ return false if @total_pages.nil?
120
+ return false if @total_pages < 0
121
+ true
122
+ end
123
+
124
+ # Custom attribute writer method with validation
125
+ # @param [Object] total_pages Value to be assigned
126
+ def total_pages=(total_pages)
127
+ if total_pages.nil?
128
+ fail ArgumentError, 'total_pages cannot be nil'
129
+ end
130
+
131
+ if total_pages < 0
132
+ fail ArgumentError, 'invalid value for "total_pages", must be greater than or equal to 0.'
133
+ end
134
+
135
+ @total_pages = total_pages
136
+ end
137
+
138
+ # Checks equality by comparing each attribute.
139
+ # @param [Object] Object to be compared
140
+ def ==(o)
141
+ return true if self.equal?(o)
142
+ self.class == o.class &&
143
+ chunks == o.chunks &&
144
+ group == o.group &&
145
+ total_pages == o.total_pages
146
+ end
147
+
148
+ # @see the `==` method
149
+ # @param [Object] Object to be compared
150
+ def eql?(o)
151
+ self == o
152
+ end
153
+
154
+ # Calculates hash code according to all attributes.
155
+ # @return [Integer] Hash code
156
+ def hash
157
+ [chunks, group, total_pages].hash
158
+ end
159
+
160
+ # Builds the object from hash
161
+ # @param [Hash] attributes Model attributes in the form of hash
162
+ # @return [Object] Returns the model itself
163
+ def self.build_from_hash(attributes)
164
+ return nil unless attributes.is_a?(Hash)
165
+ attributes = attributes.transform_keys(&:to_sym)
166
+ transformed_hash = {}
167
+ openapi_types.each_pair do |key, type|
168
+ if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
169
+ transformed_hash["#{key}"] = nil
170
+ elsif type =~ /\AArray<(.*)>/i
171
+ # check to ensure the input is an array given that the attribute
172
+ # is documented as an array but the input is not
173
+ if attributes[attribute_map[key]].is_a?(Array)
174
+ transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
175
+ end
176
+ elsif !attributes[attribute_map[key]].nil?
177
+ transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
178
+ end
179
+ end
180
+ new(transformed_hash)
181
+ end
182
+
183
+ # Deserializes the data based on type
184
+ # @param string type Data type
185
+ # @param string value Value to be deserialized
186
+ # @return [Object] Deserialized data
187
+ def self._deserialize(type, value)
188
+ case type.to_sym
189
+ when :Time
190
+ Time.parse(value)
191
+ when :Date
192
+ Date.parse(value)
193
+ when :String
194
+ value.to_s
195
+ when :Integer
196
+ value.to_i
197
+ when :Float
198
+ value.to_f
199
+ when :Boolean
200
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
201
+ true
202
+ else
203
+ false
204
+ end
205
+ when :Object
206
+ # generic object (usually a Hash), return directly
207
+ value
208
+ when /\AArray<(?<inner_type>.+)>\z/
209
+ inner_type = Regexp.last_match[:inner_type]
210
+ value.map { |v| _deserialize(inner_type, v) }
211
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
212
+ k_type = Regexp.last_match[:k_type]
213
+ v_type = Regexp.last_match[:v_type]
214
+ {}.tap do |hash|
215
+ value.each do |k, v|
216
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
217
+ end
218
+ end
219
+ else # model
220
+ # models (e.g. Pet) or oneOf
221
+ klass = TrieveRubyClient.const_get(type)
222
+ klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
223
+ end
224
+ end
225
+
226
+ # Returns the string representation of the object
227
+ # @return [String] String presentation of the object
228
+ def to_s
229
+ to_hash.to_s
230
+ end
231
+
232
+ # to_body is an alias to to_hash (backward compatibility)
233
+ # @return [Hash] Returns the object in the form of hash
234
+ def to_body
235
+ to_hash
236
+ end
237
+
238
+ # Returns the object in the form of hash
239
+ # @return [Hash] Returns the object in the form of hash
240
+ def to_hash
241
+ hash = {}
242
+ self.class.attribute_map.each_pair do |attr, param|
243
+ value = self.send(attr)
244
+ if value.nil?
245
+ is_nullable = self.class.openapi_nullable.include?(attr)
246
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
247
+ end
248
+
249
+ hash[param] = _to_hash(value)
250
+ end
251
+ hash
252
+ end
253
+
254
+ # Outputs non-array value in the form of hash
255
+ # For object, use to_hash. Otherwise, just return the value
256
+ # @param [Object] value Any valid value
257
+ # @return [Hash] Returns the value in the form of hash
258
+ def _to_hash(value)
259
+ if value.is_a?(Array)
260
+ value.compact.map { |v| _to_hash(v) }
261
+ elsif value.is_a?(Hash)
262
+ {}.tap do |hash|
263
+ value.each { |k, v| hash[k] = _to_hash(v) }
264
+ end
265
+ elsif value.respond_to? :to_hash
266
+ value.to_hash
267
+ else
268
+ value
269
+ end
270
+ end
271
+
272
+ end
273
+
274
+ end
@@ -0,0 +1,229 @@
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.11.0
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 HasIDCondition
18
+ attr_accessor :ids
19
+
20
+ attr_accessor :tracking_ids
21
+
22
+ # Attribute mapping from ruby-style variable name to JSON key.
23
+ def self.attribute_map
24
+ {
25
+ :'ids' => :'ids',
26
+ :'tracking_ids' => :'tracking_ids'
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
+ :'ids' => :'Array<String>',
39
+ :'tracking_ids' => :'Array<String>'
40
+ }
41
+ end
42
+
43
+ # List of attributes with nullable: true
44
+ def self.openapi_nullable
45
+ Set.new([
46
+ :'ids',
47
+ :'tracking_ids'
48
+ ])
49
+ end
50
+
51
+ # Initializes the object
52
+ # @param [Hash] attributes Model attributes in the form of hash
53
+ def initialize(attributes = {})
54
+ if (!attributes.is_a?(Hash))
55
+ fail ArgumentError, "The input argument (attributes) must be a hash in `TrieveRubyClient::HasIDCondition` initialize method"
56
+ end
57
+
58
+ # check to see if the attribute exists and convert string to symbol for hash key
59
+ attributes = attributes.each_with_object({}) { |(k, v), h|
60
+ if (!self.class.attribute_map.key?(k.to_sym))
61
+ fail ArgumentError, "`#{k}` is not a valid attribute in `TrieveRubyClient::HasIDCondition`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
62
+ end
63
+ h[k.to_sym] = v
64
+ }
65
+
66
+ if attributes.key?(:'ids')
67
+ if (value = attributes[:'ids']).is_a?(Array)
68
+ self.ids = value
69
+ end
70
+ end
71
+
72
+ if attributes.key?(:'tracking_ids')
73
+ if (value = attributes[:'tracking_ids']).is_a?(Array)
74
+ self.tracking_ids = value
75
+ end
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
+ invalid_properties
85
+ end
86
+
87
+ # Check to see if the all the properties in the model are valid
88
+ # @return true if the model is valid
89
+ def valid?
90
+ warn '[DEPRECATED] the `valid?` method is obsolete'
91
+ true
92
+ end
93
+
94
+ # Checks equality by comparing each attribute.
95
+ # @param [Object] Object to be compared
96
+ def ==(o)
97
+ return true if self.equal?(o)
98
+ self.class == o.class &&
99
+ ids == o.ids &&
100
+ tracking_ids == o.tracking_ids
101
+ end
102
+
103
+ # @see the `==` method
104
+ # @param [Object] Object to be compared
105
+ def eql?(o)
106
+ self == o
107
+ end
108
+
109
+ # Calculates hash code according to all attributes.
110
+ # @return [Integer] Hash code
111
+ def hash
112
+ [ids, tracking_ids].hash
113
+ end
114
+
115
+ # Builds the object from hash
116
+ # @param [Hash] attributes Model attributes in the form of hash
117
+ # @return [Object] Returns the model itself
118
+ def self.build_from_hash(attributes)
119
+ return nil unless attributes.is_a?(Hash)
120
+ attributes = attributes.transform_keys(&:to_sym)
121
+ transformed_hash = {}
122
+ openapi_types.each_pair do |key, type|
123
+ if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
124
+ transformed_hash["#{key}"] = nil
125
+ elsif type =~ /\AArray<(.*)>/i
126
+ # check to ensure the input is an array given that the attribute
127
+ # is documented as an array but the input is not
128
+ if attributes[attribute_map[key]].is_a?(Array)
129
+ transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
130
+ end
131
+ elsif !attributes[attribute_map[key]].nil?
132
+ transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
133
+ end
134
+ end
135
+ new(transformed_hash)
136
+ end
137
+
138
+ # Deserializes the data based on type
139
+ # @param string type Data type
140
+ # @param string value Value to be deserialized
141
+ # @return [Object] Deserialized data
142
+ def self._deserialize(type, value)
143
+ case type.to_sym
144
+ when :Time
145
+ Time.parse(value)
146
+ when :Date
147
+ Date.parse(value)
148
+ when :String
149
+ value.to_s
150
+ when :Integer
151
+ value.to_i
152
+ when :Float
153
+ value.to_f
154
+ when :Boolean
155
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
156
+ true
157
+ else
158
+ false
159
+ end
160
+ when :Object
161
+ # generic object (usually a Hash), return directly
162
+ value
163
+ when /\AArray<(?<inner_type>.+)>\z/
164
+ inner_type = Regexp.last_match[:inner_type]
165
+ value.map { |v| _deserialize(inner_type, v) }
166
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
167
+ k_type = Regexp.last_match[:k_type]
168
+ v_type = Regexp.last_match[:v_type]
169
+ {}.tap do |hash|
170
+ value.each do |k, v|
171
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
172
+ end
173
+ end
174
+ else # model
175
+ # models (e.g. Pet) or oneOf
176
+ klass = TrieveRubyClient.const_get(type)
177
+ klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
178
+ end
179
+ end
180
+
181
+ # Returns the string representation of the object
182
+ # @return [String] String presentation of the object
183
+ def to_s
184
+ to_hash.to_s
185
+ end
186
+
187
+ # to_body is an alias to to_hash (backward compatibility)
188
+ # @return [Hash] Returns the object in the form of hash
189
+ def to_body
190
+ to_hash
191
+ end
192
+
193
+ # Returns the object in the form of hash
194
+ # @return [Hash] Returns the object in the form of hash
195
+ def to_hash
196
+ hash = {}
197
+ self.class.attribute_map.each_pair do |attr, param|
198
+ value = self.send(attr)
199
+ if value.nil?
200
+ is_nullable = self.class.openapi_nullable.include?(attr)
201
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
202
+ end
203
+
204
+ hash[param] = _to_hash(value)
205
+ end
206
+ hash
207
+ end
208
+
209
+ # Outputs non-array value in the form of hash
210
+ # For object, use to_hash. Otherwise, just return the value
211
+ # @param [Object] value Any valid value
212
+ # @return [Hash] Returns the value in the form of hash
213
+ def _to_hash(value)
214
+ if value.is_a?(Array)
215
+ value.compact.map { |v| _to_hash(v) }
216
+ elsif value.is_a?(Hash)
217
+ {}.tap do |hash|
218
+ value.each { |k, v| hash[k] = _to_hash(v) }
219
+ end
220
+ elsif value.respond_to? :to_hash
221
+ value.to_hash
222
+ else
223
+ value
224
+ end
225
+ end
226
+
227
+ end
228
+
229
+ end