trieve_ruby_client 0.10.7 → 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 (424) hide show
  1. checksums.yaml +4 -4
  2. data/GENERATE_COMMAND.txt +2 -0
  3. data/README.md +119 -16
  4. data/docs/APIVersion.md +15 -0
  5. data/docs/AnalyticsApi.md +303 -0
  6. data/docs/AuthApi.md +4 -4
  7. data/docs/AutocompleteReqPayload.md +6 -2
  8. data/docs/BookmarkGroupResponse.md +49 -0
  9. data/docs/BookmarkGroupResult.md +1 -1
  10. data/docs/ChatMessageProxy.md +1 -1
  11. data/docs/ChunkApi.md +165 -63
  12. data/docs/ChunkFilter.md +2 -0
  13. data/docs/ChunkGroupAndFileId.md +36 -0
  14. data/docs/ChunkGroupApi.md +110 -90
  15. data/docs/ChunkMetadata.md +1 -1
  16. data/docs/ChunkMetadataStringTagSet.md +1 -1
  17. data/docs/ChunkMetadataWithScore.md +1 -1
  18. data/docs/ChunkReqPayload.md +2 -2
  19. data/docs/ChunkReturnTypes.md +49 -0
  20. data/docs/ClusterAnalytics.md +63 -0
  21. data/docs/ClusterAnalyticsFilter.md +18 -0
  22. data/docs/ClusterAnalyticsResponse.md +49 -0
  23. data/docs/ClusterQueries.md +22 -0
  24. data/docs/ClusterTopics.md +20 -0
  25. data/docs/ContentChunkMetadata.md +1 -1
  26. data/docs/CountChunkQueryResponseBody.md +18 -0
  27. data/docs/CountChunksReqPayload.md +26 -0
  28. data/docs/CountQueries.md +20 -0
  29. data/docs/CreateMessageReqPayload.md +11 -1
  30. data/docs/CreateSetupCheckoutSessionResPayload.md +18 -0
  31. data/docs/Dataset.md +0 -2
  32. data/docs/DatasetAnalytics.md +28 -0
  33. data/docs/DatasetApi.md +8 -80
  34. data/docs/DatasetDTO.md +0 -2
  35. data/docs/DeprecatedSearchOverGroupsResponseBody.md +20 -0
  36. data/docs/DistancePhrase.md +20 -0
  37. data/docs/EditMessageReqPayload.md +11 -1
  38. data/docs/Event.md +3 -5
  39. data/docs/EventTypeRequest.md +15 -0
  40. data/docs/EventsApi.md +1 -1
  41. data/docs/FileApi.md +4 -4
  42. data/docs/GenerateChunksRequest.md +11 -1
  43. data/docs/GeoInfoWithBias.md +20 -0
  44. data/docs/GetChunksForGroupsResponse.md +22 -0
  45. data/docs/GetEventsData.md +1 -1
  46. data/docs/Granularity.md +15 -0
  47. data/docs/GroupData.md +1 -1
  48. data/docs/GroupScoreChunk.md +14 -0
  49. data/docs/GroupsBookmarkQueryResult.md +22 -0
  50. data/docs/HeadQueries.md +20 -0
  51. data/docs/HeadQueries1.md +22 -0
  52. data/docs/HeadQueryResponse.md +18 -0
  53. data/docs/HealthApi.md +1 -1
  54. data/docs/InvitationApi.md +1 -1
  55. data/docs/LatencyGraph.md +22 -0
  56. data/docs/LatencyGraphResponse.md +18 -0
  57. data/docs/LowConfidenceQueries.md +24 -0
  58. data/docs/LowConfidenceRecommendations.md +24 -0
  59. data/docs/MessageApi.md +4 -4
  60. data/docs/MetricsApi.md +76 -0
  61. data/docs/NewChunkMetadataTypes.md +51 -0
  62. data/docs/NoResultQueries.md +22 -0
  63. data/docs/OrganizationApi.md +6 -6
  64. data/docs/QueryCountResponse.md +18 -0
  65. data/docs/QueryDetails.md +20 -0
  66. data/docs/RAGAnalytics.md +63 -0
  67. data/docs/RAGAnalyticsFilter.md +20 -0
  68. data/docs/RAGAnalyticsResponse.md +49 -0
  69. data/docs/RAGQueries.md +26 -0
  70. data/docs/RAGUsage.md +20 -0
  71. data/docs/RAGUsageResponse.md +18 -0
  72. data/docs/RPSGraph.md +22 -0
  73. data/docs/RPSGraphResponse.md +18 -0
  74. data/docs/RagQueryEvent.md +30 -0
  75. data/docs/RagQueryResponse.md +18 -0
  76. data/docs/RagTypes.md +15 -0
  77. data/docs/RecommendChunksRequest.md +2 -2
  78. data/docs/RecommendChunksResponseBody.md +18 -0
  79. data/docs/RecommendGroupChunksRequest.md +2 -2
  80. data/docs/RecommendGroupsResponse.md +49 -0
  81. data/docs/RecommendGroupsResponseBody.md +18 -0
  82. data/docs/RecommendResponseTypes.md +49 -0
  83. data/docs/RecommendType.md +15 -0
  84. data/docs/RecommendationAnalytics.md +63 -0
  85. data/docs/RecommendationAnalyticsFilter.md +20 -0
  86. data/docs/RecommendationAnalyticsResponse.md +47 -0
  87. data/docs/RecommendationEvent.md +38 -0
  88. data/docs/RecommendationQueries.md +26 -0
  89. data/docs/RecommendationStrategy.md +15 -0
  90. data/docs/RecommendationType.md +15 -0
  91. data/docs/RecommendationsEventResponse.md +18 -0
  92. data/docs/RegenerateMessageReqPayload.md +9 -1
  93. data/docs/RoleProxy.md +15 -0
  94. data/docs/ScoreChunk.md +22 -0
  95. data/docs/SearchAnalytics.md +77 -0
  96. data/docs/SearchAnalyticsFilter.md +22 -0
  97. data/docs/SearchAnalyticsResponse.md +59 -0
  98. data/docs/SearchChunksReqPayload.md +6 -4
  99. data/docs/SearchClusterResponse.md +18 -0
  100. data/docs/SearchClusterTopics.md +28 -0
  101. data/docs/SearchGroupResponseTypes.md +49 -0
  102. data/docs/SearchLatencyGraph.md +20 -0
  103. data/docs/SearchMethod.md +15 -0
  104. data/docs/SearchMetrics.md +20 -0
  105. data/docs/SearchOverGroupsData.md +2 -4
  106. data/docs/SearchOverGroupsResponseBody.md +4 -4
  107. data/docs/SearchOverGroupsResponseTypes.md +4 -4
  108. data/docs/SearchOverGroupsResults.md +6 -4
  109. data/docs/SearchQueries.md +26 -0
  110. data/docs/SearchQueryEvent.md +34 -0
  111. data/docs/SearchQueryResponse.md +18 -0
  112. data/docs/SearchRPSGraph.md +20 -0
  113. data/docs/SearchResponseBody.md +20 -0
  114. data/docs/SearchResponseTypes.md +49 -0
  115. data/docs/SearchResultType.md +49 -0
  116. data/docs/SearchType.md +15 -0
  117. data/docs/SearchTypeCount.md +22 -0
  118. data/docs/SearchWithinGroupData.md +6 -2
  119. data/docs/SearchWithinGroupResponseBody.md +20 -0
  120. data/docs/SearchWithinGroupResults.md +1 -1
  121. data/docs/SlimChunkMetadata.md +1 -1
  122. data/docs/SlimChunkMetadataWithArrayTagSet.md +44 -0
  123. data/docs/SlimChunkMetadataWithScore.md +1 -1
  124. data/docs/SortBy.md +15 -0
  125. data/docs/SortOrder.md +15 -0
  126. data/docs/StripeApi.md +134 -4
  127. data/docs/StripeInvoice.md +28 -0
  128. data/docs/TopicApi.md +4 -4
  129. data/docs/UpdateChunkGroupData.md +3 -1
  130. data/docs/UpdateChunkReqPayload.md +2 -0
  131. data/docs/UserApi.md +3 -3
  132. data/lib/trieve_ruby_client/api/analytics_api.rb +322 -0
  133. data/lib/trieve_ruby_client/api/auth_api.rb +9 -9
  134. data/lib/trieve_ruby_client/api/chunk_api.rb +148 -52
  135. data/lib/trieve_ruby_client/api/chunk_group_api.rb +122 -107
  136. data/lib/trieve_ruby_client/api/dataset_api.rb +17 -81
  137. data/lib/trieve_ruby_client/api/events_api.rb +3 -3
  138. data/lib/trieve_ruby_client/api/file_api.rb +9 -9
  139. data/lib/trieve_ruby_client/api/health_api.rb +3 -3
  140. data/lib/trieve_ruby_client/api/invitation_api.rb +3 -3
  141. data/lib/trieve_ruby_client/api/message_api.rb +9 -9
  142. data/lib/trieve_ruby_client/api/metrics_api.rb +79 -0
  143. data/lib/trieve_ruby_client/api/organization_api.rb +13 -13
  144. data/lib/trieve_ruby_client/api/stripe_api.rb +135 -9
  145. data/lib/trieve_ruby_client/api/topic_api.rb +9 -9
  146. data/lib/trieve_ruby_client/api/user_api.rb +7 -7
  147. data/lib/trieve_ruby_client/api_client.rb +1 -1
  148. data/lib/trieve_ruby_client/api_error.rb +1 -1
  149. data/lib/trieve_ruby_client/configuration.rb +8 -1
  150. data/lib/trieve_ruby_client/models/add_chunk_to_group_data.rb +1 -1
  151. data/lib/trieve_ruby_client/models/api_key_resp_body.rb +1 -1
  152. data/lib/trieve_ruby_client/models/api_version.rb +40 -0
  153. data/lib/trieve_ruby_client/models/auth_query.rb +1 -1
  154. data/lib/trieve_ruby_client/models/autocomplete_req_payload.rb +47 -5
  155. data/lib/trieve_ruby_client/models/batch_queued_chunk_response.rb +1 -1
  156. data/lib/trieve_ruby_client/models/bookmark_group_response.rb +105 -0
  157. data/lib/trieve_ruby_client/models/bookmark_group_result.rb +2 -2
  158. data/lib/trieve_ruby_client/models/boost_phrase.rb +1 -1
  159. data/lib/trieve_ruby_client/models/chat_message_proxy.rb +24 -2
  160. data/lib/trieve_ruby_client/models/chunk_filter.rb +13 -2
  161. data/lib/trieve_ruby_client/models/chunk_group.rb +1 -1
  162. data/lib/trieve_ruby_client/models/chunk_group_and_file_id.rb +343 -0
  163. data/lib/trieve_ruby_client/models/chunk_metadata.rb +8 -2
  164. data/lib/trieve_ruby_client/models/chunk_metadata_string_tag_set.rb +8 -2
  165. data/lib/trieve_ruby_client/models/chunk_metadata_types.rb +1 -1
  166. data/lib/trieve_ruby_client/models/chunk_metadata_with_score.rb +8 -2
  167. data/lib/trieve_ruby_client/models/chunk_req_payload.rb +12 -15
  168. data/lib/trieve_ruby_client/models/chunk_return_types.rb +105 -0
  169. data/lib/trieve_ruby_client/models/cluster_analytics.rb +43 -0
  170. data/lib/trieve_ruby_client/models/cluster_analytics_filter.rb +215 -0
  171. data/lib/trieve_ruby_client/models/cluster_analytics_response.rb +105 -0
  172. data/lib/trieve_ruby_client/models/cluster_queries.rb +296 -0
  173. data/lib/trieve_ruby_client/models/cluster_topics.rb +265 -0
  174. data/lib/trieve_ruby_client/models/condition_type.rb +1 -1
  175. data/lib/trieve_ruby_client/models/content_chunk_metadata.rb +8 -2
  176. data/lib/trieve_ruby_client/models/count_chunk_query_response_body.rb +240 -0
  177. data/lib/trieve_ruby_client/models/count_chunks_req_payload.rb +307 -0
  178. data/lib/trieve_ruby_client/models/count_queries.rb +265 -0
  179. data/lib/trieve_ruby_client/models/create_chunk_group_req_payload.rb +1 -1
  180. data/lib/trieve_ruby_client/models/create_chunk_req_payload_enum.rb +1 -1
  181. data/lib/trieve_ruby_client/models/create_dataset_request.rb +1 -1
  182. data/lib/trieve_ruby_client/models/create_message_req_payload.rb +95 -4
  183. data/lib/trieve_ruby_client/models/create_organization_data.rb +1 -1
  184. data/lib/trieve_ruby_client/models/create_setup_checkout_session_res_payload.rb +221 -0
  185. data/lib/trieve_ruby_client/models/create_topic_req_payload.rb +1 -1
  186. data/lib/trieve_ruby_client/models/dataset.rb +2 -14
  187. data/lib/trieve_ruby_client/models/dataset_analytics.rb +301 -0
  188. data/lib/trieve_ruby_client/models/dataset_and_usage.rb +1 -1
  189. data/lib/trieve_ruby_client/models/dataset_dto.rb +2 -14
  190. data/lib/trieve_ruby_client/models/dataset_usage_count.rb +1 -1
  191. data/lib/trieve_ruby_client/models/date_range.rb +1 -1
  192. data/lib/trieve_ruby_client/models/delete_topic_data.rb +1 -1
  193. data/lib/trieve_ruby_client/models/delete_user_api_key_request.rb +1 -1
  194. data/lib/trieve_ruby_client/models/deprecated_search_over_groups_response_body.rb +239 -0
  195. data/lib/trieve_ruby_client/models/distance_phrase.rb +240 -0
  196. data/lib/trieve_ruby_client/models/edit_message_req_payload.rb +95 -4
  197. data/lib/trieve_ruby_client/models/error_response_body.rb +1 -1
  198. data/lib/trieve_ruby_client/models/event.rb +12 -24
  199. data/lib/trieve_ruby_client/models/event_return.rb +1 -1
  200. data/lib/trieve_ruby_client/models/event_type_request.rb +49 -0
  201. data/lib/trieve_ruby_client/models/field_condition.rb +1 -1
  202. data/lib/trieve_ruby_client/models/file.rb +1 -1
  203. data/lib/trieve_ruby_client/models/file_dto.rb +1 -1
  204. data/lib/trieve_ruby_client/models/generate_chunks_request.rb +78 -6
  205. data/lib/trieve_ruby_client/models/geo_info.rb +1 -1
  206. data/lib/trieve_ruby_client/models/geo_info_with_bias.rb +237 -0
  207. data/lib/trieve_ruby_client/models/geo_types.rb +1 -1
  208. data/lib/trieve_ruby_client/models/get_chunks_data.rb +1 -1
  209. data/lib/trieve_ruby_client/models/get_chunks_for_groups_response.rb +274 -0
  210. data/lib/trieve_ruby_client/models/get_datasets_pagination.rb +1 -1
  211. data/lib/trieve_ruby_client/models/get_events_data.rb +2 -2
  212. data/lib/trieve_ruby_client/models/get_groups_for_chunks_data.rb +1 -1
  213. data/lib/trieve_ruby_client/models/get_tracking_chunks_data.rb +1 -1
  214. data/lib/trieve_ruby_client/models/granularity.rb +42 -0
  215. data/lib/trieve_ruby_client/models/group_data.rb +2 -2
  216. data/lib/trieve_ruby_client/models/group_score_chunk.rb +92 -2
  217. data/lib/trieve_ruby_client/models/groups_bookmark_query_result.rb +274 -0
  218. data/lib/trieve_ruby_client/models/has_id_condition.rb +1 -1
  219. data/lib/trieve_ruby_client/models/head_queries.rb +237 -0
  220. data/lib/trieve_ruby_client/models/head_queries1.rb +290 -0
  221. data/lib/trieve_ruby_client/models/head_query_response.rb +223 -0
  222. data/lib/trieve_ruby_client/models/invitation_data.rb +1 -1
  223. data/lib/trieve_ruby_client/models/latency_graph.rb +275 -0
  224. data/lib/trieve_ruby_client/models/latency_graph_response.rb +223 -0
  225. data/lib/trieve_ruby_client/models/location_bounding_box.rb +1 -1
  226. data/lib/trieve_ruby_client/models/location_polygon.rb +1 -1
  227. data/lib/trieve_ruby_client/models/location_radius.rb +1 -1
  228. data/lib/trieve_ruby_client/models/low_confidence_queries.rb +300 -0
  229. data/lib/trieve_ruby_client/models/low_confidence_recommendations.rb +300 -0
  230. data/lib/trieve_ruby_client/models/match_condition.rb +1 -1
  231. data/lib/trieve_ruby_client/models/message.rb +1 -1
  232. data/lib/trieve_ruby_client/models/new_chunk_metadata_types.rb +106 -0
  233. data/lib/trieve_ruby_client/models/no_result_queries.rb +290 -0
  234. data/lib/trieve_ruby_client/models/organization.rb +1 -1
  235. data/lib/trieve_ruby_client/models/organization_usage_count.rb +1 -1
  236. data/lib/trieve_ruby_client/models/query_count_response.rb +223 -0
  237. data/lib/trieve_ruby_client/models/query_details.rb +271 -0
  238. data/lib/trieve_ruby_client/models/rag_analytics.rb +43 -0
  239. data/lib/trieve_ruby_client/models/rag_analytics_filter.rb +247 -0
  240. data/lib/trieve_ruby_client/models/rag_analytics_response.rb +105 -0
  241. data/lib/trieve_ruby_client/models/rag_queries.rb +310 -0
  242. data/lib/trieve_ruby_client/models/rag_query_event.rb +319 -0
  243. data/lib/trieve_ruby_client/models/rag_query_response.rb +223 -0
  244. data/lib/trieve_ruby_client/models/rag_types.rb +40 -0
  245. data/lib/trieve_ruby_client/models/rag_usage.rb +265 -0
  246. data/lib/trieve_ruby_client/models/rag_usage_response.rb +240 -0
  247. data/lib/trieve_ruby_client/models/range.rb +1 -1
  248. data/lib/trieve_ruby_client/models/range_condition.rb +1 -1
  249. data/lib/trieve_ruby_client/models/recommend_chunks_request.rb +25 -5
  250. data/lib/trieve_ruby_client/models/recommend_chunks_response_body.rb +223 -0
  251. data/lib/trieve_ruby_client/models/recommend_group_chunks_request.rb +25 -5
  252. data/lib/trieve_ruby_client/models/recommend_groups_response.rb +105 -0
  253. data/lib/trieve_ruby_client/models/recommend_groups_response_body.rb +223 -0
  254. data/lib/trieve_ruby_client/models/recommend_response_types.rb +105 -0
  255. data/lib/trieve_ruby_client/models/recommend_type.rb +40 -0
  256. data/lib/trieve_ruby_client/models/recommendation_analytics.rb +43 -0
  257. data/lib/trieve_ruby_client/models/recommendation_analytics_filter.rb +247 -0
  258. data/lib/trieve_ruby_client/models/recommendation_analytics_response.rb +104 -0
  259. data/lib/trieve_ruby_client/models/recommendation_event.rb +391 -0
  260. data/lib/trieve_ruby_client/models/recommendation_queries.rb +310 -0
  261. data/lib/trieve_ruby_client/models/recommendation_strategy.rb +40 -0
  262. data/lib/trieve_ruby_client/models/recommendation_type.rb +40 -0
  263. data/lib/trieve_ruby_client/models/recommendations_event_response.rb +223 -0
  264. data/lib/trieve_ruby_client/models/regenerate_message_req_payload.rb +84 -4
  265. data/lib/trieve_ruby_client/models/remove_chunk_from_group_req_payload.rb +1 -1
  266. data/lib/trieve_ruby_client/models/return_queued_chunk.rb +1 -1
  267. data/lib/trieve_ruby_client/models/role_proxy.rb +41 -0
  268. data/lib/trieve_ruby_client/models/rps_graph.rb +275 -0
  269. data/lib/trieve_ruby_client/models/rps_graph_response.rb +223 -0
  270. data/lib/trieve_ruby_client/models/score_chunk.rb +249 -0
  271. data/lib/trieve_ruby_client/models/score_chunk_dto.rb +1 -1
  272. data/lib/trieve_ruby_client/models/search_analytics.rb +50 -0
  273. data/lib/trieve_ruby_client/models/search_analytics_filter.rb +257 -0
  274. data/lib/trieve_ruby_client/models/search_analytics_response.rb +110 -0
  275. data/lib/trieve_ruby_client/models/search_chunk_query_response_body.rb +1 -1
  276. data/lib/trieve_ruby_client/models/search_chunks_req_payload.rb +47 -16
  277. data/lib/trieve_ruby_client/models/search_cluster_response.rb +223 -0
  278. data/lib/trieve_ruby_client/models/search_cluster_topics.rb +301 -0
  279. data/lib/trieve_ruby_client/models/search_group_response_types.rb +105 -0
  280. data/lib/trieve_ruby_client/models/search_latency_graph.rb +237 -0
  281. data/lib/trieve_ruby_client/models/search_method.rb +42 -0
  282. data/lib/trieve_ruby_client/models/search_metrics.rb +265 -0
  283. data/lib/trieve_ruby_client/models/search_over_groups_data.rb +26 -16
  284. data/lib/trieve_ruby_client/models/search_over_groups_response_body.rb +23 -23
  285. data/lib/trieve_ruby_client/models/search_over_groups_response_types.rb +3 -3
  286. data/lib/trieve_ruby_client/models/search_over_groups_results.rb +33 -23
  287. data/lib/trieve_ruby_client/models/search_queries.rb +310 -0
  288. data/lib/trieve_ruby_client/models/search_query_event.rb +351 -0
  289. data/lib/trieve_ruby_client/models/search_query_response.rb +223 -0
  290. data/lib/trieve_ruby_client/models/search_response_body.rb +239 -0
  291. data/lib/trieve_ruby_client/models/search_response_types.rb +105 -0
  292. data/lib/trieve_ruby_client/models/search_result_type.rb +105 -0
  293. data/lib/trieve_ruby_client/models/search_rps_graph.rb +237 -0
  294. data/lib/trieve_ruby_client/models/search_type.rb +42 -0
  295. data/lib/trieve_ruby_client/models/search_type_count.rb +253 -0
  296. data/lib/trieve_ruby_client/models/search_within_group_data.rb +47 -5
  297. data/lib/trieve_ruby_client/models/search_within_group_response_body.rb +239 -0
  298. data/lib/trieve_ruby_client/models/search_within_group_results.rb +2 -2
  299. data/lib/trieve_ruby_client/models/set_user_api_key_request.rb +1 -1
  300. data/lib/trieve_ruby_client/models/set_user_api_key_response.rb +1 -1
  301. data/lib/trieve_ruby_client/models/single_queued_chunk_response.rb +1 -1
  302. data/lib/trieve_ruby_client/models/slim_chunk_metadata.rb +8 -2
  303. data/lib/trieve_ruby_client/models/slim_chunk_metadata_with_array_tag_set.rb +385 -0
  304. data/lib/trieve_ruby_client/models/slim_chunk_metadata_with_score.rb +8 -2
  305. data/lib/trieve_ruby_client/models/slim_user.rb +1 -1
  306. data/lib/trieve_ruby_client/models/sort_by.rb +41 -0
  307. data/lib/trieve_ruby_client/models/sort_order.rb +40 -0
  308. data/lib/trieve_ruby_client/models/stripe_invoice.rb +301 -0
  309. data/lib/trieve_ruby_client/models/stripe_plan.rb +1 -1
  310. data/lib/trieve_ruby_client/models/suggested_queries_req_payload.rb +1 -1
  311. data/lib/trieve_ruby_client/models/suggested_queries_response.rb +1 -1
  312. data/lib/trieve_ruby_client/models/topic.rb +1 -1
  313. data/lib/trieve_ruby_client/models/update_chunk_by_tracking_id_data.rb +1 -1
  314. data/lib/trieve_ruby_client/models/update_chunk_group_data.rb +17 -6
  315. data/lib/trieve_ruby_client/models/update_chunk_req_payload.rb +12 -2
  316. data/lib/trieve_ruby_client/models/update_dataset_request.rb +1 -1
  317. data/lib/trieve_ruby_client/models/update_group_by_tracking_id_req_payload.rb +1 -1
  318. data/lib/trieve_ruby_client/models/update_organization_data.rb +1 -1
  319. data/lib/trieve_ruby_client/models/update_topic_req_payload.rb +1 -1
  320. data/lib/trieve_ruby_client/models/update_user_org_role_data.rb +1 -1
  321. data/lib/trieve_ruby_client/models/upload_file_req_payload.rb +1 -1
  322. data/lib/trieve_ruby_client/models/upload_file_result.rb +1 -1
  323. data/lib/trieve_ruby_client/models/user_organization.rb +1 -1
  324. data/lib/trieve_ruby_client/version.rb +2 -2
  325. data/lib/trieve_ruby_client.rb +86 -5
  326. data/openapi-generator.yaml +2 -2
  327. data/openapi.json +11050 -1
  328. data/spec/api/analytics_api_spec.rb +87 -0
  329. data/spec/api/metrics_api_spec.rb +46 -0
  330. data/spec/models/api_version_spec.rb +30 -0
  331. data/spec/models/bookmark_group_response_spec.rb +32 -0
  332. data/spec/models/chunk_group_and_file_id_spec.rb +90 -0
  333. data/spec/models/chunk_return_types_spec.rb +32 -0
  334. data/spec/models/cluster_analytics_filter_spec.rb +36 -0
  335. data/spec/models/cluster_analytics_response_spec.rb +32 -0
  336. data/spec/models/cluster_analytics_spec.rb +38 -0
  337. data/spec/models/cluster_queries_spec.rb +52 -0
  338. data/spec/models/cluster_topics_spec.rb +46 -0
  339. data/spec/models/count_chunk_query_response_body_spec.rb +36 -0
  340. data/spec/models/count_chunks_req_payload_spec.rb +60 -0
  341. data/spec/models/count_queries_spec.rb +46 -0
  342. data/spec/models/create_setup_checkout_session_res_payload_spec.rb +36 -0
  343. data/spec/models/dataset_analytics_spec.rb +66 -0
  344. data/spec/models/deprecated_search_over_groups_response_body_spec.rb +42 -0
  345. data/spec/models/distance_phrase_spec.rb +42 -0
  346. data/spec/models/event_type_request_spec.rb +30 -0
  347. data/spec/models/geo_info_with_bias_spec.rb +42 -0
  348. data/spec/models/get_chunks_for_groups_response_spec.rb +48 -0
  349. data/spec/models/granularity_spec.rb +30 -0
  350. data/spec/models/groups_bookmark_query_result_spec.rb +48 -0
  351. data/spec/models/head_queries1_spec.rb +52 -0
  352. data/spec/models/head_queries_spec.rb +42 -0
  353. data/spec/models/head_query_response_spec.rb +36 -0
  354. data/spec/models/latency_graph_response_spec.rb +36 -0
  355. data/spec/models/latency_graph_spec.rb +52 -0
  356. data/spec/models/low_confidence_queries_spec.rb +58 -0
  357. data/spec/models/low_confidence_recommendations_spec.rb +58 -0
  358. data/spec/models/new_chunk_metadata_types_spec.rb +32 -0
  359. data/spec/models/no_result_queries_spec.rb +52 -0
  360. data/spec/models/query_count_response_spec.rb +36 -0
  361. data/spec/models/query_details_spec.rb +46 -0
  362. data/spec/models/rag_analytics_filter_spec.rb +42 -0
  363. data/spec/models/rag_analytics_response_spec.rb +32 -0
  364. data/spec/models/rag_analytics_spec.rb +38 -0
  365. data/spec/models/rag_queries_spec.rb +64 -0
  366. data/spec/models/rag_query_event_spec.rb +72 -0
  367. data/spec/models/rag_query_response_spec.rb +36 -0
  368. data/spec/models/rag_types_spec.rb +30 -0
  369. data/spec/models/rag_usage_response_spec.rb +36 -0
  370. data/spec/models/rag_usage_spec.rb +46 -0
  371. data/spec/models/recommend_chunks_response_body_spec.rb +36 -0
  372. data/spec/models/recommend_groups_response_body_spec.rb +36 -0
  373. data/spec/models/recommend_groups_response_spec.rb +32 -0
  374. data/spec/models/recommend_response_types_spec.rb +32 -0
  375. data/spec/models/recommend_type_spec.rb +30 -0
  376. data/spec/models/recommendation_analytics_filter_spec.rb +42 -0
  377. data/spec/models/recommendation_analytics_response_spec.rb +32 -0
  378. data/spec/models/recommendation_analytics_spec.rb +38 -0
  379. data/spec/models/recommendation_event_spec.rb +96 -0
  380. data/spec/models/recommendation_queries_spec.rb +64 -0
  381. data/spec/models/recommendation_strategy_spec.rb +30 -0
  382. data/spec/models/recommendation_type_spec.rb +30 -0
  383. data/spec/models/recommendations_event_response_spec.rb +36 -0
  384. data/spec/models/role_proxy_spec.rb +30 -0
  385. data/spec/models/rps_graph_response_spec.rb +36 -0
  386. data/spec/models/rps_graph_spec.rb +52 -0
  387. data/spec/models/score_chunk_spec.rb +48 -0
  388. data/spec/models/search_analytics_filter_spec.rb +48 -0
  389. data/spec/models/search_analytics_response_spec.rb +32 -0
  390. data/spec/models/search_analytics_spec.rb +38 -0
  391. data/spec/models/search_cluster_response_spec.rb +36 -0
  392. data/spec/models/search_cluster_topics_spec.rb +66 -0
  393. data/spec/models/search_group_response_types_spec.rb +32 -0
  394. data/spec/models/search_latency_graph_spec.rb +42 -0
  395. data/spec/models/search_method_spec.rb +30 -0
  396. data/spec/models/search_metrics_spec.rb +46 -0
  397. data/spec/models/search_queries_spec.rb +64 -0
  398. data/spec/models/search_query_event_spec.rb +84 -0
  399. data/spec/models/search_query_response_spec.rb +36 -0
  400. data/spec/models/search_response_body_spec.rb +42 -0
  401. data/spec/models/search_response_types_spec.rb +32 -0
  402. data/spec/models/search_result_type_spec.rb +32 -0
  403. data/spec/models/search_rps_graph_spec.rb +42 -0
  404. data/spec/models/search_type_count_spec.rb +48 -0
  405. data/spec/models/search_type_spec.rb +30 -0
  406. data/spec/models/search_within_group_response_body_spec.rb +42 -0
  407. data/spec/models/slim_chunk_metadata_with_array_tag_set_spec.rb +114 -0
  408. data/spec/models/sort_by_spec.rb +30 -0
  409. data/spec/models/sort_order_spec.rb +30 -0
  410. data/spec/models/stripe_invoice_spec.rb +66 -0
  411. data/spec/spec_helper.rb +1 -1
  412. data/trieve_ruby_client.gemspec +1 -1
  413. metadata +456 -135
  414. data/trieve_ruby_client-0.5.0.gem +0 -0
  415. data/trieve_ruby_client-0.5.7.gem +0 -0
  416. data/trieve_ruby_client-0.6.0.gem +0 -0
  417. data/trieve_ruby_client-0.6.2.gem +0 -0
  418. data/trieve_ruby_client-0.6.7.gem +0 -0
  419. data/trieve_ruby_client-0.6.9.gem +0 -0
  420. data/trieve_ruby_client-0.7.2.gem +0 -0
  421. data/trieve_ruby_client-0.7.6.gem +0 -0
  422. data/trieve_ruby_client-0.8.0.gem +0 -0
  423. data/trieve_ruby_client-0.8.2.gem +0 -0
  424. data/trieve_ruby_client-0.8.5.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.10.7
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
@@ -20,22 +20,24 @@ module TrieveRubyClient
20
20
  @api_client = api_client
21
21
  end
22
22
  # Autocomplete
23
- # Autocomplete This route provides the primary autocomplete functionality for the API. This prioritize prefix matching with semantic or full-text search.
23
+ # This route provides the primary autocomplete functionality for the API. This prioritize prefix matching with semantic or full-text search.
24
24
  # @param tr_dataset [String] The dataset id to use for the request
25
25
  # @param autocomplete_req_payload [AutocompleteReqPayload] JSON request payload to semantically search for chunks (chunks)
26
26
  # @param [Hash] opts the optional parameters
27
- # @return [SearchChunkQueryResponseBody]
27
+ # @option opts [APIVersion] :x_api_version The API version to use for this request. Defaults to V2 for orgs created after July 12, 2024 and V1 otherwise.
28
+ # @return [SearchResponseTypes]
28
29
  def autocomplete(tr_dataset, autocomplete_req_payload, opts = {})
29
30
  data, _status_code, _headers = autocomplete_with_http_info(tr_dataset, autocomplete_req_payload, opts)
30
31
  data
31
32
  end
32
33
 
33
34
  # Autocomplete
34
- # Autocomplete This route provides the primary autocomplete functionality for the API. This prioritize prefix matching with semantic or full-text search.
35
+ # This route provides the primary autocomplete functionality for the API. This prioritize prefix matching with semantic or full-text search.
35
36
  # @param tr_dataset [String] The dataset id to use for the request
36
37
  # @param autocomplete_req_payload [AutocompleteReqPayload] JSON request payload to semantically search for chunks (chunks)
37
38
  # @param [Hash] opts the optional parameters
38
- # @return [Array<(SearchChunkQueryResponseBody, Integer, Hash)>] SearchChunkQueryResponseBody data, response status code and response headers
39
+ # @option opts [APIVersion] :x_api_version The API version to use for this request. Defaults to V2 for orgs created after July 12, 2024 and V1 otherwise.
40
+ # @return [Array<(SearchResponseTypes, Integer, Hash)>] SearchResponseTypes data, response status code and response headers
39
41
  def autocomplete_with_http_info(tr_dataset, autocomplete_req_payload, opts = {})
40
42
  if @api_client.config.debugging
41
43
  @api_client.config.logger.debug 'Calling API: ChunkApi.autocomplete ...'
@@ -64,6 +66,7 @@ module TrieveRubyClient
64
66
  header_params['Content-Type'] = content_type
65
67
  end
66
68
  header_params[:'TR-Dataset'] = tr_dataset
69
+ header_params[:'X-API-Version'] = opts[:'x_api_version'] if !opts[:'x_api_version'].nil?
67
70
 
68
71
  # form parameters
69
72
  form_params = opts[:form_params] || {}
@@ -72,7 +75,7 @@ module TrieveRubyClient
72
75
  post_body = opts[:debug_body] || @api_client.object_to_http_body(autocomplete_req_payload)
73
76
 
74
77
  # return_type
75
- return_type = opts[:debug_return_type] || 'SearchChunkQueryResponseBody'
78
+ return_type = opts[:debug_return_type] || 'SearchResponseTypes'
76
79
 
77
80
  # auth_names
78
81
  auth_names = opts[:debug_auth_names] || ['ApiKey']
@@ -94,8 +97,83 @@ module TrieveRubyClient
94
97
  return data, status_code, headers
95
98
  end
96
99
 
100
+ # Count chunks above threshold
101
+ # This route can be used to determine the number of chunks that match a given search criteria including filters and score threshold. It may be high latency for large datasets. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization. There is a dataset configuration imposed restriction on the maximum limit value (default 10,000) which is used to prevent DDOS attacks.
102
+ # @param tr_dataset [String] The dataset id to use for the request
103
+ # @param count_chunks_req_payload [CountChunksReqPayload]
104
+ # @param [Hash] opts the optional parameters
105
+ # @return [CountChunkQueryResponseBody]
106
+ def count_chunks(tr_dataset, count_chunks_req_payload, opts = {})
107
+ data, _status_code, _headers = count_chunks_with_http_info(tr_dataset, count_chunks_req_payload, opts)
108
+ data
109
+ end
110
+
111
+ # Count chunks above threshold
112
+ # This route can be used to determine the number of chunks that match a given search criteria including filters and score threshold. It may be high latency for large datasets. Auth&#39;ed user or api key must have an admin or owner role for the specified dataset&#39;s organization. There is a dataset configuration imposed restriction on the maximum limit value (default 10,000) which is used to prevent DDOS attacks.
113
+ # @param tr_dataset [String] The dataset id to use for the request
114
+ # @param count_chunks_req_payload [CountChunksReqPayload]
115
+ # @param [Hash] opts the optional parameters
116
+ # @return [Array<(CountChunkQueryResponseBody, Integer, Hash)>] CountChunkQueryResponseBody data, response status code and response headers
117
+ def count_chunks_with_http_info(tr_dataset, count_chunks_req_payload, opts = {})
118
+ if @api_client.config.debugging
119
+ @api_client.config.logger.debug 'Calling API: ChunkApi.count_chunks ...'
120
+ end
121
+ # verify the required parameter 'tr_dataset' is set
122
+ if @api_client.config.client_side_validation && tr_dataset.nil?
123
+ fail ArgumentError, "Missing the required parameter 'tr_dataset' when calling ChunkApi.count_chunks"
124
+ end
125
+ # verify the required parameter 'count_chunks_req_payload' is set
126
+ if @api_client.config.client_side_validation && count_chunks_req_payload.nil?
127
+ fail ArgumentError, "Missing the required parameter 'count_chunks_req_payload' when calling ChunkApi.count_chunks"
128
+ end
129
+ # resource path
130
+ local_var_path = '/api/chunk/count'
131
+
132
+ # query parameters
133
+ query_params = opts[:query_params] || {}
134
+
135
+ # header parameters
136
+ header_params = opts[:header_params] || {}
137
+ # HTTP header 'Accept' (if needed)
138
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
139
+ # HTTP header 'Content-Type'
140
+ content_type = @api_client.select_header_content_type(['application/json'])
141
+ if !content_type.nil?
142
+ header_params['Content-Type'] = content_type
143
+ end
144
+ header_params[:'TR-Dataset'] = tr_dataset
145
+
146
+ # form parameters
147
+ form_params = opts[:form_params] || {}
148
+
149
+ # http body (model)
150
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(count_chunks_req_payload)
151
+
152
+ # return_type
153
+ return_type = opts[:debug_return_type] || 'CountChunkQueryResponseBody'
154
+
155
+ # auth_names
156
+ auth_names = opts[:debug_auth_names] || ['ApiKey']
157
+
158
+ new_options = opts.merge(
159
+ :operation => :"ChunkApi.count_chunks",
160
+ :header_params => header_params,
161
+ :query_params => query_params,
162
+ :form_params => form_params,
163
+ :body => post_body,
164
+ :auth_names => auth_names,
165
+ :return_type => return_type
166
+ )
167
+
168
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
169
+ if @api_client.config.debugging
170
+ @api_client.config.logger.debug "API called: ChunkApi#count_chunks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
171
+ end
172
+ return data, status_code, headers
173
+ end
174
+
97
175
  # Create or Upsert Chunk or Chunks
98
- # Create or Upsert Chunk or Chunks Create a new chunk. If the chunk has the same tracking_id as an existing chunk, the request will fail. Once a chunk is created, it can be searched for using the search endpoint. If uploading in bulk, the maximum amount of chunks that can be uploaded at once is 120 chunks. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
176
+ # Create a new chunk. If the chunk has the same tracking_id as an existing chunk, the request will fail. Once a chunk is created, it can be searched for using the search endpoint. If uploading in bulk, the maximum amount of chunks that can be uploaded at once is 120 chunks. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
99
177
  # @param tr_dataset [String] The dataset id to use for the request
100
178
  # @param create_chunk_req_payload_enum [CreateChunkReqPayloadEnum] JSON request payload to create a new chunk (chunk)
101
179
  # @param [Hash] opts the optional parameters
@@ -106,7 +184,7 @@ module TrieveRubyClient
106
184
  end
107
185
 
108
186
  # Create or Upsert Chunk or Chunks
109
- # Create or Upsert Chunk or Chunks Create a new chunk. If the chunk has the same tracking_id as an existing chunk, the request will fail. Once a chunk is created, it can be searched for using the search endpoint. If uploading in bulk, the maximum amount of chunks that can be uploaded at once is 120 chunks. Auth&#39;ed user or api key must have an admin or owner role for the specified dataset&#39;s organization.
187
+ # Create a new chunk. If the chunk has the same tracking_id as an existing chunk, the request will fail. Once a chunk is created, it can be searched for using the search endpoint. If uploading in bulk, the maximum amount of chunks that can be uploaded at once is 120 chunks. Auth&#39;ed user or api key must have an admin or owner role for the specified dataset&#39;s organization.
110
188
  # @param tr_dataset [String] The dataset id to use for the request
111
189
  # @param create_chunk_req_payload_enum [CreateChunkReqPayloadEnum] JSON request payload to create a new chunk (chunk)
112
190
  # @param [Hash] opts the optional parameters
@@ -170,7 +248,7 @@ module TrieveRubyClient
170
248
  end
171
249
 
172
250
  # Delete Chunk
173
- # Delete Chunk Delete a chunk by its id. If deleting a root chunk which has a collision, the most recently created collision will become a new root chunk. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
251
+ # Delete a chunk by its id. If deleting a root chunk which has a collision, the most recently created collision will become a new root chunk. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
174
252
  # @param tr_dataset [String] The dataset id to use for the request
175
253
  # @param chunk_id [String] Id of the chunk you want to fetch.
176
254
  # @param [Hash] opts the optional parameters
@@ -181,7 +259,7 @@ module TrieveRubyClient
181
259
  end
182
260
 
183
261
  # Delete Chunk
184
- # Delete Chunk Delete a chunk by its id. If deleting a root chunk which has a collision, the most recently created collision will become a new root chunk. Auth&#39;ed user or api key must have an admin or owner role for the specified dataset&#39;s organization.
262
+ # Delete a chunk by its id. If deleting a root chunk which has a collision, the most recently created collision will become a new root chunk. Auth&#39;ed user or api key must have an admin or owner role for the specified dataset&#39;s organization.
185
263
  # @param tr_dataset [String] The dataset id to use for the request
186
264
  # @param chunk_id [String] Id of the chunk you want to fetch.
187
265
  # @param [Hash] opts the optional parameters
@@ -240,7 +318,7 @@ module TrieveRubyClient
240
318
  end
241
319
 
242
320
  # Delete Chunk By Tracking Id
243
- # Delete Chunk By Tracking Id Delete a chunk by tracking_id. This is useful for when you are coordinating with an external system and want to use the tracking_id to identify the chunk. If deleting a root chunk which has a collision, the most recently created collision will become a new root chunk. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
321
+ # Delete a chunk by tracking_id. This is useful for when you are coordinating with an external system and want to use the tracking_id to identify the chunk. If deleting a root chunk which has a collision, the most recently created collision will become a new root chunk. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
244
322
  # @param tr_dataset [String] The dataset id to use for the request
245
323
  # @param tracking_id [String] tracking_id of the chunk you want to delete
246
324
  # @param [Hash] opts the optional parameters
@@ -251,7 +329,7 @@ module TrieveRubyClient
251
329
  end
252
330
 
253
331
  # Delete Chunk By Tracking Id
254
- # Delete Chunk By Tracking Id Delete a chunk by tracking_id. This is useful for when you are coordinating with an external system and want to use the tracking_id to identify the chunk. If deleting a root chunk which has a collision, the most recently created collision will become a new root chunk. Auth&#39;ed user or api key must have an admin or owner role for the specified dataset&#39;s organization.
332
+ # Delete a chunk by tracking_id. This is useful for when you are coordinating with an external system and want to use the tracking_id to identify the chunk. If deleting a root chunk which has a collision, the most recently created collision will become a new root chunk. Auth&#39;ed user or api key must have an admin or owner role for the specified dataset&#39;s organization.
255
333
  # @param tr_dataset [String] The dataset id to use for the request
256
334
  # @param tracking_id [String] tracking_id of the chunk you want to delete
257
335
  # @param [Hash] opts the optional parameters
@@ -310,7 +388,7 @@ module TrieveRubyClient
310
388
  end
311
389
 
312
390
  # RAG on Specified Chunks
313
- # RAG on Specified Chunks This endpoint exists as an alternative to the topic+message concept where our API handles chat memory. With this endpoint, the user is responsible for providing the context window and the prompt. See more in the \"search before generate\" page at docs.trieve.ai.
391
+ # This endpoint exists as an alternative to the topic+message concept where our API handles chat memory. With this endpoint, the user is responsible for providing the context window and the prompt. See more in the \"search before generate\" page at docs.trieve.ai.
314
392
  # @param tr_dataset [String] The dataset id to use for the request
315
393
  # @param generate_chunks_request [GenerateChunksRequest] JSON request payload to perform RAG on some chunks (chunks)
316
394
  # @param [Hash] opts the optional parameters
@@ -321,7 +399,7 @@ module TrieveRubyClient
321
399
  end
322
400
 
323
401
  # RAG on Specified Chunks
324
- # RAG on Specified Chunks This endpoint exists as an alternative to the topic+message concept where our API handles chat memory. With this endpoint, the user is responsible for providing the context window and the prompt. See more in the \&quot;search before generate\&quot; page at docs.trieve.ai.
402
+ # This endpoint exists as an alternative to the topic+message concept where our API handles chat memory. With this endpoint, the user is responsible for providing the context window and the prompt. See more in the \&quot;search before generate\&quot; page at docs.trieve.ai.
325
403
  # @param tr_dataset [String] The dataset id to use for the request
326
404
  # @param generate_chunks_request [GenerateChunksRequest] JSON request payload to perform RAG on some chunks (chunks)
327
405
  # @param [Hash] opts the optional parameters
@@ -385,22 +463,24 @@ module TrieveRubyClient
385
463
  end
386
464
 
387
465
  # Get Chunk By Id
388
- # Get Chunk By Id Get a singular chunk by id.
466
+ # Get a singular chunk by id.
389
467
  # @param tr_dataset [String] The dataset id to use for the request
390
468
  # @param chunk_id [String] Id of the chunk you want to fetch.
391
469
  # @param [Hash] opts the optional parameters
392
- # @return [ChunkMetadataStringTagSet]
470
+ # @option opts [APIVersion] :x_api_version The API version to use for this request. Defaults to V2 for orgs created after July 12, 2024 and V1 otherwise.
471
+ # @return [ChunkReturnTypes]
393
472
  def get_chunk_by_id(tr_dataset, chunk_id, opts = {})
394
473
  data, _status_code, _headers = get_chunk_by_id_with_http_info(tr_dataset, chunk_id, opts)
395
474
  data
396
475
  end
397
476
 
398
477
  # Get Chunk By Id
399
- # Get Chunk By Id Get a singular chunk by id.
478
+ # Get a singular chunk by id.
400
479
  # @param tr_dataset [String] The dataset id to use for the request
401
480
  # @param chunk_id [String] Id of the chunk you want to fetch.
402
481
  # @param [Hash] opts the optional parameters
403
- # @return [Array<(ChunkMetadataStringTagSet, Integer, Hash)>] ChunkMetadataStringTagSet data, response status code and response headers
482
+ # @option opts [APIVersion] :x_api_version The API version to use for this request. Defaults to V2 for orgs created after July 12, 2024 and V1 otherwise.
483
+ # @return [Array<(ChunkReturnTypes, Integer, Hash)>] ChunkReturnTypes data, response status code and response headers
404
484
  def get_chunk_by_id_with_http_info(tr_dataset, chunk_id, opts = {})
405
485
  if @api_client.config.debugging
406
486
  @api_client.config.logger.debug 'Calling API: ChunkApi.get_chunk_by_id ...'
@@ -424,6 +504,7 @@ module TrieveRubyClient
424
504
  # HTTP header 'Accept' (if needed)
425
505
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
426
506
  header_params[:'TR-Dataset'] = tr_dataset
507
+ header_params[:'X-API-Version'] = opts[:'x_api_version'] if !opts[:'x_api_version'].nil?
427
508
 
428
509
  # form parameters
429
510
  form_params = opts[:form_params] || {}
@@ -432,7 +513,7 @@ module TrieveRubyClient
432
513
  post_body = opts[:debug_body]
433
514
 
434
515
  # return_type
435
- return_type = opts[:debug_return_type] || 'ChunkMetadataStringTagSet'
516
+ return_type = opts[:debug_return_type] || 'ChunkReturnTypes'
436
517
 
437
518
  # auth_names
438
519
  auth_names = opts[:debug_auth_names] || ['ApiKey']
@@ -455,22 +536,24 @@ module TrieveRubyClient
455
536
  end
456
537
 
457
538
  # Get Chunk By Tracking Id
458
- # Get Chunk By Tracking Id Get a singular chunk by tracking_id. This is useful for when you are coordinating with an external system and want to use your own id as the primary reference for a chunk.
539
+ # Get a singular chunk by tracking_id. This is useful for when you are coordinating with an external system and want to use your own id as the primary reference for a chunk.
459
540
  # @param tr_dataset [String] The dataset id to use for the request
460
541
  # @param tracking_id [String] tracking_id of the chunk you want to fetch
461
542
  # @param [Hash] opts the optional parameters
462
- # @return [ChunkMetadataStringTagSet]
543
+ # @option opts [APIVersion] :x_api_version The API version to use for this request. Defaults to V2 for orgs created after July 12, 2024 and V1 otherwise.
544
+ # @return [ChunkReturnTypes]
463
545
  def get_chunk_by_tracking_id(tr_dataset, tracking_id, opts = {})
464
546
  data, _status_code, _headers = get_chunk_by_tracking_id_with_http_info(tr_dataset, tracking_id, opts)
465
547
  data
466
548
  end
467
549
 
468
550
  # Get Chunk By Tracking Id
469
- # Get Chunk By Tracking Id Get a singular chunk by tracking_id. This is useful for when you are coordinating with an external system and want to use your own id as the primary reference for a chunk.
551
+ # Get a singular chunk by tracking_id. This is useful for when you are coordinating with an external system and want to use your own id as the primary reference for a chunk.
470
552
  # @param tr_dataset [String] The dataset id to use for the request
471
553
  # @param tracking_id [String] tracking_id of the chunk you want to fetch
472
554
  # @param [Hash] opts the optional parameters
473
- # @return [Array<(ChunkMetadataStringTagSet, Integer, Hash)>] ChunkMetadataStringTagSet data, response status code and response headers
555
+ # @option opts [APIVersion] :x_api_version The API version to use for this request. Defaults to V2 for orgs created after July 12, 2024 and V1 otherwise.
556
+ # @return [Array<(ChunkReturnTypes, Integer, Hash)>] ChunkReturnTypes data, response status code and response headers
474
557
  def get_chunk_by_tracking_id_with_http_info(tr_dataset, tracking_id, opts = {})
475
558
  if @api_client.config.debugging
476
559
  @api_client.config.logger.debug 'Calling API: ChunkApi.get_chunk_by_tracking_id ...'
@@ -494,6 +577,7 @@ module TrieveRubyClient
494
577
  # HTTP header 'Accept' (if needed)
495
578
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
496
579
  header_params[:'TR-Dataset'] = tr_dataset
580
+ header_params[:'X-API-Version'] = opts[:'x_api_version'] if !opts[:'x_api_version'].nil?
497
581
 
498
582
  # form parameters
499
583
  form_params = opts[:form_params] || {}
@@ -502,7 +586,7 @@ module TrieveRubyClient
502
586
  post_body = opts[:debug_body]
503
587
 
504
588
  # return_type
505
- return_type = opts[:debug_return_type] || 'ChunkMetadataStringTagSet'
589
+ return_type = opts[:debug_return_type] || 'ChunkReturnTypes'
506
590
 
507
591
  # auth_names
508
592
  auth_names = opts[:debug_auth_names] || ['ApiKey']
@@ -525,22 +609,24 @@ module TrieveRubyClient
525
609
  end
526
610
 
527
611
  # Get Chunks By Ids
528
- # Get Chunks By Ids Get multiple chunks by multiple ids.
612
+ # Get multiple chunks by multiple ids.
529
613
  # @param tr_dataset [String] The dataset id to use for the request
530
614
  # @param get_chunks_data [GetChunksData] JSON request payload to get the chunks in the request
531
615
  # @param [Hash] opts the optional parameters
532
- # @return [Array<ChunkMetadataStringTagSet>]
616
+ # @option opts [APIVersion] :x_api_version The API version to use for this request. Defaults to V2 for orgs created after July 12, 2024 and V1 otherwise.
617
+ # @return [Array<ChunkReturnTypes>]
533
618
  def get_chunks_by_ids(tr_dataset, get_chunks_data, opts = {})
534
619
  data, _status_code, _headers = get_chunks_by_ids_with_http_info(tr_dataset, get_chunks_data, opts)
535
620
  data
536
621
  end
537
622
 
538
623
  # Get Chunks By Ids
539
- # Get Chunks By Ids Get multiple chunks by multiple ids.
624
+ # Get multiple chunks by multiple ids.
540
625
  # @param tr_dataset [String] The dataset id to use for the request
541
626
  # @param get_chunks_data [GetChunksData] JSON request payload to get the chunks in the request
542
627
  # @param [Hash] opts the optional parameters
543
- # @return [Array<(Array<ChunkMetadataStringTagSet>, Integer, Hash)>] Array<ChunkMetadataStringTagSet> data, response status code and response headers
628
+ # @option opts [APIVersion] :x_api_version The API version to use for this request. Defaults to V2 for orgs created after July 12, 2024 and V1 otherwise.
629
+ # @return [Array<(Array<ChunkReturnTypes>, Integer, Hash)>] Array<ChunkReturnTypes> data, response status code and response headers
544
630
  def get_chunks_by_ids_with_http_info(tr_dataset, get_chunks_data, opts = {})
545
631
  if @api_client.config.debugging
546
632
  @api_client.config.logger.debug 'Calling API: ChunkApi.get_chunks_by_ids ...'
@@ -569,6 +655,7 @@ module TrieveRubyClient
569
655
  header_params['Content-Type'] = content_type
570
656
  end
571
657
  header_params[:'TR-Dataset'] = tr_dataset
658
+ header_params[:'X-API-Version'] = opts[:'x_api_version'] if !opts[:'x_api_version'].nil?
572
659
 
573
660
  # form parameters
574
661
  form_params = opts[:form_params] || {}
@@ -577,7 +664,7 @@ module TrieveRubyClient
577
664
  post_body = opts[:debug_body] || @api_client.object_to_http_body(get_chunks_data)
578
665
 
579
666
  # return_type
580
- return_type = opts[:debug_return_type] || 'Array<ChunkMetadataStringTagSet>'
667
+ return_type = opts[:debug_return_type] || 'Array<ChunkReturnTypes>'
581
668
 
582
669
  # auth_names
583
670
  auth_names = opts[:debug_auth_names] || ['ApiKey']
@@ -599,23 +686,25 @@ module TrieveRubyClient
599
686
  return data, status_code, headers
600
687
  end
601
688
 
602
- # Get Chunks By TrackingIds
603
- # Get Chunks By TrackingIds Get multiple chunks by ids.
689
+ # Get Chunks By Tracking Ids
690
+ # Get multiple chunks by ids.
604
691
  # @param tr_dataset [String] The dataset id to use for the request
605
692
  # @param get_tracking_chunks_data [GetTrackingChunksData] JSON request payload to get the chunks in the request
606
693
  # @param [Hash] opts the optional parameters
607
- # @return [Array<ChunkMetadataStringTagSet>]
694
+ # @option opts [APIVersion] :x_api_version The API version to use for this request. Defaults to V2 for orgs created after July 12, 2024 and V1 otherwise.
695
+ # @return [Array<ChunkReturnTypes>]
608
696
  def get_chunks_by_tracking_ids(tr_dataset, get_tracking_chunks_data, opts = {})
609
697
  data, _status_code, _headers = get_chunks_by_tracking_ids_with_http_info(tr_dataset, get_tracking_chunks_data, opts)
610
698
  data
611
699
  end
612
700
 
613
- # Get Chunks By TrackingIds
614
- # Get Chunks By TrackingIds Get multiple chunks by ids.
701
+ # Get Chunks By Tracking Ids
702
+ # Get multiple chunks by ids.
615
703
  # @param tr_dataset [String] The dataset id to use for the request
616
704
  # @param get_tracking_chunks_data [GetTrackingChunksData] JSON request payload to get the chunks in the request
617
705
  # @param [Hash] opts the optional parameters
618
- # @return [Array<(Array<ChunkMetadataStringTagSet>, Integer, Hash)>] Array<ChunkMetadataStringTagSet> data, response status code and response headers
706
+ # @option opts [APIVersion] :x_api_version The API version to use for this request. Defaults to V2 for orgs created after July 12, 2024 and V1 otherwise.
707
+ # @return [Array<(Array<ChunkReturnTypes>, Integer, Hash)>] Array<ChunkReturnTypes> data, response status code and response headers
619
708
  def get_chunks_by_tracking_ids_with_http_info(tr_dataset, get_tracking_chunks_data, opts = {})
620
709
  if @api_client.config.debugging
621
710
  @api_client.config.logger.debug 'Calling API: ChunkApi.get_chunks_by_tracking_ids ...'
@@ -644,6 +733,7 @@ module TrieveRubyClient
644
733
  header_params['Content-Type'] = content_type
645
734
  end
646
735
  header_params[:'TR-Dataset'] = tr_dataset
736
+ header_params[:'X-API-Version'] = opts[:'x_api_version'] if !opts[:'x_api_version'].nil?
647
737
 
648
738
  # form parameters
649
739
  form_params = opts[:form_params] || {}
@@ -652,7 +742,7 @@ module TrieveRubyClient
652
742
  post_body = opts[:debug_body] || @api_client.object_to_http_body(get_tracking_chunks_data)
653
743
 
654
744
  # return_type
655
- return_type = opts[:debug_return_type] || 'Array<ChunkMetadataStringTagSet>'
745
+ return_type = opts[:debug_return_type] || 'Array<ChunkReturnTypes>'
656
746
 
657
747
  # auth_names
658
748
  auth_names = opts[:debug_auth_names] || ['ApiKey']
@@ -675,22 +765,24 @@ module TrieveRubyClient
675
765
  end
676
766
 
677
767
  # Get Recommended Chunks
678
- # Get Recommended Chunks Get recommendations of chunks similar to the positive samples in the request and dissimilar to the negative. You must provide at least one of either positive_chunk_ids or positive_tracking_ids.
768
+ # Get recommendations of chunks similar to the positive samples in the request and dissimilar to the negative. You must provide at least one of either positive_chunk_ids or positive_tracking_ids.
679
769
  # @param tr_dataset [String] The dataset id to use for the request
680
770
  # @param recommend_chunks_request [RecommendChunksRequest] JSON request payload to get recommendations of chunks similar to the chunks in the request
681
771
  # @param [Hash] opts the optional parameters
682
- # @return [Array<ChunkMetadataWithScore>]
772
+ # @option opts [APIVersion] :x_api_version The API version to use for this request. Defaults to V2 for orgs created after July 12, 2024 and V1 otherwise.
773
+ # @return [RecommendResponseTypes]
683
774
  def get_recommended_chunks(tr_dataset, recommend_chunks_request, opts = {})
684
775
  data, _status_code, _headers = get_recommended_chunks_with_http_info(tr_dataset, recommend_chunks_request, opts)
685
776
  data
686
777
  end
687
778
 
688
779
  # Get Recommended Chunks
689
- # Get Recommended Chunks Get recommendations of chunks similar to the positive samples in the request and dissimilar to the negative. You must provide at least one of either positive_chunk_ids or positive_tracking_ids.
780
+ # Get recommendations of chunks similar to the positive samples in the request and dissimilar to the negative. You must provide at least one of either positive_chunk_ids or positive_tracking_ids.
690
781
  # @param tr_dataset [String] The dataset id to use for the request
691
782
  # @param recommend_chunks_request [RecommendChunksRequest] JSON request payload to get recommendations of chunks similar to the chunks in the request
692
783
  # @param [Hash] opts the optional parameters
693
- # @return [Array<(Array<ChunkMetadataWithScore>, Integer, Hash)>] Array<ChunkMetadataWithScore> data, response status code and response headers
784
+ # @option opts [APIVersion] :x_api_version The API version to use for this request. Defaults to V2 for orgs created after July 12, 2024 and V1 otherwise.
785
+ # @return [Array<(RecommendResponseTypes, Integer, Hash)>] RecommendResponseTypes data, response status code and response headers
694
786
  def get_recommended_chunks_with_http_info(tr_dataset, recommend_chunks_request, opts = {})
695
787
  if @api_client.config.debugging
696
788
  @api_client.config.logger.debug 'Calling API: ChunkApi.get_recommended_chunks ...'
@@ -719,6 +811,7 @@ module TrieveRubyClient
719
811
  header_params['Content-Type'] = content_type
720
812
  end
721
813
  header_params[:'TR-Dataset'] = tr_dataset
814
+ header_params[:'X-API-Version'] = opts[:'x_api_version'] if !opts[:'x_api_version'].nil?
722
815
 
723
816
  # form parameters
724
817
  form_params = opts[:form_params] || {}
@@ -727,7 +820,7 @@ module TrieveRubyClient
727
820
  post_body = opts[:debug_body] || @api_client.object_to_http_body(recommend_chunks_request)
728
821
 
729
822
  # return_type
730
- return_type = opts[:debug_return_type] || 'Array<ChunkMetadataWithScore>'
823
+ return_type = opts[:debug_return_type] || 'RecommendResponseTypes'
731
824
 
732
825
  # auth_names
733
826
  auth_names = opts[:debug_auth_names] || ['ApiKey']
@@ -750,7 +843,7 @@ module TrieveRubyClient
750
843
  end
751
844
 
752
845
  # Generate suggested queries
753
- # Generate suggested queries This endpoint will generate 3 suggested queries based off a hybrid search using RAG with the query provided in the request body and return them as a JSON object.
846
+ # This endpoint will generate 3 suggested queries based off a hybrid search using RAG with the query provided in the request body and return them as a JSON object.
754
847
  # @param tr_dataset [String] The dataset id to use for the request
755
848
  # @param suggested_queries_req_payload [SuggestedQueriesReqPayload] JSON request payload to get alternative suggested queries
756
849
  # @param [Hash] opts the optional parameters
@@ -761,7 +854,7 @@ module TrieveRubyClient
761
854
  end
762
855
 
763
856
  # Generate suggested queries
764
- # Generate suggested queries This endpoint will generate 3 suggested queries based off a hybrid search using RAG with the query provided in the request body and return them as a JSON object.
857
+ # This endpoint will generate 3 suggested queries based off a hybrid search using RAG with the query provided in the request body and return them as a JSON object.
765
858
  # @param tr_dataset [String] The dataset id to use for the request
766
859
  # @param suggested_queries_req_payload [SuggestedQueriesReqPayload] JSON request payload to get alternative suggested queries
767
860
  # @param [Hash] opts the optional parameters
@@ -825,22 +918,24 @@ module TrieveRubyClient
825
918
  end
826
919
 
827
920
  # Search
828
- # Search This route provides the primary search functionality for the API. It can be used to search for chunks by semantic similarity, full-text similarity, or a combination of both. Results' `chunk_html` values will be modified with `<b><mark>` tags for sub-sentence highlighting.
921
+ # This route provides the primary search functionality for the API. It can be used to search for chunks by semantic similarity, full-text similarity, or a combination of both. Results' `chunk_html` values will be modified with `<b><mark>` tags for sub-sentence highlighting.
829
922
  # @param tr_dataset [String] The dataset id to use for the request
830
923
  # @param search_chunks_req_payload [SearchChunksReqPayload] JSON request payload to semantically search for chunks (chunks)
831
924
  # @param [Hash] opts the optional parameters
832
- # @return [SearchChunkQueryResponseBody]
925
+ # @option opts [APIVersion] :x_api_version The API version to use for this request. Defaults to V2 for orgs created after July 12, 2024 and V1 otherwise.
926
+ # @return [SearchResponseTypes]
833
927
  def search_chunks(tr_dataset, search_chunks_req_payload, opts = {})
834
928
  data, _status_code, _headers = search_chunks_with_http_info(tr_dataset, search_chunks_req_payload, opts)
835
929
  data
836
930
  end
837
931
 
838
932
  # Search
839
- # Search This route provides the primary search functionality for the API. It can be used to search for chunks by semantic similarity, full-text similarity, or a combination of both. Results&#39; &#x60;chunk_html&#x60; values will be modified with &#x60;&lt;b&gt;&lt;mark&gt;&#x60; tags for sub-sentence highlighting.
933
+ # This route provides the primary search functionality for the API. It can be used to search for chunks by semantic similarity, full-text similarity, or a combination of both. Results&#39; &#x60;chunk_html&#x60; values will be modified with &#x60;&lt;b&gt;&lt;mark&gt;&#x60; tags for sub-sentence highlighting.
840
934
  # @param tr_dataset [String] The dataset id to use for the request
841
935
  # @param search_chunks_req_payload [SearchChunksReqPayload] JSON request payload to semantically search for chunks (chunks)
842
936
  # @param [Hash] opts the optional parameters
843
- # @return [Array<(SearchChunkQueryResponseBody, Integer, Hash)>] SearchChunkQueryResponseBody data, response status code and response headers
937
+ # @option opts [APIVersion] :x_api_version The API version to use for this request. Defaults to V2 for orgs created after July 12, 2024 and V1 otherwise.
938
+ # @return [Array<(SearchResponseTypes, Integer, Hash)>] SearchResponseTypes data, response status code and response headers
844
939
  def search_chunks_with_http_info(tr_dataset, search_chunks_req_payload, opts = {})
845
940
  if @api_client.config.debugging
846
941
  @api_client.config.logger.debug 'Calling API: ChunkApi.search_chunks ...'
@@ -869,6 +964,7 @@ module TrieveRubyClient
869
964
  header_params['Content-Type'] = content_type
870
965
  end
871
966
  header_params[:'TR-Dataset'] = tr_dataset
967
+ header_params[:'X-API-Version'] = opts[:'x_api_version'] if !opts[:'x_api_version'].nil?
872
968
 
873
969
  # form parameters
874
970
  form_params = opts[:form_params] || {}
@@ -877,7 +973,7 @@ module TrieveRubyClient
877
973
  post_body = opts[:debug_body] || @api_client.object_to_http_body(search_chunks_req_payload)
878
974
 
879
975
  # return_type
880
- return_type = opts[:debug_return_type] || 'SearchChunkQueryResponseBody'
976
+ return_type = opts[:debug_return_type] || 'SearchResponseTypes'
881
977
 
882
978
  # auth_names
883
979
  auth_names = opts[:debug_auth_names] || ['ApiKey']
@@ -900,7 +996,7 @@ module TrieveRubyClient
900
996
  end
901
997
 
902
998
  # Update Chunk
903
- # Update Chunk Update a chunk. If you try to change the tracking_id of the chunk to have the same tracking_id as an existing chunk, the request will fail. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
999
+ # Update a chunk. If you try to change the tracking_id of the chunk to have the same tracking_id as an existing chunk, the request will fail. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
904
1000
  # @param tr_dataset [String] The dataset id to use for the request
905
1001
  # @param update_chunk_req_payload [UpdateChunkReqPayload] JSON request payload to update a chunk (chunk)
906
1002
  # @param [Hash] opts the optional parameters
@@ -911,7 +1007,7 @@ module TrieveRubyClient
911
1007
  end
912
1008
 
913
1009
  # Update Chunk
914
- # Update Chunk Update a chunk. If you try to change the tracking_id of the chunk to have the same tracking_id as an existing chunk, the request will fail. Auth&#39;ed user or api key must have an admin or owner role for the specified dataset&#39;s organization.
1010
+ # Update a chunk. If you try to change the tracking_id of the chunk to have the same tracking_id as an existing chunk, the request will fail. Auth&#39;ed user or api key must have an admin or owner role for the specified dataset&#39;s organization.
915
1011
  # @param tr_dataset [String] The dataset id to use for the request
916
1012
  # @param update_chunk_req_payload [UpdateChunkReqPayload] JSON request payload to update a chunk (chunk)
917
1013
  # @param [Hash] opts the optional parameters
@@ -975,7 +1071,7 @@ module TrieveRubyClient
975
1071
  end
976
1072
 
977
1073
  # Update Chunk By Tracking Id
978
- # Update Chunk By Tracking Id Update a chunk by tracking_id. This is useful for when you are coordinating with an external system and want to use the tracking_id to identify the chunk. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
1074
+ # Update a chunk by tracking_id. This is useful for when you are coordinating with an external system and want to use the tracking_id to identify the chunk. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
979
1075
  # @param tr_dataset [String] The dataset id to use for the request
980
1076
  # @param update_chunk_by_tracking_id_data [UpdateChunkByTrackingIdData] JSON request payload to update a chunk by tracking_id (chunks)
981
1077
  # @param [Hash] opts the optional parameters
@@ -986,7 +1082,7 @@ module TrieveRubyClient
986
1082
  end
987
1083
 
988
1084
  # Update Chunk By Tracking Id
989
- # Update Chunk By Tracking Id Update a chunk by tracking_id. This is useful for when you are coordinating with an external system and want to use the tracking_id to identify the chunk. Auth&#39;ed user or api key must have an admin or owner role for the specified dataset&#39;s organization.
1085
+ # Update a chunk by tracking_id. This is useful for when you are coordinating with an external system and want to use the tracking_id to identify the chunk. Auth&#39;ed user or api key must have an admin or owner role for the specified dataset&#39;s organization.
990
1086
  # @param tr_dataset [String] The dataset id to use for the request
991
1087
  # @param update_chunk_by_tracking_id_data [UpdateChunkByTrackingIdData] JSON request payload to update a chunk by tracking_id (chunks)
992
1088
  # @param [Hash] opts the optional parameters