trieve_ruby_client 0.6.9 → 0.7.6

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 (151) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +17 -8
  3. data/docs/ChunkApi.md +158 -10
  4. data/docs/ChunkData.md +2 -2
  5. data/docs/ChunkMetadata.md +2 -0
  6. data/docs/ClientDatasetConfiguration.md +2 -0
  7. data/docs/CreateMessageData.md +0 -2
  8. data/docs/CreateTopicData.md +3 -3
  9. data/docs/EditMessageData.md +0 -2
  10. data/docs/FieldCondition.md +6 -0
  11. data/docs/FileApi.md +4 -6
  12. data/docs/GenerateChunksRequest.md +0 -2
  13. data/docs/GeoInfo.md +20 -0
  14. data/docs/GeoTypes.md +49 -0
  15. data/docs/GetChunksData.md +18 -0
  16. data/docs/GetEventsData.md +1 -1
  17. data/docs/GetTrackingChunksData.md +18 -0
  18. data/docs/LocationBoundingBox.md +20 -0
  19. data/docs/LocationPolygon.md +20 -0
  20. data/docs/LocationRadius.md +20 -0
  21. data/docs/RangeCondition.md +2 -0
  22. data/docs/RegenerateMessageData.md +0 -2
  23. data/docs/SlimChunkMetadata.md +4 -0
  24. data/docs/Topic.md +3 -3
  25. data/docs/TopicApi.md +17 -17
  26. data/docs/UpdateChunkData.md +2 -0
  27. data/docs/UpdateUserOrgRoleData.md +22 -0
  28. data/docs/UserApi.md +9 -10
  29. data/lib/trieve_ruby_client/api/auth_api.rb +1 -1
  30. data/lib/trieve_ruby_client/api/chunk_api.rb +161 -11
  31. data/lib/trieve_ruby_client/api/chunk_group_api.rb +1 -1
  32. data/lib/trieve_ruby_client/api/dataset_api.rb +1 -1
  33. data/lib/trieve_ruby_client/api/events_api.rb +1 -1
  34. data/lib/trieve_ruby_client/api/file_api.rb +4 -11
  35. data/lib/trieve_ruby_client/api/health_api.rb +1 -1
  36. data/lib/trieve_ruby_client/api/invitation_api.rb +1 -1
  37. data/lib/trieve_ruby_client/api/message_api.rb +1 -1
  38. data/lib/trieve_ruby_client/api/organization_api.rb +1 -1
  39. data/lib/trieve_ruby_client/api/stripe_api.rb +1 -1
  40. data/lib/trieve_ruby_client/api/topic_api.rb +20 -20
  41. data/lib/trieve_ruby_client/api/user_api.rb +14 -14
  42. data/lib/trieve_ruby_client/api_client.rb +1 -1
  43. data/lib/trieve_ruby_client/api_error.rb +1 -1
  44. data/lib/trieve_ruby_client/configuration.rb +1 -1
  45. data/lib/trieve_ruby_client/models/add_chunk_to_group_data.rb +1 -1
  46. data/lib/trieve_ruby_client/models/api_key_dto.rb +1 -1
  47. data/lib/trieve_ruby_client/models/auth_query.rb +1 -1
  48. data/lib/trieve_ruby_client/models/batch_queued_chunk_response.rb +1 -1
  49. data/lib/trieve_ruby_client/models/bookmark_data.rb +1 -1
  50. data/lib/trieve_ruby_client/models/bookmark_group_result.rb +1 -1
  51. data/lib/trieve_ruby_client/models/chat_message_proxy.rb +1 -1
  52. data/lib/trieve_ruby_client/models/chunk_data.rb +12 -13
  53. data/lib/trieve_ruby_client/models/chunk_filter.rb +1 -1
  54. data/lib/trieve_ruby_client/models/chunk_group.rb +1 -1
  55. data/lib/trieve_ruby_client/models/chunk_group_and_file.rb +1 -1
  56. data/lib/trieve_ruby_client/models/chunk_metadata.rb +12 -2
  57. data/lib/trieve_ruby_client/models/chunk_metadata_with_score.rb +1 -1
  58. data/lib/trieve_ruby_client/models/client_dataset_configuration.rb +18 -2
  59. data/lib/trieve_ruby_client/models/create_chunk_data.rb +1 -1
  60. data/lib/trieve_ruby_client/models/create_chunk_group_data.rb +1 -1
  61. data/lib/trieve_ruby_client/models/create_dataset_request.rb +1 -1
  62. data/lib/trieve_ruby_client/models/create_message_data.rb +2 -13
  63. data/lib/trieve_ruby_client/models/create_organization_data.rb +1 -1
  64. data/lib/trieve_ruby_client/models/create_topic_data.rb +23 -17
  65. data/lib/trieve_ruby_client/models/dataset.rb +1 -1
  66. data/lib/trieve_ruby_client/models/dataset_and_usage.rb +1 -1
  67. data/lib/trieve_ruby_client/models/dataset_dto.rb +1 -1
  68. data/lib/trieve_ruby_client/models/dataset_usage_count.rb +1 -1
  69. data/lib/trieve_ruby_client/models/delete_topic_data.rb +1 -1
  70. data/lib/trieve_ruby_client/models/delete_user_api_key_request.rb +1 -1
  71. data/lib/trieve_ruby_client/models/edit_message_data.rb +2 -13
  72. data/lib/trieve_ruby_client/models/error_response_body.rb +1 -1
  73. data/lib/trieve_ruby_client/models/event.rb +1 -1
  74. data/lib/trieve_ruby_client/models/event_return.rb +1 -1
  75. data/lib/trieve_ruby_client/models/field_condition.rb +32 -2
  76. data/lib/trieve_ruby_client/models/file.rb +1 -1
  77. data/lib/trieve_ruby_client/models/file_dto.rb +1 -1
  78. data/lib/trieve_ruby_client/models/generate_chunks_request.rb +2 -13
  79. data/lib/trieve_ruby_client/models/geo_info.rb +237 -0
  80. data/lib/trieve_ruby_client/models/geo_types.rb +105 -0
  81. data/lib/trieve_ruby_client/models/get_chunks_data.rb +223 -0
  82. data/lib/trieve_ruby_client/models/get_events_data.rb +2 -2
  83. data/lib/trieve_ruby_client/models/get_groups_for_chunks_data.rb +1 -1
  84. data/lib/trieve_ruby_client/models/get_tracking_chunks_data.rb +223 -0
  85. data/lib/trieve_ruby_client/models/group_data.rb +1 -1
  86. data/lib/trieve_ruby_client/models/group_score_chunk.rb +1 -1
  87. data/lib/trieve_ruby_client/models/group_score_slim_chunks.rb +1 -1
  88. data/lib/trieve_ruby_client/models/invitation_data.rb +1 -1
  89. data/lib/trieve_ruby_client/models/location_bounding_box.rb +237 -0
  90. data/lib/trieve_ruby_client/models/location_polygon.rb +235 -0
  91. data/lib/trieve_ruby_client/models/location_radius.rb +237 -0
  92. data/lib/trieve_ruby_client/models/match_condition.rb +1 -1
  93. data/lib/trieve_ruby_client/models/message.rb +1 -1
  94. data/lib/trieve_ruby_client/models/organization.rb +1 -1
  95. data/lib/trieve_ruby_client/models/organization_usage_count.rb +1 -1
  96. data/lib/trieve_ruby_client/models/range.rb +1 -1
  97. data/lib/trieve_ruby_client/models/range_condition.rb +2 -1
  98. data/lib/trieve_ruby_client/models/recommend_chunks_request.rb +1 -1
  99. data/lib/trieve_ruby_client/models/recommend_group_chunks_request.rb +1 -1
  100. data/lib/trieve_ruby_client/models/regenerate_message_data.rb +2 -13
  101. data/lib/trieve_ruby_client/models/return_queued_chunk.rb +1 -1
  102. data/lib/trieve_ruby_client/models/score_chunk_dto.rb +1 -1
  103. data/lib/trieve_ruby_client/models/score_slim_chunks.rb +1 -1
  104. data/lib/trieve_ruby_client/models/search_chunk_data.rb +1 -1
  105. data/lib/trieve_ruby_client/models/search_chunk_query_response_body.rb +1 -1
  106. data/lib/trieve_ruby_client/models/search_over_groups_data.rb +1 -1
  107. data/lib/trieve_ruby_client/models/search_over_groups_results.rb +1 -1
  108. data/lib/trieve_ruby_client/models/search_over_groups_slim_results.rb +1 -1
  109. data/lib/trieve_ruby_client/models/search_slim_chunk_query_response_body.rb +1 -1
  110. data/lib/trieve_ruby_client/models/search_within_group_data.rb +1 -1
  111. data/lib/trieve_ruby_client/models/search_within_group_results.rb +1 -1
  112. data/lib/trieve_ruby_client/models/search_within_group_slim_results.rb +1 -1
  113. data/lib/trieve_ruby_client/models/set_user_api_key_request.rb +1 -1
  114. data/lib/trieve_ruby_client/models/set_user_api_key_response.rb +1 -1
  115. data/lib/trieve_ruby_client/models/single_queued_chunk_response.rb +1 -1
  116. data/lib/trieve_ruby_client/models/slim_chunk_metadata.rb +28 -2
  117. data/lib/trieve_ruby_client/models/slim_chunk_metadata_with_score.rb +1 -1
  118. data/lib/trieve_ruby_client/models/slim_group.rb +1 -1
  119. data/lib/trieve_ruby_client/models/slim_user.rb +1 -1
  120. data/lib/trieve_ruby_client/models/stripe_plan.rb +1 -1
  121. data/lib/trieve_ruby_client/models/suggested_queries_request.rb +1 -1
  122. data/lib/trieve_ruby_client/models/suggested_queries_response.rb +1 -1
  123. data/lib/trieve_ruby_client/models/topic.rb +21 -21
  124. data/lib/trieve_ruby_client/models/update_chunk_by_tracking_id_data.rb +1 -1
  125. data/lib/trieve_ruby_client/models/update_chunk_data.rb +12 -2
  126. data/lib/trieve_ruby_client/models/update_chunk_group_data.rb +1 -1
  127. data/lib/trieve_ruby_client/models/update_dataset_request.rb +1 -1
  128. data/lib/trieve_ruby_client/models/update_group_by_tracking_id_data.rb +1 -1
  129. data/lib/trieve_ruby_client/models/update_organization_data.rb +1 -1
  130. data/lib/trieve_ruby_client/models/update_topic_data.rb +1 -1
  131. data/lib/trieve_ruby_client/models/update_user_org_role_data.rb +250 -0
  132. data/lib/trieve_ruby_client/models/upload_file_data.rb +1 -1
  133. data/lib/trieve_ruby_client/models/upload_file_result.rb +1 -1
  134. data/lib/trieve_ruby_client/models/user_organization.rb +1 -1
  135. data/lib/trieve_ruby_client/version.rb +2 -2
  136. data/lib/trieve_ruby_client.rb +9 -2
  137. data/openapi-generator.yaml +1 -1
  138. data/openapi.json +360 -83
  139. data/spec/models/geo_info_spec.rb +42 -0
  140. data/spec/models/geo_types_spec.rb +32 -0
  141. data/spec/models/get_chunks_data_spec.rb +36 -0
  142. data/spec/models/get_tracking_chunks_data_spec.rb +36 -0
  143. data/spec/models/location_bounding_box_spec.rb +42 -0
  144. data/spec/models/location_polygon_spec.rb +42 -0
  145. data/spec/models/location_radius_spec.rb +42 -0
  146. data/spec/models/update_user_org_role_data_spec.rb +48 -0
  147. data/spec/spec_helper.rb +1 -1
  148. data/trieve_ruby_client-0.6.9.gem +0 -0
  149. data/trieve_ruby_client-0.7.2.gem +0 -0
  150. data/trieve_ruby_client.gemspec +1 -1
  151. metadata +36 -2
@@ -0,0 +1,20 @@
1
+ # TrieveRubyClient::LocationPolygon
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **exterior** | [**Array<GeoInfo>**](GeoInfo.md) | | |
8
+ | **interior** | **Array<Array<GeoInfo>>** | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'trieve_ruby_client'
14
+
15
+ instance = TrieveRubyClient::LocationPolygon.new(
16
+ exterior: null,
17
+ interior: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,20 @@
1
+ # TrieveRubyClient::LocationRadius
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **center** | [**GeoInfo**](GeoInfo.md) | | |
8
+ | **radius** | **Float** | | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'trieve_ruby_client'
14
+
15
+ instance = TrieveRubyClient::LocationRadius.new(
16
+ center: null,
17
+ radius: null
18
+ )
19
+ ```
20
+
@@ -15,6 +15,7 @@ TrieveRubyClient::RangeCondition.openapi_one_of
15
15
  # =>
16
16
  # [
17
17
  # :'Float',
18
+ # :'Integer',
18
19
  # :'String'
19
20
  # ]
20
21
  ```
@@ -44,6 +45,7 @@ TrieveRubyClient::RangeCondition.build(data_that_doesnt_match)
44
45
  #### Return type
45
46
 
46
47
  - `Float`
48
+ - `Integer`
47
49
  - `String`
48
50
  - `nil` (if no type matches)
49
51
 
@@ -6,7 +6,6 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **highlight_citations** | **Boolean** | Whether or not to highlight the citations in the response. If this is set to true or not included, the citations will be highlighted. If this is set to false, the citations will not be highlighted. Default is true. | [optional] |
8
8
  | **highlight_delimiters** | **Array<String>** | The delimiters to use for highlighting the citations. If this is not included, the default delimiters will be used. Default is `[\".\", \"!\", \"?\", \"\\n\", \"\\t\", \",\"]`. | [optional] |
9
- | **model** | **String** | The model to use for the assistant generative inferences. This can be any model from the openrouter model list. If no model is provided, the gpt-3.5-turbo will be used.~ | [optional] |
10
9
  | **stream_response** | **Boolean** | Whether or not to stream the response. If this is set to true or not included, the response will be a stream. If this is set to false, the response will be a normal JSON response. Default is true. | [optional] |
11
10
  | **topic_id** | **String** | The id of the topic to regenerate the last message for. | |
12
11
 
@@ -18,7 +17,6 @@ require 'trieve_ruby_client'
18
17
  instance = TrieveRubyClient::RegenerateMessageData.new(
19
18
  highlight_citations: null,
20
19
  highlight_delimiters: null,
21
- model: null,
22
20
  stream_response: null,
23
21
  topic_id: null
24
22
  )
@@ -5,8 +5,10 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **created_at** | **Time** | | |
8
+ | **dataset_id** | **String** | | |
8
9
  | **id** | **String** | | |
9
10
  | **link** | **String** | | [optional] |
11
+ | **location** | [**GeoInfo**](GeoInfo.md) | | [optional] |
10
12
  | **metadata** | **Object** | | [optional] |
11
13
  | **qdrant_point_id** | **String** | | [optional] |
12
14
  | **tag_set** | **String** | | [optional] |
@@ -22,8 +24,10 @@ require 'trieve_ruby_client'
22
24
 
23
25
  instance = TrieveRubyClient::SlimChunkMetadata.new(
24
26
  created_at: null,
27
+ dataset_id: null,
25
28
  id: null,
26
29
  link: null,
30
+ location: null,
27
31
  metadata: null,
28
32
  qdrant_point_id: null,
29
33
  tag_set: null,
data/docs/Topic.md CHANGED
@@ -9,8 +9,8 @@
9
9
  | **deleted** | **Boolean** | | |
10
10
  | **id** | **String** | | |
11
11
  | **name** | **String** | | |
12
+ | **owner_id** | **String** | | |
12
13
  | **updated_at** | **Time** | | |
13
- | **user_id** | **String** | | |
14
14
 
15
15
  ## Example
16
16
 
@@ -23,8 +23,8 @@ instance = TrieveRubyClient::Topic.new(
23
23
  deleted: null,
24
24
  id: null,
25
25
  name: null,
26
- updated_at: null,
27
- user_id: null
26
+ owner_id: null,
27
+ updated_at: null
28
28
  )
29
29
  ```
30
30
 
data/docs/TopicApi.md CHANGED
@@ -6,7 +6,7 @@ All URIs are relative to *https://api.trieve.ai*
6
6
  | ------ | ------------ | ----------- |
7
7
  | [**create_topic**](TopicApi.md#create_topic) | **POST** /api/topic | Create Topic |
8
8
  | [**delete_topic**](TopicApi.md#delete_topic) | **DELETE** /api/topic/{topic_id} | Delete Topic |
9
- | [**get_all_topics_for_user**](TopicApi.md#get_all_topics_for_user) | **GET** /api/topic/user/{user_id} | Get All Topics for User |
9
+ | [**get_all_topics_for_owner_id**](TopicApi.md#get_all_topics_for_owner_id) | **GET** /api/topic/owner/{owner_id} | Get All Topics for Owner ID |
10
10
  | [**update_topic**](TopicApi.md#update_topic) | **PUT** /api/topic | Update Topic |
11
11
 
12
12
 
@@ -16,7 +16,7 @@ All URIs are relative to *https://api.trieve.ai*
16
16
 
17
17
  Create Topic
18
18
 
19
- 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.
19
+ Create Topic Create a new chat topic. Topics are attached to a owner_id's and act as a coordinator for conversation message history of gen-AI chat sessions.
20
20
 
21
21
  ### Examples
22
22
 
@@ -33,7 +33,7 @@ end
33
33
 
34
34
  api_instance = TrieveRubyClient::TopicApi.new
35
35
  tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
36
- create_topic_data = TrieveRubyClient::CreateTopicData.new # CreateTopicData | JSON request payload to create chat topic
36
+ create_topic_data = TrieveRubyClient::CreateTopicData.new({owner_id: 'owner_id_example'}) # CreateTopicData | JSON request payload to create chat topic
37
37
 
38
38
  begin
39
39
  # Create Topic
@@ -155,13 +155,13 @@ nil (empty response body)
155
155
  - **Accept**: application/json
156
156
 
157
157
 
158
- ## get_all_topics_for_user
158
+ ## get_all_topics_for_owner_id
159
159
 
160
- > <Array<Topic>> get_all_topics_for_user(user_id, tr_dataset)
160
+ > <Array<Topic>> get_all_topics_for_owner_id(owner_id, tr_dataset)
161
161
 
162
- Get All Topics for User
162
+ Get All Topics for Owner ID
163
163
 
164
- Get All Topics for User Get all topics belonging to a the auth'ed user. Soon, we plan to allow specification of the user for this route and include pagination.
164
+ Get All Topics for Owner ID Get all topics belonging to an arbitary owner_id. This is useful for managing message history and chat sessions. It is common to use a browser fingerprint or your user's id as the owner_id.
165
165
 
166
166
  ### Examples
167
167
 
@@ -177,33 +177,33 @@ TrieveRubyClient.configure do |config|
177
177
  end
178
178
 
179
179
  api_instance = TrieveRubyClient::TopicApi.new
180
- user_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The id of the user to get topics for
180
+ owner_id = 'owner_id_example' # String | The owner_id to get topics of; A common approach is to use a browser fingerprint or your user's id
181
181
  tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
182
182
 
183
183
  begin
184
- # Get All Topics for User
185
- result = api_instance.get_all_topics_for_user(user_id, tr_dataset)
184
+ # Get All Topics for Owner ID
185
+ result = api_instance.get_all_topics_for_owner_id(owner_id, tr_dataset)
186
186
  p result
187
187
  rescue TrieveRubyClient::ApiError => e
188
- puts "Error when calling TopicApi->get_all_topics_for_user: #{e}"
188
+ puts "Error when calling TopicApi->get_all_topics_for_owner_id: #{e}"
189
189
  end
190
190
  ```
191
191
 
192
- #### Using the get_all_topics_for_user_with_http_info variant
192
+ #### Using the get_all_topics_for_owner_id_with_http_info variant
193
193
 
194
194
  This returns an Array which contains the response data, status code and headers.
195
195
 
196
- > <Array(<Array<Topic>>, Integer, Hash)> get_all_topics_for_user_with_http_info(user_id, tr_dataset)
196
+ > <Array(<Array<Topic>>, Integer, Hash)> get_all_topics_for_owner_id_with_http_info(owner_id, tr_dataset)
197
197
 
198
198
  ```ruby
199
199
  begin
200
- # Get All Topics for User
201
- data, status_code, headers = api_instance.get_all_topics_for_user_with_http_info(user_id, tr_dataset)
200
+ # Get All Topics for Owner ID
201
+ data, status_code, headers = api_instance.get_all_topics_for_owner_id_with_http_info(owner_id, tr_dataset)
202
202
  p status_code # => 2xx
203
203
  p headers # => { ... }
204
204
  p data # => <Array<Topic>>
205
205
  rescue TrieveRubyClient::ApiError => e
206
- puts "Error when calling TopicApi->get_all_topics_for_user_with_http_info: #{e}"
206
+ puts "Error when calling TopicApi->get_all_topics_for_owner_id_with_http_info: #{e}"
207
207
  end
208
208
  ```
209
209
 
@@ -211,7 +211,7 @@ end
211
211
 
212
212
  | Name | Type | Description | Notes |
213
213
  | ---- | ---- | ----------- | ----- |
214
- | **user_id** | **String** | The id of the user to get topics for | |
214
+ | **owner_id** | **String** | The owner_id to get topics of; A common approach is to use a browser fingerprint or your user&#39;s id | |
215
215
  | **tr_dataset** | **String** | The dataset id to use for the request | |
216
216
 
217
217
  ### Return type
@@ -10,6 +10,7 @@
10
10
  | **group_ids** | **Array&lt;String&gt;** | Group ids are the ids of the groups that the chunk should be placed into. This is useful for when you want to update a chunk and add it to a group or multiple groups in one request. | [optional] |
11
11
  | **group_tracking_ids** | **Array&lt;String&gt;** | Group tracking_ids are the tracking_ids of the groups that the chunk should be placed into. This is useful for when you want to update a chunk and add it to a group or multiple groups in one request. | [optional] |
12
12
  | **link** | **String** | Link of the chunk you want to update. This can also be any string. Frequently, this is a link to the source of the chunk. The link value will not affect the embedding creation. If no link is provided, the existing link will be used. | [optional] |
13
+ | **location** | [**GeoInfo**](GeoInfo.md) | | [optional] |
13
14
  | **metadata** | **Object** | The metadata is a JSON object which can be used to filter chunks. This is useful for when you want to filter chunks by arbitrary metadata. Unlike with tag filtering, there is a performance hit for filtering on metadata. If no metadata is provided, the existing metadata will be used. | [optional] |
14
15
  | **tag_set** | **Array&lt;String&gt;** | Tag set is a list of tags. This can be used to filter chunks by tag. Unlike with metadata filtering, HNSW indices will exist for each tag such that there is not a performance hit for filtering on them. If no tag_set is provided, the existing tag_set will be used. | [optional] |
15
16
  | **time_stamp** | **String** | Time_stamp should be an ISO 8601 combined date and time without timezone. It is used for time window filtering and recency-biasing search results. If no time_stamp is provided, the existing time_stamp will be used. | [optional] |
@@ -28,6 +29,7 @@ instance = TrieveRubyClient::UpdateChunkData.new(
28
29
  group_ids: null,
29
30
  group_tracking_ids: null,
30
31
  link: null,
32
+ location: null,
31
33
  metadata: null,
32
34
  tag_set: null,
33
35
  time_stamp: null,
@@ -0,0 +1,22 @@
1
+ # TrieveRubyClient::UpdateUserOrgRoleData
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **organization_id** | **String** | The id of the organization to update the user for. | |
8
+ | **role** | **Integer** | Either 0 (user), 1 (admin), or 2 (owner). If not provided, the current role will be used. The auth&#39;ed user must have a role greater than or equal to the role being assigned. | |
9
+ | **user_id** | **String** | The id of the user to update, if not provided, the auth&#39;ed user will be updated. If provided, the auth&#39;ed user must be an admin (1) or owner (2) of the organization. | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'trieve_ruby_client'
15
+
16
+ instance = TrieveRubyClient::UpdateUserOrgRoleData.new(
17
+ organization_id: null,
18
+ role: null,
19
+ user_id: null
20
+ )
21
+ ```
22
+
data/docs/UserApi.md CHANGED
@@ -153,7 +153,7 @@ end
153
153
 
154
154
  ## update_user
155
155
 
156
- > <SlimUser> update_user(update_user_data)
156
+ > update_user(update_user_org_role_data)
157
157
 
158
158
  Update User
159
159
 
@@ -173,12 +173,11 @@ TrieveRubyClient.configure do |config|
173
173
  end
174
174
 
175
175
  api_instance = TrieveRubyClient::UserApi.new
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
176
+ update_user_org_role_data = TrieveRubyClient::UpdateUserOrgRoleData.new({organization_id: 'organization_id_example', role: 37}) # UpdateUserOrgRoleData | JSON request payload to update user information for the auth'ed user
177
177
 
178
178
  begin
179
179
  # Update User
180
- result = api_instance.update_user(update_user_data)
181
- p result
180
+ api_instance.update_user(update_user_org_role_data)
182
181
  rescue TrieveRubyClient::ApiError => e
183
182
  puts "Error when calling UserApi->update_user: #{e}"
184
183
  end
@@ -186,17 +185,17 @@ end
186
185
 
187
186
  #### Using the update_user_with_http_info variant
188
187
 
189
- This returns an Array which contains the response data, status code and headers.
188
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
190
189
 
191
- > <Array(<SlimUser>, Integer, Hash)> update_user_with_http_info(update_user_data)
190
+ > <Array(nil, Integer, Hash)> update_user_with_http_info(update_user_org_role_data)
192
191
 
193
192
  ```ruby
194
193
  begin
195
194
  # Update User
196
- data, status_code, headers = api_instance.update_user_with_http_info(update_user_data)
195
+ data, status_code, headers = api_instance.update_user_with_http_info(update_user_org_role_data)
197
196
  p status_code # => 2xx
198
197
  p headers # => { ... }
199
- p data # => <SlimUser>
198
+ p data # => nil
200
199
  rescue TrieveRubyClient::ApiError => e
201
200
  puts "Error when calling UserApi->update_user_with_http_info: #{e}"
202
201
  end
@@ -206,11 +205,11 @@ end
206
205
 
207
206
  | Name | Type | Description | Notes |
208
207
  | ---- | ---- | ----------- | ----- |
209
- | **update_user_data** | [**UpdateUserData**](UpdateUserData.md) | JSON request payload to update user information for the auth&#39;ed user | |
208
+ | **update_user_org_role_data** | [**UpdateUserOrgRoleData**](UpdateUserOrgRoleData.md) | JSON request payload to update user information for the auth&#39;ed user | |
210
209
 
211
210
  ### Return type
212
211
 
213
- [**SlimUser**](SlimUser.md)
212
+ nil (empty response body)
214
213
 
215
214
  ### Authorization
216
215
 
@@ -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.6.9
6
+ The version of the OpenAPI document: 0.7.6
7
7
  Contact: developers@trieve.ai
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.4.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
5
5
 
6
- The version of the OpenAPI document: 0.6.9
6
+ The version of the OpenAPI document: 0.7.6
7
7
  Contact: developers@trieve.ai
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.4.0
@@ -20,7 +20,7 @@ module TrieveRubyClient
20
20
  @api_client = api_client
21
21
  end
22
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.
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. If uploading in bulk, the maximum amount of chunks that can be uploaded at once is 120 chunks.
24
24
  # @param tr_dataset [String] The dataset id to use for the request
25
25
  # @param create_chunk_data [CreateChunkData] JSON request payload to create a new chunk (chunk)
26
26
  # @param [Hash] opts the optional parameters
@@ -31,7 +31,7 @@ module TrieveRubyClient
31
31
  end
32
32
 
33
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.
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. If uploading in bulk, the maximum amount of chunks that can be uploaded at once is 120 chunks.
35
35
  # @param tr_dataset [String] The dataset id to use for the request
36
36
  # @param create_chunk_data [CreateChunkData] JSON request payload to create a new chunk (chunk)
37
37
  # @param [Hash] opts the optional parameters
@@ -524,6 +524,156 @@ module TrieveRubyClient
524
524
  return data, status_code, headers
525
525
  end
526
526
 
527
+ # Get Chunks By Ids
528
+ # Get Chunks By Ids Get multiple chunks by multiple ids.
529
+ # @param tr_dataset [String] The dataset id to use for the request
530
+ # @param get_chunks_data [GetChunksData] JSON request payload to get the chunks in the request
531
+ # @param [Hash] opts the optional parameters
532
+ # @return [Array<ChunkMetadata>]
533
+ def get_chunks_by_ids(tr_dataset, get_chunks_data, opts = {})
534
+ data, _status_code, _headers = get_chunks_by_ids_with_http_info(tr_dataset, get_chunks_data, opts)
535
+ data
536
+ end
537
+
538
+ # Get Chunks By Ids
539
+ # Get Chunks By Ids Get multiple chunks by multiple ids.
540
+ # @param tr_dataset [String] The dataset id to use for the request
541
+ # @param get_chunks_data [GetChunksData] JSON request payload to get the chunks in the request
542
+ # @param [Hash] opts the optional parameters
543
+ # @return [Array<(Array<ChunkMetadata>, Integer, Hash)>] Array<ChunkMetadata> data, response status code and response headers
544
+ def get_chunks_by_ids_with_http_info(tr_dataset, get_chunks_data, opts = {})
545
+ if @api_client.config.debugging
546
+ @api_client.config.logger.debug 'Calling API: ChunkApi.get_chunks_by_ids ...'
547
+ end
548
+ # verify the required parameter 'tr_dataset' is set
549
+ if @api_client.config.client_side_validation && tr_dataset.nil?
550
+ fail ArgumentError, "Missing the required parameter 'tr_dataset' when calling ChunkApi.get_chunks_by_ids"
551
+ end
552
+ # verify the required parameter 'get_chunks_data' is set
553
+ if @api_client.config.client_side_validation && get_chunks_data.nil?
554
+ fail ArgumentError, "Missing the required parameter 'get_chunks_data' when calling ChunkApi.get_chunks_by_ids"
555
+ end
556
+ # resource path
557
+ local_var_path = '/api/chunks'
558
+
559
+ # query parameters
560
+ query_params = opts[:query_params] || {}
561
+
562
+ # header parameters
563
+ header_params = opts[:header_params] || {}
564
+ # HTTP header 'Accept' (if needed)
565
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
566
+ # HTTP header 'Content-Type'
567
+ content_type = @api_client.select_header_content_type(['application/json'])
568
+ if !content_type.nil?
569
+ header_params['Content-Type'] = content_type
570
+ end
571
+ header_params[:'TR-Dataset'] = tr_dataset
572
+
573
+ # form parameters
574
+ form_params = opts[:form_params] || {}
575
+
576
+ # http body (model)
577
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(get_chunks_data)
578
+
579
+ # return_type
580
+ return_type = opts[:debug_return_type] || 'Array<ChunkMetadata>'
581
+
582
+ # auth_names
583
+ auth_names = opts[:debug_auth_names] || ['ApiKey']
584
+
585
+ new_options = opts.merge(
586
+ :operation => :"ChunkApi.get_chunks_by_ids",
587
+ :header_params => header_params,
588
+ :query_params => query_params,
589
+ :form_params => form_params,
590
+ :body => post_body,
591
+ :auth_names => auth_names,
592
+ :return_type => return_type
593
+ )
594
+
595
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
596
+ if @api_client.config.debugging
597
+ @api_client.config.logger.debug "API called: ChunkApi#get_chunks_by_ids\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
598
+ end
599
+ return data, status_code, headers
600
+ end
601
+
602
+ # Get Chunks By TrackingIds
603
+ # Get Chunks By TrackingIds Get multiple chunks by ids.
604
+ # @param tr_dataset [String] The dataset id to use for the request
605
+ # @param get_tracking_chunks_data [GetTrackingChunksData] JSON request payload to get the chunks in the request
606
+ # @param [Hash] opts the optional parameters
607
+ # @return [ChunkMetadata]
608
+ def get_chunks_by_tracking_ids(tr_dataset, get_tracking_chunks_data, opts = {})
609
+ data, _status_code, _headers = get_chunks_by_tracking_ids_with_http_info(tr_dataset, get_tracking_chunks_data, opts)
610
+ data
611
+ end
612
+
613
+ # Get Chunks By TrackingIds
614
+ # Get Chunks By TrackingIds Get multiple chunks by ids.
615
+ # @param tr_dataset [String] The dataset id to use for the request
616
+ # @param get_tracking_chunks_data [GetTrackingChunksData] JSON request payload to get the chunks in the request
617
+ # @param [Hash] opts the optional parameters
618
+ # @return [Array<(ChunkMetadata, Integer, Hash)>] ChunkMetadata data, response status code and response headers
619
+ def get_chunks_by_tracking_ids_with_http_info(tr_dataset, get_tracking_chunks_data, opts = {})
620
+ if @api_client.config.debugging
621
+ @api_client.config.logger.debug 'Calling API: ChunkApi.get_chunks_by_tracking_ids ...'
622
+ end
623
+ # verify the required parameter 'tr_dataset' is set
624
+ if @api_client.config.client_side_validation && tr_dataset.nil?
625
+ fail ArgumentError, "Missing the required parameter 'tr_dataset' when calling ChunkApi.get_chunks_by_tracking_ids"
626
+ end
627
+ # verify the required parameter 'get_tracking_chunks_data' is set
628
+ if @api_client.config.client_side_validation && get_tracking_chunks_data.nil?
629
+ fail ArgumentError, "Missing the required parameter 'get_tracking_chunks_data' when calling ChunkApi.get_chunks_by_tracking_ids"
630
+ end
631
+ # resource path
632
+ local_var_path = '/api/chunks/tracking'
633
+
634
+ # query parameters
635
+ query_params = opts[:query_params] || {}
636
+
637
+ # header parameters
638
+ header_params = opts[:header_params] || {}
639
+ # HTTP header 'Accept' (if needed)
640
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
641
+ # HTTP header 'Content-Type'
642
+ content_type = @api_client.select_header_content_type(['application/json'])
643
+ if !content_type.nil?
644
+ header_params['Content-Type'] = content_type
645
+ end
646
+ header_params[:'TR-Dataset'] = tr_dataset
647
+
648
+ # form parameters
649
+ form_params = opts[:form_params] || {}
650
+
651
+ # http body (model)
652
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(get_tracking_chunks_data)
653
+
654
+ # return_type
655
+ return_type = opts[:debug_return_type] || 'ChunkMetadata'
656
+
657
+ # auth_names
658
+ auth_names = opts[:debug_auth_names] || ['ApiKey']
659
+
660
+ new_options = opts.merge(
661
+ :operation => :"ChunkApi.get_chunks_by_tracking_ids",
662
+ :header_params => header_params,
663
+ :query_params => query_params,
664
+ :form_params => form_params,
665
+ :body => post_body,
666
+ :auth_names => auth_names,
667
+ :return_type => return_type
668
+ )
669
+
670
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
671
+ if @api_client.config.debugging
672
+ @api_client.config.logger.debug "API called: ChunkApi#get_chunks_by_tracking_ids\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
673
+ end
674
+ return data, status_code, headers
675
+ end
676
+
527
677
  # Get Recommended Chunks
528
678
  # 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.
529
679
  # @param tr_dataset [String] The dataset id to use for the request
@@ -605,8 +755,8 @@ module TrieveRubyClient
605
755
  # @param search_chunk_data [SearchChunkData] JSON request payload to semantically search for chunks (chunks)
606
756
  # @param [Hash] opts the optional parameters
607
757
  # @return [SearchChunkQueryResponseBody]
608
- def search_chunk(tr_dataset, search_chunk_data, opts = {})
609
- data, _status_code, _headers = search_chunk_with_http_info(tr_dataset, search_chunk_data, opts)
758
+ def search_chunks(tr_dataset, search_chunk_data, opts = {})
759
+ data, _status_code, _headers = search_chunks_with_http_info(tr_dataset, search_chunk_data, opts)
610
760
  data
611
761
  end
612
762
 
@@ -616,17 +766,17 @@ module TrieveRubyClient
616
766
  # @param search_chunk_data [SearchChunkData] JSON request payload to semantically search for chunks (chunks)
617
767
  # @param [Hash] opts the optional parameters
618
768
  # @return [Array<(SearchChunkQueryResponseBody, Integer, Hash)>] SearchChunkQueryResponseBody data, response status code and response headers
619
- def search_chunk_with_http_info(tr_dataset, search_chunk_data, opts = {})
769
+ def search_chunks_with_http_info(tr_dataset, search_chunk_data, opts = {})
620
770
  if @api_client.config.debugging
621
- @api_client.config.logger.debug 'Calling API: ChunkApi.search_chunk ...'
771
+ @api_client.config.logger.debug 'Calling API: ChunkApi.search_chunks ...'
622
772
  end
623
773
  # verify the required parameter 'tr_dataset' is set
624
774
  if @api_client.config.client_side_validation && tr_dataset.nil?
625
- fail ArgumentError, "Missing the required parameter 'tr_dataset' when calling ChunkApi.search_chunk"
775
+ fail ArgumentError, "Missing the required parameter 'tr_dataset' when calling ChunkApi.search_chunks"
626
776
  end
627
777
  # verify the required parameter 'search_chunk_data' is set
628
778
  if @api_client.config.client_side_validation && search_chunk_data.nil?
629
- fail ArgumentError, "Missing the required parameter 'search_chunk_data' when calling ChunkApi.search_chunk"
779
+ fail ArgumentError, "Missing the required parameter 'search_chunk_data' when calling ChunkApi.search_chunks"
630
780
  end
631
781
  # resource path
632
782
  local_var_path = '/api/chunk/search'
@@ -658,7 +808,7 @@ module TrieveRubyClient
658
808
  auth_names = opts[:debug_auth_names] || ['ApiKey']
659
809
 
660
810
  new_options = opts.merge(
661
- :operation => :"ChunkApi.search_chunk",
811
+ :operation => :"ChunkApi.search_chunks",
662
812
  :header_params => header_params,
663
813
  :query_params => query_params,
664
814
  :form_params => form_params,
@@ -669,7 +819,7 @@ module TrieveRubyClient
669
819
 
670
820
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
671
821
  if @api_client.config.debugging
672
- @api_client.config.logger.debug "API called: ChunkApi#search_chunk\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
822
+ @api_client.config.logger.debug "API called: ChunkApi#search_chunks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
673
823
  end
674
824
  return data, status_code, headers
675
825
  end
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
5
5
 
6
- The version of the OpenAPI document: 0.6.9
6
+ The version of the OpenAPI document: 0.7.6
7
7
  Contact: developers@trieve.ai
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.4.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
5
5
 
6
- The version of the OpenAPI document: 0.6.9
6
+ The version of the OpenAPI document: 0.7.6
7
7
  Contact: developers@trieve.ai
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.4.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
5
5
 
6
- The version of the OpenAPI document: 0.6.9
6
+ The version of the OpenAPI document: 0.7.6
7
7
  Contact: developers@trieve.ai
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.4.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
5
5
 
6
- The version of the OpenAPI document: 0.6.9
6
+ The version of the OpenAPI document: 0.7.6
7
7
  Contact: developers@trieve.ai
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.4.0
@@ -23,11 +23,10 @@ module TrieveRubyClient
23
23
  # Delete File Delete a file from S3 attached to the server based on its id. This will disassociate chunks from the file, but only delete them all together if you specify delete_chunks to be true. Auth'ed user must be an admin or owner of the dataset's organization to delete a file.
24
24
  # @param tr_dataset [String] The dataset id to use for the request
25
25
  # @param file_id [String] The id of the file to delete
26
- # @param delete_chunks [Boolean] Whether or not to delete the chunks associated with the file
27
26
  # @param [Hash] opts the optional parameters
28
27
  # @return [nil]
29
- def delete_file_handler(tr_dataset, file_id, delete_chunks, opts = {})
30
- delete_file_handler_with_http_info(tr_dataset, file_id, delete_chunks, opts)
28
+ def delete_file_handler(tr_dataset, file_id, opts = {})
29
+ delete_file_handler_with_http_info(tr_dataset, file_id, opts)
31
30
  nil
32
31
  end
33
32
 
@@ -35,10 +34,9 @@ module TrieveRubyClient
35
34
  # Delete File Delete a file from S3 attached to the server based on its id. This will disassociate chunks from the file, but only delete them all together if you specify delete_chunks to be true. Auth&#39;ed user must be an admin or owner of the dataset&#39;s organization to delete a file.
36
35
  # @param tr_dataset [String] The dataset id to use for the request
37
36
  # @param file_id [String] The id of the file to delete
38
- # @param delete_chunks [Boolean] Whether or not to delete the chunks associated with the file
39
37
  # @param [Hash] opts the optional parameters
40
38
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
41
- def delete_file_handler_with_http_info(tr_dataset, file_id, delete_chunks, opts = {})
39
+ def delete_file_handler_with_http_info(tr_dataset, file_id, opts = {})
42
40
  if @api_client.config.debugging
43
41
  @api_client.config.logger.debug 'Calling API: FileApi.delete_file_handler ...'
44
42
  end
@@ -50,16 +48,11 @@ module TrieveRubyClient
50
48
  if @api_client.config.client_side_validation && file_id.nil?
51
49
  fail ArgumentError, "Missing the required parameter 'file_id' when calling FileApi.delete_file_handler"
52
50
  end
53
- # verify the required parameter 'delete_chunks' is set
54
- if @api_client.config.client_side_validation && delete_chunks.nil?
55
- fail ArgumentError, "Missing the required parameter 'delete_chunks' when calling FileApi.delete_file_handler"
56
- end
57
51
  # resource path
58
52
  local_var_path = '/api/file/{file_id}'.sub('{' + 'file_id' + '}', CGI.escape(file_id.to_s))
59
53
 
60
54
  # query parameters
61
55
  query_params = opts[:query_params] || {}
62
- query_params[:'delete_chunks'] = delete_chunks
63
56
 
64
57
  # header parameters
65
58
  header_params = opts[:header_params] || {}
@@ -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.6.9
6
+ The version of the OpenAPI document: 0.7.6
7
7
  Contact: developers@trieve.ai
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.4.0