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
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 1a168187dd7ee17f3200711aa37293b261c6c2b1efcdabbcaf20824b447d13af
4
- data.tar.gz: c034af1fdb2902e0190b7493984f5a5b2517e76a12d83581fedb50f129926b14
3
+ metadata.gz: 6907f99f20fe4dff904e3daf46a25609d15085a9f51cc7c724cda992196ae964
4
+ data.tar.gz: 861b41bc2412fdb50f7312aa74aea47635e95adf29e6eff315f9e7a62146263f
5
5
  SHA512:
6
- metadata.gz: a90adfe8bf23396bb6a5bee60fae21870edf82a072303090601787ab084e33459c4da8e32487593249077734797bce8b8e933ecb5ff83f07401c7c4a5d64cfeb
7
- data.tar.gz: 2f8dd54c97384240971243258e27c0ae950b5cd8d178e850dd12b380c0b60a9c953c94a583447770f23abadcfd154c5daee2659b304fe7a36a78142f8472ff88
6
+ metadata.gz: 8470523e7ef46b499a3c73fcf86189efaf690fbc80f6b222d403c8039bb0fb6083ce3554445b884d55598c4840b6abe72aaf01c3587229828bc0a5b1555c64d5
7
+ data.tar.gz: 96ef993ec11b32bb7b6d7c8a93fe7fd360a2998d6f56aba33ac821375a7068b9fb5c92613dca77715bdccb833dba277cef5019304c1df8746f83eb092748a708
data/GENERATE_COMMAND.txt CHANGED
@@ -1 +1,3 @@
1
+ #!/bin/sh
2
+
1
3
  npx @openapitools/openapi-generator-cli generate -i openapi.json -g ruby -c ./openapi-generator.yaml --skip-validate-spec
data/README.md CHANGED
@@ -6,8 +6,8 @@ Trieve OpenAPI Specification. This document describes all of the operations avai
6
6
 
7
7
  This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
8
8
 
9
- - API version: 0.10.7
10
- - Package version: 0.10.7
9
+ - API version: 0.11.0
10
+ - Package version: 0.11.0
11
11
  - Generator version: 7.4.0
12
12
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
13
13
  For more information, please visit [https://trieve.ai](https://trieve.ai)
@@ -25,16 +25,16 @@ gem build trieve_ruby_client.gemspec
25
25
  Then either install the gem locally:
26
26
 
27
27
  ```shell
28
- gem install ./trieve_ruby_client-0.10.7.gem
28
+ gem install ./trieve_ruby_client-0.11.0.gem
29
29
  ```
30
30
 
31
- (for development, run `gem install --dev ./trieve_ruby_client-0.10.7.gem` to install the development dependencies)
31
+ (for development, run `gem install --dev ./trieve_ruby_client-0.11.0.gem` to install the development dependencies)
32
32
 
33
33
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
34
34
 
35
35
  Finally add this to the Gemfile:
36
36
 
37
- gem 'trieve_ruby_client', '~> 0.10.7'
37
+ gem 'trieve_ruby_client', '~> 0.11.0'
38
38
 
39
39
  ### Install from Git
40
40
 
@@ -58,14 +58,24 @@ Please follow the [installation](#installation) procedure and then run the follo
58
58
  # Load the gem
59
59
  require 'trieve_ruby_client'
60
60
 
61
- api_instance = TrieveRubyClient::AuthApi.new
61
+ # Setup authorization
62
+ TrieveRubyClient.configure do |config|
63
+ # Configure API key authorization: ApiKey
64
+ config.api_key['ApiKey'] = 'YOUR API KEY'
65
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
66
+ # config.api_key_prefix['ApiKey'] = 'Bearer'
67
+ end
68
+
69
+ api_instance = TrieveRubyClient::AnalyticsApi.new
70
+ tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
71
+ cluster_analytics = TrieveRubyClient::ClusterQueries.new({cluster_id: 'cluster_id_example', type: 'cluster_queries'}) # ClusterAnalytics | JSON request payload to filter the graph
62
72
 
63
73
  begin
64
- #OpenID Connect callback
65
- result = api_instance.callback
74
+ #Get Cluster Analytics
75
+ result = api_instance.get_cluster_analytics(tr_dataset, cluster_analytics)
66
76
  p result
67
77
  rescue TrieveRubyClient::ApiError => e
68
- puts "Exception when calling AuthApi->callback: #{e}"
78
+ puts "Exception when calling AnalyticsApi->get_cluster_analytics: #{e}"
69
79
  end
70
80
 
71
81
  ```
@@ -76,11 +86,16 @@ All URIs are relative to *https://api.trieve.ai*
76
86
 
77
87
  Class | Method | HTTP request | Description
78
88
  ------------ | ------------- | ------------- | -------------
89
+ *TrieveRubyClient::AnalyticsApi* | [**get_cluster_analytics**](docs/AnalyticsApi.md#get_cluster_analytics) | **POST** /api/analytics/search/cluster | Get Cluster Analytics
90
+ *TrieveRubyClient::AnalyticsApi* | [**get_rag_analytics**](docs/AnalyticsApi.md#get_rag_analytics) | **POST** /api/analytics/rag | Get RAG Analytics
91
+ *TrieveRubyClient::AnalyticsApi* | [**get_recommendation_analytics**](docs/AnalyticsApi.md#get_recommendation_analytics) | **POST** /api/analytics/recommendation | Get Recommendation Analytics
92
+ *TrieveRubyClient::AnalyticsApi* | [**get_search_analytics**](docs/AnalyticsApi.md#get_search_analytics) | **POST** /api/analytics/search | Get Search Analytics
79
93
  *TrieveRubyClient::AuthApi* | [**callback**](docs/AuthApi.md#callback) | **GET** /api/auth/callback | OpenID Connect callback
80
94
  *TrieveRubyClient::AuthApi* | [**get_me**](docs/AuthApi.md#get_me) | **GET** /api/auth/me | Get Me
81
95
  *TrieveRubyClient::AuthApi* | [**login**](docs/AuthApi.md#login) | **GET** /api/auth | Login
82
96
  *TrieveRubyClient::AuthApi* | [**logout**](docs/AuthApi.md#logout) | **DELETE** /api/auth | Logout
83
97
  *TrieveRubyClient::ChunkApi* | [**autocomplete**](docs/ChunkApi.md#autocomplete) | **POST** /api/chunk/autocomplete | Autocomplete
98
+ *TrieveRubyClient::ChunkApi* | [**count_chunks**](docs/ChunkApi.md#count_chunks) | **POST** /api/chunk/count | Count chunks above threshold
84
99
  *TrieveRubyClient::ChunkApi* | [**create_chunk**](docs/ChunkApi.md#create_chunk) | **POST** /api/chunk | Create or Upsert Chunk or Chunks
85
100
  *TrieveRubyClient::ChunkApi* | [**delete_chunk**](docs/ChunkApi.md#delete_chunk) | **DELETE** /api/chunk/{chunk_id} | Delete Chunk
86
101
  *TrieveRubyClient::ChunkApi* | [**delete_chunk_by_tracking_id**](docs/ChunkApi.md#delete_chunk_by_tracking_id) | **DELETE** /api/chunk/tracking_id/{tracking_id} | Delete Chunk By Tracking Id
@@ -88,7 +103,7 @@ Class | Method | HTTP request | Description
88
103
  *TrieveRubyClient::ChunkApi* | [**get_chunk_by_id**](docs/ChunkApi.md#get_chunk_by_id) | **GET** /api/chunk/{chunk_id} | Get Chunk By Id
89
104
  *TrieveRubyClient::ChunkApi* | [**get_chunk_by_tracking_id**](docs/ChunkApi.md#get_chunk_by_tracking_id) | **GET** /api/chunk/tracking_id/{tracking_id} | Get Chunk By Tracking Id
90
105
  *TrieveRubyClient::ChunkApi* | [**get_chunks_by_ids**](docs/ChunkApi.md#get_chunks_by_ids) | **POST** /api/chunks | Get Chunks By Ids
91
- *TrieveRubyClient::ChunkApi* | [**get_chunks_by_tracking_ids**](docs/ChunkApi.md#get_chunks_by_tracking_ids) | **POST** /api/chunks/tracking | Get Chunks By TrackingIds
106
+ *TrieveRubyClient::ChunkApi* | [**get_chunks_by_tracking_ids**](docs/ChunkApi.md#get_chunks_by_tracking_ids) | **POST** /api/chunks/tracking | Get Chunks By Tracking Ids
92
107
  *TrieveRubyClient::ChunkApi* | [**get_recommended_chunks**](docs/ChunkApi.md#get_recommended_chunks) | **POST** /api/chunk/recommend | Get Recommended Chunks
93
108
  *TrieveRubyClient::ChunkApi* | [**get_suggested_queries**](docs/ChunkApi.md#get_suggested_queries) | **POST** /api/chunk/gen_suggestions | Generate suggested queries
94
109
  *TrieveRubyClient::ChunkApi* | [**search_chunks**](docs/ChunkApi.md#search_chunks) | **POST** /api/chunk/search | Search
@@ -104,8 +119,8 @@ Class | Method | HTTP request | Description
104
119
  *TrieveRubyClient::ChunkGroupApi* | [**get_chunks_in_group_by_tracking_id**](docs/ChunkGroupApi.md#get_chunks_in_group_by_tracking_id) | **GET** /api/chunk_group/tracking_id/{group_tracking_id}/{page} | Get Chunks in Group by Tracking ID
105
120
  *TrieveRubyClient::ChunkGroupApi* | [**get_group_by_tracking_id**](docs/ChunkGroupApi.md#get_group_by_tracking_id) | **GET** /api/chunk_group/tracking_id/{tracking_id} | Get Group by Tracking ID
106
121
  *TrieveRubyClient::ChunkGroupApi* | [**get_groups_chunk_is_in**](docs/ChunkGroupApi.md#get_groups_chunk_is_in) | **POST** /api/chunk_group/chunks | Get Groups for Chunks
122
+ *TrieveRubyClient::ChunkGroupApi* | [**get_groups_for_dataset**](docs/ChunkGroupApi.md#get_groups_for_dataset) | **GET** /api/dataset/groups/{dataset_id}/{page} | Get Groups for Dataset
107
123
  *TrieveRubyClient::ChunkGroupApi* | [**get_recommended_groups**](docs/ChunkGroupApi.md#get_recommended_groups) | **POST** /api/chunk_group/recommend | Get Recommended Groups
108
- *TrieveRubyClient::ChunkGroupApi* | [**get_specific_dataset_chunk_groups**](docs/ChunkGroupApi.md#get_specific_dataset_chunk_groups) | **GET** /api/dataset/groups/{dataset_id}/{page} | Get Groups for Dataset
109
124
  *TrieveRubyClient::ChunkGroupApi* | [**remove_chunk_from_group**](docs/ChunkGroupApi.md#remove_chunk_from_group) | **DELETE** /api/chunk_group/chunk/{group_id} | Remove Chunk from Group
110
125
  *TrieveRubyClient::ChunkGroupApi* | [**search_over_groups**](docs/ChunkGroupApi.md#search_over_groups) | **POST** /api/chunk_group/group_oriented_search | Search Over Groups
111
126
  *TrieveRubyClient::ChunkGroupApi* | [**search_within_group**](docs/ChunkGroupApi.md#search_within_group) | **POST** /api/chunk_group/search | Search Within Group
@@ -115,7 +130,6 @@ Class | Method | HTTP request | Description
115
130
  *TrieveRubyClient::DatasetApi* | [**create_dataset**](docs/DatasetApi.md#create_dataset) | **POST** /api/dataset | Create dataset
116
131
  *TrieveRubyClient::DatasetApi* | [**delete_dataset**](docs/DatasetApi.md#delete_dataset) | **DELETE** /api/dataset/{dataset_id} | Delete Dataset
117
132
  *TrieveRubyClient::DatasetApi* | [**delete_dataset_by_tracking_id**](docs/DatasetApi.md#delete_dataset_by_tracking_id) | **DELETE** /api/dataset/tracking_id/{tracking_id} | Delete Dataset by Tracking ID
118
- *TrieveRubyClient::DatasetApi* | [**get_client_dataset_config**](docs/DatasetApi.md#get_client_dataset_config) | **GET** /api/dataset/envs | Get Client Configuration
119
133
  *TrieveRubyClient::DatasetApi* | [**get_dataset**](docs/DatasetApi.md#get_dataset) | **GET** /api/dataset/{dataset_id} | Get Dataset
120
134
  *TrieveRubyClient::DatasetApi* | [**get_datasets_from_organization**](docs/DatasetApi.md#get_datasets_from_organization) | **GET** /api/dataset/organization/{organization_id} | Get Datasets from Organization
121
135
  *TrieveRubyClient::DatasetApi* | [**get_usage_by_dataset_id**](docs/DatasetApi.md#get_usage_by_dataset_id) | **GET** /api/dataset/usage/{dataset_id} | Get Usage By Dataset ID
@@ -131,6 +145,7 @@ Class | Method | HTTP request | Description
131
145
  *TrieveRubyClient::MessageApi* | [**edit_message**](docs/MessageApi.md#edit_message) | **PUT** /api/message | Edit message
132
146
  *TrieveRubyClient::MessageApi* | [**get_all_topic_messages**](docs/MessageApi.md#get_all_topic_messages) | **GET** /api/messages/{messages_topic_id} | Get all messages for a given topic
133
147
  *TrieveRubyClient::MessageApi* | [**regenerate_message**](docs/MessageApi.md#regenerate_message) | **DELETE** /api/message | Regenerate message
148
+ *TrieveRubyClient::MetricsApi* | [**get_metrics**](docs/MetricsApi.md#get_metrics) | **POST** /metrics | Get Prometheus Metrics
134
149
  *TrieveRubyClient::OrganizationApi* | [**create_organization**](docs/OrganizationApi.md#create_organization) | **POST** /api/organization | Create Organization
135
150
  *TrieveRubyClient::OrganizationApi* | [**delete_organization**](docs/OrganizationApi.md#delete_organization) | **DELETE** /api/organization/{organization_id} | Delete Organization
136
151
  *TrieveRubyClient::OrganizationApi* | [**get_organization**](docs/OrganizationApi.md#get_organization) | **GET** /api/organization/{organization_id} | Get Organization
@@ -138,7 +153,9 @@ Class | Method | HTTP request | Description
138
153
  *TrieveRubyClient::OrganizationApi* | [**get_organization_users**](docs/OrganizationApi.md#get_organization_users) | **GET** /api/organization/users/{organization_id} | Get Organization Users
139
154
  *TrieveRubyClient::OrganizationApi* | [**update_organization**](docs/OrganizationApi.md#update_organization) | **PUT** /api/organization | Update Organization
140
155
  *TrieveRubyClient::StripeApi* | [**cancel_subscription**](docs/StripeApi.md#cancel_subscription) | **DELETE** /api/stripe/subscription/{subscription_id} | Cancel Subscription
156
+ *TrieveRubyClient::StripeApi* | [**create_setup_checkout_session**](docs/StripeApi.md#create_setup_checkout_session) | **POST** /api/stripe/checkout/setup/{organization_id} | Create checkout session setup
141
157
  *TrieveRubyClient::StripeApi* | [**direct_to_payment_link**](docs/StripeApi.md#direct_to_payment_link) | **GET** /api/stripe/payment_link/{plan_id}/{organization_id} | Checkout
158
+ *TrieveRubyClient::StripeApi* | [**get_all_invoices**](docs/StripeApi.md#get_all_invoices) | **GET** /api/stripe/invoices/{organization_id} | Get All Invoices
142
159
  *TrieveRubyClient::StripeApi* | [**get_all_plans**](docs/StripeApi.md#get_all_plans) | **GET** /api/stripe/plans | Get All Plans
143
160
  *TrieveRubyClient::StripeApi* | [**update_subscription_plan**](docs/StripeApi.md#update_subscription_plan) | **PATCH** /api/stripe/subscription_plan/{subscription_id}/{plan_id} | Update Subscription Plan
144
161
  *TrieveRubyClient::TopicApi* | [**create_topic**](docs/TopicApi.md#create_topic) | **POST** /api/topic | Create Topic
@@ -152,86 +169,165 @@ Class | Method | HTTP request | Description
152
169
 
153
170
  ## Documentation for Models
154
171
 
172
+ - [TrieveRubyClient::APIVersion](docs/APIVersion.md)
155
173
  - [TrieveRubyClient::AddChunkToGroupData](docs/AddChunkToGroupData.md)
156
174
  - [TrieveRubyClient::ApiKeyRespBody](docs/ApiKeyRespBody.md)
157
175
  - [TrieveRubyClient::AuthQuery](docs/AuthQuery.md)
158
176
  - [TrieveRubyClient::AutocompleteReqPayload](docs/AutocompleteReqPayload.md)
159
177
  - [TrieveRubyClient::BatchQueuedChunkResponse](docs/BatchQueuedChunkResponse.md)
160
- - [TrieveRubyClient::BookmarkData](docs/BookmarkData.md)
178
+ - [TrieveRubyClient::BookmarkGroupResponse](docs/BookmarkGroupResponse.md)
161
179
  - [TrieveRubyClient::BookmarkGroupResult](docs/BookmarkGroupResult.md)
162
180
  - [TrieveRubyClient::BoostPhrase](docs/BoostPhrase.md)
163
181
  - [TrieveRubyClient::ChatMessageProxy](docs/ChatMessageProxy.md)
164
182
  - [TrieveRubyClient::ChunkFilter](docs/ChunkFilter.md)
165
183
  - [TrieveRubyClient::ChunkGroup](docs/ChunkGroup.md)
166
- - [TrieveRubyClient::ChunkGroupAndFile](docs/ChunkGroupAndFile.md)
184
+ - [TrieveRubyClient::ChunkGroupAndFileId](docs/ChunkGroupAndFileId.md)
167
185
  - [TrieveRubyClient::ChunkMetadata](docs/ChunkMetadata.md)
168
186
  - [TrieveRubyClient::ChunkMetadataStringTagSet](docs/ChunkMetadataStringTagSet.md)
169
187
  - [TrieveRubyClient::ChunkMetadataTypes](docs/ChunkMetadataTypes.md)
170
188
  - [TrieveRubyClient::ChunkMetadataWithScore](docs/ChunkMetadataWithScore.md)
171
189
  - [TrieveRubyClient::ChunkReqPayload](docs/ChunkReqPayload.md)
172
- - [TrieveRubyClient::ClientDatasetConfiguration](docs/ClientDatasetConfiguration.md)
190
+ - [TrieveRubyClient::ChunkReturnTypes](docs/ChunkReturnTypes.md)
191
+ - [TrieveRubyClient::ClusterAnalytics](docs/ClusterAnalytics.md)
192
+ - [TrieveRubyClient::ClusterAnalyticsFilter](docs/ClusterAnalyticsFilter.md)
193
+ - [TrieveRubyClient::ClusterAnalyticsResponse](docs/ClusterAnalyticsResponse.md)
194
+ - [TrieveRubyClient::ClusterQueries](docs/ClusterQueries.md)
195
+ - [TrieveRubyClient::ClusterTopics](docs/ClusterTopics.md)
173
196
  - [TrieveRubyClient::ConditionType](docs/ConditionType.md)
174
197
  - [TrieveRubyClient::ContentChunkMetadata](docs/ContentChunkMetadata.md)
198
+ - [TrieveRubyClient::CountChunkQueryResponseBody](docs/CountChunkQueryResponseBody.md)
199
+ - [TrieveRubyClient::CountChunksReqPayload](docs/CountChunksReqPayload.md)
200
+ - [TrieveRubyClient::CountQueries](docs/CountQueries.md)
175
201
  - [TrieveRubyClient::CreateChunkGroupReqPayload](docs/CreateChunkGroupReqPayload.md)
176
202
  - [TrieveRubyClient::CreateChunkReqPayloadEnum](docs/CreateChunkReqPayloadEnum.md)
177
203
  - [TrieveRubyClient::CreateDatasetRequest](docs/CreateDatasetRequest.md)
178
204
  - [TrieveRubyClient::CreateMessageReqPayload](docs/CreateMessageReqPayload.md)
179
205
  - [TrieveRubyClient::CreateOrganizationData](docs/CreateOrganizationData.md)
206
+ - [TrieveRubyClient::CreateSetupCheckoutSessionResPayload](docs/CreateSetupCheckoutSessionResPayload.md)
180
207
  - [TrieveRubyClient::CreateTopicReqPayload](docs/CreateTopicReqPayload.md)
181
208
  - [TrieveRubyClient::Dataset](docs/Dataset.md)
209
+ - [TrieveRubyClient::DatasetAnalytics](docs/DatasetAnalytics.md)
182
210
  - [TrieveRubyClient::DatasetAndUsage](docs/DatasetAndUsage.md)
183
211
  - [TrieveRubyClient::DatasetDTO](docs/DatasetDTO.md)
184
212
  - [TrieveRubyClient::DatasetUsageCount](docs/DatasetUsageCount.md)
185
213
  - [TrieveRubyClient::DateRange](docs/DateRange.md)
186
214
  - [TrieveRubyClient::DeleteTopicData](docs/DeleteTopicData.md)
187
215
  - [TrieveRubyClient::DeleteUserApiKeyRequest](docs/DeleteUserApiKeyRequest.md)
216
+ - [TrieveRubyClient::DeprecatedSearchOverGroupsResponseBody](docs/DeprecatedSearchOverGroupsResponseBody.md)
217
+ - [TrieveRubyClient::DistancePhrase](docs/DistancePhrase.md)
188
218
  - [TrieveRubyClient::EditMessageReqPayload](docs/EditMessageReqPayload.md)
189
219
  - [TrieveRubyClient::ErrorResponseBody](docs/ErrorResponseBody.md)
190
220
  - [TrieveRubyClient::Event](docs/Event.md)
191
221
  - [TrieveRubyClient::EventReturn](docs/EventReturn.md)
222
+ - [TrieveRubyClient::EventTypeRequest](docs/EventTypeRequest.md)
192
223
  - [TrieveRubyClient::FieldCondition](docs/FieldCondition.md)
193
224
  - [TrieveRubyClient::File](docs/File.md)
194
225
  - [TrieveRubyClient::FileDTO](docs/FileDTO.md)
195
226
  - [TrieveRubyClient::GenerateChunksRequest](docs/GenerateChunksRequest.md)
196
227
  - [TrieveRubyClient::GeoInfo](docs/GeoInfo.md)
228
+ - [TrieveRubyClient::GeoInfoWithBias](docs/GeoInfoWithBias.md)
197
229
  - [TrieveRubyClient::GeoTypes](docs/GeoTypes.md)
198
230
  - [TrieveRubyClient::GetChunksData](docs/GetChunksData.md)
231
+ - [TrieveRubyClient::GetChunksForGroupsResponse](docs/GetChunksForGroupsResponse.md)
199
232
  - [TrieveRubyClient::GetDatasetsPagination](docs/GetDatasetsPagination.md)
200
233
  - [TrieveRubyClient::GetEventsData](docs/GetEventsData.md)
201
234
  - [TrieveRubyClient::GetGroupsForChunksData](docs/GetGroupsForChunksData.md)
202
235
  - [TrieveRubyClient::GetTrackingChunksData](docs/GetTrackingChunksData.md)
236
+ - [TrieveRubyClient::Granularity](docs/Granularity.md)
203
237
  - [TrieveRubyClient::GroupData](docs/GroupData.md)
204
238
  - [TrieveRubyClient::GroupScoreChunk](docs/GroupScoreChunk.md)
239
+ - [TrieveRubyClient::GroupsBookmarkQueryResult](docs/GroupsBookmarkQueryResult.md)
205
240
  - [TrieveRubyClient::HasIDCondition](docs/HasIDCondition.md)
241
+ - [TrieveRubyClient::HeadQueries](docs/HeadQueries.md)
242
+ - [TrieveRubyClient::HeadQueries1](docs/HeadQueries1.md)
243
+ - [TrieveRubyClient::HeadQueryResponse](docs/HeadQueryResponse.md)
206
244
  - [TrieveRubyClient::InvitationData](docs/InvitationData.md)
245
+ - [TrieveRubyClient::LatencyGraph](docs/LatencyGraph.md)
246
+ - [TrieveRubyClient::LatencyGraphResponse](docs/LatencyGraphResponse.md)
207
247
  - [TrieveRubyClient::LocationBoundingBox](docs/LocationBoundingBox.md)
208
248
  - [TrieveRubyClient::LocationPolygon](docs/LocationPolygon.md)
209
249
  - [TrieveRubyClient::LocationRadius](docs/LocationRadius.md)
250
+ - [TrieveRubyClient::LowConfidenceQueries](docs/LowConfidenceQueries.md)
251
+ - [TrieveRubyClient::LowConfidenceRecommendations](docs/LowConfidenceRecommendations.md)
210
252
  - [TrieveRubyClient::MatchCondition](docs/MatchCondition.md)
211
253
  - [TrieveRubyClient::Message](docs/Message.md)
254
+ - [TrieveRubyClient::NewChunkMetadataTypes](docs/NewChunkMetadataTypes.md)
255
+ - [TrieveRubyClient::NoResultQueries](docs/NoResultQueries.md)
212
256
  - [TrieveRubyClient::Organization](docs/Organization.md)
213
257
  - [TrieveRubyClient::OrganizationUsageCount](docs/OrganizationUsageCount.md)
258
+ - [TrieveRubyClient::QueryCountResponse](docs/QueryCountResponse.md)
259
+ - [TrieveRubyClient::QueryDetails](docs/QueryDetails.md)
260
+ - [TrieveRubyClient::RAGAnalytics](docs/RAGAnalytics.md)
261
+ - [TrieveRubyClient::RAGAnalyticsFilter](docs/RAGAnalyticsFilter.md)
262
+ - [TrieveRubyClient::RAGAnalyticsResponse](docs/RAGAnalyticsResponse.md)
263
+ - [TrieveRubyClient::RAGQueries](docs/RAGQueries.md)
264
+ - [TrieveRubyClient::RAGUsage](docs/RAGUsage.md)
265
+ - [TrieveRubyClient::RAGUsageResponse](docs/RAGUsageResponse.md)
266
+ - [TrieveRubyClient::RPSGraph](docs/RPSGraph.md)
267
+ - [TrieveRubyClient::RPSGraphResponse](docs/RPSGraphResponse.md)
268
+ - [TrieveRubyClient::RagQueryEvent](docs/RagQueryEvent.md)
269
+ - [TrieveRubyClient::RagQueryResponse](docs/RagQueryResponse.md)
270
+ - [TrieveRubyClient::RagTypes](docs/RagTypes.md)
214
271
  - [TrieveRubyClient::Range](docs/Range.md)
215
272
  - [TrieveRubyClient::RangeCondition](docs/RangeCondition.md)
216
273
  - [TrieveRubyClient::RecommendChunksRequest](docs/RecommendChunksRequest.md)
274
+ - [TrieveRubyClient::RecommendChunksResponseBody](docs/RecommendChunksResponseBody.md)
217
275
  - [TrieveRubyClient::RecommendGroupChunksRequest](docs/RecommendGroupChunksRequest.md)
276
+ - [TrieveRubyClient::RecommendGroupsResponse](docs/RecommendGroupsResponse.md)
277
+ - [TrieveRubyClient::RecommendGroupsResponseBody](docs/RecommendGroupsResponseBody.md)
278
+ - [TrieveRubyClient::RecommendResponseTypes](docs/RecommendResponseTypes.md)
279
+ - [TrieveRubyClient::RecommendType](docs/RecommendType.md)
280
+ - [TrieveRubyClient::RecommendationAnalytics](docs/RecommendationAnalytics.md)
281
+ - [TrieveRubyClient::RecommendationAnalyticsFilter](docs/RecommendationAnalyticsFilter.md)
282
+ - [TrieveRubyClient::RecommendationAnalyticsResponse](docs/RecommendationAnalyticsResponse.md)
283
+ - [TrieveRubyClient::RecommendationEvent](docs/RecommendationEvent.md)
284
+ - [TrieveRubyClient::RecommendationQueries](docs/RecommendationQueries.md)
285
+ - [TrieveRubyClient::RecommendationStrategy](docs/RecommendationStrategy.md)
286
+ - [TrieveRubyClient::RecommendationType](docs/RecommendationType.md)
287
+ - [TrieveRubyClient::RecommendationsEventResponse](docs/RecommendationsEventResponse.md)
218
288
  - [TrieveRubyClient::RegenerateMessageReqPayload](docs/RegenerateMessageReqPayload.md)
219
289
  - [TrieveRubyClient::RemoveChunkFromGroupReqPayload](docs/RemoveChunkFromGroupReqPayload.md)
220
290
  - [TrieveRubyClient::ReturnQueuedChunk](docs/ReturnQueuedChunk.md)
291
+ - [TrieveRubyClient::RoleProxy](docs/RoleProxy.md)
292
+ - [TrieveRubyClient::ScoreChunk](docs/ScoreChunk.md)
221
293
  - [TrieveRubyClient::ScoreChunkDTO](docs/ScoreChunkDTO.md)
294
+ - [TrieveRubyClient::SearchAnalytics](docs/SearchAnalytics.md)
295
+ - [TrieveRubyClient::SearchAnalyticsFilter](docs/SearchAnalyticsFilter.md)
296
+ - [TrieveRubyClient::SearchAnalyticsResponse](docs/SearchAnalyticsResponse.md)
222
297
  - [TrieveRubyClient::SearchChunkQueryResponseBody](docs/SearchChunkQueryResponseBody.md)
223
298
  - [TrieveRubyClient::SearchChunksReqPayload](docs/SearchChunksReqPayload.md)
299
+ - [TrieveRubyClient::SearchClusterResponse](docs/SearchClusterResponse.md)
300
+ - [TrieveRubyClient::SearchClusterTopics](docs/SearchClusterTopics.md)
301
+ - [TrieveRubyClient::SearchGroupResponseTypes](docs/SearchGroupResponseTypes.md)
302
+ - [TrieveRubyClient::SearchLatencyGraph](docs/SearchLatencyGraph.md)
303
+ - [TrieveRubyClient::SearchMethod](docs/SearchMethod.md)
304
+ - [TrieveRubyClient::SearchMetrics](docs/SearchMetrics.md)
224
305
  - [TrieveRubyClient::SearchOverGroupsData](docs/SearchOverGroupsData.md)
306
+ - [TrieveRubyClient::SearchOverGroupsResponseBody](docs/SearchOverGroupsResponseBody.md)
307
+ - [TrieveRubyClient::SearchOverGroupsResponseTypes](docs/SearchOverGroupsResponseTypes.md)
225
308
  - [TrieveRubyClient::SearchOverGroupsResults](docs/SearchOverGroupsResults.md)
309
+ - [TrieveRubyClient::SearchQueries](docs/SearchQueries.md)
310
+ - [TrieveRubyClient::SearchQueryEvent](docs/SearchQueryEvent.md)
311
+ - [TrieveRubyClient::SearchQueryResponse](docs/SearchQueryResponse.md)
312
+ - [TrieveRubyClient::SearchRPSGraph](docs/SearchRPSGraph.md)
313
+ - [TrieveRubyClient::SearchResponseBody](docs/SearchResponseBody.md)
314
+ - [TrieveRubyClient::SearchResponseTypes](docs/SearchResponseTypes.md)
315
+ - [TrieveRubyClient::SearchResultType](docs/SearchResultType.md)
316
+ - [TrieveRubyClient::SearchType](docs/SearchType.md)
317
+ - [TrieveRubyClient::SearchTypeCount](docs/SearchTypeCount.md)
226
318
  - [TrieveRubyClient::SearchWithinGroupData](docs/SearchWithinGroupData.md)
319
+ - [TrieveRubyClient::SearchWithinGroupResponseBody](docs/SearchWithinGroupResponseBody.md)
227
320
  - [TrieveRubyClient::SearchWithinGroupResults](docs/SearchWithinGroupResults.md)
228
321
  - [TrieveRubyClient::SetUserApiKeyRequest](docs/SetUserApiKeyRequest.md)
229
322
  - [TrieveRubyClient::SetUserApiKeyResponse](docs/SetUserApiKeyResponse.md)
230
323
  - [TrieveRubyClient::SingleQueuedChunkResponse](docs/SingleQueuedChunkResponse.md)
231
324
  - [TrieveRubyClient::SlimChunkMetadata](docs/SlimChunkMetadata.md)
325
+ - [TrieveRubyClient::SlimChunkMetadataWithArrayTagSet](docs/SlimChunkMetadataWithArrayTagSet.md)
232
326
  - [TrieveRubyClient::SlimChunkMetadataWithScore](docs/SlimChunkMetadataWithScore.md)
233
- - [TrieveRubyClient::SlimGroup](docs/SlimGroup.md)
234
327
  - [TrieveRubyClient::SlimUser](docs/SlimUser.md)
328
+ - [TrieveRubyClient::SortBy](docs/SortBy.md)
329
+ - [TrieveRubyClient::SortOrder](docs/SortOrder.md)
330
+ - [TrieveRubyClient::StripeInvoice](docs/StripeInvoice.md)
235
331
  - [TrieveRubyClient::StripePlan](docs/StripePlan.md)
236
332
  - [TrieveRubyClient::SuggestedQueriesReqPayload](docs/SuggestedQueriesReqPayload.md)
237
333
  - [TrieveRubyClient::SuggestedQueriesResponse](docs/SuggestedQueriesResponse.md)
@@ -260,3 +356,10 @@ Authentication schemes defined for the API:
260
356
  - **API key parameter name**: Authorization
261
357
  - **Location**: HTTP header
262
358
 
359
+ ### X-API-KEY
360
+
361
+
362
+ - **Type**: API key
363
+ - **API key parameter name**: X-API-KEY
364
+ - **Location**: HTTP header
365
+
data/docs/APIVersion.md ADDED
@@ -0,0 +1,15 @@
1
+ # TrieveRubyClient::APIVersion
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::APIVersion.new()
14
+ ```
15
+
data/docs/AnalyticsApi.md ADDED
@@ -0,0 +1,303 @@
1
+ # TrieveRubyClient::AnalyticsApi
2
+
3
+ All URIs are relative to *https://api.trieve.ai*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**get_cluster_analytics**](AnalyticsApi.md#get_cluster_analytics) | **POST** /api/analytics/search/cluster | Get Cluster Analytics |
8
+ | [**get_rag_analytics**](AnalyticsApi.md#get_rag_analytics) | **POST** /api/analytics/rag | Get RAG Analytics |
9
+ | [**get_recommendation_analytics**](AnalyticsApi.md#get_recommendation_analytics) | **POST** /api/analytics/recommendation | Get Recommendation Analytics |
10
+ | [**get_search_analytics**](AnalyticsApi.md#get_search_analytics) | **POST** /api/analytics/search | Get Search Analytics |
11
+
12
+
13
+ ## get_cluster_analytics
14
+
15
+ > <ClusterAnalyticsResponse> get_cluster_analytics(tr_dataset, cluster_analytics)
16
+
17
+ Get Cluster Analytics
18
+
19
+ This route allows you to view the cluster analytics for a dataset.
20
+
21
+ ### Examples
22
+
23
+ ```ruby
24
+ require 'time'
25
+ require 'trieve_ruby_client'
26
+ # setup authorization
27
+ TrieveRubyClient.configure do |config|
28
+ # Configure API key authorization: ApiKey
29
+ config.api_key['ApiKey'] = 'YOUR API KEY'
30
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
31
+ # config.api_key_prefix['ApiKey'] = 'Bearer'
32
+ end
33
+
34
+ api_instance = TrieveRubyClient::AnalyticsApi.new
35
+ tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
36
+ cluster_analytics = TrieveRubyClient::ClusterQueries.new({cluster_id: 'cluster_id_example', type: 'cluster_queries'}) # ClusterAnalytics | JSON request payload to filter the graph
37
+
38
+ begin
39
+ # Get Cluster Analytics
40
+ result = api_instance.get_cluster_analytics(tr_dataset, cluster_analytics)
41
+ p result
42
+ rescue TrieveRubyClient::ApiError => e
43
+ puts "Error when calling AnalyticsApi->get_cluster_analytics: #{e}"
44
+ end
45
+ ```
46
+
47
+ #### Using the get_cluster_analytics_with_http_info variant
48
+
49
+ This returns an Array which contains the response data, status code and headers.
50
+
51
+ > <Array(<ClusterAnalyticsResponse>, Integer, Hash)> get_cluster_analytics_with_http_info(tr_dataset, cluster_analytics)
52
+
53
+ ```ruby
54
+ begin
55
+ # Get Cluster Analytics
56
+ data, status_code, headers = api_instance.get_cluster_analytics_with_http_info(tr_dataset, cluster_analytics)
57
+ p status_code # => 2xx
58
+ p headers # => { ... }
59
+ p data # => <ClusterAnalyticsResponse>
60
+ rescue TrieveRubyClient::ApiError => e
61
+ puts "Error when calling AnalyticsApi->get_cluster_analytics_with_http_info: #{e}"
62
+ end
63
+ ```
64
+
65
+ ### Parameters
66
+
67
+ | Name | Type | Description | Notes |
68
+ | ---- | ---- | ----------- | ----- |
69
+ | **tr_dataset** | **String** | The dataset id to use for the request | |
70
+ | **cluster_analytics** | [**ClusterAnalytics**](ClusterAnalytics.md) | JSON request payload to filter the graph | |
71
+
72
+ ### Return type
73
+
74
+ [**ClusterAnalyticsResponse**](ClusterAnalyticsResponse.md)
75
+
76
+ ### Authorization
77
+
78
+ [ApiKey](../README.md#ApiKey)
79
+
80
+ ### HTTP request headers
81
+
82
+ - **Content-Type**: application/json
83
+ - **Accept**: application/json
84
+
85
+
86
+ ## get_rag_analytics
87
+
88
+ > <RAGAnalyticsResponse> get_rag_analytics(tr_dataset, rag_analytics)
89
+
90
+ Get RAG Analytics
91
+
92
+ This route allows you to view the RAG analytics for a dataset.
93
+
94
+ ### Examples
95
+
96
+ ```ruby
97
+ require 'time'
98
+ require 'trieve_ruby_client'
99
+ # setup authorization
100
+ TrieveRubyClient.configure do |config|
101
+ # Configure API key authorization: ApiKey
102
+ config.api_key['ApiKey'] = 'YOUR API KEY'
103
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
104
+ # config.api_key_prefix['ApiKey'] = 'Bearer'
105
+ end
106
+
107
+ api_instance = TrieveRubyClient::AnalyticsApi.new
108
+ tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
109
+ rag_analytics = TrieveRubyClient::RAGQueries.new({type: 'rag_queries'}) # RAGAnalytics | JSON request payload to filter the graph
110
+
111
+ begin
112
+ # Get RAG Analytics
113
+ result = api_instance.get_rag_analytics(tr_dataset, rag_analytics)
114
+ p result
115
+ rescue TrieveRubyClient::ApiError => e
116
+ puts "Error when calling AnalyticsApi->get_rag_analytics: #{e}"
117
+ end
118
+ ```
119
+
120
+ #### Using the get_rag_analytics_with_http_info variant
121
+
122
+ This returns an Array which contains the response data, status code and headers.
123
+
124
+ > <Array(<RAGAnalyticsResponse>, Integer, Hash)> get_rag_analytics_with_http_info(tr_dataset, rag_analytics)
125
+
126
+ ```ruby
127
+ begin
128
+ # Get RAG Analytics
129
+ data, status_code, headers = api_instance.get_rag_analytics_with_http_info(tr_dataset, rag_analytics)
130
+ p status_code # => 2xx
131
+ p headers # => { ... }
132
+ p data # => <RAGAnalyticsResponse>
133
+ rescue TrieveRubyClient::ApiError => e
134
+ puts "Error when calling AnalyticsApi->get_rag_analytics_with_http_info: #{e}"
135
+ end
136
+ ```
137
+
138
+ ### Parameters
139
+
140
+ | Name | Type | Description | Notes |
141
+ | ---- | ---- | ----------- | ----- |
142
+ | **tr_dataset** | **String** | The dataset id to use for the request | |
143
+ | **rag_analytics** | [**RAGAnalytics**](RAGAnalytics.md) | JSON request payload to filter the graph | |
144
+
145
+ ### Return type
146
+
147
+ [**RAGAnalyticsResponse**](RAGAnalyticsResponse.md)
148
+
149
+ ### Authorization
150
+
151
+ [ApiKey](../README.md#ApiKey)
152
+
153
+ ### HTTP request headers
154
+
155
+ - **Content-Type**: application/json
156
+ - **Accept**: application/json
157
+
158
+
159
+ ## get_recommendation_analytics
160
+
161
+ > <RecommendationAnalyticsResponse> get_recommendation_analytics(tr_dataset, recommendation_analytics)
162
+
163
+ Get Recommendation Analytics
164
+
165
+ This route allows you to view the recommendation analytics for a dataset.
166
+
167
+ ### Examples
168
+
169
+ ```ruby
170
+ require 'time'
171
+ require 'trieve_ruby_client'
172
+ # setup authorization
173
+ TrieveRubyClient.configure do |config|
174
+ # Configure API key authorization: ApiKey
175
+ config.api_key['ApiKey'] = 'YOUR API KEY'
176
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
177
+ # config.api_key_prefix['ApiKey'] = 'Bearer'
178
+ end
179
+
180
+ api_instance = TrieveRubyClient::AnalyticsApi.new
181
+ tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
182
+ recommendation_analytics = TrieveRubyClient::LowConfidenceRecommendations.new({type: 'low_confidence_recommendations'}) # RecommendationAnalytics | JSON request payload to filter the graph
183
+
184
+ begin
185
+ # Get Recommendation Analytics
186
+ result = api_instance.get_recommendation_analytics(tr_dataset, recommendation_analytics)
187
+ p result
188
+ rescue TrieveRubyClient::ApiError => e
189
+ puts "Error when calling AnalyticsApi->get_recommendation_analytics: #{e}"
190
+ end
191
+ ```
192
+
193
+ #### Using the get_recommendation_analytics_with_http_info variant
194
+
195
+ This returns an Array which contains the response data, status code and headers.
196
+
197
+ > <Array(<RecommendationAnalyticsResponse>, Integer, Hash)> get_recommendation_analytics_with_http_info(tr_dataset, recommendation_analytics)
198
+
199
+ ```ruby
200
+ begin
201
+ # Get Recommendation Analytics
202
+ data, status_code, headers = api_instance.get_recommendation_analytics_with_http_info(tr_dataset, recommendation_analytics)
203
+ p status_code # => 2xx
204
+ p headers # => { ... }
205
+ p data # => <RecommendationAnalyticsResponse>
206
+ rescue TrieveRubyClient::ApiError => e
207
+ puts "Error when calling AnalyticsApi->get_recommendation_analytics_with_http_info: #{e}"
208
+ end
209
+ ```
210
+
211
+ ### Parameters
212
+
213
+ | Name | Type | Description | Notes |
214
+ | ---- | ---- | ----------- | ----- |
215
+ | **tr_dataset** | **String** | The dataset id to use for the request | |
216
+ | **recommendation_analytics** | [**RecommendationAnalytics**](RecommendationAnalytics.md) | JSON request payload to filter the graph | |
217
+
218
+ ### Return type
219
+
220
+ [**RecommendationAnalyticsResponse**](RecommendationAnalyticsResponse.md)
221
+
222
+ ### Authorization
223
+
224
+ [ApiKey](../README.md#ApiKey)
225
+
226
+ ### HTTP request headers
227
+
228
+ - **Content-Type**: application/json
229
+ - **Accept**: application/json
230
+
231
+
232
+ ## get_search_analytics
233
+
234
+ > <SearchAnalyticsResponse> get_search_analytics(tr_dataset, search_analytics)
235
+
236
+ Get Search Analytics
237
+
238
+ This route allows you to view the search analytics for a dataset.
239
+
240
+ ### Examples
241
+
242
+ ```ruby
243
+ require 'time'
244
+ require 'trieve_ruby_client'
245
+ # setup authorization
246
+ TrieveRubyClient.configure do |config|
247
+ # Configure API key authorization: ApiKey
248
+ config.api_key['ApiKey'] = 'YOUR API KEY'
249
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
250
+ # config.api_key_prefix['ApiKey'] = 'Bearer'
251
+ end
252
+
253
+ api_instance = TrieveRubyClient::AnalyticsApi.new
254
+ tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
255
+ search_analytics = TrieveRubyClient::CountQueries.new({type: 'count_queries'}) # SearchAnalytics | JSON request payload to filter the graph
256
+
257
+ begin
258
+ # Get Search Analytics
259
+ result = api_instance.get_search_analytics(tr_dataset, search_analytics)
260
+ p result
261
+ rescue TrieveRubyClient::ApiError => e
262
+ puts "Error when calling AnalyticsApi->get_search_analytics: #{e}"
263
+ end
264
+ ```
265
+
266
+ #### Using the get_search_analytics_with_http_info variant
267
+
268
+ This returns an Array which contains the response data, status code and headers.
269
+
270
+ > <Array(<SearchAnalyticsResponse>, Integer, Hash)> get_search_analytics_with_http_info(tr_dataset, search_analytics)
271
+
272
+ ```ruby
273
+ begin
274
+ # Get Search Analytics
275
+ data, status_code, headers = api_instance.get_search_analytics_with_http_info(tr_dataset, search_analytics)
276
+ p status_code # => 2xx
277
+ p headers # => { ... }
278
+ p data # => <SearchAnalyticsResponse>
279
+ rescue TrieveRubyClient::ApiError => e
280
+ puts "Error when calling AnalyticsApi->get_search_analytics_with_http_info: #{e}"
281
+ end
282
+ ```
283
+
284
+ ### Parameters
285
+
286
+ | Name | Type | Description | Notes |
287
+ | ---- | ---- | ----------- | ----- |
288
+ | **tr_dataset** | **String** | The dataset id to use for the request | |
289
+ | **search_analytics** | [**SearchAnalytics**](SearchAnalytics.md) | JSON request payload to filter the graph | |
290
+
291
+ ### Return type
292
+
293
+ [**SearchAnalyticsResponse**](SearchAnalyticsResponse.md)
294
+
295
+ ### Authorization
296
+
297
+ [ApiKey](../README.md#ApiKey)
298
+
299
+ ### HTTP request headers
300
+
301
+ - **Content-Type**: application/json
302
+ - **Accept**: application/json
303
+