trieve_ruby_client 0.3.4 → 0.4.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 (128) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +78 -81
  3. data/docs/AuthApi.md +29 -40
  4. data/docs/AuthQuery.md +22 -0
  5. data/docs/BatchQueuedChunkResponse.md +20 -0
  6. data/docs/ChunkApi.md +80 -214
  7. data/docs/ChunkData.md +42 -0
  8. data/docs/ChunkGroupApi.md +183 -174
  9. data/docs/CreateChunkData.md +41 -34
  10. data/docs/DatasetApi.md +37 -67
  11. data/docs/EventsApi.md +14 -19
  12. data/docs/FileApi.md +25 -45
  13. data/docs/GetEventsData.md +22 -0
  14. data/docs/HealthApi.md +6 -4
  15. data/docs/InvitationApi.md +7 -12
  16. data/docs/MessageApi.md +25 -45
  17. data/docs/OrganizationApi.md +37 -67
  18. data/docs/ReturnQueuedChunk.md +39 -10
  19. data/docs/SingleQueuedChunkResponse.md +20 -0
  20. data/docs/StripeApi.md +23 -25
  21. data/docs/TopicApi.md +25 -45
  22. data/docs/UserApi.md +19 -34
  23. data/lib/trieve_ruby_client/api/auth_api.rb +28 -35
  24. data/lib/trieve_ruby_client/api/chunk_api.rb +68 -143
  25. data/lib/trieve_ruby_client/api/chunk_group_api.rb +164 -76
  26. data/lib/trieve_ruby_client/api/dataset_api.rb +31 -31
  27. data/lib/trieve_ruby_client/api/events_api.rb +22 -17
  28. data/lib/trieve_ruby_client/api/file_api.rb +21 -21
  29. data/lib/trieve_ruby_client/api/health_api.rb +5 -1
  30. data/lib/trieve_ruby_client/api/invitation_api.rb +6 -6
  31. data/lib/trieve_ruby_client/api/message_api.rb +21 -21
  32. data/lib/trieve_ruby_client/api/organization_api.rb +31 -31
  33. data/lib/trieve_ruby_client/api/stripe_api.rb +19 -3
  34. data/lib/trieve_ruby_client/api/topic_api.rb +21 -21
  35. data/lib/trieve_ruby_client/api/user_api.rb +16 -16
  36. data/lib/trieve_ruby_client/api_client.rb +1 -1
  37. data/lib/trieve_ruby_client/api_error.rb +1 -1
  38. data/lib/trieve_ruby_client/configuration.rb +8 -11
  39. data/lib/trieve_ruby_client/models/add_chunk_to_group_data.rb +1 -1
  40. data/lib/trieve_ruby_client/models/api_key_dto.rb +1 -1
  41. data/lib/trieve_ruby_client/models/auth_query.rb +238 -0
  42. data/lib/trieve_ruby_client/models/batch_queued_chunk_response.rb +240 -0
  43. data/lib/trieve_ruby_client/models/bookmark_data.rb +1 -1
  44. data/lib/trieve_ruby_client/models/bookmark_group_result.rb +1 -1
  45. data/lib/trieve_ruby_client/models/chat_message_proxy.rb +1 -1
  46. data/lib/trieve_ruby_client/models/chunk_data.rb +356 -0
  47. data/lib/trieve_ruby_client/models/chunk_filter.rb +1 -1
  48. data/lib/trieve_ruby_client/models/chunk_group.rb +1 -1
  49. data/lib/trieve_ruby_client/models/chunk_group_and_file.rb +1 -1
  50. data/lib/trieve_ruby_client/models/chunk_metadata.rb +1 -1
  51. data/lib/trieve_ruby_client/models/chunk_metadata_with_file_data.rb +1 -1
  52. data/lib/trieve_ruby_client/models/client_dataset_configuration.rb +1 -1
  53. data/lib/trieve_ruby_client/models/create_chunk_data.rb +79 -330
  54. data/lib/trieve_ruby_client/models/create_chunk_group_data.rb +1 -1
  55. data/lib/trieve_ruby_client/models/create_dataset_request.rb +1 -1
  56. data/lib/trieve_ruby_client/models/create_message_data.rb +1 -1
  57. data/lib/trieve_ruby_client/models/create_organization_data.rb +1 -1
  58. data/lib/trieve_ruby_client/models/create_topic_data.rb +1 -1
  59. data/lib/trieve_ruby_client/models/dataset.rb +1 -1
  60. data/lib/trieve_ruby_client/models/dataset_and_usage.rb +1 -1
  61. data/lib/trieve_ruby_client/models/dataset_dto.rb +1 -1
  62. data/lib/trieve_ruby_client/models/dataset_usage_count.rb +1 -1
  63. data/lib/trieve_ruby_client/models/delete_dataset_request.rb +1 -1
  64. data/lib/trieve_ruby_client/models/delete_topic_data.rb +1 -1
  65. data/lib/trieve_ruby_client/models/delete_user_api_key_request.rb +1 -1
  66. data/lib/trieve_ruby_client/models/edit_message_data.rb +1 -1
  67. data/lib/trieve_ruby_client/models/error_response_body.rb +1 -1
  68. data/lib/trieve_ruby_client/models/event.rb +1 -1
  69. data/lib/trieve_ruby_client/models/event_return.rb +1 -1
  70. data/lib/trieve_ruby_client/models/field_condition.rb +1 -1
  71. data/lib/trieve_ruby_client/models/file.rb +1 -1
  72. data/lib/trieve_ruby_client/models/file_dto.rb +1 -1
  73. data/lib/trieve_ruby_client/models/generate_chunks_request.rb +1 -1
  74. data/lib/trieve_ruby_client/models/get_events_data.rb +240 -0
  75. data/lib/trieve_ruby_client/models/get_groups_for_chunks_data.rb +1 -1
  76. data/lib/trieve_ruby_client/models/group_data.rb +1 -1
  77. data/lib/trieve_ruby_client/models/group_score_chunk_dto.rb +1 -1
  78. data/lib/trieve_ruby_client/models/invitation_data.rb +1 -1
  79. data/lib/trieve_ruby_client/models/match_condition.rb +1 -1
  80. data/lib/trieve_ruby_client/models/message.rb +1 -1
  81. data/lib/trieve_ruby_client/models/organization.rb +1 -1
  82. data/lib/trieve_ruby_client/models/organization_usage_count.rb +1 -1
  83. data/lib/trieve_ruby_client/models/range.rb +1 -1
  84. data/lib/trieve_ruby_client/models/reccomend_group_chunks_request.rb +1 -1
  85. data/lib/trieve_ruby_client/models/recommend_chunks_request.rb +1 -1
  86. data/lib/trieve_ruby_client/models/regenerate_message_data.rb +1 -1
  87. data/lib/trieve_ruby_client/models/return_queued_chunk.rb +75 -207
  88. data/lib/trieve_ruby_client/models/score_chunk_dto.rb +1 -1
  89. data/lib/trieve_ruby_client/models/search_chunk_data.rb +1 -1
  90. data/lib/trieve_ruby_client/models/search_chunk_query_response_body.rb +1 -1
  91. data/lib/trieve_ruby_client/models/search_groups_result.rb +1 -1
  92. data/lib/trieve_ruby_client/models/search_over_groups_data.rb +1 -1
  93. data/lib/trieve_ruby_client/models/search_over_groups_response_body.rb +1 -1
  94. data/lib/trieve_ruby_client/models/search_within_group_data.rb +1 -1
  95. data/lib/trieve_ruby_client/models/set_user_api_key_request.rb +1 -1
  96. data/lib/trieve_ruby_client/models/set_user_api_key_response.rb +1 -1
  97. data/lib/trieve_ruby_client/models/single_queued_chunk_response.rb +238 -0
  98. data/lib/trieve_ruby_client/models/slim_group.rb +1 -1
  99. data/lib/trieve_ruby_client/models/slim_user.rb +1 -1
  100. data/lib/trieve_ruby_client/models/stripe_plan.rb +1 -1
  101. data/lib/trieve_ruby_client/models/stripe_subscription.rb +1 -1
  102. data/lib/trieve_ruby_client/models/suggested_queries_request.rb +1 -1
  103. data/lib/trieve_ruby_client/models/suggested_queries_response.rb +1 -1
  104. data/lib/trieve_ruby_client/models/topic.rb +1 -1
  105. data/lib/trieve_ruby_client/models/update_chunk_by_tracking_id_data.rb +1 -1
  106. data/lib/trieve_ruby_client/models/update_chunk_data.rb +1 -1
  107. data/lib/trieve_ruby_client/models/update_chunk_group_data.rb +1 -1
  108. data/lib/trieve_ruby_client/models/update_dataset_request.rb +1 -1
  109. data/lib/trieve_ruby_client/models/update_group_by_tracking_id_data.rb +1 -1
  110. data/lib/trieve_ruby_client/models/update_organization_data.rb +1 -1
  111. data/lib/trieve_ruby_client/models/update_topic_data.rb +1 -1
  112. data/lib/trieve_ruby_client/models/update_user_data.rb +1 -1
  113. data/lib/trieve_ruby_client/models/upload_file_data.rb +1 -1
  114. data/lib/trieve_ruby_client/models/upload_file_result.rb +1 -1
  115. data/lib/trieve_ruby_client/models/user_organization.rb +1 -1
  116. data/lib/trieve_ruby_client/version.rb +2 -2
  117. data/lib/trieve_ruby_client.rb +6 -2
  118. data/openapi-generator.yaml +2 -2
  119. data/openapi.json +1280 -876
  120. data/spec/models/auth_query_spec.rb +48 -0
  121. data/spec/models/batch_queued_chunk_response_spec.rb +42 -0
  122. data/spec/models/chunk_data_spec.rb +108 -0
  123. data/spec/models/get_events_data_spec.rb +48 -0
  124. data/spec/models/single_queued_chunk_response_spec.rb +42 -0
  125. data/spec/spec_helper.rb +1 -1
  126. data/trieve_ruby_client-0.3.5.gem +0 -0
  127. data/trieve_ruby_client.gemspec +2 -2
  128. metadata +25 -3
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
5
5
 
6
- The version of the OpenAPI document: 0.3.4
6
+ The version of the OpenAPI document: 0.4.0
7
7
  Contact: developers@trieve.ai
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.4.0
@@ -19,8 +19,8 @@ module TrieveRubyClient
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
- # add_chunk_to_group
23
- # add_chunk_to_group Route to add a chunk to a group
22
+ # Add Chunk to Group
23
+ # Add Chunk to Group Route to add a chunk to a group
24
24
  # @param tr_dataset [String] The dataset id to use for the request
25
25
  # @param group_id [String] Id of the group to add the chunk to as a bookmark
26
26
  # @param add_chunk_to_group_data [AddChunkToGroupData] JSON request payload to add a chunk to a group (bookmark it)
@@ -31,8 +31,8 @@ module TrieveRubyClient
31
31
  nil
32
32
  end
33
33
 
34
- # add_chunk_to_group
35
- # add_chunk_to_group Route to add a chunk to a group
34
+ # Add Chunk to Group
35
+ # Add Chunk to Group Route to add a chunk to a group
36
36
  # @param tr_dataset [String] The dataset id to use for the request
37
37
  # @param group_id [String] Id of the group to add the chunk to as a bookmark
38
38
  # @param add_chunk_to_group_data [AddChunkToGroupData] JSON request payload to add a chunk to a group (bookmark it)
@@ -81,7 +81,7 @@ module TrieveRubyClient
81
81
  return_type = opts[:debug_return_type]
82
82
 
83
83
  # auth_names
84
- auth_names = opts[:debug_auth_names] || ['Cookie', 'ApiKey']
84
+ auth_names = opts[:debug_auth_names] || ['ApiKey']
85
85
 
86
86
  new_options = opts.merge(
87
87
  :operation => :"ChunkGroupApi.add_chunk_to_group",
@@ -100,8 +100,8 @@ module TrieveRubyClient
100
100
  return data, status_code, headers
101
101
  end
102
102
 
103
- # add_chunk_to_group_by_tracking_id
104
- # add_chunk_to_group_by_tracking_id Route to add a chunk to a group by tracking id. Think of a bookmark as a chunk which is a member of a group.
103
+ # Add Chunk to Group by Tracking ID
104
+ # Add Chunk to Group by Tracking ID Route to add a chunk to a group by tracking id. Think of a bookmark as a chunk which is a member of a group.
105
105
  # @param tr_dataset [String] The dataset id to use for the request
106
106
  # @param tracking_id [String] Id of the group to add the chunk to as a bookmark
107
107
  # @param add_chunk_to_group_data [AddChunkToGroupData] JSON request payload to add a chunk to a group (bookmark it)
@@ -112,8 +112,8 @@ module TrieveRubyClient
112
112
  nil
113
113
  end
114
114
 
115
- # add_chunk_to_group_by_tracking_id
116
- # add_chunk_to_group_by_tracking_id Route to add a chunk to a group by tracking id. Think of a bookmark as a chunk which is a member of a group.
115
+ # Add Chunk to Group by Tracking ID
116
+ # Add Chunk to Group by Tracking ID Route to add a chunk to a group by tracking id. Think of a bookmark as a chunk which is a member of a group.
117
117
  # @param tr_dataset [String] The dataset id to use for the request
118
118
  # @param tracking_id [String] Id of the group to add the chunk to as a bookmark
119
119
  # @param add_chunk_to_group_data [AddChunkToGroupData] JSON request payload to add a chunk to a group (bookmark it)
@@ -162,7 +162,7 @@ module TrieveRubyClient
162
162
  return_type = opts[:debug_return_type]
163
163
 
164
164
  # auth_names
165
- auth_names = opts[:debug_auth_names] || ['Cookie', 'ApiKey']
165
+ auth_names = opts[:debug_auth_names] || ['ApiKey']
166
166
 
167
167
  new_options = opts.merge(
168
168
  :operation => :"ChunkGroupApi.add_chunk_to_group_by_tracking_id",
@@ -181,8 +181,8 @@ module TrieveRubyClient
181
181
  return data, status_code, headers
182
182
  end
183
183
 
184
- # create_chunk_group
185
- # create_chunk_group Create a new chunk_group.
184
+ # Create Chunk Group
185
+ # Create Chunk Group Create a new chunk_group.
186
186
  # @param tr_dataset [String] The dataset id to use for the request
187
187
  # @param create_chunk_group_data [CreateChunkGroupData] JSON request payload to cretea a chunkGroup
188
188
  # @param [Hash] opts the optional parameters
@@ -192,8 +192,8 @@ module TrieveRubyClient
192
192
  data
193
193
  end
194
194
 
195
- # create_chunk_group
196
- # create_chunk_group Create a new chunk_group.
195
+ # Create Chunk Group
196
+ # Create Chunk Group Create a new chunk_group.
197
197
  # @param tr_dataset [String] The dataset id to use for the request
198
198
  # @param create_chunk_group_data [CreateChunkGroupData] JSON request payload to cretea a chunkGroup
199
199
  # @param [Hash] opts the optional parameters
@@ -237,7 +237,7 @@ module TrieveRubyClient
237
237
  return_type = opts[:debug_return_type] || 'ChunkGroup'
238
238
 
239
239
  # auth_names
240
- auth_names = opts[:debug_auth_names] || ['Cookie', 'ApiKey']
240
+ auth_names = opts[:debug_auth_names] || ['ApiKey']
241
241
 
242
242
  new_options = opts.merge(
243
243
  :operation => :"ChunkGroupApi.create_chunk_group",
@@ -256,28 +256,28 @@ module TrieveRubyClient
256
256
  return data, status_code, headers
257
257
  end
258
258
 
259
- # delete_chunk_group
260
- # delete_chunk_group This will delete a chunk_group. This will not delete the chunks that are in the group. We will soon support deleting a chunk_group along with its member chunks.
259
+ # Delete Group
260
+ # Delete Group This will delete a chunk_group. This will not delete the chunks that are in the group. We will soon support deleting a chunk_group along with its member chunks.
261
261
  # @param tr_dataset [String] The dataset id to use for the request
262
- # @param group_id [Uuid] Id of the group you want to fetch. This can be either the group_id or the tracking_id. If both are provided, the group_id will be used.
263
262
  # @param tracking_or_chunk [String] The type of id you are using to search for the group. This can be either 'chunk' or 'tracking_id'
263
+ # @param group_id [String] Id of the group you want to fetch. This can be either the group_id or the tracking_id. If both are provided, the group_id will be used.
264
264
  # @param delete_chunks [Boolean] Delete the chunks within the group
265
265
  # @param [Hash] opts the optional parameters
266
266
  # @return [nil]
267
- def delete_chunk_group(tr_dataset, group_id, tracking_or_chunk, delete_chunks, opts = {})
268
- delete_chunk_group_with_http_info(tr_dataset, group_id, tracking_or_chunk, delete_chunks, opts)
267
+ def delete_chunk_group(tr_dataset, tracking_or_chunk, group_id, delete_chunks, opts = {})
268
+ delete_chunk_group_with_http_info(tr_dataset, tracking_or_chunk, group_id, delete_chunks, opts)
269
269
  nil
270
270
  end
271
271
 
272
- # delete_chunk_group
273
- # delete_chunk_group This will delete a chunk_group. This will not delete the chunks that are in the group. We will soon support deleting a chunk_group along with its member chunks.
272
+ # Delete Group
273
+ # Delete Group This will delete a chunk_group. This will not delete the chunks that are in the group. We will soon support deleting a chunk_group along with its member chunks.
274
274
  # @param tr_dataset [String] The dataset id to use for the request
275
- # @param group_id [Uuid] Id of the group you want to fetch. This can be either the group_id or the tracking_id. If both are provided, the group_id will be used.
276
275
  # @param tracking_or_chunk [String] The type of id you are using to search for the group. This can be either 'chunk' or 'tracking_id'
276
+ # @param group_id [String] Id of the group you want to fetch. This can be either the group_id or the tracking_id. If both are provided, the group_id will be used.
277
277
  # @param delete_chunks [Boolean] Delete the chunks within the group
278
278
  # @param [Hash] opts the optional parameters
279
279
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
280
- def delete_chunk_group_with_http_info(tr_dataset, group_id, tracking_or_chunk, delete_chunks, opts = {})
280
+ def delete_chunk_group_with_http_info(tr_dataset, tracking_or_chunk, group_id, delete_chunks, opts = {})
281
281
  if @api_client.config.debugging
282
282
  @api_client.config.logger.debug 'Calling API: ChunkGroupApi.delete_chunk_group ...'
283
283
  end
@@ -294,7 +294,7 @@ module TrieveRubyClient
294
294
  fail ArgumentError, "Missing the required parameter 'delete_chunks' when calling ChunkGroupApi.delete_chunk_group"
295
295
  end
296
296
  # resource path
297
- local_var_path = '/api/{tracking_or_chunk}/{group_id}'.sub('{' + 'group_id' + '}', CGI.escape(group_id.to_s)).sub('{' + 'tracking_or_chunk' + '}', CGI.escape(tracking_or_chunk.to_s))
297
+ local_var_path = '/api/chunk_group/{tracking_or_chunk}/{group_id}'.sub('{' + 'tracking_or_chunk' + '}', CGI.escape(tracking_or_chunk.to_s)).sub('{' + 'group_id' + '}', CGI.escape(group_id.to_s))
298
298
 
299
299
  # query parameters
300
300
  query_params = opts[:query_params] || {}
@@ -316,7 +316,7 @@ module TrieveRubyClient
316
316
  return_type = opts[:debug_return_type]
317
317
 
318
318
  # auth_names
319
- auth_names = opts[:debug_auth_names] || ['Cookie', 'ApiKey']
319
+ auth_names = opts[:debug_auth_names] || ['ApiKey']
320
320
 
321
321
  new_options = opts.merge(
322
322
  :operation => :"ChunkGroupApi.delete_chunk_group",
@@ -335,6 +335,8 @@ module TrieveRubyClient
335
335
  return data, status_code, headers
336
336
  end
337
337
 
338
+ # Delete Group by Tracking ID
339
+ # Delete Group by Tracking ID Delete a chunk_group with the given tracking id.
338
340
  # @param tr_dataset [String] The dataset id to use for the request
339
341
  # @param tracking_id [String] Tracking id of the chunk_group to delete
340
342
  # @param [Hash] opts the optional parameters
@@ -344,6 +346,8 @@ module TrieveRubyClient
344
346
  nil
345
347
  end
346
348
 
349
+ # Delete Group by Tracking ID
350
+ # Delete Group by Tracking ID Delete a chunk_group with the given tracking id.
347
351
  # @param tr_dataset [String] The dataset id to use for the request
348
352
  # @param tracking_id [String] Tracking id of the chunk_group to delete
349
353
  # @param [Hash] opts the optional parameters
@@ -382,7 +386,7 @@ module TrieveRubyClient
382
386
  return_type = opts[:debug_return_type]
383
387
 
384
388
  # auth_names
385
- auth_names = opts[:debug_auth_names] || ['Cookie', 'ApiKey']
389
+ auth_names = opts[:debug_auth_names] || ['ApiKey']
386
390
 
387
391
  new_options = opts.merge(
388
392
  :operation => :"ChunkGroupApi.delete_group_by_tracking_id",
@@ -401,28 +405,100 @@ module TrieveRubyClient
401
405
  return data, status_code, headers
402
406
  end
403
407
 
404
- # get_chunks_in_group
405
- # get_chunks_in_group Route to get all chunks for a group. The response is paginated, with each page containing 10 chunks. Support for custom page size is coming soon.
408
+ # Get Group
409
+ # Get Group Fetch the group with the given id. get_group
406
410
  # @param tr_dataset [String] The dataset id to use for the request
407
- # @param group_id [Uuid] Id of the group you want to fetch. This can be either the group_id or the tracking_id. If both are provided, the group_id will be used.
408
411
  # @param tracking_or_chunk [String] The type of id you are using to search for the group. This can be either &#39;chunk&#39; or &#39;tracking_id&#39;
412
+ # @param group_id [String] Id of the group you want to fetch. This can be either the group_id or the tracking_id.
413
+ # @param [Hash] opts the optional parameters
414
+ # @return [ChunkGroup]
415
+ def get_chunk_group(tr_dataset, tracking_or_chunk, group_id, opts = {})
416
+ data, _status_code, _headers = get_chunk_group_with_http_info(tr_dataset, tracking_or_chunk, group_id, opts)
417
+ data
418
+ end
419
+
420
+ # Get Group
421
+ # Get Group Fetch the group with the given id. get_group
422
+ # @param tr_dataset [String] The dataset id to use for the request
423
+ # @param tracking_or_chunk [String] The type of id you are using to search for the group. This can be either &#39;chunk&#39; or &#39;tracking_id&#39;
424
+ # @param group_id [String] Id of the group you want to fetch. This can be either the group_id or the tracking_id.
425
+ # @param [Hash] opts the optional parameters
426
+ # @return [Array<(ChunkGroup, Integer, Hash)>] ChunkGroup data, response status code and response headers
427
+ def get_chunk_group_with_http_info(tr_dataset, tracking_or_chunk, group_id, opts = {})
428
+ if @api_client.config.debugging
429
+ @api_client.config.logger.debug 'Calling API: ChunkGroupApi.get_chunk_group ...'
430
+ end
431
+ # verify the required parameter 'tr_dataset' is set
432
+ if @api_client.config.client_side_validation && tr_dataset.nil?
433
+ fail ArgumentError, "Missing the required parameter 'tr_dataset' when calling ChunkGroupApi.get_chunk_group"
434
+ end
435
+ # verify the required parameter 'tracking_or_chunk' is set
436
+ if @api_client.config.client_side_validation && tracking_or_chunk.nil?
437
+ fail ArgumentError, "Missing the required parameter 'tracking_or_chunk' when calling ChunkGroupApi.get_chunk_group"
438
+ end
439
+ # resource path
440
+ local_var_path = '/api/chunk_group/{tracking_or_chunk}/{group_id}'.sub('{' + 'tracking_or_chunk' + '}', CGI.escape(tracking_or_chunk.to_s)).sub('{' + 'group_id' + '}', CGI.escape(group_id.to_s))
441
+
442
+ # query parameters
443
+ query_params = opts[:query_params] || {}
444
+
445
+ # header parameters
446
+ header_params = opts[:header_params] || {}
447
+ # HTTP header 'Accept' (if needed)
448
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
449
+ header_params[:'TR-Dataset'] = tr_dataset
450
+
451
+ # form parameters
452
+ form_params = opts[:form_params] || {}
453
+
454
+ # http body (model)
455
+ post_body = opts[:debug_body]
456
+
457
+ # return_type
458
+ return_type = opts[:debug_return_type] || 'ChunkGroup'
459
+
460
+ # auth_names
461
+ auth_names = opts[:debug_auth_names] || ['ApiKey']
462
+
463
+ new_options = opts.merge(
464
+ :operation => :"ChunkGroupApi.get_chunk_group",
465
+ :header_params => header_params,
466
+ :query_params => query_params,
467
+ :form_params => form_params,
468
+ :body => post_body,
469
+ :auth_names => auth_names,
470
+ :return_type => return_type
471
+ )
472
+
473
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
474
+ if @api_client.config.debugging
475
+ @api_client.config.logger.debug "API called: ChunkGroupApi#get_chunk_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
476
+ end
477
+ return data, status_code, headers
478
+ end
479
+
480
+ # Get Chunks in Group
481
+ # Get Chunks in Group Route to get all chunks for a group. The response is paginated, with each page containing 10 chunks. Support for custom page size is coming soon.
482
+ # @param tr_dataset [String] The dataset id to use for the request
483
+ # @param tracking_or_chunk [String] The type of id you are using to search for the group. This can be either &#39;chunk&#39; or &#39;tracking_id&#39;
484
+ # @param group_id [String] Id of the group you want to fetch. This can be either the group_id or the tracking_id. If both are provided, the group_id will be used.
409
485
  # @param page [Integer] The page of chunks to get from the group
410
486
  # @param [Hash] opts the optional parameters
411
487
  # @return [BookmarkData]
412
- def get_chunks_in_group(tr_dataset, group_id, tracking_or_chunk, page, opts = {})
413
- data, _status_code, _headers = get_chunks_in_group_with_http_info(tr_dataset, group_id, tracking_or_chunk, page, opts)
488
+ def get_chunks_in_group(tr_dataset, tracking_or_chunk, group_id, page, opts = {})
489
+ data, _status_code, _headers = get_chunks_in_group_with_http_info(tr_dataset, tracking_or_chunk, group_id, page, opts)
414
490
  data
415
491
  end
416
492
 
417
- # get_chunks_in_group
418
- # get_chunks_in_group Route to get all chunks for a group. The response is paginated, with each page containing 10 chunks. Support for custom page size is coming soon.
493
+ # Get Chunks in Group
494
+ # Get Chunks in Group Route to get all chunks for a group. The response is paginated, with each page containing 10 chunks. Support for custom page size is coming soon.
419
495
  # @param tr_dataset [String] The dataset id to use for the request
420
- # @param group_id [Uuid] Id of the group you want to fetch. This can be either the group_id or the tracking_id. If both are provided, the group_id will be used.
421
496
  # @param tracking_or_chunk [String] The type of id you are using to search for the group. This can be either &#39;chunk&#39; or &#39;tracking_id&#39;
497
+ # @param group_id [String] Id of the group you want to fetch. This can be either the group_id or the tracking_id. If both are provided, the group_id will be used.
422
498
  # @param page [Integer] The page of chunks to get from the group
423
499
  # @param [Hash] opts the optional parameters
424
500
  # @return [Array<(BookmarkData, Integer, Hash)>] BookmarkData data, response status code and response headers
425
- def get_chunks_in_group_with_http_info(tr_dataset, group_id, tracking_or_chunk, page, opts = {})
501
+ def get_chunks_in_group_with_http_info(tr_dataset, tracking_or_chunk, group_id, page, opts = {})
426
502
  if @api_client.config.debugging
427
503
  @api_client.config.logger.debug 'Calling API: ChunkGroupApi.get_chunks_in_group ...'
428
504
  end
@@ -443,7 +519,7 @@ module TrieveRubyClient
443
519
  end
444
520
 
445
521
  # resource path
446
- local_var_path = '/api/chunk_group/{tracking_or_chunk}/{group_id}/{page}'.sub('{' + 'group_id' + '}', CGI.escape(group_id.to_s)).sub('{' + 'tracking_or_chunk' + '}', CGI.escape(tracking_or_chunk.to_s)).sub('{' + 'page' + '}', CGI.escape(page.to_s))
522
+ local_var_path = '/api/chunk_group/{tracking_or_chunk}/{group_id}/{page}'.sub('{' + 'tracking_or_chunk' + '}', CGI.escape(tracking_or_chunk.to_s)).sub('{' + 'group_id' + '}', CGI.escape(group_id.to_s)).sub('{' + 'page' + '}', CGI.escape(page.to_s))
447
523
 
448
524
  # query parameters
449
525
  query_params = opts[:query_params] || {}
@@ -464,7 +540,7 @@ module TrieveRubyClient
464
540
  return_type = opts[:debug_return_type] || 'BookmarkData'
465
541
 
466
542
  # auth_names
467
- auth_names = opts[:debug_auth_names] || ['Cookie', 'ApiKey']
543
+ auth_names = opts[:debug_auth_names] || ['ApiKey']
468
544
 
469
545
  new_options = opts.merge(
470
546
  :operation => :"ChunkGroupApi.get_chunks_in_group",
@@ -483,8 +559,8 @@ module TrieveRubyClient
483
559
  return data, status_code, headers
484
560
  end
485
561
 
486
- # get_chunks_in_group_by_tracking_id
487
- # get_chunks_in_group_by_tracking_id Route to get all chunks for a group. The response is paginated, with each page containing 10 chunks. Support for custom page size is coming soon.
562
+ # Get Chunks in Group by Tracking ID
563
+ # Get Chunks in Group by Tracking ID Route to get all chunks for a group. The response is paginated, with each page containing 10 chunks. Support for custom page size is coming soon.
488
564
  # @param tr_dataset [String] The dataset id to use for the request
489
565
  # @param group_tracking_id [String] The id of the group to get the chunks from
490
566
  # @param page [Integer] The page of chunks to get from the group
@@ -495,8 +571,8 @@ module TrieveRubyClient
495
571
  data
496
572
  end
497
573
 
498
- # get_chunks_in_group_by_tracking_id
499
- # get_chunks_in_group_by_tracking_id Route to get all chunks for a group. The response is paginated, with each page containing 10 chunks. Support for custom page size is coming soon.
574
+ # Get Chunks in Group by Tracking ID
575
+ # Get Chunks in Group by Tracking ID Route to get all chunks for a group. The response is paginated, with each page containing 10 chunks. Support for custom page size is coming soon.
500
576
  # @param tr_dataset [String] The dataset id to use for the request
501
577
  # @param group_tracking_id [String] The id of the group to get the chunks from
502
578
  # @param page [Integer] The page of chunks to get from the group
@@ -544,7 +620,7 @@ module TrieveRubyClient
544
620
  return_type = opts[:debug_return_type] || 'BookmarkData'
545
621
 
546
622
  # auth_names
547
- auth_names = opts[:debug_auth_names] || ['Cookie', 'ApiKey']
623
+ auth_names = opts[:debug_auth_names] || ['ApiKey']
548
624
 
549
625
  new_options = opts.merge(
550
626
  :operation => :"ChunkGroupApi.get_chunks_in_group_by_tracking_id",
@@ -563,8 +639,8 @@ module TrieveRubyClient
563
639
  return data, status_code, headers
564
640
  end
565
641
 
566
- # get_group_by_tracking_id
567
- # get_group_by_tracking_id
642
+ # Get Group by Tracking ID
643
+ # Get Group by Tracking ID Fetch the group with the given tracking id. get_group_by_tracking_id
568
644
  # @param tr_dataset [String] The dataset id to use for the request
569
645
  # @param tracking_id [String] The tracking id of the group to fetch.
570
646
  # @param [Hash] opts the optional parameters
@@ -574,8 +650,8 @@ module TrieveRubyClient
574
650
  data
575
651
  end
576
652
 
577
- # get_group_by_tracking_id
578
- # get_group_by_tracking_id
653
+ # Get Group by Tracking ID
654
+ # Get Group by Tracking ID Fetch the group with the given tracking id. get_group_by_tracking_id
579
655
  # @param tr_dataset [String] The dataset id to use for the request
580
656
  # @param tracking_id [String] The tracking id of the group to fetch.
581
657
  # @param [Hash] opts the optional parameters
@@ -614,7 +690,7 @@ module TrieveRubyClient
614
690
  return_type = opts[:debug_return_type] || 'ChunkGroup'
615
691
 
616
692
  # auth_names
617
- auth_names = opts[:debug_auth_names] || ['Cookie', 'ApiKey']
693
+ auth_names = opts[:debug_auth_names] || ['ApiKey']
618
694
 
619
695
  new_options = opts.merge(
620
696
  :operation => :"ChunkGroupApi.get_group_by_tracking_id",
@@ -633,6 +709,8 @@ module TrieveRubyClient
633
709
  return data, status_code, headers
634
710
  end
635
711
 
712
+ # Get Groups for Chunks
713
+ # Get Groups for Chunks Route to get the groups that a chunk is in.
636
714
  # @param tr_dataset [String] The dataset id to use for the request
637
715
  # @param get_groups_for_chunks_data [GetGroupsForChunksData] JSON request payload to get the groups that a chunk is in
638
716
  # @param [Hash] opts the optional parameters
@@ -642,6 +720,8 @@ module TrieveRubyClient
642
720
  data
643
721
  end
644
722
 
723
+ # Get Groups for Chunks
724
+ # Get Groups for Chunks Route to get the groups that a chunk is in.
645
725
  # @param tr_dataset [String] The dataset id to use for the request
646
726
  # @param get_groups_for_chunks_data [GetGroupsForChunksData] JSON request payload to get the groups that a chunk is in
647
727
  # @param [Hash] opts the optional parameters
@@ -685,7 +765,7 @@ module TrieveRubyClient
685
765
  return_type = opts[:debug_return_type] || 'Array<BookmarkGroupResult>'
686
766
 
687
767
  # auth_names
688
- auth_names = opts[:debug_auth_names] || ['Cookie', 'ApiKey']
768
+ auth_names = opts[:debug_auth_names] || ['ApiKey']
689
769
 
690
770
  new_options = opts.merge(
691
771
  :operation => :"ChunkGroupApi.get_groups_chunk_is_in",
@@ -704,6 +784,8 @@ module TrieveRubyClient
704
784
  return data, status_code, headers
705
785
  end
706
786
 
787
+ # Get Recommended Groups
788
+ # Get Recommended Groups Route to get recommended groups. This route will return groups which are similar to the groups in the request body.
707
789
  # @param tr_dataset [String] The dataset id to use for the request
708
790
  # @param reccomend_group_chunks_request [ReccomendGroupChunksRequest] JSON request payload to get recommendations of chunks similar to the chunks in the request
709
791
  # @param [Hash] opts the optional parameters
@@ -713,6 +795,8 @@ module TrieveRubyClient
713
795
  data
714
796
  end
715
797
 
798
+ # Get Recommended Groups
799
+ # Get Recommended Groups Route to get recommended groups. This route will return groups which are similar to the groups in the request body.
716
800
  # @param tr_dataset [String] The dataset id to use for the request
717
801
  # @param reccomend_group_chunks_request [ReccomendGroupChunksRequest] JSON request payload to get recommendations of chunks similar to the chunks in the request
718
802
  # @param [Hash] opts the optional parameters
@@ -756,7 +840,7 @@ module TrieveRubyClient
756
840
  return_type = opts[:debug_return_type] || 'Array<GroupScoreChunkDTO>'
757
841
 
758
842
  # auth_names
759
- auth_names = opts[:debug_auth_names] || ['Cookie', 'ApiKey']
843
+ auth_names = opts[:debug_auth_names] || ['ApiKey']
760
844
 
761
845
  new_options = opts.merge(
762
846
  :operation => :"ChunkGroupApi.get_recommended_groups",
@@ -775,8 +859,8 @@ module TrieveRubyClient
775
859
  return data, status_code, headers
776
860
  end
777
861
 
778
- # get_dataset_groups
779
- # get_dataset_groups Fetch the groups which belong to a dataset specified by its id.
862
+ # Get Groups for Dataset
863
+ # Get Groups for Dataset Fetch the groups which belong to a dataset specified by its id.
780
864
  # @param tr_dataset [String] The dataset id to use for the request
781
865
  # @param dataset_id [String] The id of the dataset to fetch groups for.
782
866
  # @param page [Integer] The page of groups to fetch. Each page contains 10 groups. Support for custom page size is coming soon.
@@ -787,8 +871,8 @@ module TrieveRubyClient
787
871
  data
788
872
  end
789
873
 
790
- # get_dataset_groups
791
- # get_dataset_groups Fetch the groups which belong to a dataset specified by its id.
874
+ # Get Groups for Dataset
875
+ # Get Groups for Dataset Fetch the groups which belong to a dataset specified by its id.
792
876
  # @param tr_dataset [String] The dataset id to use for the request
793
877
  # @param dataset_id [String] The id of the dataset to fetch groups for.
794
878
  # @param page [Integer] The page of groups to fetch. Each page contains 10 groups. Support for custom page size is coming soon.
@@ -832,7 +916,7 @@ module TrieveRubyClient
832
916
  return_type = opts[:debug_return_type] || 'GroupData'
833
917
 
834
918
  # auth_names
835
- auth_names = opts[:debug_auth_names] || ['Cookie', 'ApiKey']
919
+ auth_names = opts[:debug_auth_names] || ['ApiKey']
836
920
 
837
921
  new_options = opts.merge(
838
922
  :operation => :"ChunkGroupApi.get_specific_dataset_chunk_groups",
@@ -851,8 +935,8 @@ module TrieveRubyClient
851
935
  return data, status_code, headers
852
936
  end
853
937
 
854
- # remove_chunk_from_group
855
- # remove_chunk_from_group Route to remove a chunk from a group.
938
+ # Remove Chunk from Group
939
+ # Remove Chunk from Group Route to remove a chunk from a group.
856
940
  # @param tr_dataset [String] The dataset id to use for the request
857
941
  # @param group_id [String] Id of the group to remove the bookmark&#39;ed chunk from
858
942
  # @param create_chunk_group_data [CreateChunkGroupData] JSON request payload to cretea a chunkGroup
@@ -863,8 +947,8 @@ module TrieveRubyClient
863
947
  nil
864
948
  end
865
949
 
866
- # remove_chunk_from_group
867
- # remove_chunk_from_group Route to remove a chunk from a group.
950
+ # Remove Chunk from Group
951
+ # Remove Chunk from Group Route to remove a chunk from a group.
868
952
  # @param tr_dataset [String] The dataset id to use for the request
869
953
  # @param group_id [String] Id of the group to remove the bookmark&#39;ed chunk from
870
954
  # @param create_chunk_group_data [CreateChunkGroupData] JSON request payload to cretea a chunkGroup
@@ -913,7 +997,7 @@ module TrieveRubyClient
913
997
  return_type = opts[:debug_return_type]
914
998
 
915
999
  # auth_names
916
- auth_names = opts[:debug_auth_names] || ['Cookie', 'ApiKey']
1000
+ auth_names = opts[:debug_auth_names] || ['ApiKey']
917
1001
 
918
1002
  new_options = opts.merge(
919
1003
  :operation => :"ChunkGroupApi.remove_chunk_from_group",
@@ -932,8 +1016,8 @@ module TrieveRubyClient
932
1016
  return data, status_code, headers
933
1017
  end
934
1018
 
935
- # group_oriented_search
936
- # group_oriented_search This route allows you to get groups as results instead of chunks. Each group returned will have the matching chunks sorted by similarity within the group. This is useful for when you want to get groups of chunks which are similar to the search query. If choosing hybrid search, the results will be re-ranked using BAAI/bge-reranker-large. Compatible with semantic, fulltext, or hybrid search modes.
1019
+ # Search Over Groups
1020
+ # Search Over Groups This route allows you to get groups as results instead of chunks. Each group returned will have the matching chunks sorted by similarity within the group. This is useful for when you want to get groups of chunks which are similar to the search query. If choosing hybrid search, the results will be re-ranked using BAAI/bge-reranker-large. Compatible with semantic, fulltext, or hybrid search modes.
937
1021
  # @param search_over_groups_data [SearchOverGroupsData] JSON request payload to semantically search over groups
938
1022
  # @param [Hash] opts the optional parameters
939
1023
  # @return [SearchOverGroupsResponseBody]
@@ -942,8 +1026,8 @@ module TrieveRubyClient
942
1026
  data
943
1027
  end
944
1028
 
945
- # group_oriented_search
946
- # group_oriented_search This route allows you to get groups as results instead of chunks. Each group returned will have the matching chunks sorted by similarity within the group. This is useful for when you want to get groups of chunks which are similar to the search query. If choosing hybrid search, the results will be re-ranked using BAAI/bge-reranker-large. Compatible with semantic, fulltext, or hybrid search modes.
1029
+ # Search Over Groups
1030
+ # Search Over Groups This route allows you to get groups as results instead of chunks. Each group returned will have the matching chunks sorted by similarity within the group. This is useful for when you want to get groups of chunks which are similar to the search query. If choosing hybrid search, the results will be re-ranked using BAAI/bge-reranker-large. Compatible with semantic, fulltext, or hybrid search modes.
947
1031
  # @param search_over_groups_data [SearchOverGroupsData] JSON request payload to semantically search over groups
948
1032
  # @param [Hash] opts the optional parameters
949
1033
  # @return [Array<(SearchOverGroupsResponseBody, Integer, Hash)>] SearchOverGroupsResponseBody data, response status code and response headers
@@ -1000,8 +1084,8 @@ module TrieveRubyClient
1000
1084
  return data, status_code, headers
1001
1085
  end
1002
1086
 
1003
- # search_within_group
1004
- # search_within_group This route allows you to search only within a group. This is useful for when you only want search results to contain chunks which are members of a specific group. If choosing hybrid search, the results will be re-ranked using BAAI/bge-reranker-large.
1087
+ # Search Within Group
1088
+ # Search Within Group This route allows you to search only within a group. This is useful for when you only want search results to contain chunks which are members of a specific group. If choosing hybrid search, the results will be re-ranked using BAAI/bge-reranker-large.
1005
1089
  # @param tr_dataset [String] The dataset id to use for the request
1006
1090
  # @param search_within_group_data [SearchWithinGroupData] JSON request payload to semantically search a group
1007
1091
  # @param [Hash] opts the optional parameters
@@ -1011,8 +1095,8 @@ module TrieveRubyClient
1011
1095
  data
1012
1096
  end
1013
1097
 
1014
- # search_within_group
1015
- # search_within_group This route allows you to search only within a group. This is useful for when you only want search results to contain chunks which are members of a specific group. If choosing hybrid search, the results will be re-ranked using BAAI/bge-reranker-large.
1098
+ # Search Within Group
1099
+ # Search Within Group This route allows you to search only within a group. This is useful for when you only want search results to contain chunks which are members of a specific group. If choosing hybrid search, the results will be re-ranked using BAAI/bge-reranker-large.
1016
1100
  # @param tr_dataset [String] The dataset id to use for the request
1017
1101
  # @param search_within_group_data [SearchWithinGroupData] JSON request payload to semantically search a group
1018
1102
  # @param [Hash] opts the optional parameters
@@ -1056,7 +1140,7 @@ module TrieveRubyClient
1056
1140
  return_type = opts[:debug_return_type] || 'SearchGroupsResult'
1057
1141
 
1058
1142
  # auth_names
1059
- auth_names = opts[:debug_auth_names] || ['Cookie', 'ApiKey']
1143
+ auth_names = opts[:debug_auth_names] || ['ApiKey']
1060
1144
 
1061
1145
  new_options = opts.merge(
1062
1146
  :operation => :"ChunkGroupApi.search_within_group",
@@ -1075,8 +1159,8 @@ module TrieveRubyClient
1075
1159
  return data, status_code, headers
1076
1160
  end
1077
1161
 
1078
- # update_chunk_group
1079
- # update_chunk_group Update a chunk_group.
1162
+ # Update Group
1163
+ # Update Group Update a chunk_group.
1080
1164
  # @param tr_dataset [String] The dataset id to use for the request
1081
1165
  # @param update_chunk_group_data [UpdateChunkGroupData] JSON request payload to update a chunkGroup
1082
1166
  # @param [Hash] opts the optional parameters
@@ -1086,8 +1170,8 @@ module TrieveRubyClient
1086
1170
  nil
1087
1171
  end
1088
1172
 
1089
- # update_chunk_group
1090
- # update_chunk_group Update a chunk_group.
1173
+ # Update Group
1174
+ # Update Group Update a chunk_group.
1091
1175
  # @param tr_dataset [String] The dataset id to use for the request
1092
1176
  # @param update_chunk_group_data [UpdateChunkGroupData] JSON request payload to update a chunkGroup
1093
1177
  # @param [Hash] opts the optional parameters
@@ -1131,7 +1215,7 @@ module TrieveRubyClient
1131
1215
  return_type = opts[:debug_return_type]
1132
1216
 
1133
1217
  # auth_names
1134
- auth_names = opts[:debug_auth_names] || ['Cookie', 'ApiKey']
1218
+ auth_names = opts[:debug_auth_names] || ['ApiKey']
1135
1219
 
1136
1220
  new_options = opts.merge(
1137
1221
  :operation => :"ChunkGroupApi.update_chunk_group",
@@ -1150,6 +1234,8 @@ module TrieveRubyClient
1150
1234
  return data, status_code, headers
1151
1235
  end
1152
1236
 
1237
+ # Update Group by Tracking ID
1238
+ # Update Group by Tracking ID Update a chunk_group with the given tracking id.
1153
1239
  # @param tr_dataset [String] The dataset id to use for the request
1154
1240
  # @param tracking_id [String] Tracking id of the chunk_group to update
1155
1241
  # @param update_group_by_tracking_id_data [UpdateGroupByTrackingIDData] JSON request payload to update a chunkGroup
@@ -1160,6 +1246,8 @@ module TrieveRubyClient
1160
1246
  nil
1161
1247
  end
1162
1248
 
1249
+ # Update Group by Tracking ID
1250
+ # Update Group by Tracking ID Update a chunk_group with the given tracking id.
1163
1251
  # @param tr_dataset [String] The dataset id to use for the request
1164
1252
  # @param tracking_id [String] Tracking id of the chunk_group to update
1165
1253
  # @param update_group_by_tracking_id_data [UpdateGroupByTrackingIDData] JSON request payload to update a chunkGroup
@@ -1208,7 +1296,7 @@ module TrieveRubyClient
1208
1296
  return_type = opts[:debug_return_type]
1209
1297
 
1210
1298
  # auth_names
1211
- auth_names = opts[:debug_auth_names] || ['Cookie', 'ApiKey']
1299
+ auth_names = opts[:debug_auth_names] || ['ApiKey']
1212
1300
 
1213
1301
  new_options = opts.merge(
1214
1302
  :operation => :"ChunkGroupApi.update_group_by_tracking_id",