trieve_ruby_client 0.3.5 → 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 (217) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +78 -74
  3. data/docs/AddChunkToGroupData.md +1 -1
  4. data/docs/AuthApi.md +28 -34
  5. data/docs/AuthQuery.md +22 -0
  6. data/docs/BatchQueuedChunkResponse.md +20 -0
  7. data/docs/ChunkApi.md +69 -147
  8. data/docs/ChunkData.md +42 -0
  9. data/docs/ChunkGroupApi.md +168 -90
  10. data/docs/CreateChunkData.md +41 -34
  11. data/docs/DatasetApi.md +31 -31
  12. data/docs/EventsApi.md +13 -13
  13. data/docs/FileApi.md +21 -21
  14. data/docs/GetEventsData.md +22 -0
  15. data/docs/HealthApi.md +6 -4
  16. data/docs/InvitationApi.md +6 -6
  17. data/docs/MessageApi.md +21 -21
  18. data/docs/OrganizationApi.md +31 -31
  19. data/docs/ReturnQueuedChunk.md +39 -10
  20. data/docs/SingleQueuedChunkResponse.md +20 -0
  21. data/docs/StripeApi.md +21 -13
  22. data/docs/TopicApi.md +21 -21
  23. data/docs/UserApi.md +16 -16
  24. data/lib/trieve_ruby_client/api/auth_api.rb +27 -34
  25. data/lib/trieve_ruby_client/api/chunk_api.rb +64 -143
  26. data/lib/trieve_ruby_client/api/chunk_group_api.rb +153 -75
  27. data/lib/trieve_ruby_client/api/dataset_api.rb +25 -25
  28. data/lib/trieve_ruby_client/api/events_api.rb +21 -16
  29. data/lib/trieve_ruby_client/api/file_api.rb +17 -17
  30. data/lib/trieve_ruby_client/api/health_api.rb +5 -1
  31. data/lib/trieve_ruby_client/api/invitation_api.rb +5 -5
  32. data/lib/trieve_ruby_client/api/message_api.rb +17 -17
  33. data/lib/trieve_ruby_client/api/organization_api.rb +25 -25
  34. data/lib/trieve_ruby_client/api/stripe_api.rb +17 -1
  35. data/lib/trieve_ruby_client/api/topic_api.rb +17 -17
  36. data/lib/trieve_ruby_client/api/user_api.rb +13 -13
  37. data/lib/trieve_ruby_client/api_client.rb +1 -1
  38. data/lib/trieve_ruby_client/api_error.rb +1 -1
  39. data/lib/trieve_ruby_client/configuration.rb +8 -4
  40. data/lib/trieve_ruby_client/models/add_chunk_to_group_data.rb +2 -2
  41. data/lib/trieve_ruby_client/models/api_key_dto.rb +1 -1
  42. data/lib/trieve_ruby_client/models/{stripe_subscription.rb → auth_query.rb} +23 -96
  43. data/lib/trieve_ruby_client/models/batch_queued_chunk_response.rb +240 -0
  44. data/lib/trieve_ruby_client/models/bookmark_data.rb +1 -1
  45. data/lib/trieve_ruby_client/models/bookmark_group_result.rb +1 -1
  46. data/lib/trieve_ruby_client/models/chat_message_proxy.rb +1 -1
  47. data/lib/trieve_ruby_client/models/chunk_data.rb +356 -0
  48. data/lib/trieve_ruby_client/models/chunk_filter.rb +1 -1
  49. data/lib/trieve_ruby_client/models/chunk_group.rb +1 -1
  50. data/lib/trieve_ruby_client/models/chunk_group_and_file.rb +1 -1
  51. data/lib/trieve_ruby_client/models/chunk_metadata.rb +1 -1
  52. data/lib/trieve_ruby_client/models/chunk_metadata_with_file_data.rb +1 -1
  53. data/lib/trieve_ruby_client/models/client_dataset_configuration.rb +1 -1
  54. data/lib/trieve_ruby_client/models/create_chunk_data.rb +79 -330
  55. data/lib/trieve_ruby_client/models/create_chunk_group_data.rb +1 -1
  56. data/lib/trieve_ruby_client/models/create_dataset_request.rb +1 -1
  57. data/lib/trieve_ruby_client/models/create_message_data.rb +1 -1
  58. data/lib/trieve_ruby_client/models/create_organization_data.rb +1 -1
  59. data/lib/trieve_ruby_client/models/create_topic_data.rb +1 -1
  60. data/lib/trieve_ruby_client/models/dataset.rb +1 -1
  61. data/lib/trieve_ruby_client/models/dataset_and_usage.rb +1 -1
  62. data/lib/trieve_ruby_client/models/dataset_dto.rb +1 -1
  63. data/lib/trieve_ruby_client/models/dataset_usage_count.rb +1 -1
  64. data/lib/trieve_ruby_client/models/delete_dataset_request.rb +1 -1
  65. data/lib/trieve_ruby_client/models/delete_topic_data.rb +1 -1
  66. data/lib/trieve_ruby_client/models/delete_user_api_key_request.rb +1 -1
  67. data/lib/trieve_ruby_client/models/edit_message_data.rb +1 -1
  68. data/lib/trieve_ruby_client/models/error_response_body.rb +1 -1
  69. data/lib/trieve_ruby_client/models/event.rb +1 -1
  70. data/lib/trieve_ruby_client/models/event_return.rb +1 -1
  71. data/lib/trieve_ruby_client/models/field_condition.rb +1 -1
  72. data/lib/trieve_ruby_client/models/file.rb +1 -1
  73. data/lib/trieve_ruby_client/models/file_dto.rb +1 -1
  74. data/lib/trieve_ruby_client/models/generate_chunks_request.rb +1 -1
  75. data/lib/trieve_ruby_client/models/get_events_data.rb +240 -0
  76. data/lib/trieve_ruby_client/models/get_groups_for_chunks_data.rb +1 -1
  77. data/lib/trieve_ruby_client/models/group_data.rb +1 -1
  78. data/lib/trieve_ruby_client/models/group_score_chunk_dto.rb +1 -1
  79. data/lib/trieve_ruby_client/models/invitation_data.rb +1 -1
  80. data/lib/trieve_ruby_client/models/match_condition.rb +1 -1
  81. data/lib/trieve_ruby_client/models/message.rb +1 -1
  82. data/lib/trieve_ruby_client/models/organization.rb +1 -1
  83. data/lib/trieve_ruby_client/models/organization_usage_count.rb +1 -1
  84. data/lib/trieve_ruby_client/models/range.rb +1 -1
  85. data/lib/trieve_ruby_client/models/reccomend_group_chunks_request.rb +1 -1
  86. data/lib/trieve_ruby_client/models/recommend_chunks_request.rb +1 -1
  87. data/lib/trieve_ruby_client/models/regenerate_message_data.rb +1 -1
  88. data/lib/trieve_ruby_client/models/return_queued_chunk.rb +75 -207
  89. data/lib/trieve_ruby_client/models/score_chunk_dto.rb +1 -1
  90. data/lib/trieve_ruby_client/models/search_chunk_data.rb +1 -1
  91. data/lib/trieve_ruby_client/models/search_chunk_query_response_body.rb +1 -1
  92. data/lib/trieve_ruby_client/models/search_groups_result.rb +1 -1
  93. data/lib/trieve_ruby_client/models/search_over_groups_data.rb +1 -1
  94. data/lib/trieve_ruby_client/models/search_over_groups_response_body.rb +1 -1
  95. data/lib/trieve_ruby_client/models/search_within_group_data.rb +1 -1
  96. data/lib/trieve_ruby_client/models/set_user_api_key_request.rb +1 -1
  97. data/lib/trieve_ruby_client/models/set_user_api_key_response.rb +1 -1
  98. data/lib/trieve_ruby_client/models/single_queued_chunk_response.rb +238 -0
  99. data/lib/trieve_ruby_client/models/slim_group.rb +1 -1
  100. data/lib/trieve_ruby_client/models/slim_user.rb +1 -1
  101. data/lib/trieve_ruby_client/models/stripe_plan.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 +1 -1
  119. data/openapi.json +1196 -849
  120. data/spec/api/auth_api_spec.rb +16 -18
  121. data/spec/api/chunk_api_spec.rb +30 -43
  122. data/spec/api/chunk_group_api_spec.rb +54 -33
  123. data/spec/api/dataset_api_spec.rb +19 -19
  124. data/spec/api/events_api_spec.rb +10 -10
  125. data/spec/api/file_api_spec.rb +15 -15
  126. data/spec/api/health_api_spec.rb +9 -7
  127. data/spec/api/invitation_api_spec.rb +9 -9
  128. data/spec/api/message_api_spec.rb +15 -15
  129. data/spec/api/organization_api_spec.rb +19 -19
  130. data/spec/api/stripe_api_spec.rb +15 -7
  131. data/spec/api/topic_api_spec.rb +15 -15
  132. data/spec/api/user_api_spec.rb +13 -13
  133. data/spec/models/add_chunk_to_group_data_spec.rb +8 -8
  134. data/spec/models/api_key_dto_spec.rb +8 -8
  135. data/spec/models/auth_query_spec.rb +48 -0
  136. data/spec/models/batch_queued_chunk_response_spec.rb +42 -0
  137. data/spec/models/bookmark_data_spec.rb +8 -8
  138. data/spec/models/bookmark_group_result_spec.rb +8 -8
  139. data/spec/models/chat_message_proxy_spec.rb +8 -8
  140. data/spec/models/chunk_data_spec.rb +108 -0
  141. data/spec/models/chunk_filter_spec.rb +8 -8
  142. data/spec/models/chunk_group_and_file_spec.rb +8 -8
  143. data/spec/models/chunk_group_spec.rb +8 -8
  144. data/spec/models/chunk_metadata_spec.rb +8 -8
  145. data/spec/models/chunk_metadata_with_file_data_spec.rb +8 -8
  146. data/spec/models/client_dataset_configuration_spec.rb +8 -8
  147. data/spec/models/create_chunk_data_spec.rb +11 -87
  148. data/spec/models/create_chunk_group_data_spec.rb +8 -8
  149. data/spec/models/create_dataset_request_spec.rb +8 -8
  150. data/spec/models/create_message_data_spec.rb +8 -8
  151. data/spec/models/create_organization_data_spec.rb +8 -8
  152. data/spec/models/create_topic_data_spec.rb +8 -8
  153. data/spec/models/dataset_and_usage_spec.rb +8 -8
  154. data/spec/models/dataset_dto_spec.rb +8 -8
  155. data/spec/models/dataset_spec.rb +8 -8
  156. data/spec/models/dataset_usage_count_spec.rb +8 -8
  157. data/spec/models/delete_dataset_request_spec.rb +8 -8
  158. data/spec/models/delete_topic_data_spec.rb +8 -8
  159. data/spec/models/delete_user_api_key_request_spec.rb +8 -8
  160. data/spec/models/edit_message_data_spec.rb +8 -8
  161. data/spec/models/error_response_body_spec.rb +8 -8
  162. data/spec/models/event_return_spec.rb +8 -8
  163. data/spec/models/event_spec.rb +8 -8
  164. data/spec/models/field_condition_spec.rb +8 -8
  165. data/spec/models/file_dto_spec.rb +8 -8
  166. data/spec/models/file_spec.rb +8 -8
  167. data/spec/models/generate_chunks_request_spec.rb +8 -8
  168. data/spec/models/get_events_data_spec.rb +48 -0
  169. data/spec/models/get_groups_for_chunks_data_spec.rb +8 -8
  170. data/spec/models/group_data_spec.rb +8 -8
  171. data/spec/models/group_score_chunk_dto_spec.rb +8 -8
  172. data/spec/models/invitation_data_spec.rb +8 -8
  173. data/spec/models/match_condition_spec.rb +6 -6
  174. data/spec/models/message_spec.rb +8 -8
  175. data/spec/models/organization_spec.rb +8 -8
  176. data/spec/models/organization_usage_count_spec.rb +8 -8
  177. data/spec/models/range_spec.rb +8 -8
  178. data/spec/models/reccomend_group_chunks_request_spec.rb +8 -8
  179. data/spec/models/recommend_chunks_request_spec.rb +8 -8
  180. data/spec/models/regenerate_message_data_spec.rb +8 -8
  181. data/spec/models/return_queued_chunk_spec.rb +11 -21
  182. data/spec/models/score_chunk_dto_spec.rb +8 -8
  183. data/spec/models/search_chunk_data_spec.rb +8 -8
  184. data/spec/models/search_chunk_query_response_body_spec.rb +8 -8
  185. data/spec/models/search_groups_result_spec.rb +8 -8
  186. data/spec/models/search_over_groups_data_spec.rb +8 -8
  187. data/spec/models/search_over_groups_response_body_spec.rb +8 -8
  188. data/spec/models/search_within_group_data_spec.rb +8 -8
  189. data/spec/models/set_user_api_key_request_spec.rb +8 -8
  190. data/spec/models/set_user_api_key_response_spec.rb +8 -8
  191. data/spec/models/single_queued_chunk_response_spec.rb +42 -0
  192. data/spec/models/slim_group_spec.rb +8 -8
  193. data/spec/models/slim_user_spec.rb +8 -8
  194. data/spec/models/stripe_plan_spec.rb +8 -8
  195. data/spec/models/suggested_queries_request_spec.rb +8 -8
  196. data/spec/models/suggested_queries_response_spec.rb +8 -8
  197. data/spec/models/topic_spec.rb +8 -8
  198. data/spec/models/update_chunk_by_tracking_id_data_spec.rb +20 -8
  199. data/spec/models/update_chunk_data_spec.rb +20 -8
  200. data/spec/models/update_chunk_group_data_spec.rb +14 -8
  201. data/spec/models/update_dataset_request_spec.rb +8 -8
  202. data/spec/models/update_group_by_tracking_id_data_spec.rb +8 -8
  203. data/spec/models/update_organization_data_spec.rb +8 -8
  204. data/spec/models/update_topic_data_spec.rb +8 -8
  205. data/spec/models/update_user_data_spec.rb +8 -8
  206. data/spec/models/upload_file_data_spec.rb +8 -8
  207. data/spec/models/upload_file_result_spec.rb +8 -8
  208. data/spec/models/user_organization_spec.rb +8 -8
  209. data/spec/spec_helper.rb +1 -1
  210. data/trieve_ruby_client-0.3.5.gem +0 -0
  211. data/trieve_ruby_client-0.4.0.gem +0 -0
  212. data/trieve_ruby_client.gemspec +1 -1
  213. metadata +24 -8
  214. data/docs/StripeSubscription.md +0 -30
  215. data/spec/models/stripe_subscription_spec.rb +0 -72
  216. data/trieve_ruby_client-0.3.4.gem +0 -0
  217. data/trieve_ruby_client-0.3.41.gem +0 -0
data/docs/UserApi.md CHANGED
@@ -1,21 +1,21 @@
1
1
  # TrieveRubyClient::UserApi
2
2
 
3
- All URIs are relative to *http://localhost*
3
+ All URIs are relative to *http://localhost:8090*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
7
- | [**delete_user_api_key**](UserApi.md#delete_user_api_key) | **DELETE** /api/user/delete_api_key | delete_user_api_key |
8
- | [**set_user_api_key**](UserApi.md#set_user_api_key) | **POST** /api/user/set_api_key | set_user_api_key |
9
- | [**update_user**](UserApi.md#update_user) | **PUT** /api/user | update_user |
7
+ | [**delete_user_api_key**](UserApi.md#delete_user_api_key) | **DELETE** /api/user/delete_api_key | Delete User Api Key |
8
+ | [**set_user_api_key**](UserApi.md#set_user_api_key) | **POST** /api/user/set_api_key | Set User Api Key |
9
+ | [**update_user**](UserApi.md#update_user) | **PUT** /api/user | Update User |
10
10
 
11
11
 
12
12
  ## delete_user_api_key
13
13
 
14
14
  > <Array<ApiKeyDTO>> delete_user_api_key(delete_user_api_key_request)
15
15
 
16
- delete_user_api_key
16
+ Delete User Api Key
17
17
 
18
- delete_user_api_key Delete an api key for the auth'ed user.
18
+ Delete User Api Key Delete an api key for the auth'ed user.
19
19
 
20
20
  ### Examples
21
21
 
@@ -34,7 +34,7 @@ api_instance = TrieveRubyClient::UserApi.new
34
34
  delete_user_api_key_request = TrieveRubyClient::DeleteUserApiKeyRequest.new({api_key_id: 'api_key_id_example'}) # DeleteUserApiKeyRequest | JSON request payload to delete a user api key
35
35
 
36
36
  begin
37
- # delete_user_api_key
37
+ # Delete User Api Key
38
38
  result = api_instance.delete_user_api_key(delete_user_api_key_request)
39
39
  p result
40
40
  rescue TrieveRubyClient::ApiError => e
@@ -50,7 +50,7 @@ This returns an Array which contains the response data, status code and headers.
50
50
 
51
51
  ```ruby
52
52
  begin
53
- # delete_user_api_key
53
+ # Delete User Api Key
54
54
  data, status_code, headers = api_instance.delete_user_api_key_with_http_info(delete_user_api_key_request)
55
55
  p status_code # => 2xx
56
56
  p headers # => { ... }
@@ -84,9 +84,9 @@ end
84
84
 
85
85
  > <SetUserApiKeyResponse> set_user_api_key(set_user_api_key_request)
86
86
 
87
- set_user_api_key
87
+ Set User Api Key
88
88
 
89
- set_user_api_key Create a new api key for the auth'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'ed user who calls this endpoint.
89
+ Set User Api Key Create a new api key for the auth'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'ed user who calls this endpoint.
90
90
 
91
91
  ### Examples
92
92
 
@@ -105,7 +105,7 @@ api_instance = TrieveRubyClient::UserApi.new
105
105
  set_user_api_key_request = TrieveRubyClient::SetUserApiKeyRequest.new({name: 'name_example', role: 37}) # SetUserApiKeyRequest | JSON request payload to create a new user api key
106
106
 
107
107
  begin
108
- # set_user_api_key
108
+ # Set User Api Key
109
109
  result = api_instance.set_user_api_key(set_user_api_key_request)
110
110
  p result
111
111
  rescue TrieveRubyClient::ApiError => e
@@ -121,7 +121,7 @@ This returns an Array which contains the response data, status code and headers.
121
121
 
122
122
  ```ruby
123
123
  begin
124
- # set_user_api_key
124
+ # Set User Api Key
125
125
  data, status_code, headers = api_instance.set_user_api_key_with_http_info(set_user_api_key_request)
126
126
  p status_code # => 2xx
127
127
  p headers # => { ... }
@@ -155,9 +155,9 @@ end
155
155
 
156
156
  > <SlimUser> update_user(update_user_data)
157
157
 
158
- update_user
158
+ Update User
159
159
 
160
- update_user Update a user's information. If the user_id is not provided, the auth'ed user will be updated. If the user_id is provided, the auth'ed user must be an admin (1) or owner (2) of the organization.
160
+ Update User Update a user's information. If the user_id is not provided, the auth'ed user will be updated. If the user_id is provided, the auth'ed user must be an admin (1) or owner (2) of the organization.
161
161
 
162
162
  ### Examples
163
163
 
@@ -176,7 +176,7 @@ api_instance = TrieveRubyClient::UserApi.new
176
176
  update_user_data = TrieveRubyClient::UpdateUserData.new({organization_id: 'organization_id_example'}) # UpdateUserData | JSON request payload to update user information for the auth'ed user
177
177
 
178
178
  begin
179
- # update_user
179
+ # Update User
180
180
  result = api_instance.update_user(update_user_data)
181
181
  p result
182
182
  rescue TrieveRubyClient::ApiError => e
@@ -192,7 +192,7 @@ This returns an Array which contains the response data, status code and headers.
192
192
 
193
193
  ```ruby
194
194
  begin
195
- # update_user
195
+ # Update User
196
196
  data, status_code, headers = api_instance.update_user_with_http_info(update_user_data)
197
197
  p status_code # => 2xx
198
198
  p headers # => { ... }
@@ -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.5.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
- # openid_callback
23
- # openid_callback This is the callback route for the OAuth provider, it should not be called directly. Redirects to browser with set-cookie header.
22
+ # OpenID Connect callback
23
+ # OpenID Connect callback This is the callback route for the OAuth provider, it should not be called directly. Redirects to browser with set-cookie header.
24
24
  # @param [Hash] opts the optional parameters
25
25
  # @return [SlimUser]
26
26
  def callback(opts = {})
@@ -28,8 +28,8 @@ module TrieveRubyClient
28
28
  data
29
29
  end
30
30
 
31
- # openid_callback
32
- # openid_callback This is the callback route for the OAuth provider, it should not be called directly. Redirects to browser with set-cookie header.
31
+ # OpenID Connect callback
32
+ # OpenID Connect callback This is the callback route for the OAuth provider, it should not be called directly. Redirects to browser with set-cookie header.
33
33
  # @param [Hash] opts the optional parameters
34
34
  # @return [Array<(SlimUser, Integer, Hash)>] SlimUser data, response status code and response headers
35
35
  def callback_with_http_info(opts = {})
@@ -76,8 +76,8 @@ module TrieveRubyClient
76
76
  return data, status_code, headers
77
77
  end
78
78
 
79
- # get_me
80
- # get_me Get the user corresponding to your current auth credentials.
79
+ # Get Me
80
+ # Get Me Get the user corresponding to your current auth credentials.
81
81
  # @param [Hash] opts the optional parameters
82
82
  # @return [SlimUser]
83
83
  def get_me(opts = {})
@@ -85,8 +85,8 @@ module TrieveRubyClient
85
85
  data
86
86
  end
87
87
 
88
- # get_me
89
- # get_me Get the user corresponding to your current auth credentials.
88
+ # Get Me
89
+ # Get Me Get the user corresponding to your current auth credentials.
90
90
  # @param [Hash] opts the optional parameters
91
91
  # @return [Array<(SlimUser, Integer, Hash)>] SlimUser data, response status code and response headers
92
92
  def get_me_with_http_info(opts = {})
@@ -133,50 +133,43 @@ module TrieveRubyClient
133
133
  return data, status_code, headers
134
134
  end
135
135
 
136
- # login
137
- # login This will redirect you to the OAuth provider for authentication with email/pass, SSO, Google, Github, etc.
136
+ # Login
137
+ # Login This will redirect you to the OAuth provider for authentication with email/pass, SSO, Google, Github, etc.
138
+ # @param content [AuthQuery] Query parameters for login to be included as kv pairs after ? on the request URL.
138
139
  # @param [Hash] opts the optional parameters
139
- # @option opts [String] :inv_code Code sent via email as a result of successful call to send_invitation
140
- # @option opts [String] :organization_id ID of organization to authenticate into
141
- # @option opts [String] :redirect_uri URL to redirect to after successful login
142
140
  # @return [nil]
143
- def login(opts = {})
144
- login_with_http_info(opts)
141
+ def login(content, opts = {})
142
+ login_with_http_info(content, opts)
145
143
  nil
146
144
  end
147
145
 
148
- # login
149
- # login This will redirect you to the OAuth provider for authentication with email/pass, SSO, Google, Github, etc.
146
+ # Login
147
+ # Login This will redirect you to the OAuth provider for authentication with email/pass, SSO, Google, Github, etc.
148
+ # @param content [AuthQuery] Query parameters for login to be included as kv pairs after ? on the request URL.
150
149
  # @param [Hash] opts the optional parameters
151
- # @option opts [String] :inv_code Code sent via email as a result of successful call to send_invitation
152
- # @option opts [String] :organization_id ID of organization to authenticate into
153
- # @option opts [String] :redirect_uri URL to redirect to after successful login
154
150
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
155
- def login_with_http_info(opts = {})
151
+ def login_with_http_info(content, opts = {})
156
152
  if @api_client.config.debugging
157
153
  @api_client.config.logger.debug 'Calling API: AuthApi.login ...'
158
154
  end
155
+ # verify the required parameter 'content' is set
156
+ if @api_client.config.client_side_validation && content.nil?
157
+ fail ArgumentError, "Missing the required parameter 'content' when calling AuthApi.login"
158
+ end
159
159
  # resource path
160
160
  local_var_path = '/api/auth'
161
161
 
162
162
  # query parameters
163
163
  query_params = opts[:query_params] || {}
164
+ query_params[:'content'] = content
164
165
 
165
166
  # header parameters
166
167
  header_params = opts[:header_params] || {}
167
168
  # HTTP header 'Accept' (if needed)
168
169
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
169
- # HTTP header 'Content-Type'
170
- content_type = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
171
- if !content_type.nil?
172
- header_params['Content-Type'] = content_type
173
- end
174
170
 
175
171
  # form parameters
176
172
  form_params = opts[:form_params] || {}
177
- form_params['inv_code'] = opts[:'inv_code'] if !opts[:'inv_code'].nil?
178
- form_params['organization_id'] = opts[:'organization_id'] if !opts[:'organization_id'].nil?
179
- form_params['redirect_uri'] = opts[:'redirect_uri'] if !opts[:'redirect_uri'].nil?
180
173
 
181
174
  # http body (model)
182
175
  post_body = opts[:debug_body]
@@ -204,8 +197,8 @@ module TrieveRubyClient
204
197
  return data, status_code, headers
205
198
  end
206
199
 
207
- # logout
208
- # logout Invalidate your current auth credential stored typically stored in a cookie. This does not invalidate your API key.
200
+ # Logout
201
+ # Logout Invalidate your current auth credential stored typically stored in a cookie. This does not invalidate your API key.
209
202
  # @param [Hash] opts the optional parameters
210
203
  # @return [nil]
211
204
  def logout(opts = {})
@@ -213,8 +206,8 @@ module TrieveRubyClient
213
206
  nil
214
207
  end
215
208
 
216
- # logout
217
- # logout Invalidate your current auth credential stored typically stored in a cookie. This does not invalidate your API key.
209
+ # Logout
210
+ # Logout Invalidate your current auth credential stored typically stored in a cookie. This does not invalidate your API key.
218
211
  # @param [Hash] opts the optional parameters
219
212
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
220
213
  def logout_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.5.0
7
7
  Contact: developers@trieve.ai
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.4.0
@@ -19,83 +19,8 @@ module TrieveRubyClient
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
- # bulk_create_chunk
23
- # bulk_create_chunk Create a new chunk from an array of chunks. If the chunk has the same tracking_id as an existing chunk, the request will fail. Once a chunk is created, it can be searched for using the search endpoint.
24
- # @param tr_dataset [String] The dataset id to use for the request
25
- # @param create_chunk_data [CreateChunkData] JSON request payload to create a new chunk (chunk)
26
- # @param [Hash] opts the optional parameters
27
- # @return [ReturnQueuedChunk]
28
- def bulk_create_chunk(tr_dataset, create_chunk_data, opts = {})
29
- data, _status_code, _headers = bulk_create_chunk_with_http_info(tr_dataset, create_chunk_data, opts)
30
- data
31
- end
32
-
33
- # bulk_create_chunk
34
- # bulk_create_chunk Create a new chunk from an array of chunks. If the chunk has the same tracking_id as an existing chunk, the request will fail. Once a chunk is created, it can be searched for using the search endpoint.
35
- # @param tr_dataset [String] The dataset id to use for the request
36
- # @param create_chunk_data [CreateChunkData] JSON request payload to create a new chunk (chunk)
37
- # @param [Hash] opts the optional parameters
38
- # @return [Array<(ReturnQueuedChunk, Integer, Hash)>] ReturnQueuedChunk data, response status code and response headers
39
- def bulk_create_chunk_with_http_info(tr_dataset, create_chunk_data, opts = {})
40
- if @api_client.config.debugging
41
- @api_client.config.logger.debug 'Calling API: ChunkApi.bulk_create_chunk ...'
42
- end
43
- # verify the required parameter 'tr_dataset' is set
44
- if @api_client.config.client_side_validation && tr_dataset.nil?
45
- fail ArgumentError, "Missing the required parameter 'tr_dataset' when calling ChunkApi.bulk_create_chunk"
46
- end
47
- # verify the required parameter 'create_chunk_data' is set
48
- if @api_client.config.client_side_validation && create_chunk_data.nil?
49
- fail ArgumentError, "Missing the required parameter 'create_chunk_data' when calling ChunkApi.bulk_create_chunk"
50
- end
51
- # resource path
52
- local_var_path = '/api/chunk/bulk'
53
-
54
- # query parameters
55
- query_params = opts[:query_params] || {}
56
-
57
- # header parameters
58
- header_params = opts[:header_params] || {}
59
- # HTTP header 'Accept' (if needed)
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
66
- header_params[:'TR-Dataset'] = tr_dataset
67
-
68
- # form parameters
69
- form_params = opts[:form_params] || {}
70
-
71
- # http body (model)
72
- post_body = opts[:debug_body] || @api_client.object_to_http_body(create_chunk_data)
73
-
74
- # return_type
75
- return_type = opts[:debug_return_type] || 'ReturnQueuedChunk'
76
-
77
- # auth_names
78
- auth_names = opts[:debug_auth_names] || ['ApiKey']
79
-
80
- new_options = opts.merge(
81
- :operation => :"ChunkApi.bulk_create_chunk",
82
- :header_params => header_params,
83
- :query_params => query_params,
84
- :form_params => form_params,
85
- :body => post_body,
86
- :auth_names => auth_names,
87
- :return_type => return_type
88
- )
89
-
90
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
91
- if @api_client.config.debugging
92
- @api_client.config.logger.debug "API called: ChunkApi#bulk_create_chunk\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
93
- end
94
- return data, status_code, headers
95
- end
96
-
97
- # create_chunk
98
- # create_chunk Create a new chunk. If the chunk has the same tracking_id as an existing chunk, the request will fail. Once a chunk is created, it can be searched for using the search endpoint.
22
+ # Create or Upsert Chunk or Chunks
23
+ # Create or Upsert Chunk or Chunks Create a new chunk. If the chunk has the same tracking_id as an existing chunk, the request will fail. Once a chunk is created, it can be searched for using the search endpoint.
99
24
  # @param tr_dataset [String] The dataset id to use for the request
100
25
  # @param create_chunk_data [CreateChunkData] JSON request payload to create a new chunk (chunk)
101
26
  # @param [Hash] opts the optional parameters
@@ -105,8 +30,8 @@ module TrieveRubyClient
105
30
  data
106
31
  end
107
32
 
108
- # create_chunk
109
- # create_chunk Create a new chunk. If the chunk has the same tracking_id as an existing chunk, the request will fail. Once a chunk is created, it can be searched for using the search endpoint.
33
+ # Create or Upsert Chunk or Chunks
34
+ # Create or Upsert Chunk or Chunks Create a new chunk. If the chunk has the same tracking_id as an existing chunk, the request will fail. Once a chunk is created, it can be searched for using the search endpoint.
110
35
  # @param tr_dataset [String] The dataset id to use for the request
111
36
  # @param create_chunk_data [CreateChunkData] JSON request payload to create a new chunk (chunk)
112
37
  # @param [Hash] opts the optional parameters
@@ -169,8 +94,8 @@ module TrieveRubyClient
169
94
  return data, status_code, headers
170
95
  end
171
96
 
172
- # get_suggested_queries
173
- # get_suggested_queries This endpoint will generate 3 suggested queries based off the query provided in the request body and return them as a JSON object.
97
+ # Generate suggested queries
98
+ # Generate suggested queries This endpoint will generate 3 suggested queries based off the query provided in the request body and return them as a JSON object.
174
99
  # @param tr_dataset [String] The dataset id to use for the request
175
100
  # @param suggested_queries_request [SuggestedQueriesRequest] JSON request payload to get alternative suggested queries
176
101
  # @param [Hash] opts the optional parameters
@@ -180,8 +105,8 @@ module TrieveRubyClient
180
105
  data
181
106
  end
182
107
 
183
- # get_suggested_queries
184
- # get_suggested_queries This endpoint will generate 3 suggested queries based off the query provided in the request body and return them as a JSON object.
108
+ # Generate suggested queries
109
+ # Generate suggested queries This endpoint will generate 3 suggested queries based off the query provided in the request body and return them as a JSON object.
185
110
  # @param tr_dataset [String] The dataset id to use for the request
186
111
  # @param suggested_queries_request [SuggestedQueriesRequest] JSON request payload to get alternative suggested queries
187
112
  # @param [Hash] opts the optional parameters
@@ -244,26 +169,24 @@ module TrieveRubyClient
244
169
  return data, status_code, headers
245
170
  end
246
171
 
247
- # delete_chunk
248
- # delete_chunk Delete a chunk by its id. If deleting a root chunk which has a collision, the most recently created collision will become a new root chunk.
172
+ # Delete Chunk
173
+ # Delete Chunk Delete a chunk by its id. If deleting a root chunk which has a collision, the most recently created collision will become a new root chunk.
249
174
  # @param tr_dataset [String] The dataset id to use for the request
250
- # @param chunk_id [Uuid] Id of the chunk you want to fetch. This can be either the chunk_id or the tracking_id.
251
- # @param tracking_or_chunk [String] The type of id you are using to search for the chunk. This can be either &#39;chunk&#39; or &#39;tracking_id&#39;
175
+ # @param chunk_id [String] Id of the chunk you want to fetch.
252
176
  # @param [Hash] opts the optional parameters
253
177
  # @return [nil]
254
- def delete_chunk(tr_dataset, chunk_id, tracking_or_chunk, opts = {})
255
- delete_chunk_with_http_info(tr_dataset, chunk_id, tracking_or_chunk, opts)
178
+ def delete_chunk(tr_dataset, chunk_id, opts = {})
179
+ delete_chunk_with_http_info(tr_dataset, chunk_id, opts)
256
180
  nil
257
181
  end
258
182
 
259
- # delete_chunk
260
- # delete_chunk Delete a chunk by its id. If deleting a root chunk which has a collision, the most recently created collision will become a new root chunk.
183
+ # Delete Chunk
184
+ # Delete Chunk Delete a chunk by its id. If deleting a root chunk which has a collision, the most recently created collision will become a new root chunk.
261
185
  # @param tr_dataset [String] The dataset id to use for the request
262
- # @param chunk_id [Uuid] Id of the chunk you want to fetch. This can be either the chunk_id or the tracking_id.
263
- # @param tracking_or_chunk [String] The type of id you are using to search for the chunk. This can be either &#39;chunk&#39; or &#39;tracking_id&#39;
186
+ # @param chunk_id [String] Id of the chunk you want to fetch.
264
187
  # @param [Hash] opts the optional parameters
265
188
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
266
- def delete_chunk_with_http_info(tr_dataset, chunk_id, tracking_or_chunk, opts = {})
189
+ def delete_chunk_with_http_info(tr_dataset, chunk_id, opts = {})
267
190
  if @api_client.config.debugging
268
191
  @api_client.config.logger.debug 'Calling API: ChunkApi.delete_chunk ...'
269
192
  end
@@ -271,12 +194,12 @@ module TrieveRubyClient
271
194
  if @api_client.config.client_side_validation && tr_dataset.nil?
272
195
  fail ArgumentError, "Missing the required parameter 'tr_dataset' when calling ChunkApi.delete_chunk"
273
196
  end
274
- # verify the required parameter 'tracking_or_chunk' is set
275
- if @api_client.config.client_side_validation && tracking_or_chunk.nil?
276
- fail ArgumentError, "Missing the required parameter 'tracking_or_chunk' when calling ChunkApi.delete_chunk"
197
+ # verify the required parameter 'chunk_id' is set
198
+ if @api_client.config.client_side_validation && chunk_id.nil?
199
+ fail ArgumentError, "Missing the required parameter 'chunk_id' when calling ChunkApi.delete_chunk"
277
200
  end
278
201
  # resource path
279
- local_var_path = '/api/{tracking_or_chunk}/{chunk_id}'.sub('{' + 'chunk_id' + '}', CGI.escape(chunk_id.to_s)).sub('{' + 'tracking_or_chunk' + '}', CGI.escape(tracking_or_chunk.to_s))
202
+ local_var_path = '/api/chunk/{chunk_id}'.sub('{' + 'chunk_id' + '}', CGI.escape(chunk_id.to_s))
280
203
 
281
204
  # query parameters
282
205
  query_params = opts[:query_params] || {}
@@ -316,8 +239,8 @@ module TrieveRubyClient
316
239
  return data, status_code, headers
317
240
  end
318
241
 
319
- # delete_chunk_by_tracking_id
320
- # delete_chunk_by_tracking_id Delete a chunk by tracking_id. This is useful for when you are coordinating with an external system and want to use the tracking_id to identify the chunk. If deleting a root chunk which has a collision, the most recently created collision will become a new root chunk.
242
+ # Delete Chunk By Tracking Id
243
+ # Delete Chunk By Tracking Id Delete a chunk by tracking_id. This is useful for when you are coordinating with an external system and want to use the tracking_id to identify the chunk. If deleting a root chunk which has a collision, the most recently created collision will become a new root chunk.
321
244
  # @param tr_dataset [String] The dataset id to use for the request
322
245
  # @param tracking_id [String] tracking_id of the chunk you want to delete
323
246
  # @param [Hash] opts the optional parameters
@@ -327,8 +250,8 @@ module TrieveRubyClient
327
250
  nil
328
251
  end
329
252
 
330
- # delete_chunk_by_tracking_id
331
- # delete_chunk_by_tracking_id Delete a chunk by tracking_id. This is useful for when you are coordinating with an external system and want to use the tracking_id to identify the chunk. If deleting a root chunk which has a collision, the most recently created collision will become a new root chunk.
253
+ # Delete Chunk By Tracking Id
254
+ # Delete Chunk By Tracking Id Delete a chunk by tracking_id. This is useful for when you are coordinating with an external system and want to use the tracking_id to identify the chunk. If deleting a root chunk which has a collision, the most recently created collision will become a new root chunk.
332
255
  # @param tr_dataset [String] The dataset id to use for the request
333
256
  # @param tracking_id [String] tracking_id of the chunk you want to delete
334
257
  # @param [Hash] opts the optional parameters
@@ -386,8 +309,8 @@ module TrieveRubyClient
386
309
  return data, status_code, headers
387
310
  end
388
311
 
389
- # augmented_generation_from_chunks
390
- # augmented_generation_from_chunks This endpoint exists as an alternative to the topic+message concept where our API handles chat memory. With this endpoint, the user is responsible for providing the context window and the prompt. See more in the \"search before generate\" page at docs.trieve.ai.
312
+ # RAG on Specified Chunks
313
+ # RAG on Specified Chunks This endpoint exists as an alternative to the topic+message concept where our API handles chat memory. With this endpoint, the user is responsible for providing the context window and the prompt. See more in the \"search before generate\" page at docs.trieve.ai.
391
314
  # @param tr_dataset [String] The dataset id to use for the request
392
315
  # @param generate_chunks_request [GenerateChunksRequest] JSON request payload to perform RAG on some chunks (chunks)
393
316
  # @param [Hash] opts the optional parameters
@@ -397,8 +320,8 @@ module TrieveRubyClient
397
320
  data
398
321
  end
399
322
 
400
- # augmented_generation_from_chunks
401
- # augmented_generation_from_chunks This endpoint exists as an alternative to the topic+message concept where our API handles chat memory. With this endpoint, the user is responsible for providing the context window and the prompt. See more in the \&quot;search before generate\&quot; page at docs.trieve.ai.
323
+ # RAG on Specified Chunks
324
+ # RAG on Specified Chunks This endpoint exists as an alternative to the topic+message concept where our API handles chat memory. With this endpoint, the user is responsible for providing the context window and the prompt. See more in the \&quot;search before generate\&quot; page at docs.trieve.ai.
402
325
  # @param tr_dataset [String] The dataset id to use for the request
403
326
  # @param generate_chunks_request [GenerateChunksRequest] JSON request payload to perform RAG on some chunks (chunks)
404
327
  # @param [Hash] opts the optional parameters
@@ -461,26 +384,24 @@ module TrieveRubyClient
461
384
  return data, status_code, headers
462
385
  end
463
386
 
464
- # get_chunk
465
- # get_chunk Get a singular chunk by id.
387
+ # Get Chunk By Id
388
+ # Get Chunk By Id Get a singular chunk by id.
466
389
  # @param tr_dataset [String] The dataset id to use for the request
467
- # @param chunk_id [Uuid] Id of the chunk you want to fetch. This can be either the chunk_id or the tracking_id.
468
- # @param tracking_or_chunk [String] The type of id you are using to search for the chunk. This can be either &#39;chunk&#39; or &#39;tracking_id&#39;
390
+ # @param chunk_id [String] Id of the chunk you want to fetch.
469
391
  # @param [Hash] opts the optional parameters
470
392
  # @return [ChunkMetadata]
471
- def get_chunk_by_id(tr_dataset, chunk_id, tracking_or_chunk, opts = {})
472
- data, _status_code, _headers = get_chunk_by_id_with_http_info(tr_dataset, chunk_id, tracking_or_chunk, opts)
393
+ def get_chunk_by_id(tr_dataset, chunk_id, opts = {})
394
+ data, _status_code, _headers = get_chunk_by_id_with_http_info(tr_dataset, chunk_id, opts)
473
395
  data
474
396
  end
475
397
 
476
- # get_chunk
477
- # get_chunk Get a singular chunk by id.
398
+ # Get Chunk By Id
399
+ # Get Chunk By Id Get a singular chunk by id.
478
400
  # @param tr_dataset [String] The dataset id to use for the request
479
- # @param chunk_id [Uuid] Id of the chunk you want to fetch. This can be either the chunk_id or the tracking_id.
480
- # @param tracking_or_chunk [String] The type of id you are using to search for the chunk. This can be either &#39;chunk&#39; or &#39;tracking_id&#39;
401
+ # @param chunk_id [String] Id of the chunk you want to fetch.
481
402
  # @param [Hash] opts the optional parameters
482
403
  # @return [Array<(ChunkMetadata, Integer, Hash)>] ChunkMetadata data, response status code and response headers
483
- def get_chunk_by_id_with_http_info(tr_dataset, chunk_id, tracking_or_chunk, opts = {})
404
+ def get_chunk_by_id_with_http_info(tr_dataset, chunk_id, opts = {})
484
405
  if @api_client.config.debugging
485
406
  @api_client.config.logger.debug 'Calling API: ChunkApi.get_chunk_by_id ...'
486
407
  end
@@ -488,12 +409,12 @@ module TrieveRubyClient
488
409
  if @api_client.config.client_side_validation && tr_dataset.nil?
489
410
  fail ArgumentError, "Missing the required parameter 'tr_dataset' when calling ChunkApi.get_chunk_by_id"
490
411
  end
491
- # verify the required parameter 'tracking_or_chunk' is set
492
- if @api_client.config.client_side_validation && tracking_or_chunk.nil?
493
- fail ArgumentError, "Missing the required parameter 'tracking_or_chunk' when calling ChunkApi.get_chunk_by_id"
412
+ # verify the required parameter 'chunk_id' is set
413
+ if @api_client.config.client_side_validation && chunk_id.nil?
414
+ fail ArgumentError, "Missing the required parameter 'chunk_id' when calling ChunkApi.get_chunk_by_id"
494
415
  end
495
416
  # resource path
496
- local_var_path = '/api/{tracking_or_chunk}/{chunk_id}'.sub('{' + 'chunk_id' + '}', CGI.escape(chunk_id.to_s)).sub('{' + 'tracking_or_chunk' + '}', CGI.escape(tracking_or_chunk.to_s))
417
+ local_var_path = '/api/chunk/{chunk_id}'.sub('{' + 'chunk_id' + '}', CGI.escape(chunk_id.to_s))
497
418
 
498
419
  # query parameters
499
420
  query_params = opts[:query_params] || {}
@@ -533,8 +454,8 @@ module TrieveRubyClient
533
454
  return data, status_code, headers
534
455
  end
535
456
 
536
- # get_chunk_by_tracking_id
537
- # get_chunk_by_tracking_id Get a singular chunk by tracking_id. This is useful for when you are coordinating with an external system and want to use your own id as the primary reference for a chunk.
457
+ # Get Chunk By Tracking Id
458
+ # Get Chunk By Tracking Id Get a singular chunk by tracking_id. This is useful for when you are coordinating with an external system and want to use your own id as the primary reference for a chunk.
538
459
  # @param tr_dataset [String] The dataset id to use for the request
539
460
  # @param tracking_id [String] tracking_id of the chunk you want to fetch
540
461
  # @param [Hash] opts the optional parameters
@@ -544,8 +465,8 @@ module TrieveRubyClient
544
465
  data
545
466
  end
546
467
 
547
- # get_chunk_by_tracking_id
548
- # get_chunk_by_tracking_id Get a singular chunk by tracking_id. This is useful for when you are coordinating with an external system and want to use your own id as the primary reference for a chunk.
468
+ # Get Chunk By Tracking Id
469
+ # Get Chunk By Tracking Id Get a singular chunk by tracking_id. This is useful for when you are coordinating with an external system and want to use your own id as the primary reference for a chunk.
549
470
  # @param tr_dataset [String] The dataset id to use for the request
550
471
  # @param tracking_id [String] tracking_id of the chunk you want to fetch
551
472
  # @param [Hash] opts the optional parameters
@@ -603,8 +524,8 @@ module TrieveRubyClient
603
524
  return data, status_code, headers
604
525
  end
605
526
 
606
- # get_recommended_chunks
607
- # get_recommended_chunks Get recommendations of chunks similar to the chunks in the request. Think about this as a feature similar to the \"add to playlist\" recommendation feature on Spotify. This request pairs especially well with our groups endpoint.
527
+ # Get Recommended Chunks
528
+ # Get Recommended Chunks Get recommendations of chunks similar to the chunks in the request. Think about this as a feature similar to the \"add to playlist\" recommendation feature on Spotify. This request pairs especially well with our groups endpoint.
608
529
  # @param tr_dataset [String] The dataset id to use for the request
609
530
  # @param recommend_chunks_request [RecommendChunksRequest] JSON request payload to get recommendations of chunks similar to the chunks in the request
610
531
  # @param [Hash] opts the optional parameters
@@ -614,8 +535,8 @@ module TrieveRubyClient
614
535
  data
615
536
  end
616
537
 
617
- # get_recommended_chunks
618
- # get_recommended_chunks Get recommendations of chunks similar to the chunks in the request. Think about this as a feature similar to the \&quot;add to playlist\&quot; recommendation feature on Spotify. This request pairs especially well with our groups endpoint.
538
+ # Get Recommended Chunks
539
+ # Get Recommended Chunks Get recommendations of chunks similar to the chunks in the request. Think about this as a feature similar to the \&quot;add to playlist\&quot; recommendation feature on Spotify. This request pairs especially well with our groups endpoint.
619
540
  # @param tr_dataset [String] The dataset id to use for the request
620
541
  # @param recommend_chunks_request [RecommendChunksRequest] JSON request payload to get recommendations of chunks similar to the chunks in the request
621
542
  # @param [Hash] opts the optional parameters
@@ -678,8 +599,8 @@ module TrieveRubyClient
678
599
  return data, status_code, headers
679
600
  end
680
601
 
681
- # search
682
- # search This route provides the primary search functionality for the API. It can be used to search for chunks by semantic similarity, full-text similarity, or a combination of both. Results' `chunk_html` values will be modified with `<b>` tags for sub-sentence highlighting.
602
+ # Search
603
+ # Search This route provides the primary search functionality for the API. It can be used to search for chunks by semantic similarity, full-text similarity, or a combination of both. Results' `chunk_html` values will be modified with `<b>` tags for sub-sentence highlighting.
683
604
  # @param tr_dataset [String] The dataset id to use for the request
684
605
  # @param search_chunk_data [SearchChunkData] JSON request payload to semantically search for chunks (chunks)
685
606
  # @param [Hash] opts the optional parameters
@@ -689,8 +610,8 @@ module TrieveRubyClient
689
610
  data
690
611
  end
691
612
 
692
- # search
693
- # search This route provides the primary search functionality for the API. It can be used to search for chunks by semantic similarity, full-text similarity, or a combination of both. Results&#39; &#x60;chunk_html&#x60; values will be modified with &#x60;&lt;b&gt;&#x60; tags for sub-sentence highlighting.
613
+ # Search
614
+ # Search This route provides the primary search functionality for the API. It can be used to search for chunks by semantic similarity, full-text similarity, or a combination of both. Results&#39; &#x60;chunk_html&#x60; values will be modified with &#x60;&lt;b&gt;&#x60; tags for sub-sentence highlighting.
694
615
  # @param tr_dataset [String] The dataset id to use for the request
695
616
  # @param search_chunk_data [SearchChunkData] JSON request payload to semantically search for chunks (chunks)
696
617
  # @param [Hash] opts the optional parameters
@@ -753,8 +674,8 @@ module TrieveRubyClient
753
674
  return data, status_code, headers
754
675
  end
755
676
 
756
- # update_chunk
757
- # update_chunk Update a chunk. If you try to change the tracking_id of the chunk to have the same tracking_id as an existing chunk, the request will fail.
677
+ # Update Chunk
678
+ # Update Chunk Update a chunk. If you try to change the tracking_id of the chunk to have the same tracking_id as an existing chunk, the request will fail.
758
679
  # @param tr_dataset [String] The dataset id to use for the request
759
680
  # @param update_chunk_data [UpdateChunkData] JSON request payload to update a chunk (chunk)
760
681
  # @param [Hash] opts the optional parameters
@@ -764,8 +685,8 @@ module TrieveRubyClient
764
685
  nil
765
686
  end
766
687
 
767
- # update_chunk
768
- # update_chunk Update a chunk. If you try to change the tracking_id of the chunk to have the same tracking_id as an existing chunk, the request will fail.
688
+ # Update Chunk
689
+ # Update Chunk Update a chunk. If you try to change the tracking_id of the chunk to have the same tracking_id as an existing chunk, the request will fail.
769
690
  # @param tr_dataset [String] The dataset id to use for the request
770
691
  # @param update_chunk_data [UpdateChunkData] JSON request payload to update a chunk (chunk)
771
692
  # @param [Hash] opts the optional parameters
@@ -783,7 +704,7 @@ module TrieveRubyClient
783
704
  fail ArgumentError, "Missing the required parameter 'update_chunk_data' when calling ChunkApi.update_chunk"
784
705
  end
785
706
  # resource path
786
- local_var_path = '/api/chunk/update'
707
+ local_var_path = '/api/chunk'
787
708
 
788
709
  # query parameters
789
710
  query_params = opts[:query_params] || {}
@@ -828,8 +749,8 @@ module TrieveRubyClient
828
749
  return data, status_code, headers
829
750
  end
830
751
 
831
- # update_chunk_by_tracking_id
832
- # update_chunk_by_tracking_id Update a chunk by tracking_id. This is useful for when you are coordinating with an external system and want to use the tracking_id to identify the chunk.
752
+ # Update Chunk By Tracking Id
753
+ # Update Chunk By Tracking Id Update a chunk by tracking_id. This is useful for when you are coordinating with an external system and want to use the tracking_id to identify the chunk.
833
754
  # @param tr_dataset [String] The dataset id to use for the request
834
755
  # @param update_chunk_by_tracking_id_data [UpdateChunkByTrackingIdData] JSON request payload to update a chunk by tracking_id (chunks)
835
756
  # @param [Hash] opts the optional parameters
@@ -839,8 +760,8 @@ module TrieveRubyClient
839
760
  nil
840
761
  end
841
762
 
842
- # update_chunk_by_tracking_id
843
- # update_chunk_by_tracking_id Update a chunk by tracking_id. This is useful for when you are coordinating with an external system and want to use the tracking_id to identify the chunk.
763
+ # Update Chunk By Tracking Id
764
+ # Update Chunk By Tracking Id Update a chunk by tracking_id. This is useful for when you are coordinating with an external system and want to use the tracking_id to identify the chunk.
844
765
  # @param tr_dataset [String] The dataset id to use for the request
845
766
  # @param update_chunk_by_tracking_id_data [UpdateChunkByTrackingIdData] JSON request payload to update a chunk by tracking_id (chunks)
846
767
  # @param [Hash] opts the optional parameters