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
@@ -0,0 +1,20 @@
1
+ # TrieveRubyClient::RecommendationAnalyticsFilter
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **date_range** | [**DateRange**](DateRange.md) | | [optional] |
8
+ | **recommendation_type** | [**RecommendationType**](RecommendationType.md) | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'trieve_ruby_client'
14
+
15
+ instance = TrieveRubyClient::RecommendationAnalyticsFilter.new(
16
+ date_range: null,
17
+ recommendation_type: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,47 @@
1
+ # TrieveRubyClient::RecommendationAnalyticsResponse
2
+
3
+ ## Class instance methods
4
+
5
+ ### `openapi_one_of`
6
+
7
+ Returns the list of classes defined in oneOf.
8
+
9
+ #### Example
10
+
11
+ ```ruby
12
+ require 'trieve_ruby_client'
13
+
14
+ TrieveRubyClient::RecommendationAnalyticsResponse.openapi_one_of
15
+ # =>
16
+ # [
17
+ # :'RecommendationsEventResponse'
18
+ # ]
19
+ ```
20
+
21
+ ### build
22
+
23
+ Find the appropriate object from the `openapi_one_of` list and casts the data into it.
24
+
25
+ #### Example
26
+
27
+ ```ruby
28
+ require 'trieve_ruby_client'
29
+
30
+ TrieveRubyClient::RecommendationAnalyticsResponse.build(data)
31
+ # => #<RecommendationsEventResponse:0x00007fdd4aab02a0>
32
+
33
+ TrieveRubyClient::RecommendationAnalyticsResponse.build(data_that_doesnt_match)
34
+ # => nil
35
+ ```
36
+
37
+ #### Parameters
38
+
39
+ | Name | Type | Description |
40
+ | ---- | ---- | ----------- |
41
+ | **data** | **Mixed** | data to be matched against the list of oneOf items |
42
+
43
+ #### Return type
44
+
45
+ - `RecommendationsEventResponse`
46
+ - `nil` (if no type matches)
47
+
@@ -0,0 +1,38 @@
1
+ # TrieveRubyClient::RecommendationEvent
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **created_at** | **String** | | |
8
+ | **dataset_id** | **String** | | |
9
+ | **id** | **String** | | |
10
+ | **negative_ids** | **Array&lt;String&gt;** | | |
11
+ | **negative_tracking_ids** | **Array&lt;String&gt;** | | |
12
+ | **positive_ids** | **Array&lt;String&gt;** | | |
13
+ | **positive_tracking_ids** | **Array&lt;String&gt;** | | |
14
+ | **recommendation_type** | **String** | | |
15
+ | **request_params** | **String** | | |
16
+ | **results** | [**Array&lt;SearchResultType&gt;**](SearchResultType.md) | | |
17
+ | **top_score** | **Float** | | |
18
+
19
+ ## Example
20
+
21
+ ```ruby
22
+ require 'trieve_ruby_client'
23
+
24
+ instance = TrieveRubyClient::RecommendationEvent.new(
25
+ created_at: null,
26
+ dataset_id: null,
27
+ id: null,
28
+ negative_ids: null,
29
+ negative_tracking_ids: null,
30
+ positive_ids: null,
31
+ positive_tracking_ids: null,
32
+ recommendation_type: null,
33
+ request_params: null,
34
+ results: null,
35
+ top_score: null
36
+ )
37
+ ```
38
+
@@ -0,0 +1,26 @@
1
+ # TrieveRubyClient::RecommendationQueries
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **filter** | [**RecommendationAnalyticsFilter**](RecommendationAnalyticsFilter.md) | | [optional] |
8
+ | **page** | **Integer** | | [optional] |
9
+ | **sort_by** | [**SortBy**](SortBy.md) | | [optional] |
10
+ | **sort_order** | [**SortOrder**](SortOrder.md) | | [optional] |
11
+ | **type** | **String** | | |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'trieve_ruby_client'
17
+
18
+ instance = TrieveRubyClient::RecommendationQueries.new(
19
+ filter: null,
20
+ page: null,
21
+ sort_by: null,
22
+ sort_order: null,
23
+ type: null
24
+ )
25
+ ```
26
+
@@ -0,0 +1,15 @@
1
+ # TrieveRubyClient::RecommendationStrategy
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+
8
+ ## Example
9
+
10
+ ```ruby
11
+ require 'trieve_ruby_client'
12
+
13
+ instance = TrieveRubyClient::RecommendationStrategy.new()
14
+ ```
15
+
@@ -0,0 +1,15 @@
1
+ # TrieveRubyClient::RecommendationType
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+
8
+ ## Example
9
+
10
+ ```ruby
11
+ require 'trieve_ruby_client'
12
+
13
+ instance = TrieveRubyClient::RecommendationType.new()
14
+ ```
15
+
@@ -0,0 +1,18 @@
1
+ # TrieveRubyClient::RecommendationsEventResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **queries** | [**Array&lt;RecommendationEvent&gt;**](RecommendationEvent.md) | | |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'trieve_ruby_client'
13
+
14
+ instance = TrieveRubyClient::RecommendationsEventResponse.new(
15
+ queries: null
16
+ )
17
+ ```
18
+
@@ -5,13 +5,17 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **completion_first** | **Boolean** | Completion first decides whether the stream should contain the stream of the completion response or the chunks first. Default is false. Keep in mind that || is used to separate the chunks from the completion response. If || is in the completion then you may want to split on ||{ instead. | [optional] |
8
+ | **concat_user_messages_query** | **Boolean** | If concat user messages query is set to true, all of the user messages in the topic will be concatenated together and used as the search query. If not specified, this defaults to false. Default is false. | [optional] |
8
9
  | **filters** | [**ChunkFilter**](ChunkFilter.md) | | [optional] |
9
10
  | **frequency_penalty** | **Float** | Frequency penalty is a number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model&#39;s likelihood to repeat the same line verbatim. Default is 0.7. | [optional] |
10
11
  | **highlight_citations** | **Boolean** | Whether or not to highlight the citations in the response. If this is set to true or not included, the citations will be highlighted. If this is set to false, the citations will not be highlighted. Default is true. | [optional] |
11
12
  | **highlight_delimiters** | **Array&lt;String&gt;** | The delimiters to use for highlighting the citations. If this is not included, the default delimiters will be used. Default is &#x60;[\&quot;.\&quot;, \&quot;!\&quot;, \&quot;?\&quot;, \&quot;\\n\&quot;, \&quot;\\t\&quot;, \&quot;,\&quot;]&#x60;. | [optional] |
12
13
  | **max_tokens** | **Integer** | The maximum number of tokens to generate in the chat completion. | [optional] |
14
+ | **page_size** | **Integer** | Page size is the number of chunks to fetch during RAG. If 0, then no search will be performed. If specified, this will override the N retrievals to include in the dataset configuration. Default is None. | [optional] |
13
15
  | **presence_penalty** | **Float** | Presence penalty is a number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model&#39;s likelihood to talk about new topics. | [optional] |
14
- | **search_type** | **String** | Search_type can be either \&quot;semantic\&quot;, \&quot;fulltext\&quot;, or \&quot;hybrid\&quot;. \&quot;hybrid\&quot; will pull in one page (10 chunks) of both semantic and full-text results then re-rank them using BAAI/bge-reranker-large. \&quot;semantic\&quot; will pull in one page (10 chunks) of the nearest cosine distant vectors. \&quot;fulltext\&quot; will pull in one page (10 chunks) of full-text results based on SPLADE. | [optional] |
16
+ | **score_threshold** | **Float** | Set score_threshold to a float to filter out chunks with a score below the threshold. This threshold applies before weight and bias modifications. If not specified, this defaults to 0.0. | [optional] |
17
+ | **search_query** | **String** | Query is the search query. This can be any string. The search_query will be used to create a dense embedding vector and/or sparse vector which will be used to find the result set. If not specified, will default to the last user message or HyDE if HyDE is enabled in the dataset configuration. Default is None. | [optional] |
18
+ | **search_type** | [**SearchMethod**](SearchMethod.md) | | [optional] |
15
19
  | **stop_tokens** | **Array&lt;String&gt;** | Stop tokens are up to 4 sequences where the API will stop generating further tokens. | [optional] |
16
20
  | **stream_response** | **Boolean** | Whether or not to stream the response. If this is set to true or not included, the response will be a stream. If this is set to false, the response will be a normal JSON response. Default is true. | [optional] |
17
21
  | **temperature** | **Float** | What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. Default is 0.7. | [optional] |
@@ -24,12 +28,16 @@ require 'trieve_ruby_client'
24
28
 
25
29
  instance = TrieveRubyClient::RegenerateMessageReqPayload.new(
26
30
  completion_first: null,
31
+ concat_user_messages_query: null,
27
32
  filters: null,
28
33
  frequency_penalty: null,
29
34
  highlight_citations: null,
30
35
  highlight_delimiters: null,
31
36
  max_tokens: null,
37
+ page_size: null,
32
38
  presence_penalty: null,
39
+ score_threshold: null,
40
+ search_query: null,
33
41
  search_type: null,
34
42
  stop_tokens: null,
35
43
  stream_response: null,
data/docs/RoleProxy.md ADDED
@@ -0,0 +1,15 @@
1
+ # TrieveRubyClient::RoleProxy
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+
8
+ ## Example
9
+
10
+ ```ruby
11
+ require 'trieve_ruby_client'
12
+
13
+ instance = TrieveRubyClient::RoleProxy.new()
14
+ ```
15
+
@@ -0,0 +1,22 @@
1
+ # TrieveRubyClient::ScoreChunk
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **chunk** | [**NewChunkMetadataTypes**](NewChunkMetadataTypes.md) | | |
8
+ | **highlights** | **Array&lt;String&gt;** | | [optional] |
9
+ | **score** | **Float** | | |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'trieve_ruby_client'
15
+
16
+ instance = TrieveRubyClient::ScoreChunk.new(
17
+ chunk: null,
18
+ highlights: null,
19
+ score: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,77 @@
1
+ # TrieveRubyClient::SearchAnalytics
2
+
3
+ ## Class instance methods
4
+
5
+ ### `openapi_one_of`
6
+
7
+ Returns the list of classes defined in oneOf.
8
+
9
+ #### Example
10
+
11
+ ```ruby
12
+ require 'trieve_ruby_client'
13
+
14
+ TrieveRubyClient::SearchAnalytics.openapi_one_of
15
+ # =>
16
+ # [
17
+ # :'CountQueries',
18
+ # :'HeadQueries1',
19
+ # :'LatencyGraph',
20
+ # :'LowConfidenceQueries',
21
+ # :'NoResultQueries',
22
+ # :'QueryDetails',
23
+ # :'RPSGraph',
24
+ # :'SearchMetrics',
25
+ # :'SearchQueries'
26
+ # ]
27
+ ```
28
+
29
+ ### `openapi_discriminator_name`
30
+
31
+ Returns the discriminator's property name.
32
+
33
+ #### Example
34
+
35
+ ```ruby
36
+ require 'trieve_ruby_client'
37
+
38
+ TrieveRubyClient::SearchAnalytics.openapi_discriminator_name
39
+ # => :'type'
40
+ ```
41
+ ```
42
+
43
+ ### build
44
+
45
+ Find the appropriate object from the `openapi_one_of` list and casts the data into it.
46
+
47
+ #### Example
48
+
49
+ ```ruby
50
+ require 'trieve_ruby_client'
51
+
52
+ TrieveRubyClient::SearchAnalytics.build(data)
53
+ # => #<CountQueries:0x00007fdd4aab02a0>
54
+
55
+ TrieveRubyClient::SearchAnalytics.build(data_that_doesnt_match)
56
+ # => nil
57
+ ```
58
+
59
+ #### Parameters
60
+
61
+ | Name | Type | Description |
62
+ | ---- | ---- | ----------- |
63
+ | **data** | **Mixed** | data to be matched against the list of oneOf items |
64
+
65
+ #### Return type
66
+
67
+ - `CountQueries`
68
+ - `HeadQueries1`
69
+ - `LatencyGraph`
70
+ - `LowConfidenceQueries`
71
+ - `NoResultQueries`
72
+ - `QueryDetails`
73
+ - `RPSGraph`
74
+ - `SearchMetrics`
75
+ - `SearchQueries`
76
+ - `nil` (if no type matches)
77
+
@@ -0,0 +1,22 @@
1
+ # TrieveRubyClient::SearchAnalyticsFilter
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **date_range** | [**DateRange**](DateRange.md) | | [optional] |
8
+ | **search_method** | [**SearchMethod**](SearchMethod.md) | | [optional] |
9
+ | **search_type** | [**SearchType**](SearchType.md) | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'trieve_ruby_client'
15
+
16
+ instance = TrieveRubyClient::SearchAnalyticsFilter.new(
17
+ date_range: null,
18
+ search_method: null,
19
+ search_type: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,59 @@
1
+ # TrieveRubyClient::SearchAnalyticsResponse
2
+
3
+ ## Class instance methods
4
+
5
+ ### `openapi_one_of`
6
+
7
+ Returns the list of classes defined in oneOf.
8
+
9
+ #### Example
10
+
11
+ ```ruby
12
+ require 'trieve_ruby_client'
13
+
14
+ TrieveRubyClient::SearchAnalyticsResponse.openapi_one_of
15
+ # =>
16
+ # [
17
+ # :'DatasetAnalytics',
18
+ # :'HeadQueryResponse',
19
+ # :'LatencyGraphResponse',
20
+ # :'QueryCountResponse',
21
+ # :'RPSGraphResponse',
22
+ # :'SearchQueryEvent',
23
+ # :'SearchQueryResponse'
24
+ # ]
25
+ ```
26
+
27
+ ### build
28
+
29
+ Find the appropriate object from the `openapi_one_of` list and casts the data into it.
30
+
31
+ #### Example
32
+
33
+ ```ruby
34
+ require 'trieve_ruby_client'
35
+
36
+ TrieveRubyClient::SearchAnalyticsResponse.build(data)
37
+ # => #<DatasetAnalytics:0x00007fdd4aab02a0>
38
+
39
+ TrieveRubyClient::SearchAnalyticsResponse.build(data_that_doesnt_match)
40
+ # => nil
41
+ ```
42
+
43
+ #### Parameters
44
+
45
+ | Name | Type | Description |
46
+ | ---- | ---- | ----------- |
47
+ | **data** | **Mixed** | data to be matched against the list of oneOf items |
48
+
49
+ #### Return type
50
+
51
+ - `DatasetAnalytics`
52
+ - `HeadQueryResponse`
53
+ - `LatencyGraphResponse`
54
+ - `QueryCountResponse`
55
+ - `RPSGraphResponse`
56
+ - `SearchQueryEvent`
57
+ - `SearchQueryResponse`
58
+ - `nil` (if no type matches)
59
+
@@ -6,7 +6,6 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **content_only** | **Boolean** | Set content_only to true to only returning the chunk_html of the chunks. This is useful for when you want to reduce amount of data over the wire for latency improvement (typically 10-50ms). Default is false. | [optional] |
8
8
  | **filters** | [**ChunkFilter**](ChunkFilter.md) | | [optional] |
9
- | **get_collisions** | **Boolean** | Set get_collisions to true to get the collisions for each chunk. This will only apply if environment variable COLLISIONS_ENABLED is set to true. | [optional] |
10
9
  | **get_total_pages** | **Boolean** | Get total page count for the query accounting for the applied filters. Defaults to false, but can be set to true when the latency penalty is acceptable (typically 50-200ms). | [optional] |
11
10
  | **highlight_delimiters** | **Array&lt;String&gt;** | Set highlight_delimiters to a list of strings to use as delimiters for highlighting. If not specified, this defaults to [\&quot;?\&quot;, \&quot;,\&quot;, \&quot;.\&quot;, \&quot;!\&quot;]. These are the characters that will be used to split the chunk_html into splits for highlighting. These are the characters that will be used to split the chunk_html into splits for highlighting. | [optional] |
12
11
  | **highlight_max_length** | **Integer** | Set highlight_max_length to control the maximum number of tokens (typically whitespace separated strings, but sometimes also word stems) which can be present within a single highlight. If not specified, this defaults to 8. This is useful to shorten large splits which may have low scores due to length compared to the query. Set to something very large like 100 to highlight entire splits. | [optional] |
@@ -14,14 +13,16 @@
14
13
  | **highlight_results** | **Boolean** | Set highlight_results to false for a slight latency improvement (1-10ms). If not specified, this defaults to true. This will add &#x60;&lt;b&gt;&lt;mark&gt;&#x60; tags to the chunk_html of the chunks to highlight matching splits and return the highlights on each scored chunk in the response. | [optional] |
15
14
  | **highlight_threshold** | **Float** | Set highlight_threshold to a lower or higher value to adjust the sensitivity of the highlights applied to the chunk html. If not specified, this defaults to 0.8. The range is 0.0 to 1.0. | [optional] |
16
15
  | **highlight_window** | **Integer** | Set highlight_window to a number to control the amount of words that are returned around the matched phrases. If not specified, this defaults to 0. This is useful for when you want to show more context around the matched words. When specified, window/2 whitespace separated words are added before and after each highlight in the response&#39;s highlights array. If an extended highlight overlaps with another highlight, the overlapping words are only included once. | [optional] |
16
+ | **location_bias** | [**GeoInfoWithBias**](GeoInfoWithBias.md) | | [optional] |
17
17
  | **page** | **Integer** | Page of chunks to fetch. Page is 1-indexed. | [optional] |
18
18
  | **page_size** | **Integer** | Page size is the number of chunks to fetch. This can be used to fetch more than 10 chunks at a time. | [optional] |
19
19
  | **query** | **String** | Query is the search query. This can be any string. The query will be used to create an embedding vector and/or SPLADE vector which will be used to find the result set. | |
20
20
  | **recency_bias** | **Float** | Recency Bias lets you determine how much of an effect the recency of chunks will have on the search results. If not specified, this defaults to 0.0. We recommend setting this to 1.0 for a gentle reranking of the results, &gt;3.0 for a strong reranking of the results. | [optional] |
21
- | **score_threshold** | **Float** | Set score_threshold to a float to filter out chunks with a score below the threshold. | [optional] |
22
- | **search_type** | **String** | Can be either \&quot;semantic\&quot;, \&quot;fulltext\&quot;, or \&quot;hybrid\&quot;. If specified as \&quot;hybrid\&quot;, it will pull in one page (10 chunks) of both semantic and full-text results then re-rank them using BAAI/bge-reranker-large. \&quot;semantic\&quot; will pull in one page (10 chunks) of the nearest cosine distant vectors. \&quot;fulltext\&quot; will pull in one page (10 chunks) of full-text results based on SPLADE. | |
21
+ | **score_threshold** | **Float** | Set score_threshold to a float to filter out chunks with a score below the threshold. This threshold applies before weight and bias modifications. If not specified, this defaults to 0.0. | [optional] |
22
+ | **search_type** | [**SearchMethod**](SearchMethod.md) | | |
23
23
  | **slim_chunks** | **Boolean** | Set slim_chunks to true to avoid returning the content and chunk_html of the chunks. This is useful for when you want to reduce amount of data over the wire for latency improvement (typically 10-50ms). Default is false. | [optional] |
24
24
  | **tag_weights** | **Hash&lt;String, Float&gt;** | Tag weights is a JSON object which can be used to boost the ranking of chunks with certain tags. This is useful for when you want to be able to bias towards chunks with a certain tag on the fly. The keys are the tag names and the values are the weights. | [optional] |
25
+ | **use_reranker** | **Boolean** | If true, chunks will be reranked using scores from a cross encoder model. \&quot;hybrid\&quot; search will always use the reranker regardless of this setting. | [optional] |
25
26
  | **use_weights** | **Boolean** | Set use_weights to true to use the weights of the chunks in the result set in order to sort them. If not specified, this defaults to true. | [optional] |
26
27
 
27
28
  ## Example
@@ -32,7 +33,6 @@ require 'trieve_ruby_client'
32
33
  instance = TrieveRubyClient::SearchChunksReqPayload.new(
33
34
  content_only: null,
34
35
  filters: null,
35
- get_collisions: null,
36
36
  get_total_pages: null,
37
37
  highlight_delimiters: null,
38
38
  highlight_max_length: null,
@@ -40,6 +40,7 @@ instance = TrieveRubyClient::SearchChunksReqPayload.new(
40
40
  highlight_results: null,
41
41
  highlight_threshold: null,
42
42
  highlight_window: null,
43
+ location_bias: null,
43
44
  page: null,
44
45
  page_size: null,
45
46
  query: null,
@@ -48,6 +49,7 @@ instance = TrieveRubyClient::SearchChunksReqPayload.new(
48
49
  search_type: null,
49
50
  slim_chunks: null,
50
51
  tag_weights: null,
52
+ use_reranker: null,
51
53
  use_weights: null
52
54
  )
53
55
  ```
@@ -0,0 +1,18 @@
1
+ # TrieveRubyClient::SearchClusterResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **clusters** | [**Array&lt;SearchClusterTopics&gt;**](SearchClusterTopics.md) | | |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'trieve_ruby_client'
13
+
14
+ instance = TrieveRubyClient::SearchClusterResponse.new(
15
+ clusters: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,28 @@
1
+ # TrieveRubyClient::SearchClusterTopics
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **avg_score** | **Float** | | |
8
+ | **created_at** | **String** | | |
9
+ | **dataset_id** | **String** | | |
10
+ | **density** | **Integer** | | |
11
+ | **id** | **String** | | |
12
+ | **topic** | **String** | | |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'trieve_ruby_client'
18
+
19
+ instance = TrieveRubyClient::SearchClusterTopics.new(
20
+ avg_score: null,
21
+ created_at: null,
22
+ dataset_id: null,
23
+ density: null,
24
+ id: null,
25
+ topic: null
26
+ )
27
+ ```
28
+
@@ -0,0 +1,49 @@
1
+ # TrieveRubyClient::SearchGroupResponseTypes
2
+
3
+ ## Class instance methods
4
+
5
+ ### `openapi_one_of`
6
+
7
+ Returns the list of classes defined in oneOf.
8
+
9
+ #### Example
10
+
11
+ ```ruby
12
+ require 'trieve_ruby_client'
13
+
14
+ TrieveRubyClient::SearchGroupResponseTypes.openapi_one_of
15
+ # =>
16
+ # [
17
+ # :'SearchWithinGroupResponseBody',
18
+ # :'SearchWithinGroupResults'
19
+ # ]
20
+ ```
21
+
22
+ ### build
23
+
24
+ Find the appropriate object from the `openapi_one_of` list and casts the data into it.
25
+
26
+ #### Example
27
+
28
+ ```ruby
29
+ require 'trieve_ruby_client'
30
+
31
+ TrieveRubyClient::SearchGroupResponseTypes.build(data)
32
+ # => #<SearchWithinGroupResponseBody:0x00007fdd4aab02a0>
33
+
34
+ TrieveRubyClient::SearchGroupResponseTypes.build(data_that_doesnt_match)
35
+ # => nil
36
+ ```
37
+
38
+ #### Parameters
39
+
40
+ | Name | Type | Description |
41
+ | ---- | ---- | ----------- |
42
+ | **data** | **Mixed** | data to be matched against the list of oneOf items |
43
+
44
+ #### Return type
45
+
46
+ - `SearchWithinGroupResponseBody`
47
+ - `SearchWithinGroupResults`
48
+ - `nil` (if no type matches)
49
+
@@ -0,0 +1,20 @@
1
+ # TrieveRubyClient::SearchLatencyGraph
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **average_latency** | **Float** | | |
8
+ | **time_stamp** | **String** | | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'trieve_ruby_client'
14
+
15
+ instance = TrieveRubyClient::SearchLatencyGraph.new(
16
+ average_latency: null,
17
+ time_stamp: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,15 @@
1
+ # TrieveRubyClient::SearchMethod
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+
8
+ ## Example
9
+
10
+ ```ruby
11
+ require 'trieve_ruby_client'
12
+
13
+ instance = TrieveRubyClient::SearchMethod.new()
14
+ ```
15
+
@@ -0,0 +1,20 @@
1
+ # TrieveRubyClient::SearchMetrics
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **filter** | [**SearchAnalyticsFilter**](SearchAnalyticsFilter.md) | | [optional] |
8
+ | **type** | **String** | | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'trieve_ruby_client'
14
+
15
+ instance = TrieveRubyClient::SearchMetrics.new(
16
+ filter: null,
17
+ type: null
18
+ )
19
+ ```
20
+
@@ -5,7 +5,6 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **filters** | [**ChunkFilter**](ChunkFilter.md) | | [optional] |
8
- | **get_collisions** | **Boolean** | Set get_collisions to true to get the collisions for each chunk. This will only apply if environment variable COLLISIONS_ENABLED is set to true. | [optional] |
9
8
  | **get_total_pages** | **Boolean** | Get total page count for the query accounting for the applied filters. Defaults to false, but can be set to true when the latency penalty is acceptable (typically 50-200ms). | [optional] |
10
9
  | **group_size** | **Integer** | Group_size is the number of chunks to fetch for each group. The default is 3. If a group has less than group_size chunks, all chunks will be returned. If this is set to a large number, we recommend setting slim_chunks to true to avoid returning the content and chunk_html of the chunks so as to lower the amount of time required for content download and serialization. | [optional] |
11
10
  | **highlight_delimiters** | **Array&lt;String&gt;** | Set highlight_delimiters to a list of strings to use as delimiters for highlighting. If not specified, this defaults to [\&quot;?\&quot;, \&quot;,\&quot;, \&quot;.\&quot;, \&quot;!\&quot;]. These are the characters that will be used to split the chunk_html into splits for highlighting. | [optional] |
@@ -17,8 +16,8 @@
17
16
  | **page** | **Integer** | Page of group results to fetch. Page is 1-indexed. | [optional] |
18
17
  | **page_size** | **Integer** | Page size is the number of group results to fetch. The default is 10. | [optional] |
19
18
  | **query** | **String** | Query is the search query. This can be any string. The query will be used to create an embedding vector and/or SPLADE vector which will be used to find the result set. | |
20
- | **score_threshold** | **Float** | Set score_threshold to a float to filter out chunks with a score below the threshold. | [optional] |
21
- | **search_type** | **String** | Can be either \&quot;semantic\&quot;, \&quot;fulltext\&quot;, or \&quot;hybrid\&quot;. \&quot;hybrid\&quot; will pull in one page (10 chunks) of both semantic and full-text results then re-rank them using BAAI/bge-reranker-large. \&quot;semantic\&quot; will pull in one page (10 chunks) of the nearest cosine distant vectors. \&quot;fulltext\&quot; will pull in one page (10 chunks) of full-text results based on SPLADE. | |
19
+ | **score_threshold** | **Float** | Set score_threshold to a float to filter out chunks with a score below the threshold. This threshold applies before weight and bias modifications. If not specified, this defaults to 0.0. | [optional] |
20
+ | **search_type** | [**SearchMethod**](SearchMethod.md) | | |
22
21
  | **slim_chunks** | **Boolean** | Set slim_chunks to true to avoid returning the content and chunk_html of the chunks. This is useful for when you want to reduce amount of data over the wire for latency improvement (typicall 10-50ms). Default is false. | [optional] |
23
22
 
24
23
  ## Example
@@ -28,7 +27,6 @@ require 'trieve_ruby_client'
28
27
 
29
28
  instance = TrieveRubyClient::SearchOverGroupsData.new(
30
29
  filters: null,
31
- get_collisions: null,
32
30
  get_total_pages: null,
33
31
  group_size: null,
34
32
  highlight_delimiters: null,