trieve_ruby_client 0.4.0 → 0.5.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (255) hide show
  1. checksums.yaml +4 -4
  2. data/GENERATE_COMMAND.txt +1 -0
  3. data/README.md +29 -18
  4. data/docs/AddChunkToGroupData.md +1 -1
  5. data/docs/AuthApi.md +1 -1
  6. data/docs/ChunkApi.md +34 -38
  7. data/docs/ChunkGroupApi.md +51 -48
  8. data/docs/DatasetApi.md +9 -9
  9. data/docs/EventsApi.md +1 -1
  10. data/docs/FileApi.md +1 -1
  11. data/docs/GetEventsData.md +1 -1
  12. data/docs/GroupScoreChunkDTO.md +2 -0
  13. data/docs/GroupSlimChunksDTO.md +20 -0
  14. data/docs/HealthApi.md +1 -1
  15. data/docs/InvitationApi.md +1 -1
  16. data/docs/MessageApi.md +1 -1
  17. data/docs/OrganizationApi.md +1 -1
  18. data/docs/Range.md +4 -4
  19. data/docs/RangeCondition.md +49 -0
  20. data/docs/ReccomendGroupChunksRequest.md +3 -1
  21. data/docs/RecommendChunksRequest.md +3 -1
  22. data/docs/RecommendChunksResponseTypes.md +49 -0
  23. data/docs/RecommendGroupChunkResponseTypes.md +49 -0
  24. data/docs/ScoreSlimChunks.md +20 -0
  25. data/docs/SearchChunkData.md +4 -0
  26. data/docs/SearchChunkResponseTypes.md +49 -0
  27. data/docs/SearchGroupSlimChunksResult.md +22 -0
  28. data/docs/SearchOverGroupsData.md +5 -1
  29. data/docs/SearchOverGroupsResponseTypes.md +49 -0
  30. data/docs/SearchOverGroupsSlimChunksResponseBody.md +20 -0
  31. data/docs/SearchSlimChunkQueryResponseBody.md +20 -0
  32. data/docs/SearchWithinGroupData.md +4 -0
  33. data/docs/SearchWithinGroupResponseTypes.md +49 -0
  34. data/docs/SlimChunkMetadata.md +36 -0
  35. data/docs/SlimUser.md +1 -7
  36. data/docs/StripeApi.md +1 -1
  37. data/docs/TopicApi.md +9 -9
  38. data/docs/UpdateChunkData.md +2 -0
  39. data/docs/UpdateUserData.md +1 -7
  40. data/docs/UserApi.md +9 -9
  41. data/lib/trieve_ruby_client/api/auth_api.rb +1 -1
  42. data/lib/trieve_ruby_client/api/chunk_api.rb +34 -38
  43. data/lib/trieve_ruby_client/api/chunk_group_api.rb +56 -59
  44. data/lib/trieve_ruby_client/api/dataset_api.rb +11 -16
  45. data/lib/trieve_ruby_client/api/events_api.rb +1 -1
  46. data/lib/trieve_ruby_client/api/file_api.rb +1 -1
  47. data/lib/trieve_ruby_client/api/health_api.rb +1 -1
  48. data/lib/trieve_ruby_client/api/invitation_api.rb +1 -1
  49. data/lib/trieve_ruby_client/api/message_api.rb +1 -1
  50. data/lib/trieve_ruby_client/api/organization_api.rb +1 -1
  51. data/lib/trieve_ruby_client/api/stripe_api.rb +1 -1
  52. data/lib/trieve_ruby_client/api/topic_api.rb +11 -16
  53. data/lib/trieve_ruby_client/api/user_api.rb +11 -16
  54. data/lib/trieve_ruby_client/api_client.rb +1 -1
  55. data/lib/trieve_ruby_client/api_error.rb +1 -1
  56. data/lib/trieve_ruby_client/configuration.rb +7 -7
  57. data/lib/trieve_ruby_client/models/add_chunk_to_group_data.rb +2 -2
  58. data/lib/trieve_ruby_client/models/api_key_dto.rb +1 -1
  59. data/lib/trieve_ruby_client/models/auth_query.rb +1 -1
  60. data/lib/trieve_ruby_client/models/batch_queued_chunk_response.rb +1 -1
  61. data/lib/trieve_ruby_client/models/bookmark_data.rb +1 -1
  62. data/lib/trieve_ruby_client/models/bookmark_group_result.rb +1 -1
  63. data/lib/trieve_ruby_client/models/chat_message_proxy.rb +1 -1
  64. data/lib/trieve_ruby_client/models/chunk_data.rb +1 -1
  65. data/lib/trieve_ruby_client/models/chunk_filter.rb +1 -1
  66. data/lib/trieve_ruby_client/models/chunk_group.rb +1 -1
  67. data/lib/trieve_ruby_client/models/chunk_group_and_file.rb +1 -1
  68. data/lib/trieve_ruby_client/models/chunk_metadata.rb +1 -1
  69. data/lib/trieve_ruby_client/models/chunk_metadata_with_file_data.rb +1 -1
  70. data/lib/trieve_ruby_client/models/client_dataset_configuration.rb +1 -1
  71. data/lib/trieve_ruby_client/models/create_chunk_data.rb +1 -1
  72. data/lib/trieve_ruby_client/models/create_chunk_group_data.rb +1 -1
  73. data/lib/trieve_ruby_client/models/create_dataset_request.rb +1 -1
  74. data/lib/trieve_ruby_client/models/create_message_data.rb +1 -1
  75. data/lib/trieve_ruby_client/models/create_organization_data.rb +1 -1
  76. data/lib/trieve_ruby_client/models/create_topic_data.rb +1 -1
  77. data/lib/trieve_ruby_client/models/dataset.rb +1 -1
  78. data/lib/trieve_ruby_client/models/dataset_and_usage.rb +1 -1
  79. data/lib/trieve_ruby_client/models/dataset_dto.rb +1 -1
  80. data/lib/trieve_ruby_client/models/dataset_usage_count.rb +1 -1
  81. data/lib/trieve_ruby_client/models/delete_dataset_request.rb +1 -1
  82. data/lib/trieve_ruby_client/models/delete_topic_data.rb +1 -1
  83. data/lib/trieve_ruby_client/models/delete_user_api_key_request.rb +1 -1
  84. data/lib/trieve_ruby_client/models/edit_message_data.rb +1 -1
  85. data/lib/trieve_ruby_client/models/error_response_body.rb +1 -1
  86. data/lib/trieve_ruby_client/models/event.rb +1 -1
  87. data/lib/trieve_ruby_client/models/event_return.rb +1 -1
  88. data/lib/trieve_ruby_client/models/field_condition.rb +1 -1
  89. data/lib/trieve_ruby_client/models/file.rb +1 -1
  90. data/lib/trieve_ruby_client/models/file_dto.rb +1 -1
  91. data/lib/trieve_ruby_client/models/generate_chunks_request.rb +1 -1
  92. data/lib/trieve_ruby_client/models/get_events_data.rb +2 -2
  93. data/lib/trieve_ruby_client/models/get_groups_for_chunks_data.rb +1 -1
  94. data/lib/trieve_ruby_client/models/group_data.rb +1 -1
  95. data/lib/trieve_ruby_client/models/group_score_chunk_dto.rb +12 -2
  96. data/lib/trieve_ruby_client/models/group_slim_chunks_dto.rb +239 -0
  97. data/lib/trieve_ruby_client/models/invitation_data.rb +1 -1
  98. data/lib/trieve_ruby_client/models/match_condition.rb +1 -1
  99. data/lib/trieve_ruby_client/models/message.rb +1 -1
  100. data/lib/trieve_ruby_client/models/organization.rb +1 -1
  101. data/lib/trieve_ruby_client/models/organization_usage_count.rb +1 -1
  102. data/lib/trieve_ruby_client/models/range.rb +5 -5
  103. data/lib/trieve_ruby_client/models/range_condition.rb +105 -0
  104. data/lib/trieve_ruby_client/models/reccomend_group_chunks_request.rb +17 -6
  105. data/lib/trieve_ruby_client/models/recommend_chunks_request.rb +17 -6
  106. data/lib/trieve_ruby_client/models/recommend_chunks_response_types.rb +105 -0
  107. data/lib/trieve_ruby_client/models/recommend_group_chunk_response_types.rb +105 -0
  108. data/lib/trieve_ruby_client/models/regenerate_message_data.rb +1 -1
  109. data/lib/trieve_ruby_client/models/return_queued_chunk.rb +1 -1
  110. data/lib/trieve_ruby_client/models/score_chunk_dto.rb +1 -1
  111. data/lib/trieve_ruby_client/models/score_slim_chunks.rb +239 -0
  112. data/lib/trieve_ruby_client/models/search_chunk_data.rb +24 -2
  113. data/lib/trieve_ruby_client/models/search_chunk_query_response_body.rb +1 -1
  114. data/lib/trieve_ruby_client/models/search_chunk_response_types.rb +105 -0
  115. data/lib/trieve_ruby_client/models/search_group_slim_chunks_result.rb +255 -0
  116. data/lib/trieve_ruby_client/models/search_groups_result.rb +1 -1
  117. data/lib/trieve_ruby_client/models/search_over_groups_data.rb +27 -5
  118. data/lib/trieve_ruby_client/models/search_over_groups_response_body.rb +1 -1
  119. data/lib/trieve_ruby_client/models/search_over_groups_response_types.rb +105 -0
  120. data/lib/trieve_ruby_client/models/search_over_groups_slim_chunks_response_body.rb +239 -0
  121. data/lib/trieve_ruby_client/models/search_slim_chunk_query_response_body.rb +239 -0
  122. data/lib/trieve_ruby_client/models/search_within_group_data.rb +24 -2
  123. data/lib/trieve_ruby_client/models/search_within_group_response_types.rb +105 -0
  124. data/lib/trieve_ruby_client/models/set_user_api_key_request.rb +1 -1
  125. data/lib/trieve_ruby_client/models/set_user_api_key_response.rb +1 -1
  126. data/lib/trieve_ruby_client/models/single_queued_chunk_response.rb +1 -1
  127. data/lib/trieve_ruby_client/models/{stripe_subscription.rb → slim_chunk_metadata.rb} +75 -57
  128. data/lib/trieve_ruby_client/models/slim_group.rb +1 -1
  129. data/lib/trieve_ruby_client/models/slim_user.rb +5 -41
  130. data/lib/trieve_ruby_client/models/stripe_plan.rb +1 -1
  131. data/lib/trieve_ruby_client/models/suggested_queries_request.rb +1 -1
  132. data/lib/trieve_ruby_client/models/suggested_queries_response.rb +1 -1
  133. data/lib/trieve_ruby_client/models/topic.rb +1 -1
  134. data/lib/trieve_ruby_client/models/update_chunk_by_tracking_id_data.rb +1 -1
  135. data/lib/trieve_ruby_client/models/update_chunk_data.rb +15 -2
  136. data/lib/trieve_ruby_client/models/update_chunk_group_data.rb +1 -1
  137. data/lib/trieve_ruby_client/models/update_dataset_request.rb +1 -1
  138. data/lib/trieve_ruby_client/models/update_group_by_tracking_id_data.rb +1 -1
  139. data/lib/trieve_ruby_client/models/update_organization_data.rb +1 -1
  140. data/lib/trieve_ruby_client/models/update_topic_data.rb +1 -1
  141. data/lib/trieve_ruby_client/models/update_user_data.rb +6 -39
  142. data/lib/trieve_ruby_client/models/upload_file_data.rb +1 -1
  143. data/lib/trieve_ruby_client/models/upload_file_result.rb +1 -1
  144. data/lib/trieve_ruby_client/models/user_organization.rb +1 -1
  145. data/lib/trieve_ruby_client/version.rb +2 -2
  146. data/lib/trieve_ruby_client.rb +13 -2
  147. data/openapi-generator.yaml +1 -1
  148. data/openapi.json +692 -335
  149. data/spec/api/auth_api_spec.rb +16 -18
  150. data/spec/api/chunk_api_spec.rb +30 -43
  151. data/spec/api/chunk_group_api_spec.rb +54 -33
  152. data/spec/api/dataset_api_spec.rb +19 -19
  153. data/spec/api/events_api_spec.rb +10 -10
  154. data/spec/api/file_api_spec.rb +15 -15
  155. data/spec/api/health_api_spec.rb +9 -7
  156. data/spec/api/invitation_api_spec.rb +9 -9
  157. data/spec/api/message_api_spec.rb +15 -15
  158. data/spec/api/organization_api_spec.rb +19 -19
  159. data/spec/api/stripe_api_spec.rb +15 -7
  160. data/spec/api/topic_api_spec.rb +15 -15
  161. data/spec/api/user_api_spec.rb +13 -13
  162. data/spec/models/add_chunk_to_group_data_spec.rb +8 -8
  163. data/spec/models/api_key_dto_spec.rb +8 -8
  164. data/spec/models/auth_query_spec.rb +1 -1
  165. data/spec/models/batch_queued_chunk_response_spec.rb +1 -1
  166. data/spec/models/bookmark_data_spec.rb +8 -8
  167. data/spec/models/bookmark_group_result_spec.rb +8 -8
  168. data/spec/models/chat_message_proxy_spec.rb +8 -8
  169. data/spec/models/chunk_data_spec.rb +1 -1
  170. data/spec/models/chunk_filter_spec.rb +8 -8
  171. data/spec/models/chunk_group_and_file_spec.rb +8 -8
  172. data/spec/models/chunk_group_spec.rb +8 -8
  173. data/spec/models/chunk_metadata_spec.rb +8 -8
  174. data/spec/models/chunk_metadata_with_file_data_spec.rb +8 -8
  175. data/spec/models/client_dataset_configuration_spec.rb +8 -8
  176. data/spec/models/create_chunk_data_spec.rb +11 -87
  177. data/spec/models/create_chunk_group_data_spec.rb +8 -8
  178. data/spec/models/create_dataset_request_spec.rb +8 -8
  179. data/spec/models/create_message_data_spec.rb +8 -8
  180. data/spec/models/create_organization_data_spec.rb +8 -8
  181. data/spec/models/create_topic_data_spec.rb +8 -8
  182. data/spec/models/dataset_and_usage_spec.rb +8 -8
  183. data/spec/models/dataset_dto_spec.rb +8 -8
  184. data/spec/models/dataset_spec.rb +8 -8
  185. data/spec/models/dataset_usage_count_spec.rb +8 -8
  186. data/spec/models/delete_dataset_request_spec.rb +8 -8
  187. data/spec/models/delete_topic_data_spec.rb +8 -8
  188. data/spec/models/delete_user_api_key_request_spec.rb +8 -8
  189. data/spec/models/edit_message_data_spec.rb +8 -8
  190. data/spec/models/error_response_body_spec.rb +8 -8
  191. data/spec/models/event_return_spec.rb +8 -8
  192. data/spec/models/event_spec.rb +8 -8
  193. data/spec/models/field_condition_spec.rb +8 -8
  194. data/spec/models/file_dto_spec.rb +8 -8
  195. data/spec/models/file_spec.rb +8 -8
  196. data/spec/models/generate_chunks_request_spec.rb +8 -8
  197. data/spec/models/get_events_data_spec.rb +1 -1
  198. data/spec/models/get_groups_for_chunks_data_spec.rb +8 -8
  199. data/spec/models/group_data_spec.rb +8 -8
  200. data/spec/models/group_score_chunk_dto_spec.rb +8 -8
  201. data/spec/models/group_slim_chunks_dto_spec.rb +42 -0
  202. data/spec/models/invitation_data_spec.rb +8 -8
  203. data/spec/models/match_condition_spec.rb +6 -6
  204. data/spec/models/message_spec.rb +8 -8
  205. data/spec/models/organization_spec.rb +8 -8
  206. data/spec/models/organization_usage_count_spec.rb +8 -8
  207. data/spec/models/range_condition_spec.rb +32 -0
  208. data/spec/models/range_spec.rb +8 -8
  209. data/spec/models/reccomend_group_chunks_request_spec.rb +8 -8
  210. data/spec/models/recommend_chunks_request_spec.rb +8 -8
  211. data/spec/models/recommend_chunks_response_types_spec.rb +32 -0
  212. data/spec/models/recommend_group_chunk_response_types_spec.rb +32 -0
  213. data/spec/models/regenerate_message_data_spec.rb +8 -8
  214. data/spec/models/return_queued_chunk_spec.rb +11 -21
  215. data/spec/models/score_chunk_dto_spec.rb +8 -8
  216. data/spec/models/score_slim_chunks_spec.rb +42 -0
  217. data/spec/models/search_chunk_data_spec.rb +8 -8
  218. data/spec/models/search_chunk_query_response_body_spec.rb +8 -8
  219. data/spec/models/search_chunk_response_types_spec.rb +32 -0
  220. data/spec/models/search_group_slim_chunks_result_spec.rb +48 -0
  221. data/spec/models/search_groups_result_spec.rb +8 -8
  222. data/spec/models/search_over_groups_data_spec.rb +8 -8
  223. data/spec/models/search_over_groups_response_body_spec.rb +8 -8
  224. data/spec/models/search_over_groups_response_types_spec.rb +32 -0
  225. data/spec/models/search_over_groups_slim_chunks_response_body_spec.rb +42 -0
  226. data/spec/models/search_slim_chunk_query_response_body_spec.rb +42 -0
  227. data/spec/models/search_within_group_data_spec.rb +8 -8
  228. data/spec/models/search_within_group_response_types_spec.rb +32 -0
  229. data/spec/models/set_user_api_key_request_spec.rb +8 -8
  230. data/spec/models/set_user_api_key_response_spec.rb +8 -8
  231. data/spec/models/single_queued_chunk_response_spec.rb +1 -1
  232. data/spec/models/{stripe_subscription_spec.rb → slim_chunk_metadata_spec.rb} +33 -15
  233. data/spec/models/slim_group_spec.rb +8 -8
  234. data/spec/models/slim_user_spec.rb +8 -8
  235. data/spec/models/stripe_plan_spec.rb +8 -8
  236. data/spec/models/suggested_queries_request_spec.rb +8 -8
  237. data/spec/models/suggested_queries_response_spec.rb +8 -8
  238. data/spec/models/topic_spec.rb +8 -8
  239. data/spec/models/update_chunk_by_tracking_id_data_spec.rb +20 -8
  240. data/spec/models/update_chunk_data_spec.rb +20 -8
  241. data/spec/models/update_chunk_group_data_spec.rb +14 -8
  242. data/spec/models/update_dataset_request_spec.rb +8 -8
  243. data/spec/models/update_group_by_tracking_id_data_spec.rb +8 -8
  244. data/spec/models/update_organization_data_spec.rb +8 -8
  245. data/spec/models/update_topic_data_spec.rb +8 -8
  246. data/spec/models/update_user_data_spec.rb +8 -8
  247. data/spec/models/upload_file_data_spec.rb +8 -8
  248. data/spec/models/upload_file_result_spec.rb +8 -8
  249. data/spec/models/user_organization_spec.rb +8 -8
  250. data/spec/spec_helper.rb +1 -1
  251. data/trieve_ruby_client-0.5.0.gem +0 -0
  252. data/trieve_ruby_client.gemspec +1 -1
  253. metadata +52 -7
  254. data/docs/StripeSubscription.md +0 -30
  255. data/trieve_ruby_client-0.3.5.gem +0 -0
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 428109731fb106d9fb3729b1d014c1791762e06e6ab980105e985def7887983c
4
- data.tar.gz: 522971264c88fac99b1f3d71091fc069a6295db96d9214d2d27f5fba9d39a4a1
3
+ metadata.gz: 18478b254543ca42dcece001a1e8993304e962dca71bd8ecd9a9ff2565f6848d
4
+ data.tar.gz: bcd91779a266e6c098011f911d1bb4455f9d17abbc2772d2988ce8a0aaa5f0b3
5
5
  SHA512:
6
- metadata.gz: 2206deffff5229fbd5a7c27277055365ad77d12408e7159c595ae4a23decba33b693d626e7c4e7dccfd216f4097b9efc56eb5612bdd4d1043a17be5487d80f54
7
- data.tar.gz: d6a29402668fadb5bfd7aed3988264487a94c80d24f1e5aaee5d24129fb0b64566d6d05ad4ad9eae4ab952e57b64f6afabc90ef2254a3cca45bcbd42e6c06901
6
+ metadata.gz: bc80bd7b9875a1efc352842c6069e5c240c70df26360725f93ce0ca317af4f0097fbffbcd5e93130e21d988287485e468f59eba030d9d2099b8bcf29e141c144
7
+ data.tar.gz: 4865cc754d50322018810aed7cb5a9d6b0f331e6aa40f7d4aab0f903b598cc51b022634aed8640227e06938cd29d1feb4caf333f673c741cbbd2a3ce22f32705
@@ -0,0 +1 @@
1
+ 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.4.0
10
- - Package version: 0.4.0
9
+ - API version: 0.5.7
10
+ - Package version: 0.5.7
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.4.0.gem
28
+ gem install ./trieve_ruby_client-0.5.7.gem
29
29
  ```
30
30
 
31
- (for development, run `gem install --dev ./trieve_ruby_client-0.4.0.gem` to install the development dependencies)
31
+ (for development, run `gem install --dev ./trieve_ruby_client-0.5.7.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.4.0'
37
+ gem 'trieve_ruby_client', '~> 0.5.7'
38
38
 
39
39
  ### Install from Git
40
40
 
@@ -72,7 +72,7 @@ end
72
72
 
73
73
  ## Documentation for API Endpoints
74
74
 
75
- All URIs are relative to *http://localhost:8090*
75
+ All URIs are relative to *https://api.trieve.ai*
76
76
 
77
77
  Class | Method | HTTP request | Description
78
78
  ------------ | ------------- | ------------- | -------------
@@ -80,24 +80,24 @@ Class | Method | HTTP request | Description
80
80
  *TrieveRubyClient::AuthApi* | [**get_me**](docs/AuthApi.md#get_me) | **GET** /api/auth/me | Get Me
81
81
  *TrieveRubyClient::AuthApi* | [**login**](docs/AuthApi.md#login) | **GET** /api/auth | Login
82
82
  *TrieveRubyClient::AuthApi* | [**logout**](docs/AuthApi.md#logout) | **DELETE** /api/auth | Logout
83
- *TrieveRubyClient::ChunkApi* | [**create_chunk**](docs/ChunkApi.md#create_chunk) | **POST** /api/chunk | Create Chunk
83
+ *TrieveRubyClient::ChunkApi* | [**create_chunk**](docs/ChunkApi.md#create_chunk) | **POST** /api/chunk | Create or Upsert Chunk or Chunks
84
84
  *TrieveRubyClient::ChunkApi* | [**create_suggested_queries_handler**](docs/ChunkApi.md#create_suggested_queries_handler) | **POST** /api/chunk/gen_suggestions | Generate suggested queries
85
- *TrieveRubyClient::ChunkApi* | [**delete_chunk**](docs/ChunkApi.md#delete_chunk) | **DELETE** /api/chunk/{tracking_or_chunk}/{chunk_id} | Delete Chunk
85
+ *TrieveRubyClient::ChunkApi* | [**delete_chunk**](docs/ChunkApi.md#delete_chunk) | **DELETE** /api/chunk/{chunk_id} | Delete Chunk
86
86
  *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
87
- *TrieveRubyClient::ChunkApi* | [**generate_off_chunks**](docs/ChunkApi.md#generate_off_chunks) | **POST** /api/chunk/generate | RAG on User Defined Chunks
88
- *TrieveRubyClient::ChunkApi* | [**get_chunk_by_id**](docs/ChunkApi.md#get_chunk_by_id) | **GET** /api/chunk/{tracking_or_chunk}/{chunk_id} | Get Chunk By Id
87
+ *TrieveRubyClient::ChunkApi* | [**generate_off_chunks**](docs/ChunkApi.md#generate_off_chunks) | **POST** /api/chunk/generate | RAG on Specified Chunks
88
+ *TrieveRubyClient::ChunkApi* | [**get_chunk_by_id**](docs/ChunkApi.md#get_chunk_by_id) | **GET** /api/chunk/{chunk_id} | Get Chunk By Id
89
89
  *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
90
  *TrieveRubyClient::ChunkApi* | [**get_recommended_chunks**](docs/ChunkApi.md#get_recommended_chunks) | **POST** /api/chunk/recommend | Get Recommended Chunks
91
91
  *TrieveRubyClient::ChunkApi* | [**search_chunk**](docs/ChunkApi.md#search_chunk) | **POST** /api/chunk/search | Search
92
- *TrieveRubyClient::ChunkApi* | [**update_chunk**](docs/ChunkApi.md#update_chunk) | **PUT** /api/chunk/update | Update Chunk
92
+ *TrieveRubyClient::ChunkApi* | [**update_chunk**](docs/ChunkApi.md#update_chunk) | **PUT** /api/chunk | Update Chunk
93
93
  *TrieveRubyClient::ChunkApi* | [**update_chunk_by_tracking_id**](docs/ChunkApi.md#update_chunk_by_tracking_id) | **PUT** /api/chunk/tracking_id/update | Update Chunk By Tracking Id
94
94
  *TrieveRubyClient::ChunkGroupApi* | [**add_chunk_to_group**](docs/ChunkGroupApi.md#add_chunk_to_group) | **POST** /api/chunk_group/chunk/{group_id} | Add Chunk to Group
95
95
  *TrieveRubyClient::ChunkGroupApi* | [**add_chunk_to_group_by_tracking_id**](docs/ChunkGroupApi.md#add_chunk_to_group_by_tracking_id) | **POST** /api/chunk_group/tracking_id/{tracking_id} | Add Chunk to Group by Tracking ID
96
96
  *TrieveRubyClient::ChunkGroupApi* | [**create_chunk_group**](docs/ChunkGroupApi.md#create_chunk_group) | **POST** /api/chunk_group | Create Chunk Group
97
- *TrieveRubyClient::ChunkGroupApi* | [**delete_chunk_group**](docs/ChunkGroupApi.md#delete_chunk_group) | **DELETE** /api/chunk_group/{tracking_or_chunk}/{group_id} | Delete Group
97
+ *TrieveRubyClient::ChunkGroupApi* | [**delete_chunk_group**](docs/ChunkGroupApi.md#delete_chunk_group) | **DELETE** /api/chunk_group/{group_id} | Delete Group
98
98
  *TrieveRubyClient::ChunkGroupApi* | [**delete_group_by_tracking_id**](docs/ChunkGroupApi.md#delete_group_by_tracking_id) | **DELETE** /api/chunk_group/tracking_id/{tracking_id} | Delete Group by Tracking ID
99
- *TrieveRubyClient::ChunkGroupApi* | [**get_chunk_group**](docs/ChunkGroupApi.md#get_chunk_group) | **GET** /api/chunk_group/{tracking_or_chunk}/{group_id} | Get Group
100
- *TrieveRubyClient::ChunkGroupApi* | [**get_chunks_in_group**](docs/ChunkGroupApi.md#get_chunks_in_group) | **GET** /api/chunk_group/{tracking_or_chunk}/{group_id}/{page} | Get Chunks in Group
99
+ *TrieveRubyClient::ChunkGroupApi* | [**get_chunk_group**](docs/ChunkGroupApi.md#get_chunk_group) | **GET** /api/chunk_group/{group_id} | Get Group
100
+ *TrieveRubyClient::ChunkGroupApi* | [**get_chunks_in_group**](docs/ChunkGroupApi.md#get_chunks_in_group) | **GET** /api/chunk_group/{group_id}/{page} | Get Chunks in Group
101
101
  *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
102
102
  *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
103
103
  *TrieveRubyClient::ChunkGroupApi* | [**get_groups_chunk_is_in**](docs/ChunkGroupApi.md#get_groups_chunk_is_in) | **POST** /api/chunk_group/chunks | Get Groups for Chunks
@@ -109,7 +109,7 @@ Class | Method | HTTP request | Description
109
109
  *TrieveRubyClient::ChunkGroupApi* | [**update_chunk_group**](docs/ChunkGroupApi.md#update_chunk_group) | **PUT** /api/chunk_group | Update Group
110
110
  *TrieveRubyClient::ChunkGroupApi* | [**update_group_by_tracking_id**](docs/ChunkGroupApi.md#update_group_by_tracking_id) | **PUT** /api/chunk_group/tracking_id/{tracking_id} | Update Group by Tracking ID
111
111
  *TrieveRubyClient::DatasetApi* | [**create_dataset**](docs/DatasetApi.md#create_dataset) | **POST** /api/dataset | Create dataset
112
- *TrieveRubyClient::DatasetApi* | [**delete_dataset**](docs/DatasetApi.md#delete_dataset) | **DELETE** /api/dataset | Delete Dataset
112
+ *TrieveRubyClient::DatasetApi* | [**delete_dataset**](docs/DatasetApi.md#delete_dataset) | **DELETE** /api/dataset/{dataset_id} | Delete Dataset
113
113
  *TrieveRubyClient::DatasetApi* | [**get_client_dataset_config**](docs/DatasetApi.md#get_client_dataset_config) | **GET** /api/dataset/envs | Get Client Configuration
114
114
  *TrieveRubyClient::DatasetApi* | [**get_dataset**](docs/DatasetApi.md#get_dataset) | **GET** /api/dataset/{dataset_id} | Get Dataset
115
115
  *TrieveRubyClient::DatasetApi* | [**get_datasets_from_organization**](docs/DatasetApi.md#get_datasets_from_organization) | **GET** /api/dataset/organization/{organization_id} | Get Datasets from Organization
@@ -136,10 +136,10 @@ Class | Method | HTTP request | Description
136
136
  *TrieveRubyClient::StripeApi* | [**get_all_plans**](docs/StripeApi.md#get_all_plans) | **GET** /api/stripe/plans | Get All Plans
137
137
  *TrieveRubyClient::StripeApi* | [**update_subscription_plan**](docs/StripeApi.md#update_subscription_plan) | **PATCH** /api/stripe/subscription_plan/{subscription_id}/{plan_id} | Update Subscription Plan
138
138
  *TrieveRubyClient::TopicApi* | [**create_topic**](docs/TopicApi.md#create_topic) | **POST** /api/topic | Create Topic
139
- *TrieveRubyClient::TopicApi* | [**delete_topic**](docs/TopicApi.md#delete_topic) | **DELETE** /api/topic | Delete Topic
139
+ *TrieveRubyClient::TopicApi* | [**delete_topic**](docs/TopicApi.md#delete_topic) | **DELETE** /api/topic/{topic_id} | Delete Topic
140
140
  *TrieveRubyClient::TopicApi* | [**get_all_topics_for_user**](docs/TopicApi.md#get_all_topics_for_user) | **GET** /api/topic/user/{user_id} | Get All Topics for User
141
141
  *TrieveRubyClient::TopicApi* | [**update_topic**](docs/TopicApi.md#update_topic) | **PUT** /api/topic | Update Topic
142
- *TrieveRubyClient::UserApi* | [**delete_user_api_key**](docs/UserApi.md#delete_user_api_key) | **DELETE** /api/user/delete_api_key | Delete User Api Key
142
+ *TrieveRubyClient::UserApi* | [**delete_user_api_key**](docs/UserApi.md#delete_user_api_key) | **DELETE** /api/user/delete_api_key/{api_key_id} | Delete User Api Key
143
143
  *TrieveRubyClient::UserApi* | [**set_user_api_key**](docs/UserApi.md#set_user_api_key) | **POST** /api/user/set_api_key | Set User Api Key
144
144
  *TrieveRubyClient::UserApi* | [**update_user**](docs/UserApi.md#update_user) | **PUT** /api/user | Update User
145
145
 
@@ -170,7 +170,6 @@ Class | Method | HTTP request | Description
170
170
  - [TrieveRubyClient::DatasetAndUsage](docs/DatasetAndUsage.md)
171
171
  - [TrieveRubyClient::DatasetDTO](docs/DatasetDTO.md)
172
172
  - [TrieveRubyClient::DatasetUsageCount](docs/DatasetUsageCount.md)
173
- - [TrieveRubyClient::DeleteDatasetRequest](docs/DeleteDatasetRequest.md)
174
173
  - [TrieveRubyClient::DeleteTopicData](docs/DeleteTopicData.md)
175
174
  - [TrieveRubyClient::DeleteUserApiKeyRequest](docs/DeleteUserApiKeyRequest.md)
176
175
  - [TrieveRubyClient::EditMessageData](docs/EditMessageData.md)
@@ -185,26 +184,38 @@ Class | Method | HTTP request | Description
185
184
  - [TrieveRubyClient::GetGroupsForChunksData](docs/GetGroupsForChunksData.md)
186
185
  - [TrieveRubyClient::GroupData](docs/GroupData.md)
187
186
  - [TrieveRubyClient::GroupScoreChunkDTO](docs/GroupScoreChunkDTO.md)
187
+ - [TrieveRubyClient::GroupSlimChunksDTO](docs/GroupSlimChunksDTO.md)
188
188
  - [TrieveRubyClient::InvitationData](docs/InvitationData.md)
189
189
  - [TrieveRubyClient::MatchCondition](docs/MatchCondition.md)
190
190
  - [TrieveRubyClient::Message](docs/Message.md)
191
191
  - [TrieveRubyClient::Organization](docs/Organization.md)
192
192
  - [TrieveRubyClient::OrganizationUsageCount](docs/OrganizationUsageCount.md)
193
193
  - [TrieveRubyClient::Range](docs/Range.md)
194
+ - [TrieveRubyClient::RangeCondition](docs/RangeCondition.md)
194
195
  - [TrieveRubyClient::ReccomendGroupChunksRequest](docs/ReccomendGroupChunksRequest.md)
195
196
  - [TrieveRubyClient::RecommendChunksRequest](docs/RecommendChunksRequest.md)
197
+ - [TrieveRubyClient::RecommendChunksResponseTypes](docs/RecommendChunksResponseTypes.md)
198
+ - [TrieveRubyClient::RecommendGroupChunkResponseTypes](docs/RecommendGroupChunkResponseTypes.md)
196
199
  - [TrieveRubyClient::RegenerateMessageData](docs/RegenerateMessageData.md)
197
200
  - [TrieveRubyClient::ReturnQueuedChunk](docs/ReturnQueuedChunk.md)
198
201
  - [TrieveRubyClient::ScoreChunkDTO](docs/ScoreChunkDTO.md)
202
+ - [TrieveRubyClient::ScoreSlimChunks](docs/ScoreSlimChunks.md)
199
203
  - [TrieveRubyClient::SearchChunkData](docs/SearchChunkData.md)
200
204
  - [TrieveRubyClient::SearchChunkQueryResponseBody](docs/SearchChunkQueryResponseBody.md)
205
+ - [TrieveRubyClient::SearchChunkResponseTypes](docs/SearchChunkResponseTypes.md)
206
+ - [TrieveRubyClient::SearchGroupSlimChunksResult](docs/SearchGroupSlimChunksResult.md)
201
207
  - [TrieveRubyClient::SearchGroupsResult](docs/SearchGroupsResult.md)
202
208
  - [TrieveRubyClient::SearchOverGroupsData](docs/SearchOverGroupsData.md)
203
209
  - [TrieveRubyClient::SearchOverGroupsResponseBody](docs/SearchOverGroupsResponseBody.md)
210
+ - [TrieveRubyClient::SearchOverGroupsResponseTypes](docs/SearchOverGroupsResponseTypes.md)
211
+ - [TrieveRubyClient::SearchOverGroupsSlimChunksResponseBody](docs/SearchOverGroupsSlimChunksResponseBody.md)
212
+ - [TrieveRubyClient::SearchSlimChunkQueryResponseBody](docs/SearchSlimChunkQueryResponseBody.md)
204
213
  - [TrieveRubyClient::SearchWithinGroupData](docs/SearchWithinGroupData.md)
214
+ - [TrieveRubyClient::SearchWithinGroupResponseTypes](docs/SearchWithinGroupResponseTypes.md)
205
215
  - [TrieveRubyClient::SetUserApiKeyRequest](docs/SetUserApiKeyRequest.md)
206
216
  - [TrieveRubyClient::SetUserApiKeyResponse](docs/SetUserApiKeyResponse.md)
207
217
  - [TrieveRubyClient::SingleQueuedChunkResponse](docs/SingleQueuedChunkResponse.md)
218
+ - [TrieveRubyClient::SlimChunkMetadata](docs/SlimChunkMetadata.md)
208
219
  - [TrieveRubyClient::SlimGroup](docs/SlimGroup.md)
209
220
  - [TrieveRubyClient::SlimUser](docs/SlimUser.md)
210
221
  - [TrieveRubyClient::StripePlan](docs/StripePlan.md)
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **chunk_id** | **String** | Id of the chunk to make a member of the group. Think of this as \"bookmark\"ing a chunk. | |
7
+ | **chunk_id** | **String** | Id of the chunk to make a member of the group. | |
8
8
 
9
9
  ## Example
10
10
 
data/docs/AuthApi.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # TrieveRubyClient::AuthApi
2
2
 
3
- All URIs are relative to *http://localhost:8090*
3
+ All URIs are relative to *https://api.trieve.ai*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
data/docs/ChunkApi.md CHANGED
@@ -1,19 +1,19 @@
1
1
  # TrieveRubyClient::ChunkApi
2
2
 
3
- All URIs are relative to *http://localhost:8090*
3
+ All URIs are relative to *https://api.trieve.ai*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
7
- | [**create_chunk**](ChunkApi.md#create_chunk) | **POST** /api/chunk | Create Chunk |
7
+ | [**create_chunk**](ChunkApi.md#create_chunk) | **POST** /api/chunk | Create or Upsert Chunk or Chunks |
8
8
  | [**create_suggested_queries_handler**](ChunkApi.md#create_suggested_queries_handler) | **POST** /api/chunk/gen_suggestions | Generate suggested queries |
9
- | [**delete_chunk**](ChunkApi.md#delete_chunk) | **DELETE** /api/chunk/{tracking_or_chunk}/{chunk_id} | Delete Chunk |
9
+ | [**delete_chunk**](ChunkApi.md#delete_chunk) | **DELETE** /api/chunk/{chunk_id} | Delete Chunk |
10
10
  | [**delete_chunk_by_tracking_id**](ChunkApi.md#delete_chunk_by_tracking_id) | **DELETE** /api/chunk/tracking_id/{tracking_id} | Delete Chunk By Tracking Id |
11
- | [**generate_off_chunks**](ChunkApi.md#generate_off_chunks) | **POST** /api/chunk/generate | RAG on User Defined Chunks |
12
- | [**get_chunk_by_id**](ChunkApi.md#get_chunk_by_id) | **GET** /api/chunk/{tracking_or_chunk}/{chunk_id} | Get Chunk By Id |
11
+ | [**generate_off_chunks**](ChunkApi.md#generate_off_chunks) | **POST** /api/chunk/generate | RAG on Specified Chunks |
12
+ | [**get_chunk_by_id**](ChunkApi.md#get_chunk_by_id) | **GET** /api/chunk/{chunk_id} | Get Chunk By Id |
13
13
  | [**get_chunk_by_tracking_id**](ChunkApi.md#get_chunk_by_tracking_id) | **GET** /api/chunk/tracking_id/{tracking_id} | Get Chunk By Tracking Id |
14
14
  | [**get_recommended_chunks**](ChunkApi.md#get_recommended_chunks) | **POST** /api/chunk/recommend | Get Recommended Chunks |
15
15
  | [**search_chunk**](ChunkApi.md#search_chunk) | **POST** /api/chunk/search | Search |
16
- | [**update_chunk**](ChunkApi.md#update_chunk) | **PUT** /api/chunk/update | Update Chunk |
16
+ | [**update_chunk**](ChunkApi.md#update_chunk) | **PUT** /api/chunk | Update Chunk |
17
17
  | [**update_chunk_by_tracking_id**](ChunkApi.md#update_chunk_by_tracking_id) | **PUT** /api/chunk/tracking_id/update | Update Chunk By Tracking Id |
18
18
 
19
19
 
@@ -21,9 +21,9 @@ All URIs are relative to *http://localhost:8090*
21
21
 
22
22
  > <ReturnQueuedChunk> create_chunk(tr_dataset, create_chunk_data)
23
23
 
24
- Create Chunk
24
+ Create or Upsert Chunk or Chunks
25
25
 
26
- Create Chunk Create a new chunk. If the chunk has the same tracking_id as an existing chunk, the request will fail. Once a chunk is created, it can be searched for using the search endpoint.
26
+ Create or Upsert Chunk or Chunks Create a new chunk. If the chunk has the same tracking_id as an existing chunk, the request will fail. Once a chunk is created, it can be searched for using the search endpoint.
27
27
 
28
28
  ### Examples
29
29
 
@@ -43,7 +43,7 @@ tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the reque
43
43
  create_chunk_data = nil # CreateChunkData | JSON request payload to create a new chunk (chunk)
44
44
 
45
45
  begin
46
- # Create Chunk
46
+ # Create or Upsert Chunk or Chunks
47
47
  result = api_instance.create_chunk(tr_dataset, create_chunk_data)
48
48
  p result
49
49
  rescue TrieveRubyClient::ApiError => e
@@ -59,7 +59,7 @@ This returns an Array which contains the response data, status code and headers.
59
59
 
60
60
  ```ruby
61
61
  begin
62
- # Create Chunk
62
+ # Create or Upsert Chunk or Chunks
63
63
  data, status_code, headers = api_instance.create_chunk_with_http_info(tr_dataset, create_chunk_data)
64
64
  p status_code # => 2xx
65
65
  p headers # => { ... }
@@ -165,7 +165,7 @@ end
165
165
 
166
166
  ## delete_chunk
167
167
 
168
- > delete_chunk(tr_dataset, tracking_or_chunk, chunk_id)
168
+ > delete_chunk(tr_dataset, chunk_id)
169
169
 
170
170
  Delete Chunk
171
171
 
@@ -186,12 +186,11 @@ end
186
186
 
187
187
  api_instance = TrieveRubyClient::ChunkApi.new
188
188
  tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
189
- tracking_or_chunk = 'tracking_or_chunk_example' # String | The type of id you are using to search for the chunk. This can be either 'chunk' or 'tracking_id'
190
- chunk_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Id of the chunk you want to fetch. This can be either the chunk_id or the tracking_id.
189
+ chunk_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Id of the chunk you want to fetch.
191
190
 
192
191
  begin
193
192
  # Delete Chunk
194
- api_instance.delete_chunk(tr_dataset, tracking_or_chunk, chunk_id)
193
+ api_instance.delete_chunk(tr_dataset, chunk_id)
195
194
  rescue TrieveRubyClient::ApiError => e
196
195
  puts "Error when calling ChunkApi->delete_chunk: #{e}"
197
196
  end
@@ -201,12 +200,12 @@ end
201
200
 
202
201
  This returns an Array which contains the response data (`nil` in this case), status code and headers.
203
202
 
204
- > <Array(nil, Integer, Hash)> delete_chunk_with_http_info(tr_dataset, tracking_or_chunk, chunk_id)
203
+ > <Array(nil, Integer, Hash)> delete_chunk_with_http_info(tr_dataset, chunk_id)
205
204
 
206
205
  ```ruby
207
206
  begin
208
207
  # Delete Chunk
209
- data, status_code, headers = api_instance.delete_chunk_with_http_info(tr_dataset, tracking_or_chunk, chunk_id)
208
+ data, status_code, headers = api_instance.delete_chunk_with_http_info(tr_dataset, chunk_id)
210
209
  p status_code # => 2xx
211
210
  p headers # => { ... }
212
211
  p data # => nil
@@ -220,8 +219,7 @@ end
220
219
  | Name | Type | Description | Notes |
221
220
  | ---- | ---- | ----------- | ----- |
222
221
  | **tr_dataset** | **String** | The dataset id to use for the request | |
223
- | **tracking_or_chunk** | **String** | The type of id you are using to search for the chunk. This can be either &#39;chunk&#39; or &#39;tracking_id&#39; | |
224
- | **chunk_id** | **String** | Id of the chunk you want to fetch. This can be either the chunk_id or the tracking_id. | |
222
+ | **chunk_id** | **String** | Id of the chunk you want to fetch. | |
225
223
 
226
224
  ### Return type
227
225
 
@@ -313,9 +311,9 @@ nil (empty response body)
313
311
 
314
312
  > String generate_off_chunks(tr_dataset, generate_chunks_request)
315
313
 
316
- RAG on User Defined Chunks
314
+ RAG on Specified Chunks
317
315
 
318
- RAG on User Defined Chunks This endpoint exists as an alternative to the topic+message concept where our API handles chat memory. With this endpoint, the user is responsible for providing the context window and the prompt. See more in the \"search before generate\" page at docs.trieve.ai.
316
+ RAG on Specified Chunks This endpoint exists as an alternative to the topic+message concept where our API handles chat memory. With this endpoint, the user is responsible for providing the context window and the prompt. See more in the \"search before generate\" page at docs.trieve.ai.
319
317
 
320
318
  ### Examples
321
319
 
@@ -335,7 +333,7 @@ tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the reque
335
333
  generate_chunks_request = TrieveRubyClient::GenerateChunksRequest.new({chunk_ids: ['chunk_ids_example'], prev_messages: [TrieveRubyClient::ChatMessageProxy.new({content: 'content_example', role: 'role_example'})]}) # GenerateChunksRequest | JSON request payload to perform RAG on some chunks (chunks)
336
334
 
337
335
  begin
338
- # RAG on User Defined Chunks
336
+ # RAG on Specified Chunks
339
337
  result = api_instance.generate_off_chunks(tr_dataset, generate_chunks_request)
340
338
  p result
341
339
  rescue TrieveRubyClient::ApiError => e
@@ -351,7 +349,7 @@ This returns an Array which contains the response data, status code and headers.
351
349
 
352
350
  ```ruby
353
351
  begin
354
- # RAG on User Defined Chunks
352
+ # RAG on Specified Chunks
355
353
  data, status_code, headers = api_instance.generate_off_chunks_with_http_info(tr_dataset, generate_chunks_request)
356
354
  p status_code # => 2xx
357
355
  p headers # => { ... }
@@ -384,7 +382,7 @@ end
384
382
 
385
383
  ## get_chunk_by_id
386
384
 
387
- > <ChunkMetadata> get_chunk_by_id(tr_dataset, tracking_or_chunk, chunk_id)
385
+ > <ChunkMetadata> get_chunk_by_id(tr_dataset, chunk_id)
388
386
 
389
387
  Get Chunk By Id
390
388
 
@@ -405,12 +403,11 @@ end
405
403
 
406
404
  api_instance = TrieveRubyClient::ChunkApi.new
407
405
  tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
408
- tracking_or_chunk = 'tracking_or_chunk_example' # String | The type of id you are using to search for the chunk. This can be either 'chunk' or 'tracking_id'
409
- chunk_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Id of the chunk you want to fetch. This can be either the chunk_id or the tracking_id.
406
+ chunk_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Id of the chunk you want to fetch.
410
407
 
411
408
  begin
412
409
  # Get Chunk By Id
413
- result = api_instance.get_chunk_by_id(tr_dataset, tracking_or_chunk, chunk_id)
410
+ result = api_instance.get_chunk_by_id(tr_dataset, chunk_id)
414
411
  p result
415
412
  rescue TrieveRubyClient::ApiError => e
416
413
  puts "Error when calling ChunkApi->get_chunk_by_id: #{e}"
@@ -421,12 +418,12 @@ end
421
418
 
422
419
  This returns an Array which contains the response data, status code and headers.
423
420
 
424
- > <Array(<ChunkMetadata>, Integer, Hash)> get_chunk_by_id_with_http_info(tr_dataset, tracking_or_chunk, chunk_id)
421
+ > <Array(<ChunkMetadata>, Integer, Hash)> get_chunk_by_id_with_http_info(tr_dataset, chunk_id)
425
422
 
426
423
  ```ruby
427
424
  begin
428
425
  # Get Chunk By Id
429
- data, status_code, headers = api_instance.get_chunk_by_id_with_http_info(tr_dataset, tracking_or_chunk, chunk_id)
426
+ data, status_code, headers = api_instance.get_chunk_by_id_with_http_info(tr_dataset, chunk_id)
430
427
  p status_code # => 2xx
431
428
  p headers # => { ... }
432
429
  p data # => <ChunkMetadata>
@@ -440,8 +437,7 @@ end
440
437
  | Name | Type | Description | Notes |
441
438
  | ---- | ---- | ----------- | ----- |
442
439
  | **tr_dataset** | **String** | The dataset id to use for the request | |
443
- | **tracking_or_chunk** | **String** | The type of id you are using to search for the chunk. This can be either &#39;chunk&#39; or &#39;tracking_id&#39; | |
444
- | **chunk_id** | **String** | Id of the chunk you want to fetch. This can be either the chunk_id or the tracking_id. | |
440
+ | **chunk_id** | **String** | Id of the chunk you want to fetch. | |
445
441
 
446
442
  ### Return type
447
443
 
@@ -532,7 +528,7 @@ end
532
528
 
533
529
  ## get_recommended_chunks
534
530
 
535
- > <Array<ChunkMetadataWithFileData>> get_recommended_chunks(tr_dataset, recommend_chunks_request)
531
+ > <RecommendChunksResponseTypes> get_recommended_chunks(tr_dataset, recommend_chunks_request)
536
532
 
537
533
  Get Recommended Chunks
538
534
 
@@ -568,7 +564,7 @@ end
568
564
 
569
565
  This returns an Array which contains the response data, status code and headers.
570
566
 
571
- > <Array(<Array<ChunkMetadataWithFileData>>, Integer, Hash)> get_recommended_chunks_with_http_info(tr_dataset, recommend_chunks_request)
567
+ > <Array(<RecommendChunksResponseTypes>, Integer, Hash)> get_recommended_chunks_with_http_info(tr_dataset, recommend_chunks_request)
572
568
 
573
569
  ```ruby
574
570
  begin
@@ -576,7 +572,7 @@ begin
576
572
  data, status_code, headers = api_instance.get_recommended_chunks_with_http_info(tr_dataset, recommend_chunks_request)
577
573
  p status_code # => 2xx
578
574
  p headers # => { ... }
579
- p data # => <Array<ChunkMetadataWithFileData>>
575
+ p data # => <RecommendChunksResponseTypes>
580
576
  rescue TrieveRubyClient::ApiError => e
581
577
  puts "Error when calling ChunkApi->get_recommended_chunks_with_http_info: #{e}"
582
578
  end
@@ -591,7 +587,7 @@ end
591
587
 
592
588
  ### Return type
593
589
 
594
- [**Array&lt;ChunkMetadataWithFileData&gt;**](ChunkMetadataWithFileData.md)
590
+ [**RecommendChunksResponseTypes**](RecommendChunksResponseTypes.md)
595
591
 
596
592
  ### Authorization
597
593
 
@@ -605,7 +601,7 @@ end
605
601
 
606
602
  ## search_chunk
607
603
 
608
- > <SearchChunkQueryResponseBody> search_chunk(tr_dataset, search_chunk_data)
604
+ > <SearchChunkResponseTypes> search_chunk(tr_dataset, search_chunk_data)
609
605
 
610
606
  Search
611
607
 
@@ -641,7 +637,7 @@ end
641
637
 
642
638
  This returns an Array which contains the response data, status code and headers.
643
639
 
644
- > <Array(<SearchChunkQueryResponseBody>, Integer, Hash)> search_chunk_with_http_info(tr_dataset, search_chunk_data)
640
+ > <Array(<SearchChunkResponseTypes>, Integer, Hash)> search_chunk_with_http_info(tr_dataset, search_chunk_data)
645
641
 
646
642
  ```ruby
647
643
  begin
@@ -649,7 +645,7 @@ begin
649
645
  data, status_code, headers = api_instance.search_chunk_with_http_info(tr_dataset, search_chunk_data)
650
646
  p status_code # => 2xx
651
647
  p headers # => { ... }
652
- p data # => <SearchChunkQueryResponseBody>
648
+ p data # => <SearchChunkResponseTypes>
653
649
  rescue TrieveRubyClient::ApiError => e
654
650
  puts "Error when calling ChunkApi->search_chunk_with_http_info: #{e}"
655
651
  end
@@ -664,7 +660,7 @@ end
664
660
 
665
661
  ### Return type
666
662
 
667
- [**SearchChunkQueryResponseBody**](SearchChunkQueryResponseBody.md)
663
+ [**SearchChunkResponseTypes**](SearchChunkResponseTypes.md)
668
664
 
669
665
  ### Authorization
670
666