trieve_ruby_client 0.4.0 → 0.5.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 (198) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +13 -13
  3. data/docs/AddChunkToGroupData.md +1 -1
  4. data/docs/ChunkApi.md +25 -29
  5. data/docs/ChunkGroupApi.md +26 -32
  6. data/docs/GetEventsData.md +1 -1
  7. data/lib/trieve_ruby_client/api/auth_api.rb +1 -1
  8. data/lib/trieve_ruby_client/api/chunk_api.rb +28 -32
  9. data/lib/trieve_ruby_client/api/chunk_group_api.rb +36 -46
  10. data/lib/trieve_ruby_client/api/dataset_api.rb +1 -1
  11. data/lib/trieve_ruby_client/api/events_api.rb +1 -1
  12. data/lib/trieve_ruby_client/api/file_api.rb +1 -1
  13. data/lib/trieve_ruby_client/api/health_api.rb +1 -1
  14. data/lib/trieve_ruby_client/api/invitation_api.rb +1 -1
  15. data/lib/trieve_ruby_client/api/message_api.rb +1 -1
  16. data/lib/trieve_ruby_client/api/organization_api.rb +1 -1
  17. data/lib/trieve_ruby_client/api/stripe_api.rb +1 -1
  18. data/lib/trieve_ruby_client/api/topic_api.rb +1 -1
  19. data/lib/trieve_ruby_client/api/user_api.rb +1 -1
  20. data/lib/trieve_ruby_client/api_client.rb +1 -1
  21. data/lib/trieve_ruby_client/api_error.rb +1 -1
  22. data/lib/trieve_ruby_client/configuration.rb +1 -1
  23. data/lib/trieve_ruby_client/models/add_chunk_to_group_data.rb +2 -2
  24. data/lib/trieve_ruby_client/models/api_key_dto.rb +1 -1
  25. data/lib/trieve_ruby_client/models/auth_query.rb +1 -1
  26. data/lib/trieve_ruby_client/models/batch_queued_chunk_response.rb +1 -1
  27. data/lib/trieve_ruby_client/models/bookmark_data.rb +1 -1
  28. data/lib/trieve_ruby_client/models/bookmark_group_result.rb +1 -1
  29. data/lib/trieve_ruby_client/models/chat_message_proxy.rb +1 -1
  30. data/lib/trieve_ruby_client/models/chunk_data.rb +1 -1
  31. data/lib/trieve_ruby_client/models/chunk_filter.rb +1 -1
  32. data/lib/trieve_ruby_client/models/chunk_group.rb +1 -1
  33. data/lib/trieve_ruby_client/models/chunk_group_and_file.rb +1 -1
  34. data/lib/trieve_ruby_client/models/chunk_metadata.rb +1 -1
  35. data/lib/trieve_ruby_client/models/chunk_metadata_with_file_data.rb +1 -1
  36. data/lib/trieve_ruby_client/models/client_dataset_configuration.rb +1 -1
  37. data/lib/trieve_ruby_client/models/create_chunk_data.rb +1 -1
  38. data/lib/trieve_ruby_client/models/create_chunk_group_data.rb +1 -1
  39. data/lib/trieve_ruby_client/models/create_dataset_request.rb +1 -1
  40. data/lib/trieve_ruby_client/models/create_message_data.rb +1 -1
  41. data/lib/trieve_ruby_client/models/create_organization_data.rb +1 -1
  42. data/lib/trieve_ruby_client/models/create_topic_data.rb +1 -1
  43. data/lib/trieve_ruby_client/models/dataset.rb +1 -1
  44. data/lib/trieve_ruby_client/models/dataset_and_usage.rb +1 -1
  45. data/lib/trieve_ruby_client/models/dataset_dto.rb +1 -1
  46. data/lib/trieve_ruby_client/models/dataset_usage_count.rb +1 -1
  47. data/lib/trieve_ruby_client/models/delete_dataset_request.rb +1 -1
  48. data/lib/trieve_ruby_client/models/delete_topic_data.rb +1 -1
  49. data/lib/trieve_ruby_client/models/delete_user_api_key_request.rb +1 -1
  50. data/lib/trieve_ruby_client/models/edit_message_data.rb +1 -1
  51. data/lib/trieve_ruby_client/models/error_response_body.rb +1 -1
  52. data/lib/trieve_ruby_client/models/event.rb +1 -1
  53. data/lib/trieve_ruby_client/models/event_return.rb +1 -1
  54. data/lib/trieve_ruby_client/models/field_condition.rb +1 -1
  55. data/lib/trieve_ruby_client/models/file.rb +1 -1
  56. data/lib/trieve_ruby_client/models/file_dto.rb +1 -1
  57. data/lib/trieve_ruby_client/models/generate_chunks_request.rb +1 -1
  58. data/lib/trieve_ruby_client/models/get_events_data.rb +2 -2
  59. data/lib/trieve_ruby_client/models/get_groups_for_chunks_data.rb +1 -1
  60. data/lib/trieve_ruby_client/models/group_data.rb +1 -1
  61. data/lib/trieve_ruby_client/models/group_score_chunk_dto.rb +1 -1
  62. data/lib/trieve_ruby_client/models/invitation_data.rb +1 -1
  63. data/lib/trieve_ruby_client/models/match_condition.rb +1 -1
  64. data/lib/trieve_ruby_client/models/message.rb +1 -1
  65. data/lib/trieve_ruby_client/models/organization.rb +1 -1
  66. data/lib/trieve_ruby_client/models/organization_usage_count.rb +1 -1
  67. data/lib/trieve_ruby_client/models/range.rb +1 -1
  68. data/lib/trieve_ruby_client/models/reccomend_group_chunks_request.rb +1 -1
  69. data/lib/trieve_ruby_client/models/recommend_chunks_request.rb +1 -1
  70. data/lib/trieve_ruby_client/models/regenerate_message_data.rb +1 -1
  71. data/lib/trieve_ruby_client/models/return_queued_chunk.rb +1 -1
  72. data/lib/trieve_ruby_client/models/score_chunk_dto.rb +1 -1
  73. data/lib/trieve_ruby_client/models/search_chunk_data.rb +1 -1
  74. data/lib/trieve_ruby_client/models/search_chunk_query_response_body.rb +1 -1
  75. data/lib/trieve_ruby_client/models/search_groups_result.rb +1 -1
  76. data/lib/trieve_ruby_client/models/search_over_groups_data.rb +1 -1
  77. data/lib/trieve_ruby_client/models/search_over_groups_response_body.rb +1 -1
  78. data/lib/trieve_ruby_client/models/search_within_group_data.rb +1 -1
  79. data/lib/trieve_ruby_client/models/set_user_api_key_request.rb +1 -1
  80. data/lib/trieve_ruby_client/models/set_user_api_key_response.rb +1 -1
  81. data/lib/trieve_ruby_client/models/single_queued_chunk_response.rb +1 -1
  82. data/lib/trieve_ruby_client/models/slim_group.rb +1 -1
  83. data/lib/trieve_ruby_client/models/slim_user.rb +1 -1
  84. data/lib/trieve_ruby_client/models/stripe_plan.rb +1 -1
  85. data/lib/trieve_ruby_client/models/suggested_queries_request.rb +1 -1
  86. data/lib/trieve_ruby_client/models/suggested_queries_response.rb +1 -1
  87. data/lib/trieve_ruby_client/models/topic.rb +1 -1
  88. data/lib/trieve_ruby_client/models/update_chunk_by_tracking_id_data.rb +1 -1
  89. data/lib/trieve_ruby_client/models/update_chunk_data.rb +1 -1
  90. data/lib/trieve_ruby_client/models/update_chunk_group_data.rb +1 -1
  91. data/lib/trieve_ruby_client/models/update_dataset_request.rb +1 -1
  92. data/lib/trieve_ruby_client/models/update_group_by_tracking_id_data.rb +1 -1
  93. data/lib/trieve_ruby_client/models/update_organization_data.rb +1 -1
  94. data/lib/trieve_ruby_client/models/update_topic_data.rb +1 -1
  95. data/lib/trieve_ruby_client/models/update_user_data.rb +1 -1
  96. data/lib/trieve_ruby_client/models/upload_file_data.rb +1 -1
  97. data/lib/trieve_ruby_client/models/upload_file_result.rb +1 -1
  98. data/lib/trieve_ruby_client/models/user_organization.rb +1 -1
  99. data/lib/trieve_ruby_client/version.rb +2 -2
  100. data/lib/trieve_ruby_client.rb +1 -1
  101. data/openapi-generator.yaml +1 -1
  102. data/openapi.json +111 -173
  103. data/spec/api/auth_api_spec.rb +16 -18
  104. data/spec/api/chunk_api_spec.rb +30 -43
  105. data/spec/api/chunk_group_api_spec.rb +54 -33
  106. data/spec/api/dataset_api_spec.rb +19 -19
  107. data/spec/api/events_api_spec.rb +10 -10
  108. data/spec/api/file_api_spec.rb +15 -15
  109. data/spec/api/health_api_spec.rb +9 -7
  110. data/spec/api/invitation_api_spec.rb +9 -9
  111. data/spec/api/message_api_spec.rb +15 -15
  112. data/spec/api/organization_api_spec.rb +19 -19
  113. data/spec/api/stripe_api_spec.rb +15 -7
  114. data/spec/api/topic_api_spec.rb +15 -15
  115. data/spec/api/user_api_spec.rb +13 -13
  116. data/spec/models/add_chunk_to_group_data_spec.rb +8 -8
  117. data/spec/models/api_key_dto_spec.rb +8 -8
  118. data/spec/models/auth_query_spec.rb +1 -1
  119. data/spec/models/batch_queued_chunk_response_spec.rb +1 -1
  120. data/spec/models/bookmark_data_spec.rb +8 -8
  121. data/spec/models/bookmark_group_result_spec.rb +8 -8
  122. data/spec/models/chat_message_proxy_spec.rb +8 -8
  123. data/spec/models/chunk_data_spec.rb +1 -1
  124. data/spec/models/chunk_filter_spec.rb +8 -8
  125. data/spec/models/chunk_group_and_file_spec.rb +8 -8
  126. data/spec/models/chunk_group_spec.rb +8 -8
  127. data/spec/models/chunk_metadata_spec.rb +8 -8
  128. data/spec/models/chunk_metadata_with_file_data_spec.rb +8 -8
  129. data/spec/models/client_dataset_configuration_spec.rb +8 -8
  130. data/spec/models/create_chunk_data_spec.rb +11 -87
  131. data/spec/models/create_chunk_group_data_spec.rb +8 -8
  132. data/spec/models/create_dataset_request_spec.rb +8 -8
  133. data/spec/models/create_message_data_spec.rb +8 -8
  134. data/spec/models/create_organization_data_spec.rb +8 -8
  135. data/spec/models/create_topic_data_spec.rb +8 -8
  136. data/spec/models/dataset_and_usage_spec.rb +8 -8
  137. data/spec/models/dataset_dto_spec.rb +8 -8
  138. data/spec/models/dataset_spec.rb +8 -8
  139. data/spec/models/dataset_usage_count_spec.rb +8 -8
  140. data/spec/models/delete_dataset_request_spec.rb +8 -8
  141. data/spec/models/delete_topic_data_spec.rb +8 -8
  142. data/spec/models/delete_user_api_key_request_spec.rb +8 -8
  143. data/spec/models/edit_message_data_spec.rb +8 -8
  144. data/spec/models/error_response_body_spec.rb +8 -8
  145. data/spec/models/event_return_spec.rb +8 -8
  146. data/spec/models/event_spec.rb +8 -8
  147. data/spec/models/field_condition_spec.rb +8 -8
  148. data/spec/models/file_dto_spec.rb +8 -8
  149. data/spec/models/file_spec.rb +8 -8
  150. data/spec/models/generate_chunks_request_spec.rb +8 -8
  151. data/spec/models/get_events_data_spec.rb +1 -1
  152. data/spec/models/get_groups_for_chunks_data_spec.rb +8 -8
  153. data/spec/models/group_data_spec.rb +8 -8
  154. data/spec/models/group_score_chunk_dto_spec.rb +8 -8
  155. data/spec/models/invitation_data_spec.rb +8 -8
  156. data/spec/models/match_condition_spec.rb +6 -6
  157. data/spec/models/message_spec.rb +8 -8
  158. data/spec/models/organization_spec.rb +8 -8
  159. data/spec/models/organization_usage_count_spec.rb +8 -8
  160. data/spec/models/range_spec.rb +8 -8
  161. data/spec/models/reccomend_group_chunks_request_spec.rb +8 -8
  162. data/spec/models/recommend_chunks_request_spec.rb +8 -8
  163. data/spec/models/regenerate_message_data_spec.rb +8 -8
  164. data/spec/models/return_queued_chunk_spec.rb +11 -21
  165. data/spec/models/score_chunk_dto_spec.rb +8 -8
  166. data/spec/models/search_chunk_data_spec.rb +8 -8
  167. data/spec/models/search_chunk_query_response_body_spec.rb +8 -8
  168. data/spec/models/search_groups_result_spec.rb +8 -8
  169. data/spec/models/search_over_groups_data_spec.rb +8 -8
  170. data/spec/models/search_over_groups_response_body_spec.rb +8 -8
  171. data/spec/models/search_within_group_data_spec.rb +8 -8
  172. data/spec/models/set_user_api_key_request_spec.rb +8 -8
  173. data/spec/models/set_user_api_key_response_spec.rb +8 -8
  174. data/spec/models/single_queued_chunk_response_spec.rb +1 -1
  175. data/spec/models/slim_group_spec.rb +8 -8
  176. data/spec/models/slim_user_spec.rb +8 -8
  177. data/spec/models/stripe_plan_spec.rb +8 -8
  178. data/spec/models/suggested_queries_request_spec.rb +8 -8
  179. data/spec/models/suggested_queries_response_spec.rb +8 -8
  180. data/spec/models/topic_spec.rb +8 -8
  181. data/spec/models/update_chunk_by_tracking_id_data_spec.rb +20 -8
  182. data/spec/models/update_chunk_data_spec.rb +20 -8
  183. data/spec/models/update_chunk_group_data_spec.rb +14 -8
  184. data/spec/models/update_dataset_request_spec.rb +8 -8
  185. data/spec/models/update_group_by_tracking_id_data_spec.rb +8 -8
  186. data/spec/models/update_organization_data_spec.rb +8 -8
  187. data/spec/models/update_topic_data_spec.rb +8 -8
  188. data/spec/models/update_user_data_spec.rb +8 -8
  189. data/spec/models/upload_file_data_spec.rb +8 -8
  190. data/spec/models/upload_file_result_spec.rb +8 -8
  191. data/spec/models/user_organization_spec.rb +8 -8
  192. data/spec/spec_helper.rb +1 -1
  193. data/trieve_ruby_client-0.4.0.gem +0 -0
  194. data/trieve_ruby_client.gemspec +1 -1
  195. metadata +3 -6
  196. data/docs/StripeSubscription.md +0 -30
  197. data/lib/trieve_ruby_client/models/stripe_subscription.rb +0 -311
  198. data/spec/models/stripe_subscription_spec.rb +0 -72
@@ -1,10 +1,10 @@
1
1
  =begin
2
- #trieve-server
2
+ #Trieve API
3
3
 
4
- #Trieve REST API OpenAPI Documentation
5
-
6
- The version of the OpenAPI document: 0.3.3
4
+ #Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
7
5
 
6
+ The version of the OpenAPI document: 0.5.0
7
+ Contact: developers@trieve.ai
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.4.0
10
10
 
@@ -13,13 +13,13 @@ Generator version: 7.4.0
13
13
  require 'spec_helper'
14
14
  require 'json'
15
15
 
16
- # Unit tests for OpenapiClient::FileApi
16
+ # Unit tests for TrieveRubyClient::FileApi
17
17
  # Automatically generated by openapi-generator (https://openapi-generator.tech)
18
18
  # Please update as you see appropriate
19
19
  describe 'FileApi' do
20
20
  before do
21
21
  # run before each test
22
- @api_instance = OpenapiClient::FileApi.new
22
+ @api_instance = TrieveRubyClient::FileApi.new
23
23
  end
24
24
 
25
25
  after do
@@ -28,13 +28,13 @@ describe 'FileApi' do
28
28
 
29
29
  describe 'test an instance of FileApi' do
30
30
  it 'should create an instance of FileApi' do
31
- expect(@api_instance).to be_instance_of(OpenapiClient::FileApi)
31
+ expect(@api_instance).to be_instance_of(TrieveRubyClient::FileApi)
32
32
  end
33
33
  end
34
34
 
35
35
  # unit tests for delete_file_handler
36
- # delete_file
37
- # 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.
36
+ # Delete File
37
+ # 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.
38
38
  # @param tr_dataset The dataset id to use for the request
39
39
  # @param file_id The id of the file to delete
40
40
  # @param delete_chunks Whether or not to delete the chunks associated with the file
@@ -47,8 +47,8 @@ describe 'FileApi' do
47
47
  end
48
48
 
49
49
  # unit tests for get_dataset_files_handler
50
- # get_dataset_files
51
- # get_dataset_files Get all files which belong to a given dataset specified by the dataset_id parameter. 10 files are returned per page.
50
+ # Get Files for Dataset
51
+ # 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.
52
52
  # @param tr_dataset The dataset id to use for the request
53
53
  # @param dataset_id The id of the dataset to fetch files for.
54
54
  # @param page The page number of files you wish to fetch. Each page contains at most 10 files.
@@ -61,8 +61,8 @@ describe 'FileApi' do
61
61
  end
62
62
 
63
63
  # unit tests for get_file_handler
64
- # get_file
65
- # 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.
64
+ # Get File
65
+ # 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.
66
66
  # @param tr_dataset The dataset id to use for the request
67
67
  # @param file_id The id of the file to fetch
68
68
  # @param [Hash] opts the optional parameters
@@ -74,8 +74,8 @@ describe 'FileApi' do
74
74
  end
75
75
 
76
76
  # unit tests for upload_file_handler
77
- # upload_file
78
- # 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.
77
+ # Upload File
78
+ # 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.
79
79
  # @param tr_dataset The dataset id to use for the request
80
80
  # @param upload_file_data JSON request payload to upload a file
81
81
  # @param [Hash] opts the optional parameters
@@ -1,10 +1,10 @@
1
1
  =begin
2
- #trieve-server
2
+ #Trieve API
3
3
 
4
- #Trieve REST API OpenAPI Documentation
5
-
6
- The version of the OpenAPI document: 0.3.3
4
+ #Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
7
5
 
6
+ The version of the OpenAPI document: 0.5.0
7
+ Contact: developers@trieve.ai
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.4.0
10
10
 
@@ -13,13 +13,13 @@ Generator version: 7.4.0
13
13
  require 'spec_helper'
14
14
  require 'json'
15
15
 
16
- # Unit tests for OpenapiClient::HealthApi
16
+ # Unit tests for TrieveRubyClient::HealthApi
17
17
  # Automatically generated by openapi-generator (https://openapi-generator.tech)
18
18
  # Please update as you see appropriate
19
19
  describe 'HealthApi' do
20
20
  before do
21
21
  # run before each test
22
- @api_instance = OpenapiClient::HealthApi.new
22
+ @api_instance = TrieveRubyClient::HealthApi.new
23
23
  end
24
24
 
25
25
  after do
@@ -28,11 +28,13 @@ describe 'HealthApi' do
28
28
 
29
29
  describe 'test an instance of HealthApi' do
30
30
  it 'should create an instance of HealthApi' do
31
- expect(@api_instance).to be_instance_of(OpenapiClient::HealthApi)
31
+ expect(@api_instance).to be_instance_of(TrieveRubyClient::HealthApi)
32
32
  end
33
33
  end
34
34
 
35
35
  # unit tests for health_check
36
+ # Health Check
37
+ # Health Check Confirmation that the service is healthy and can make embedding vectors
36
38
  # @param [Hash] opts the optional parameters
37
39
  # @return [nil]
38
40
  describe 'health_check test' do
@@ -1,10 +1,10 @@
1
1
  =begin
2
- #trieve-server
2
+ #Trieve API
3
3
 
4
- #Trieve REST API OpenAPI Documentation
5
-
6
- The version of the OpenAPI document: 0.3.3
4
+ #Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
7
5
 
6
+ The version of the OpenAPI document: 0.5.0
7
+ Contact: developers@trieve.ai
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.4.0
10
10
 
@@ -13,13 +13,13 @@ Generator version: 7.4.0
13
13
  require 'spec_helper'
14
14
  require 'json'
15
15
 
16
- # Unit tests for OpenapiClient::InvitationApi
16
+ # Unit tests for TrieveRubyClient::InvitationApi
17
17
  # Automatically generated by openapi-generator (https://openapi-generator.tech)
18
18
  # Please update as you see appropriate
19
19
  describe 'InvitationApi' do
20
20
  before do
21
21
  # run before each test
22
- @api_instance = OpenapiClient::InvitationApi.new
22
+ @api_instance = TrieveRubyClient::InvitationApi.new
23
23
  end
24
24
 
25
25
  after do
@@ -28,13 +28,13 @@ describe 'InvitationApi' do
28
28
 
29
29
  describe 'test an instance of InvitationApi' do
30
30
  it 'should create an instance of InvitationApi' do
31
- expect(@api_instance).to be_instance_of(OpenapiClient::InvitationApi)
31
+ expect(@api_instance).to be_instance_of(TrieveRubyClient::InvitationApi)
32
32
  end
33
33
  end
34
34
 
35
35
  # unit tests for post_invitation
36
- # send_invitation
37
- # 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.
36
+ # Send Invitation
37
+ # 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.
38
38
  # @param tr_organization The organization id to use for the request
39
39
  # @param invitation_data JSON request payload to send an invitation
40
40
  # @param [Hash] opts the optional parameters
@@ -1,10 +1,10 @@
1
1
  =begin
2
- #trieve-server
2
+ #Trieve API
3
3
 
4
- #Trieve REST API OpenAPI Documentation
5
-
6
- The version of the OpenAPI document: 0.3.3
4
+ #Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
7
5
 
6
+ The version of the OpenAPI document: 0.5.0
7
+ Contact: developers@trieve.ai
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.4.0
10
10
 
@@ -13,13 +13,13 @@ Generator version: 7.4.0
13
13
  require 'spec_helper'
14
14
  require 'json'
15
15
 
16
- # Unit tests for OpenapiClient::MessageApi
16
+ # Unit tests for TrieveRubyClient::MessageApi
17
17
  # Automatically generated by openapi-generator (https://openapi-generator.tech)
18
18
  # Please update as you see appropriate
19
19
  describe 'MessageApi' do
20
20
  before do
21
21
  # run before each test
22
- @api_instance = OpenapiClient::MessageApi.new
22
+ @api_instance = TrieveRubyClient::MessageApi.new
23
23
  end
24
24
 
25
25
  after do
@@ -28,13 +28,13 @@ describe 'MessageApi' do
28
28
 
29
29
  describe 'test an instance of MessageApi' do
30
30
  it 'should create an instance of MessageApi' do
31
- expect(@api_instance).to be_instance_of(OpenapiClient::MessageApi)
31
+ expect(@api_instance).to be_instance_of(TrieveRubyClient::MessageApi)
32
32
  end
33
33
  end
34
34
 
35
35
  # unit tests for create_message_completion_handler
36
- # create_message
37
- # 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.
36
+ # Create a message
37
+ # 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.
38
38
  # @param tr_dataset The dataset id to use for the request
39
39
  # @param create_message_data JSON request payload to create a message completion
40
40
  # @param [Hash] opts the optional parameters
@@ -46,8 +46,8 @@ describe 'MessageApi' do
46
46
  end
47
47
 
48
48
  # unit tests for edit_message_handler
49
- # edit_message
50
- # 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.
49
+ # Edit a message
50
+ # 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.
51
51
  # @param tr_dataset The dataset id to use for the request
52
52
  # @param edit_message_data JSON request payload to edit a message and get a new stream
53
53
  # @param [Hash] opts the optional parameters
@@ -59,8 +59,8 @@ describe 'MessageApi' do
59
59
  end
60
60
 
61
61
  # unit tests for get_all_topic_messages
62
- # get_all_messages
63
- # 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.
62
+ # Get all messages for a given topic
63
+ # 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.
64
64
  # @param tr_dataset The dataset id to use for the request
65
65
  # @param messages_topic_id The ID of the topic to get messages for.
66
66
  # @param [Hash] opts the optional parameters
@@ -72,8 +72,8 @@ describe 'MessageApi' do
72
72
  end
73
73
 
74
74
  # unit tests for regenerate_message_handler
75
- # regenerate_message
76
- # 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.
75
+ # Regenerate message
76
+ # 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.
77
77
  # @param tr_dataset The dataset id to use for the request
78
78
  # @param regenerate_message_data JSON request payload to delete an agent message then regenerate it in a strem
79
79
  # @param [Hash] opts the optional parameters
@@ -1,10 +1,10 @@
1
1
  =begin
2
- #trieve-server
2
+ #Trieve API
3
3
 
4
- #Trieve REST API OpenAPI Documentation
5
-
6
- The version of the OpenAPI document: 0.3.3
4
+ #Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
7
5
 
6
+ The version of the OpenAPI document: 0.5.0
7
+ Contact: developers@trieve.ai
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.4.0
10
10
 
@@ -13,13 +13,13 @@ Generator version: 7.4.0
13
13
  require 'spec_helper'
14
14
  require 'json'
15
15
 
16
- # Unit tests for OpenapiClient::OrganizationApi
16
+ # Unit tests for TrieveRubyClient::OrganizationApi
17
17
  # Automatically generated by openapi-generator (https://openapi-generator.tech)
18
18
  # Please update as you see appropriate
19
19
  describe 'OrganizationApi' do
20
20
  before do
21
21
  # run before each test
22
- @api_instance = OpenapiClient::OrganizationApi.new
22
+ @api_instance = TrieveRubyClient::OrganizationApi.new
23
23
  end
24
24
 
25
25
  after do
@@ -28,13 +28,13 @@ describe 'OrganizationApi' do
28
28
 
29
29
  describe 'test an instance of OrganizationApi' do
30
30
  it 'should create an instance of OrganizationApi' do
31
- expect(@api_instance).to be_instance_of(OpenapiClient::OrganizationApi)
31
+ expect(@api_instance).to be_instance_of(TrieveRubyClient::OrganizationApi)
32
32
  end
33
33
  end
34
34
 
35
35
  # unit tests for create_organization
36
- # create_organization
37
- # create_organization Create a new organization. The auth'ed user who creates the organization will be the default owner of the organization.
36
+ # Create Organization
37
+ # Create Organization Create a new organization. The auth'ed user who creates the organization will be the default owner of the organization.
38
38
  # @param create_organization_data The organization data that you want to create
39
39
  # @param [Hash] opts the optional parameters
40
40
  # @return [Organization]
@@ -45,8 +45,8 @@ describe 'OrganizationApi' do
45
45
  end
46
46
 
47
47
  # unit tests for delete_organization_by_id
48
- # delete_organization
49
- # delete_organization Delete an organization by its id. The auth'ed user must be an owner of the organization to delete it.
48
+ # Delete Organization
49
+ # Delete Organization Delete an organization by its id. The auth'ed user must be an owner of the organization to delete it.
50
50
  # @param tr_organization The organization id to use for the request
51
51
  # @param organization_id The id of the organization you want to fetch.
52
52
  # @param [Hash] opts the optional parameters
@@ -58,8 +58,8 @@ describe 'OrganizationApi' do
58
58
  end
59
59
 
60
60
  # unit tests for get_organization_by_id
61
- # get_organization
62
- # 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.
61
+ # Get Organization
62
+ # 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.
63
63
  # @param tr_organization The organization id to use for the request
64
64
  # @param organization_id The id of the organization you want to fetch.
65
65
  # @param [Hash] opts the optional parameters
@@ -71,8 +71,8 @@ describe 'OrganizationApi' do
71
71
  end
72
72
 
73
73
  # unit tests for get_organization_usage
74
- # get_organization_usage
75
- # 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.
74
+ # Get Organization Usage
75
+ # 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.
76
76
  # @param tr_organization The organization id to use for the request
77
77
  # @param organization_id The id of the organization you want to fetch the usage of.
78
78
  # @param [Hash] opts the optional parameters
@@ -84,8 +84,8 @@ describe 'OrganizationApi' do
84
84
  end
85
85
 
86
86
  # unit tests for get_organization_users
87
- # get_organization_users
88
- # 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.
87
+ # Get Organization Users
88
+ # 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.
89
89
  # @param tr_organization The organization id to use for the request
90
90
  # @param organization_id The id of the organization you want to fetch the users of.
91
91
  # @param [Hash] opts the optional parameters
@@ -97,8 +97,8 @@ describe 'OrganizationApi' do
97
97
  end
98
98
 
99
99
  # unit tests for update_organization
100
- # update_organization
101
- # update_organization Update an organization. Only the owner of the organization can update it.
100
+ # Update Organization
101
+ # Update Organization Update an organization. Only the owner of the organization can update it.
102
102
  # @param tr_organization The organization id to use for the request
103
103
  # @param update_organization_data The organization data that you want to update
104
104
  # @param [Hash] opts the optional parameters
@@ -1,10 +1,10 @@
1
1
  =begin
2
- #trieve-server
2
+ #Trieve API
3
3
 
4
- #Trieve REST API OpenAPI Documentation
5
-
6
- The version of the OpenAPI document: 0.3.3
4
+ #Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
7
5
 
6
+ The version of the OpenAPI document: 0.5.0
7
+ Contact: developers@trieve.ai
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.4.0
10
10
 
@@ -13,13 +13,13 @@ Generator version: 7.4.0
13
13
  require 'spec_helper'
14
14
  require 'json'
15
15
 
16
- # Unit tests for OpenapiClient::StripeApi
16
+ # Unit tests for TrieveRubyClient::StripeApi
17
17
  # Automatically generated by openapi-generator (https://openapi-generator.tech)
18
18
  # Please update as you see appropriate
19
19
  describe 'StripeApi' do
20
20
  before do
21
21
  # run before each test
22
- @api_instance = OpenapiClient::StripeApi.new
22
+ @api_instance = TrieveRubyClient::StripeApi.new
23
23
  end
24
24
 
25
25
  after do
@@ -28,11 +28,13 @@ describe 'StripeApi' do
28
28
 
29
29
  describe 'test an instance of StripeApi' do
30
30
  it 'should create an instance of StripeApi' do
31
- expect(@api_instance).to be_instance_of(OpenapiClient::StripeApi)
31
+ expect(@api_instance).to be_instance_of(TrieveRubyClient::StripeApi)
32
32
  end
33
33
  end
34
34
 
35
35
  # unit tests for cancel_subscription
36
+ # Cancel Subscription
37
+ # Cancel Subscription Cancel a subscription by its id
36
38
  # @param tr_organization The organization id to use for the request
37
39
  # @param subscription_id id of the subscription you want to cancel
38
40
  # @param [Hash] opts the optional parameters
@@ -44,6 +46,8 @@ describe 'StripeApi' do
44
46
  end
45
47
 
46
48
  # unit tests for direct_to_payment_link
49
+ # Checkout
50
+ # Checkout Get a direct link to the stripe checkout page for the plan and organization
47
51
  # @param plan_id id of the plan you want to subscribe to
48
52
  # @param organization_id id of the organization you want to subscribe to the plan
49
53
  # @param [Hash] opts the optional parameters
@@ -55,6 +59,8 @@ describe 'StripeApi' do
55
59
  end
56
60
 
57
61
  # unit tests for get_all_plans
62
+ # Get All Plans
63
+ # Get All Plans Get a list of all plans
58
64
  # @param [Hash] opts the optional parameters
59
65
  # @return [Array<StripePlan>]
60
66
  describe 'get_all_plans test' do
@@ -64,6 +70,8 @@ describe 'StripeApi' do
64
70
  end
65
71
 
66
72
  # unit tests for update_subscription_plan
73
+ # Update Subscription Plan
74
+ # Update Subscription Plan Update a subscription to a new plan
67
75
  # @param tr_organization The organization id to use for the request
68
76
  # @param subscription_id id of the subscription you want to update
69
77
  # @param plan_id id of the plan you want to subscribe to
@@ -1,10 +1,10 @@
1
1
  =begin
2
- #trieve-server
2
+ #Trieve API
3
3
 
4
- #Trieve REST API OpenAPI Documentation
5
-
6
- The version of the OpenAPI document: 0.3.3
4
+ #Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
7
5
 
6
+ The version of the OpenAPI document: 0.5.0
7
+ Contact: developers@trieve.ai
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.4.0
10
10
 
@@ -13,13 +13,13 @@ Generator version: 7.4.0
13
13
  require 'spec_helper'
14
14
  require 'json'
15
15
 
16
- # Unit tests for OpenapiClient::TopicApi
16
+ # Unit tests for TrieveRubyClient::TopicApi
17
17
  # Automatically generated by openapi-generator (https://openapi-generator.tech)
18
18
  # Please update as you see appropriate
19
19
  describe 'TopicApi' do
20
20
  before do
21
21
  # run before each test
22
- @api_instance = OpenapiClient::TopicApi.new
22
+ @api_instance = TrieveRubyClient::TopicApi.new
23
23
  end
24
24
 
25
25
  after do
@@ -28,13 +28,13 @@ describe 'TopicApi' do
28
28
 
29
29
  describe 'test an instance of TopicApi' do
30
30
  it 'should create an instance of TopicApi' do
31
- expect(@api_instance).to be_instance_of(OpenapiClient::TopicApi)
31
+ expect(@api_instance).to be_instance_of(TrieveRubyClient::TopicApi)
32
32
  end
33
33
  end
34
34
 
35
35
  # unit tests for create_topic
36
- # create_topic
37
- # create_topic Create a new chat topic. Topics are attached to a user and act as a coordinator for memory of gen-AI chat sessions. We are considering refactoring this resource of the API soon.
36
+ # Create Topic
37
+ # Create Topic Create a new chat topic. Topics are attached to a user and act as a coordinator for memory of gen-AI chat sessions. We are considering refactoring this resource of the API soon.
38
38
  # @param tr_dataset The dataset id to use for the request
39
39
  # @param create_topic_data JSON request payload to create chat topic
40
40
  # @param [Hash] opts the optional parameters
@@ -46,8 +46,8 @@ describe 'TopicApi' do
46
46
  end
47
47
 
48
48
  # unit tests for delete_topic
49
- # delete_topic
50
- # delete_topic Delete an existing chat topic. When a topic is deleted, all associated chat messages are also deleted.
49
+ # Delete Topic
50
+ # Delete Topic Delete an existing chat topic. When a topic is deleted, all associated chat messages are also deleted.
51
51
  # @param tr_dataset The dataset id to use for the request
52
52
  # @param delete_topic_data JSON request payload to delete a chat topic
53
53
  # @param [Hash] opts the optional parameters
@@ -59,8 +59,8 @@ describe 'TopicApi' do
59
59
  end
60
60
 
61
61
  # unit tests for get_all_topics_for_user
62
- # get_all_topics_for_user
63
- # get_all_topics_for_user Get all topics belonging to a the auth&#39;ed user. Soon, we plan to allow specification of the user for this route and include pagination.
62
+ # Get All Topics for User
63
+ # Get All Topics for User Get all topics belonging to a the auth&#39;ed user. Soon, we plan to allow specification of the user for this route and include pagination.
64
64
  # @param user_id The id of the user to get topics for
65
65
  # @param tr_dataset The dataset id to use for the request
66
66
  # @param [Hash] opts the optional parameters
@@ -72,8 +72,8 @@ describe 'TopicApi' do
72
72
  end
73
73
 
74
74
  # unit tests for update_topic
75
- # update_topic
76
- # update_topic Update an existing chat topic. Currently, only the name of the topic can be updated.
75
+ # Update Topic
76
+ # Update Topic Update an existing chat topic. Currently, only the name of the topic can be updated.
77
77
  # @param tr_dataset The dataset id to use for the request
78
78
  # @param update_topic_data JSON request payload to update a chat topic
79
79
  # @param [Hash] opts the optional parameters
@@ -1,10 +1,10 @@
1
1
  =begin
2
- #trieve-server
2
+ #Trieve API
3
3
 
4
- #Trieve REST API OpenAPI Documentation
5
-
6
- The version of the OpenAPI document: 0.3.3
4
+ #Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
7
5
 
6
+ The version of the OpenAPI document: 0.5.0
7
+ Contact: developers@trieve.ai
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.4.0
10
10
 
@@ -13,13 +13,13 @@ Generator version: 7.4.0
13
13
  require 'spec_helper'
14
14
  require 'json'
15
15
 
16
- # Unit tests for OpenapiClient::UserApi
16
+ # Unit tests for TrieveRubyClient::UserApi
17
17
  # Automatically generated by openapi-generator (https://openapi-generator.tech)
18
18
  # Please update as you see appropriate
19
19
  describe 'UserApi' do
20
20
  before do
21
21
  # run before each test
22
- @api_instance = OpenapiClient::UserApi.new
22
+ @api_instance = TrieveRubyClient::UserApi.new
23
23
  end
24
24
 
25
25
  after do
@@ -28,13 +28,13 @@ describe 'UserApi' do
28
28
 
29
29
  describe 'test an instance of UserApi' do
30
30
  it 'should create an instance of UserApi' do
31
- expect(@api_instance).to be_instance_of(OpenapiClient::UserApi)
31
+ expect(@api_instance).to be_instance_of(TrieveRubyClient::UserApi)
32
32
  end
33
33
  end
34
34
 
35
35
  # unit tests for delete_user_api_key
36
- # delete_user_api_key
37
- # delete_user_api_key Delete an api key for the auth&#39;ed user.
36
+ # Delete User Api Key
37
+ # Delete User Api Key Delete an api key for the auth&#39;ed user.
38
38
  # @param delete_user_api_key_request JSON request payload to delete a user api key
39
39
  # @param [Hash] opts the optional parameters
40
40
  # @return [Array<ApiKeyDTO>]
@@ -45,8 +45,8 @@ describe 'UserApi' do
45
45
  end
46
46
 
47
47
  # unit tests for set_user_api_key
48
- # set_user_api_key
49
- # set_user_api_key Create a new api key for the auth&#39;ed user. Successful response will contain the newly created api key. If a write role is assigned the api key will have permission level of the auth&#39;ed user who calls this endpoint.
48
+ # Set User Api Key
49
+ # Set User Api Key Create a new api key for the auth&#39;ed user. Successful response will contain the newly created api key. If a write role is assigned the api key will have permission level of the auth&#39;ed user who calls this endpoint.
50
50
  # @param set_user_api_key_request JSON request payload to create a new user api key
51
51
  # @param [Hash] opts the optional parameters
52
52
  # @return [SetUserApiKeyResponse]
@@ -57,8 +57,8 @@ describe 'UserApi' do
57
57
  end
58
58
 
59
59
  # unit tests for update_user
60
- # update_user
61
- # update_user Update a user&#39;s information. If the user_id is not provided, the auth&#39;ed user will be updated. If the user_id is provided, the auth&#39;ed user must be an admin (1) or owner (2) of the organization.
60
+ # Update User
61
+ # Update User Update a user&#39;s information. If the user_id is not provided, the auth&#39;ed user will be updated. If the user_id is provided, the auth&#39;ed user must be an admin (1) or owner (2) of the organization.
62
62
  # @param update_user_data JSON request payload to update user information for the auth&#39;ed user
63
63
  # @param [Hash] opts the optional parameters
64
64
  # @return [SlimUser]
@@ -1,10 +1,10 @@
1
1
  =begin
2
- #trieve-server
2
+ #Trieve API
3
3
 
4
- #Trieve REST API OpenAPI Documentation
5
-
6
- The version of the OpenAPI document: 0.3.3
4
+ #Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
7
5
 
6
+ The version of the OpenAPI document: 0.5.0
7
+ Contact: developers@trieve.ai
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.4.0
10
10
 
@@ -14,16 +14,16 @@ require 'spec_helper'
14
14
  require 'json'
15
15
  require 'date'
16
16
 
17
- # Unit tests for OpenapiClient::AddChunkToGroupData
17
+ # Unit tests for TrieveRubyClient::AddChunkToGroupData
18
18
  # Automatically generated by openapi-generator (https://openapi-generator.tech)
19
19
  # Please update as you see appropriate
20
- describe OpenapiClient::AddChunkToGroupData do
21
- let(:instance) { OpenapiClient::AddChunkToGroupData.new }
20
+ describe TrieveRubyClient::AddChunkToGroupData do
21
+ let(:instance) { TrieveRubyClient::AddChunkToGroupData.new }
22
22
 
23
23
  describe 'test an instance of AddChunkToGroupData' do
24
24
  it 'should create an instance of AddChunkToGroupData' do
25
25
  # uncomment below to test the instance creation
26
- #expect(instance).to be_instance_of(OpenapiClient::AddChunkToGroupData)
26
+ #expect(instance).to be_instance_of(TrieveRubyClient::AddChunkToGroupData)
27
27
  end
28
28
  end
29
29
 
@@ -1,10 +1,10 @@
1
1
  =begin
2
- #trieve-server
2
+ #Trieve API
3
3
 
4
- #Trieve REST API OpenAPI Documentation
5
-
6
- The version of the OpenAPI document: 0.3.3
4
+ #Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
7
5
 
6
+ The version of the OpenAPI document: 0.5.0
7
+ Contact: developers@trieve.ai
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.4.0
10
10
 
@@ -14,16 +14,16 @@ require 'spec_helper'
14
14
  require 'json'
15
15
  require 'date'
16
16
 
17
- # Unit tests for OpenapiClient::ApiKeyDTO
17
+ # Unit tests for TrieveRubyClient::ApiKeyDTO
18
18
  # Automatically generated by openapi-generator (https://openapi-generator.tech)
19
19
  # Please update as you see appropriate
20
- describe OpenapiClient::ApiKeyDTO do
21
- let(:instance) { OpenapiClient::ApiKeyDTO.new }
20
+ describe TrieveRubyClient::ApiKeyDTO do
21
+ let(:instance) { TrieveRubyClient::ApiKeyDTO.new }
22
22
 
23
23
  describe 'test an instance of ApiKeyDTO' do
24
24
  it 'should create an instance of ApiKeyDTO' do
25
25
  # uncomment below to test the instance creation
26
- #expect(instance).to be_instance_of(OpenapiClient::ApiKeyDTO)
26
+ #expect(instance).to be_instance_of(TrieveRubyClient::ApiKeyDTO)
27
27
  end
28
28
  end
29
29
 
@@ -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.4.0
6
+ The version of the OpenAPI document: 0.5.0
7
7
  Contact: developers@trieve.ai
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.4.0