trieve_ruby_client 0.3.5 → 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 (129) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +78 -74
  3. data/docs/AuthApi.md +28 -34
  4. data/docs/AuthQuery.md +22 -0
  5. data/docs/BatchQueuedChunkResponse.md +20 -0
  6. data/docs/ChunkApi.md +69 -143
  7. data/docs/ChunkData.md +42 -0
  8. data/docs/ChunkGroupApi.md +169 -85
  9. data/docs/CreateChunkData.md +41 -34
  10. data/docs/DatasetApi.md +31 -31
  11. data/docs/EventsApi.md +13 -13
  12. data/docs/FileApi.md +21 -21
  13. data/docs/GetEventsData.md +22 -0
  14. data/docs/HealthApi.md +6 -4
  15. data/docs/InvitationApi.md +6 -6
  16. data/docs/MessageApi.md +21 -21
  17. data/docs/OrganizationApi.md +31 -31
  18. data/docs/ReturnQueuedChunk.md +39 -10
  19. data/docs/SingleQueuedChunkResponse.md +20 -0
  20. data/docs/StripeApi.md +21 -13
  21. data/docs/TopicApi.md +21 -21
  22. data/docs/UserApi.md +16 -16
  23. data/lib/trieve_ruby_client/api/auth_api.rb +27 -34
  24. data/lib/trieve_ruby_client/api/chunk_api.rb +57 -132
  25. data/lib/trieve_ruby_client/api/chunk_group_api.rb +149 -61
  26. data/lib/trieve_ruby_client/api/dataset_api.rb +25 -25
  27. data/lib/trieve_ruby_client/api/events_api.rb +21 -16
  28. data/lib/trieve_ruby_client/api/file_api.rb +17 -17
  29. data/lib/trieve_ruby_client/api/health_api.rb +5 -1
  30. data/lib/trieve_ruby_client/api/invitation_api.rb +5 -5
  31. data/lib/trieve_ruby_client/api/message_api.rb +17 -17
  32. data/lib/trieve_ruby_client/api/organization_api.rb +25 -25
  33. data/lib/trieve_ruby_client/api/stripe_api.rb +17 -1
  34. data/lib/trieve_ruby_client/api/topic_api.rb +17 -17
  35. data/lib/trieve_ruby_client/api/user_api.rb +13 -13
  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 -4
  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/suggested_queries_request.rb +1 -1
  102. data/lib/trieve_ruby_client/models/suggested_queries_response.rb +1 -1
  103. data/lib/trieve_ruby_client/models/topic.rb +1 -1
  104. data/lib/trieve_ruby_client/models/update_chunk_by_tracking_id_data.rb +1 -1
  105. data/lib/trieve_ruby_client/models/update_chunk_data.rb +1 -1
  106. data/lib/trieve_ruby_client/models/update_chunk_group_data.rb +1 -1
  107. data/lib/trieve_ruby_client/models/update_dataset_request.rb +1 -1
  108. data/lib/trieve_ruby_client/models/update_group_by_tracking_id_data.rb +1 -1
  109. data/lib/trieve_ruby_client/models/update_organization_data.rb +1 -1
  110. data/lib/trieve_ruby_client/models/update_topic_data.rb +1 -1
  111. data/lib/trieve_ruby_client/models/update_user_data.rb +1 -1
  112. data/lib/trieve_ruby_client/models/upload_file_data.rb +1 -1
  113. data/lib/trieve_ruby_client/models/upload_file_result.rb +1 -1
  114. data/lib/trieve_ruby_client/models/user_organization.rb +1 -1
  115. data/lib/trieve_ruby_client/version.rb +2 -2
  116. data/lib/trieve_ruby_client.rb +6 -2
  117. data/openapi-generator.yaml +1 -1
  118. data/openapi.json +1233 -824
  119. data/spec/models/auth_query_spec.rb +48 -0
  120. data/spec/models/batch_queued_chunk_response_spec.rb +42 -0
  121. data/spec/models/chunk_data_spec.rb +108 -0
  122. data/spec/models/get_events_data_spec.rb +48 -0
  123. data/spec/models/single_queued_chunk_response_spec.rb +42 -0
  124. data/spec/spec_helper.rb +1 -1
  125. data/trieve_ruby_client-0.3.5.gem +0 -0
  126. data/trieve_ruby_client.gemspec +1 -1
  127. metadata +23 -4
  128. data/trieve_ruby_client-0.3.4.gem +0 -0
  129. data/trieve_ruby_client-0.3.41.gem +0 -0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
5
5
 
6
- The version of the OpenAPI document: 0.3.5
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,24 +19,24 @@ module TrieveRubyClient
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
- # get_events
23
- # get_events Get events for the auth'ed user. Currently, this is only for events belonging to the auth'ed user. Soon, we plan to associate events to datasets instead of users. Each page contains 10 events.
22
+ # Get events for the dataset
23
+ # Get events for the dataset Get events for the auth'ed user. Currently, this is only for events belonging to the auth'ed user. Soon, we plan to associate events to datasets instead of users.
24
24
  # @param tr_dataset [String] The dataset id to use for the request
25
- # @param page [Integer] Page number of events to get
25
+ # @param get_events_data [GetEventsData] JSON request payload to get events for a dataset
26
26
  # @param [Hash] opts the optional parameters
27
27
  # @return [EventReturn]
28
- def get_events(tr_dataset, page, opts = {})
29
- data, _status_code, _headers = get_events_with_http_info(tr_dataset, page, opts)
28
+ def get_events(tr_dataset, get_events_data, opts = {})
29
+ data, _status_code, _headers = get_events_with_http_info(tr_dataset, get_events_data, opts)
30
30
  data
31
31
  end
32
32
 
33
- # get_events
34
- # get_events Get events for the auth'ed user. Currently, this is only for events belonging to the auth'ed user. Soon, we plan to associate events to datasets instead of users. Each page contains 10 events.
33
+ # Get events for the dataset
34
+ # Get events for the dataset Get events for the auth'ed user. Currently, this is only for events belonging to the auth'ed user. Soon, we plan to associate events to datasets instead of users.
35
35
  # @param tr_dataset [String] The dataset id to use for the request
36
- # @param page [Integer] Page number of events to get
36
+ # @param get_events_data [GetEventsData] JSON request payload to get events for a dataset
37
37
  # @param [Hash] opts the optional parameters
38
38
  # @return [Array<(EventReturn, Integer, Hash)>] EventReturn data, response status code and response headers
39
- def get_events_with_http_info(tr_dataset, page, opts = {})
39
+ def get_events_with_http_info(tr_dataset, get_events_data, opts = {})
40
40
  if @api_client.config.debugging
41
41
  @api_client.config.logger.debug 'Calling API: EventsApi.get_events ...'
42
42
  end
@@ -44,12 +44,12 @@ module TrieveRubyClient
44
44
  if @api_client.config.client_side_validation && tr_dataset.nil?
45
45
  fail ArgumentError, "Missing the required parameter 'tr_dataset' when calling EventsApi.get_events"
46
46
  end
47
- # verify the required parameter 'page' is set
48
- if @api_client.config.client_side_validation && page.nil?
49
- fail ArgumentError, "Missing the required parameter 'page' when calling EventsApi.get_events"
47
+ # verify the required parameter 'get_events_data' is set
48
+ if @api_client.config.client_side_validation && get_events_data.nil?
49
+ fail ArgumentError, "Missing the required parameter 'get_events_data' when calling EventsApi.get_events"
50
50
  end
51
51
  # resource path
52
- local_var_path = '/api/events/{page}'.sub('{' + 'page' + '}', CGI.escape(page.to_s))
52
+ local_var_path = '/api/events'
53
53
 
54
54
  # query parameters
55
55
  query_params = opts[:query_params] || {}
@@ -58,13 +58,18 @@ module TrieveRubyClient
58
58
  header_params = opts[:header_params] || {}
59
59
  # HTTP header 'Accept' (if needed)
60
60
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
61
+ # HTTP header 'Content-Type'
62
+ content_type = @api_client.select_header_content_type(['application/json'])
63
+ if !content_type.nil?
64
+ header_params['Content-Type'] = content_type
65
+ end
61
66
  header_params[:'TR-Dataset'] = tr_dataset
62
67
 
63
68
  # form parameters
64
69
  form_params = opts[:form_params] || {}
65
70
 
66
71
  # http body (model)
67
- post_body = opts[:debug_body]
72
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(get_events_data)
68
73
 
69
74
  # return_type
70
75
  return_type = opts[:debug_return_type] || 'EventReturn'
@@ -82,7 +87,7 @@ module TrieveRubyClient
82
87
  :return_type => return_type
83
88
  )
84
89
 
85
- data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
90
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
86
91
  if @api_client.config.debugging
87
92
  @api_client.config.logger.debug "API called: EventsApi#get_events\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
88
93
  end
@@ -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.5
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
- # delete_file
23
- # delete_file Delete a file from S3 attached to the server based on its id. This will disassociate chunks from the file, but will not delete the chunks. We plan to add support for deleting chunks in a release soon. Auth'ed user must be an admin or owner of the dataset's organization to upload a file.
22
+ # Delete File
23
+ # Delete File Delete a file from S3 attached to the server based on its id. This will disassociate chunks from the file, but will not delete the chunks. We plan to add support for deleting chunks in a release soon. Auth'ed user must be an admin or owner of the dataset's organization to upload a file.
24
24
  # @param tr_dataset [String] The dataset id to use for the request
25
25
  # @param file_id [String] The id of the file to delete
26
26
  # @param delete_chunks [Boolean] Whether or not to delete the chunks associated with the file
@@ -31,8 +31,8 @@ module TrieveRubyClient
31
31
  nil
32
32
  end
33
33
 
34
- # delete_file
35
- # delete_file Delete a file from S3 attached to the server based on its id. This will disassociate chunks from the file, but will not delete the chunks. We plan to add support for deleting chunks in a release soon. Auth&#39;ed user must be an admin or owner of the dataset&#39;s organization to upload a file.
34
+ # Delete File
35
+ # Delete File Delete a file from S3 attached to the server based on its id. This will disassociate chunks from the file, but will not delete the chunks. We plan to add support for deleting chunks in a release soon. Auth&#39;ed user must be an admin or owner of the dataset&#39;s organization to upload a file.
36
36
  # @param tr_dataset [String] The dataset id to use for the request
37
37
  # @param file_id [String] The id of the file to delete
38
38
  # @param delete_chunks [Boolean] Whether or not to delete the chunks associated with the file
@@ -96,8 +96,8 @@ module TrieveRubyClient
96
96
  return data, status_code, headers
97
97
  end
98
98
 
99
- # get_dataset_files
100
- # get_dataset_files Get all files which belong to a given dataset specified by the dataset_id parameter. 10 files are returned per page.
99
+ # Get Files for Dataset
100
+ # Get Files for Dataset Get all files which belong to a given dataset specified by the dataset_id parameter. 10 files are returned per page.
101
101
  # @param tr_dataset [String] The dataset id to use for the request
102
102
  # @param dataset_id [String] The id of the dataset to fetch files for.
103
103
  # @param page [Integer] The page number of files you wish to fetch. Each page contains at most 10 files.
@@ -108,8 +108,8 @@ module TrieveRubyClient
108
108
  data
109
109
  end
110
110
 
111
- # get_dataset_files
112
- # get_dataset_files Get all files which belong to a given dataset specified by the dataset_id parameter. 10 files are returned per page.
111
+ # Get Files for Dataset
112
+ # Get Files for Dataset Get all files which belong to a given dataset specified by the dataset_id parameter. 10 files are returned per page.
113
113
  # @param tr_dataset [String] The dataset id to use for the request
114
114
  # @param dataset_id [String] The id of the dataset to fetch files for.
115
115
  # @param page [Integer] The page number of files you wish to fetch. Each page contains at most 10 files.
@@ -176,8 +176,8 @@ module TrieveRubyClient
176
176
  return data, status_code, headers
177
177
  end
178
178
 
179
- # get_file
180
- # get_file Download a file from S3 attached to the server based on its id. We plan to add support for getting signed S3 URLs to download from S3 directly in a release soon.
179
+ # Get File
180
+ # Get File Download a file from S3 attached to the server based on its id. We plan to add support for getting signed S3 URLs to download from S3 directly in a release soon.
181
181
  # @param tr_dataset [String] The dataset id to use for the request
182
182
  # @param file_id [String] The id of the file to fetch
183
183
  # @param [Hash] opts the optional parameters
@@ -187,8 +187,8 @@ module TrieveRubyClient
187
187
  data
188
188
  end
189
189
 
190
- # get_file
191
- # get_file Download a file from S3 attached to the server based on its id. We plan to add support for getting signed S3 URLs to download from S3 directly in a release soon.
190
+ # Get File
191
+ # Get File Download a file from S3 attached to the server based on its id. We plan to add support for getting signed S3 URLs to download from S3 directly in a release soon.
192
192
  # @param tr_dataset [String] The dataset id to use for the request
193
193
  # @param file_id [String] The id of the file to fetch
194
194
  # @param [Hash] opts the optional parameters
@@ -246,8 +246,8 @@ module TrieveRubyClient
246
246
  return data, status_code, headers
247
247
  end
248
248
 
249
- # upload_file
250
- # upload_file Upload a file to S3 attached to the server. The file will be converted to HTML with tika and chunked algorithmically, images will be OCR'ed with tesseract. The resulting chunks will be indexed and searchable. Optionally, you can only upload the file and manually create chunks associated to the file after. See docs.trieve.ai and/or contact us for more details and tips. Auth'ed user must be an admin or owner of the dataset's organization to upload a file.
249
+ # Upload File
250
+ # Upload File Upload a file to S3 attached to the server. The file will be converted to HTML with tika and chunked algorithmically, images will be OCR'ed with tesseract. The resulting chunks will be indexed and searchable. Optionally, you can only upload the file and manually create chunks associated to the file after. See docs.trieve.ai and/or contact us for more details and tips. Auth'ed user must be an admin or owner of the dataset's organization to upload a file.
251
251
  # @param tr_dataset [String] The dataset id to use for the request
252
252
  # @param upload_file_data [UploadFileData] JSON request payload to upload a file
253
253
  # @param [Hash] opts the optional parameters
@@ -257,8 +257,8 @@ module TrieveRubyClient
257
257
  data
258
258
  end
259
259
 
260
- # upload_file
261
- # upload_file Upload a file to S3 attached to the server. The file will be converted to HTML with tika and chunked algorithmically, images will be OCR&#39;ed with tesseract. The resulting chunks will be indexed and searchable. Optionally, you can only upload the file and manually create chunks associated to the file after. See docs.trieve.ai and/or contact us for more details and tips. Auth&#39;ed user must be an admin or owner of the dataset&#39;s organization to upload a file.
260
+ # Upload File
261
+ # Upload File Upload a file to S3 attached to the server. The file will be converted to HTML with tika and chunked algorithmically, images will be OCR&#39;ed with tesseract. The resulting chunks will be indexed and searchable. Optionally, you can only upload the file and manually create chunks associated to the file after. See docs.trieve.ai and/or contact us for more details and tips. Auth&#39;ed user must be an admin or owner of the dataset&#39;s organization to upload a file.
262
262
  # @param tr_dataset [String] The dataset id to use for the request
263
263
  # @param upload_file_data [UploadFileData] JSON request payload to upload a file
264
264
  # @param [Hash] opts the optional parameters
@@ -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.5
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,6 +19,8 @@ module TrieveRubyClient
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
+ # Health Check
23
+ # Health Check Confirmation that the service is healthy and can make embedding vectors
22
24
  # @param [Hash] opts the optional parameters
23
25
  # @return [nil]
24
26
  def health_check(opts = {})
@@ -26,6 +28,8 @@ module TrieveRubyClient
26
28
  nil
27
29
  end
28
30
 
31
+ # Health Check
32
+ # Health Check Confirmation that the service is healthy and can make embedding vectors
29
33
  # @param [Hash] opts the optional parameters
30
34
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
31
35
  def health_check_with_http_info(opts = {})
@@ -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.5
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
- # send_invitation
23
- # send_invitation Invitations act as a way to invite users to join an organization. After a user is invited, they will automatically be added to the organization with the role specified in the invitation once they set their.
22
+ # Send Invitation
23
+ # Send Invitation Invitations act as a way to invite users to join an organization. After a user is invited, they will automatically be added to the organization with the role specified in the invitation once they set their.
24
24
  # @param tr_organization [String] The organization id to use for the request
25
25
  # @param invitation_data [InvitationData] JSON request payload to send an invitation
26
26
  # @param [Hash] opts the optional parameters
@@ -30,8 +30,8 @@ module TrieveRubyClient
30
30
  nil
31
31
  end
32
32
 
33
- # send_invitation
34
- # send_invitation Invitations act as a way to invite users to join an organization. After a user is invited, they will automatically be added to the organization with the role specified in the invitation once they set their.
33
+ # Send Invitation
34
+ # Send Invitation Invitations act as a way to invite users to join an organization. After a user is invited, they will automatically be added to the organization with the role specified in the invitation once they set their.
35
35
  # @param tr_organization [String] The organization id to use for the request
36
36
  # @param invitation_data [InvitationData] JSON request payload to send an invitation
37
37
  # @param [Hash] opts the optional parameters
@@ -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.5
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
- # create_message
23
- # create_message Create a message. Messages are attached to topics in order to coordinate memory of gen-AI chat sessions. We are considering refactoring this resource of the API soon. Currently, you can only send user messages. If the topic is a RAG topic then the response will include Chunks first on the stream. The structure will look like `[chunks]||mesage`. See docs.trieve.ai for more information.
22
+ # Create a message
23
+ # Create a message Create a message. Messages are attached to topics in order to coordinate memory of gen-AI chat sessions. We are considering refactoring this resource of the API soon. Currently, you can only send user messages. If the topic is a RAG topic then the response will include Chunks first on the stream. The structure will look like `[chunks]||mesage`. See docs.trieve.ai for more information.
24
24
  # @param tr_dataset [String] The dataset id to use for the request
25
25
  # @param create_message_data [CreateMessageData] JSON request payload to create a message completion
26
26
  # @param [Hash] opts the optional parameters
@@ -30,8 +30,8 @@ module TrieveRubyClient
30
30
  data
31
31
  end
32
32
 
33
- # create_message
34
- # create_message Create a message. Messages are attached to topics in order to coordinate memory of gen-AI chat sessions. We are considering refactoring this resource of the API soon. Currently, you can only send user messages. If the topic is a RAG topic then the response will include Chunks first on the stream. The structure will look like &#x60;[chunks]||mesage&#x60;. See docs.trieve.ai for more information.
33
+ # Create a message
34
+ # Create a message Create a message. Messages are attached to topics in order to coordinate memory of gen-AI chat sessions. We are considering refactoring this resource of the API soon. Currently, you can only send user messages. If the topic is a RAG topic then the response will include Chunks first on the stream. The structure will look like &#x60;[chunks]||mesage&#x60;. See docs.trieve.ai for more information.
35
35
  # @param tr_dataset [String] The dataset id to use for the request
36
36
  # @param create_message_data [CreateMessageData] JSON request payload to create a message completion
37
37
  # @param [Hash] opts the optional parameters
@@ -94,8 +94,8 @@ module TrieveRubyClient
94
94
  return data, status_code, headers
95
95
  end
96
96
 
97
- # edit_message
98
- # edit_message Edit a message which exists within the topic's chat history. This will delete the message and replace it with a new message. The new message will be generated by the AI based on the new content provided in the request body. The response will include Chunks first on the stream if the topic is using RAG. The structure will look like `[chunks]||mesage`. See docs.trieve.ai for more information.
97
+ # Edit a message
98
+ # Edit a message Edit a message which exists within the topic's chat history. This will delete the message and replace it with a new message. The new message will be generated by the AI based on the new content provided in the request body. The response will include Chunks first on the stream if the topic is using RAG. The structure will look like `[chunks]||mesage`. See docs.trieve.ai for more information.
99
99
  # @param tr_dataset [String] The dataset id to use for the request
100
100
  # @param edit_message_data [EditMessageData] JSON request payload to edit a message and get a new stream
101
101
  # @param [Hash] opts the optional parameters
@@ -105,8 +105,8 @@ module TrieveRubyClient
105
105
  nil
106
106
  end
107
107
 
108
- # edit_message
109
- # edit_message Edit a message which exists within the topic&#39;s chat history. This will delete the message and replace it with a new message. The new message will be generated by the AI based on the new content provided in the request body. The response will include Chunks first on the stream if the topic is using RAG. The structure will look like &#x60;[chunks]||mesage&#x60;. See docs.trieve.ai for more information.
108
+ # Edit a message
109
+ # Edit a message Edit a message which exists within the topic&#39;s chat history. This will delete the message and replace it with a new message. The new message will be generated by the AI based on the new content provided in the request body. The response will include Chunks first on the stream if the topic is using RAG. The structure will look like &#x60;[chunks]||mesage&#x60;. See docs.trieve.ai for more information.
110
110
  # @param tr_dataset [String] The dataset id to use for the request
111
111
  # @param edit_message_data [EditMessageData] JSON request payload to edit a message and get a new stream
112
112
  # @param [Hash] opts the optional parameters
@@ -169,8 +169,8 @@ module TrieveRubyClient
169
169
  return data, status_code, headers
170
170
  end
171
171
 
172
- # get_all_messages
173
- # get_all_messages Get all messages for a given topic. If the topic is a RAG topic then the response will include Chunks first on each message. The structure will look like `[chunks]||mesage`. See docs.trieve.ai for more information.
172
+ # Get all messages for a given topic
173
+ # Get all messages for a given topic Get all messages for a given topic. If the topic is a RAG topic then the response will include Chunks first on each message. The structure will look like `[chunks]||mesage`. See docs.trieve.ai for more information.
174
174
  # @param tr_dataset [String] The dataset id to use for the request
175
175
  # @param messages_topic_id [String] The ID of the topic to get messages for.
176
176
  # @param [Hash] opts the optional parameters
@@ -180,8 +180,8 @@ module TrieveRubyClient
180
180
  data
181
181
  end
182
182
 
183
- # get_all_messages
184
- # get_all_messages Get all messages for a given topic. If the topic is a RAG topic then the response will include Chunks first on each message. The structure will look like &#x60;[chunks]||mesage&#x60;. See docs.trieve.ai for more information.
183
+ # Get all messages for a given topic
184
+ # Get all messages for a given topic Get all messages for a given topic. If the topic is a RAG topic then the response will include Chunks first on each message. The structure will look like &#x60;[chunks]||mesage&#x60;. See docs.trieve.ai for more information.
185
185
  # @param tr_dataset [String] The dataset id to use for the request
186
186
  # @param messages_topic_id [String] The ID of the topic to get messages for.
187
187
  # @param [Hash] opts the optional parameters
@@ -239,8 +239,8 @@ module TrieveRubyClient
239
239
  return data, status_code, headers
240
240
  end
241
241
 
242
- # regenerate_message
243
- # regenerate_message Regenerate the assistant response to the last user message of a topic. This will delete the last message and replace it with a new message. The response will include Chunks first on the stream if the topic is using RAG. The structure will look like `[chunks]||mesage`. See docs.trieve.ai for more information.
242
+ # Regenerate message
243
+ # Regenerate message Regenerate the assistant response to the last user message of a topic. This will delete the last message and replace it with a new message. The response will include Chunks first on the stream if the topic is using RAG. The structure will look like `[chunks]||mesage`. See docs.trieve.ai for more information.
244
244
  # @param tr_dataset [String] The dataset id to use for the request
245
245
  # @param regenerate_message_data [RegenerateMessageData] JSON request payload to delete an agent message then regenerate it in a strem
246
246
  # @param [Hash] opts the optional parameters
@@ -250,8 +250,8 @@ module TrieveRubyClient
250
250
  data
251
251
  end
252
252
 
253
- # regenerate_message
254
- # regenerate_message Regenerate the assistant response to the last user message of a topic. This will delete the last message and replace it with a new message. The response will include Chunks first on the stream if the topic is using RAG. The structure will look like &#x60;[chunks]||mesage&#x60;. See docs.trieve.ai for more information.
253
+ # Regenerate message
254
+ # Regenerate message Regenerate the assistant response to the last user message of a topic. This will delete the last message and replace it with a new message. The response will include Chunks first on the stream if the topic is using RAG. The structure will look like &#x60;[chunks]||mesage&#x60;. See docs.trieve.ai for more information.
255
255
  # @param tr_dataset [String] The dataset id to use for the request
256
256
  # @param regenerate_message_data [RegenerateMessageData] JSON request payload to delete an agent message then regenerate it in a strem
257
257
  # @param [Hash] opts the optional parameters
@@ -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.5
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
- # create_organization
23
- # create_organization Create a new organization. The auth'ed user who creates the organization will be the default owner of the organization.
22
+ # Create Organization
23
+ # Create Organization Create a new organization. The auth'ed user who creates the organization will be the default owner of the organization.
24
24
  # @param create_organization_data [CreateOrganizationData] The organization data that you want to create
25
25
  # @param [Hash] opts the optional parameters
26
26
  # @return [Organization]
@@ -29,8 +29,8 @@ module TrieveRubyClient
29
29
  data
30
30
  end
31
31
 
32
- # create_organization
33
- # create_organization Create a new organization. The auth&#39;ed user who creates the organization will be the default owner of the organization.
32
+ # Create Organization
33
+ # Create Organization Create a new organization. The auth&#39;ed user who creates the organization will be the default owner of the organization.
34
34
  # @param create_organization_data [CreateOrganizationData] The organization data that you want to create
35
35
  # @param [Hash] opts the optional parameters
36
36
  # @return [Array<(Organization, Integer, Hash)>] Organization data, response status code and response headers
@@ -87,8 +87,8 @@ module TrieveRubyClient
87
87
  return data, status_code, headers
88
88
  end
89
89
 
90
- # delete_organization
91
- # delete_organization Delete an organization by its id. The auth'ed user must be an owner of the organization to delete it.
90
+ # Delete Organization
91
+ # Delete Organization Delete an organization by its id. The auth'ed user must be an owner of the organization to delete it.
92
92
  # @param tr_organization [String] The organization id to use for the request
93
93
  # @param organization_id [String] The id of the organization you want to fetch.
94
94
  # @param [Hash] opts the optional parameters
@@ -98,8 +98,8 @@ module TrieveRubyClient
98
98
  data
99
99
  end
100
100
 
101
- # delete_organization
102
- # delete_organization Delete an organization by its id. The auth&#39;ed user must be an owner of the organization to delete it.
101
+ # Delete Organization
102
+ # Delete Organization Delete an organization by its id. The auth&#39;ed user must be an owner of the organization to delete it.
103
103
  # @param tr_organization [String] The organization id to use for the request
104
104
  # @param organization_id [String] The id of the organization you want to fetch.
105
105
  # @param [Hash] opts the optional parameters
@@ -157,8 +157,8 @@ module TrieveRubyClient
157
157
  return data, status_code, headers
158
158
  end
159
159
 
160
- # get_organization
161
- # get_organization Fetch the details of an organization by its id. The auth'ed user must be an admin or owner of the organization to fetch it.
160
+ # Get Organization
161
+ # Get Organization Fetch the details of an organization by its id. The auth'ed user must be an admin or owner of the organization to fetch it.
162
162
  # @param tr_organization [String] The organization id to use for the request
163
163
  # @param organization_id [String] The id of the organization you want to fetch.
164
164
  # @param [Hash] opts the optional parameters
@@ -168,8 +168,8 @@ module TrieveRubyClient
168
168
  data
169
169
  end
170
170
 
171
- # get_organization
172
- # get_organization Fetch the details of an organization by its id. The auth&#39;ed user must be an admin or owner of the organization to fetch it.
171
+ # Get Organization
172
+ # Get Organization Fetch the details of an organization by its id. The auth&#39;ed user must be an admin or owner of the organization to fetch it.
173
173
  # @param tr_organization [String] The organization id to use for the request
174
174
  # @param organization_id [String] The id of the organization you want to fetch.
175
175
  # @param [Hash] opts the optional parameters
@@ -227,8 +227,8 @@ module TrieveRubyClient
227
227
  return data, status_code, headers
228
228
  end
229
229
 
230
- # get_organization_usage
231
- # get_organization_usage Fetch the current usage specification of an organization by its id. The auth'ed user must be an admin or owner of the organization to fetch it.
230
+ # Get Organization Usage
231
+ # Get Organization Usage Fetch the current usage specification of an organization by its id. The auth'ed user must be an admin or owner of the organization to fetch it.
232
232
  # @param tr_organization [String] The organization id to use for the request
233
233
  # @param organization_id [String] The id of the organization you want to fetch the usage of.
234
234
  # @param [Hash] opts the optional parameters
@@ -238,8 +238,8 @@ module TrieveRubyClient
238
238
  data
239
239
  end
240
240
 
241
- # get_organization_usage
242
- # get_organization_usage Fetch the current usage specification of an organization by its id. The auth&#39;ed user must be an admin or owner of the organization to fetch it.
241
+ # Get Organization Usage
242
+ # Get Organization Usage Fetch the current usage specification of an organization by its id. The auth&#39;ed user must be an admin or owner of the organization to fetch it.
243
243
  # @param tr_organization [String] The organization id to use for the request
244
244
  # @param organization_id [String] The id of the organization you want to fetch the usage of.
245
245
  # @param [Hash] opts the optional parameters
@@ -297,8 +297,8 @@ module TrieveRubyClient
297
297
  return data, status_code, headers
298
298
  end
299
299
 
300
- # get_organization_users
301
- # get_organization_users Fetch the users of an organization by its id. The auth'ed user must be an admin or owner of the organization to fetch it.
300
+ # Get Organization Users
301
+ # Get Organization Users Fetch the users of an organization by its id. The auth'ed user must be an admin or owner of the organization to fetch it.
302
302
  # @param tr_organization [String] The organization id to use for the request
303
303
  # @param organization_id [String] The id of the organization you want to fetch the users of.
304
304
  # @param [Hash] opts the optional parameters
@@ -308,8 +308,8 @@ module TrieveRubyClient
308
308
  data
309
309
  end
310
310
 
311
- # get_organization_users
312
- # get_organization_users Fetch the users of an organization by its id. The auth&#39;ed user must be an admin or owner of the organization to fetch it.
311
+ # Get Organization Users
312
+ # Get Organization Users Fetch the users of an organization by its id. The auth&#39;ed user must be an admin or owner of the organization to fetch it.
313
313
  # @param tr_organization [String] The organization id to use for the request
314
314
  # @param organization_id [String] The id of the organization you want to fetch the users of.
315
315
  # @param [Hash] opts the optional parameters
@@ -367,8 +367,8 @@ module TrieveRubyClient
367
367
  return data, status_code, headers
368
368
  end
369
369
 
370
- # update_organization
371
- # update_organization Update an organization. Only the owner of the organization can update it.
370
+ # Update Organization
371
+ # Update Organization Update an organization. Only the owner of the organization can update it.
372
372
  # @param tr_organization [String] The organization id to use for the request
373
373
  # @param update_organization_data [UpdateOrganizationData] The organization data that you want to update
374
374
  # @param [Hash] opts the optional parameters
@@ -378,8 +378,8 @@ module TrieveRubyClient
378
378
  data
379
379
  end
380
380
 
381
- # update_organization
382
- # update_organization Update an organization. Only the owner of the organization can update it.
381
+ # Update Organization
382
+ # Update Organization Update an organization. Only the owner of the organization can update it.
383
383
  # @param tr_organization [String] The organization id to use for the request
384
384
  # @param update_organization_data [UpdateOrganizationData] The organization data that you want to update
385
385
  # @param [Hash] opts the optional parameters
@@ -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.5
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,6 +19,8 @@ module TrieveRubyClient
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
+ # Cancel Subscription
23
+ # Cancel Subscription Cancel a subscription by its id
22
24
  # @param tr_organization [String] The organization id to use for the request
23
25
  # @param subscription_id [String] id of the subscription you want to cancel
24
26
  # @param [Hash] opts the optional parameters
@@ -28,6 +30,8 @@ module TrieveRubyClient
28
30
  nil
29
31
  end
30
32
 
33
+ # Cancel Subscription
34
+ # Cancel Subscription Cancel a subscription by its id
31
35
  # @param tr_organization [String] The organization id to use for the request
32
36
  # @param subscription_id [String] id of the subscription you want to cancel
33
37
  # @param [Hash] opts the optional parameters
@@ -85,6 +89,8 @@ module TrieveRubyClient
85
89
  return data, status_code, headers
86
90
  end
87
91
 
92
+ # Checkout
93
+ # Checkout Get a direct link to the stripe checkout page for the plan and organization
88
94
  # @param plan_id [String] id of the plan you want to subscribe to
89
95
  # @param organization_id [String] id of the organization you want to subscribe to the plan
90
96
  # @param [Hash] opts the optional parameters
@@ -94,6 +100,8 @@ module TrieveRubyClient
94
100
  nil
95
101
  end
96
102
 
103
+ # Checkout
104
+ # Checkout Get a direct link to the stripe checkout page for the plan and organization
97
105
  # @param plan_id [String] id of the plan you want to subscribe to
98
106
  # @param organization_id [String] id of the organization you want to subscribe to the plan
99
107
  # @param [Hash] opts the optional parameters
@@ -150,6 +158,8 @@ module TrieveRubyClient
150
158
  return data, status_code, headers
151
159
  end
152
160
 
161
+ # Get All Plans
162
+ # Get All Plans Get a list of all plans
153
163
  # @param [Hash] opts the optional parameters
154
164
  # @return [Array<StripePlan>]
155
165
  def get_all_plans(opts = {})
@@ -157,6 +167,8 @@ module TrieveRubyClient
157
167
  data
158
168
  end
159
169
 
170
+ # Get All Plans
171
+ # Get All Plans Get a list of all plans
160
172
  # @param [Hash] opts the optional parameters
161
173
  # @return [Array<(Array<StripePlan>, Integer, Hash)>] Array<StripePlan> data, response status code and response headers
162
174
  def get_all_plans_with_http_info(opts = {})
@@ -203,6 +215,8 @@ module TrieveRubyClient
203
215
  return data, status_code, headers
204
216
  end
205
217
 
218
+ # Update Subscription Plan
219
+ # Update Subscription Plan Update a subscription to a new plan
206
220
  # @param tr_organization [String] The organization id to use for the request
207
221
  # @param subscription_id [String] id of the subscription you want to update
208
222
  # @param plan_id [String] id of the plan you want to subscribe to
@@ -213,6 +227,8 @@ module TrieveRubyClient
213
227
  nil
214
228
  end
215
229
 
230
+ # Update Subscription Plan
231
+ # Update Subscription Plan Update a subscription to a new plan
216
232
  # @param tr_organization [String] The organization id to use for the request
217
233
  # @param subscription_id [String] id of the subscription you want to update
218
234
  # @param plan_id [String] id of the plan you want to subscribe to