trieve_ruby_client 0.3.4 → 0.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +78 -81
- data/docs/AuthApi.md +29 -40
- data/docs/AuthQuery.md +22 -0
- data/docs/BatchQueuedChunkResponse.md +20 -0
- data/docs/ChunkApi.md +80 -214
- data/docs/ChunkData.md +42 -0
- data/docs/ChunkGroupApi.md +183 -174
- data/docs/CreateChunkData.md +41 -34
- data/docs/DatasetApi.md +37 -67
- data/docs/EventsApi.md +14 -19
- data/docs/FileApi.md +25 -45
- data/docs/GetEventsData.md +22 -0
- data/docs/HealthApi.md +6 -4
- data/docs/InvitationApi.md +7 -12
- data/docs/MessageApi.md +25 -45
- data/docs/OrganizationApi.md +37 -67
- data/docs/ReturnQueuedChunk.md +39 -10
- data/docs/SingleQueuedChunkResponse.md +20 -0
- data/docs/StripeApi.md +23 -25
- data/docs/TopicApi.md +25 -45
- data/docs/UserApi.md +19 -34
- data/lib/trieve_ruby_client/api/auth_api.rb +28 -35
- data/lib/trieve_ruby_client/api/chunk_api.rb +68 -143
- data/lib/trieve_ruby_client/api/chunk_group_api.rb +164 -76
- data/lib/trieve_ruby_client/api/dataset_api.rb +31 -31
- data/lib/trieve_ruby_client/api/events_api.rb +22 -17
- data/lib/trieve_ruby_client/api/file_api.rb +21 -21
- data/lib/trieve_ruby_client/api/health_api.rb +5 -1
- data/lib/trieve_ruby_client/api/invitation_api.rb +6 -6
- data/lib/trieve_ruby_client/api/message_api.rb +21 -21
- data/lib/trieve_ruby_client/api/organization_api.rb +31 -31
- data/lib/trieve_ruby_client/api/stripe_api.rb +19 -3
- data/lib/trieve_ruby_client/api/topic_api.rb +21 -21
- data/lib/trieve_ruby_client/api/user_api.rb +16 -16
- data/lib/trieve_ruby_client/api_client.rb +1 -1
- data/lib/trieve_ruby_client/api_error.rb +1 -1
- data/lib/trieve_ruby_client/configuration.rb +8 -11
- data/lib/trieve_ruby_client/models/add_chunk_to_group_data.rb +1 -1
- data/lib/trieve_ruby_client/models/api_key_dto.rb +1 -1
- data/lib/trieve_ruby_client/models/auth_query.rb +238 -0
- data/lib/trieve_ruby_client/models/batch_queued_chunk_response.rb +240 -0
- data/lib/trieve_ruby_client/models/bookmark_data.rb +1 -1
- data/lib/trieve_ruby_client/models/bookmark_group_result.rb +1 -1
- data/lib/trieve_ruby_client/models/chat_message_proxy.rb +1 -1
- data/lib/trieve_ruby_client/models/chunk_data.rb +356 -0
- data/lib/trieve_ruby_client/models/chunk_filter.rb +1 -1
- data/lib/trieve_ruby_client/models/chunk_group.rb +1 -1
- data/lib/trieve_ruby_client/models/chunk_group_and_file.rb +1 -1
- data/lib/trieve_ruby_client/models/chunk_metadata.rb +1 -1
- data/lib/trieve_ruby_client/models/chunk_metadata_with_file_data.rb +1 -1
- data/lib/trieve_ruby_client/models/client_dataset_configuration.rb +1 -1
- data/lib/trieve_ruby_client/models/create_chunk_data.rb +79 -330
- data/lib/trieve_ruby_client/models/create_chunk_group_data.rb +1 -1
- data/lib/trieve_ruby_client/models/create_dataset_request.rb +1 -1
- data/lib/trieve_ruby_client/models/create_message_data.rb +1 -1
- data/lib/trieve_ruby_client/models/create_organization_data.rb +1 -1
- data/lib/trieve_ruby_client/models/create_topic_data.rb +1 -1
- data/lib/trieve_ruby_client/models/dataset.rb +1 -1
- data/lib/trieve_ruby_client/models/dataset_and_usage.rb +1 -1
- data/lib/trieve_ruby_client/models/dataset_dto.rb +1 -1
- data/lib/trieve_ruby_client/models/dataset_usage_count.rb +1 -1
- data/lib/trieve_ruby_client/models/delete_dataset_request.rb +1 -1
- data/lib/trieve_ruby_client/models/delete_topic_data.rb +1 -1
- data/lib/trieve_ruby_client/models/delete_user_api_key_request.rb +1 -1
- data/lib/trieve_ruby_client/models/edit_message_data.rb +1 -1
- data/lib/trieve_ruby_client/models/error_response_body.rb +1 -1
- data/lib/trieve_ruby_client/models/event.rb +1 -1
- data/lib/trieve_ruby_client/models/event_return.rb +1 -1
- data/lib/trieve_ruby_client/models/field_condition.rb +1 -1
- data/lib/trieve_ruby_client/models/file.rb +1 -1
- data/lib/trieve_ruby_client/models/file_dto.rb +1 -1
- data/lib/trieve_ruby_client/models/generate_chunks_request.rb +1 -1
- data/lib/trieve_ruby_client/models/get_events_data.rb +240 -0
- data/lib/trieve_ruby_client/models/get_groups_for_chunks_data.rb +1 -1
- data/lib/trieve_ruby_client/models/group_data.rb +1 -1
- data/lib/trieve_ruby_client/models/group_score_chunk_dto.rb +1 -1
- data/lib/trieve_ruby_client/models/invitation_data.rb +1 -1
- data/lib/trieve_ruby_client/models/match_condition.rb +1 -1
- data/lib/trieve_ruby_client/models/message.rb +1 -1
- data/lib/trieve_ruby_client/models/organization.rb +1 -1
- data/lib/trieve_ruby_client/models/organization_usage_count.rb +1 -1
- data/lib/trieve_ruby_client/models/range.rb +1 -1
- data/lib/trieve_ruby_client/models/reccomend_group_chunks_request.rb +1 -1
- data/lib/trieve_ruby_client/models/recommend_chunks_request.rb +1 -1
- data/lib/trieve_ruby_client/models/regenerate_message_data.rb +1 -1
- data/lib/trieve_ruby_client/models/return_queued_chunk.rb +75 -207
- data/lib/trieve_ruby_client/models/score_chunk_dto.rb +1 -1
- data/lib/trieve_ruby_client/models/search_chunk_data.rb +1 -1
- data/lib/trieve_ruby_client/models/search_chunk_query_response_body.rb +1 -1
- data/lib/trieve_ruby_client/models/search_groups_result.rb +1 -1
- data/lib/trieve_ruby_client/models/search_over_groups_data.rb +1 -1
- data/lib/trieve_ruby_client/models/search_over_groups_response_body.rb +1 -1
- data/lib/trieve_ruby_client/models/search_within_group_data.rb +1 -1
- data/lib/trieve_ruby_client/models/set_user_api_key_request.rb +1 -1
- data/lib/trieve_ruby_client/models/set_user_api_key_response.rb +1 -1
- data/lib/trieve_ruby_client/models/single_queued_chunk_response.rb +238 -0
- data/lib/trieve_ruby_client/models/slim_group.rb +1 -1
- data/lib/trieve_ruby_client/models/slim_user.rb +1 -1
- data/lib/trieve_ruby_client/models/stripe_plan.rb +1 -1
- data/lib/trieve_ruby_client/models/stripe_subscription.rb +1 -1
- data/lib/trieve_ruby_client/models/suggested_queries_request.rb +1 -1
- data/lib/trieve_ruby_client/models/suggested_queries_response.rb +1 -1
- data/lib/trieve_ruby_client/models/topic.rb +1 -1
- data/lib/trieve_ruby_client/models/update_chunk_by_tracking_id_data.rb +1 -1
- data/lib/trieve_ruby_client/models/update_chunk_data.rb +1 -1
- data/lib/trieve_ruby_client/models/update_chunk_group_data.rb +1 -1
- data/lib/trieve_ruby_client/models/update_dataset_request.rb +1 -1
- data/lib/trieve_ruby_client/models/update_group_by_tracking_id_data.rb +1 -1
- data/lib/trieve_ruby_client/models/update_organization_data.rb +1 -1
- data/lib/trieve_ruby_client/models/update_topic_data.rb +1 -1
- data/lib/trieve_ruby_client/models/update_user_data.rb +1 -1
- data/lib/trieve_ruby_client/models/upload_file_data.rb +1 -1
- data/lib/trieve_ruby_client/models/upload_file_result.rb +1 -1
- data/lib/trieve_ruby_client/models/user_organization.rb +1 -1
- data/lib/trieve_ruby_client/version.rb +2 -2
- data/lib/trieve_ruby_client.rb +6 -2
- data/openapi-generator.yaml +2 -2
- data/openapi.json +1280 -876
- data/spec/models/auth_query_spec.rb +48 -0
- data/spec/models/batch_queued_chunk_response_spec.rb +42 -0
- data/spec/models/chunk_data_spec.rb +108 -0
- data/spec/models/get_events_data_spec.rb +48 -0
- data/spec/models/single_queued_chunk_response_spec.rb +42 -0
- data/spec/spec_helper.rb +1 -1
- data/trieve_ruby_client-0.3.5.gem +0 -0
- data/trieve_ruby_client.gemspec +2 -2
- metadata +25 -3
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 0.
|
6
|
+
The version of the OpenAPI document: 0.4.0
|
7
7
|
Contact: developers@trieve.ai
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
Generator version: 7.4.0
|
@@ -19,8 +19,8 @@ module TrieveRubyClient
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
|
-
#
|
23
|
-
#
|
22
|
+
# Create dataset
|
23
|
+
# Create dataset Create a new dataset. The auth'ed user must be an owner of the organization to create a dataset.
|
24
24
|
# @param tr_organization [String] The organization id to use for the request
|
25
25
|
# @param create_dataset_request [CreateDatasetRequest] JSON request payload to create a new dataset
|
26
26
|
# @param [Hash] opts the optional parameters
|
@@ -30,8 +30,8 @@ module TrieveRubyClient
|
|
30
30
|
data
|
31
31
|
end
|
32
32
|
|
33
|
-
#
|
34
|
-
#
|
33
|
+
# Create dataset
|
34
|
+
# Create dataset Create a new dataset. The auth'ed user must be an owner of the organization to create a dataset.
|
35
35
|
# @param tr_organization [String] The organization id to use for the request
|
36
36
|
# @param create_dataset_request [CreateDatasetRequest] JSON request payload to create a new dataset
|
37
37
|
# @param [Hash] opts the optional parameters
|
@@ -75,7 +75,7 @@ module TrieveRubyClient
|
|
75
75
|
return_type = opts[:debug_return_type] || 'Dataset'
|
76
76
|
|
77
77
|
# auth_names
|
78
|
-
auth_names = opts[:debug_auth_names] || ['
|
78
|
+
auth_names = opts[:debug_auth_names] || ['ApiKey']
|
79
79
|
|
80
80
|
new_options = opts.merge(
|
81
81
|
:operation => :"DatasetApi.create_dataset",
|
@@ -94,8 +94,8 @@ module TrieveRubyClient
|
|
94
94
|
return data, status_code, headers
|
95
95
|
end
|
96
96
|
|
97
|
-
#
|
98
|
-
#
|
97
|
+
# Delete Dataset
|
98
|
+
# Delete Dataset Delete a dataset. The auth'ed user must be an owner of the organization to delete a dataset.
|
99
99
|
# @param tr_organization [String] The organization id to use for the request
|
100
100
|
# @param delete_dataset_request [DeleteDatasetRequest] JSON request payload to delete a dataset
|
101
101
|
# @param [Hash] opts the optional parameters
|
@@ -105,8 +105,8 @@ module TrieveRubyClient
|
|
105
105
|
nil
|
106
106
|
end
|
107
107
|
|
108
|
-
#
|
109
|
-
#
|
108
|
+
# Delete Dataset
|
109
|
+
# Delete Dataset Delete a dataset. The auth'ed user must be an owner of the organization to delete a dataset.
|
110
110
|
# @param tr_organization [String] The organization id to use for the request
|
111
111
|
# @param delete_dataset_request [DeleteDatasetRequest] JSON request payload to delete a dataset
|
112
112
|
# @param [Hash] opts the optional parameters
|
@@ -150,7 +150,7 @@ module TrieveRubyClient
|
|
150
150
|
return_type = opts[:debug_return_type]
|
151
151
|
|
152
152
|
# auth_names
|
153
|
-
auth_names = opts[:debug_auth_names] || ['
|
153
|
+
auth_names = opts[:debug_auth_names] || ['ApiKey']
|
154
154
|
|
155
155
|
new_options = opts.merge(
|
156
156
|
:operation => :"DatasetApi.delete_dataset",
|
@@ -169,8 +169,8 @@ module TrieveRubyClient
|
|
169
169
|
return data, status_code, headers
|
170
170
|
end
|
171
171
|
|
172
|
-
#
|
173
|
-
#
|
172
|
+
# Get Client Configuration
|
173
|
+
# Get Client Configuration Get the client configuration for a dataset. Will use the TR-D
|
174
174
|
# @param tr_dataset [String] The dataset id to use for the request
|
175
175
|
# @param [Hash] opts the optional parameters
|
176
176
|
# @return [ClientDatasetConfiguration]
|
@@ -179,8 +179,8 @@ module TrieveRubyClient
|
|
179
179
|
data
|
180
180
|
end
|
181
181
|
|
182
|
-
#
|
183
|
-
#
|
182
|
+
# Get Client Configuration
|
183
|
+
# Get Client Configuration Get the client configuration for a dataset. Will use the TR-D
|
184
184
|
# @param tr_dataset [String] The dataset id to use for the request
|
185
185
|
# @param [Hash] opts the optional parameters
|
186
186
|
# @return [Array<(ClientDatasetConfiguration, Integer, Hash)>] ClientDatasetConfiguration data, response status code and response headers
|
@@ -214,7 +214,7 @@ module TrieveRubyClient
|
|
214
214
|
return_type = opts[:debug_return_type] || 'ClientDatasetConfiguration'
|
215
215
|
|
216
216
|
# auth_names
|
217
|
-
auth_names = opts[:debug_auth_names] || ['
|
217
|
+
auth_names = opts[:debug_auth_names] || ['ApiKey']
|
218
218
|
|
219
219
|
new_options = opts.merge(
|
220
220
|
:operation => :"DatasetApi.get_client_dataset_config",
|
@@ -233,8 +233,8 @@ module TrieveRubyClient
|
|
233
233
|
return data, status_code, headers
|
234
234
|
end
|
235
235
|
|
236
|
-
#
|
237
|
-
#
|
236
|
+
# Get Dataset
|
237
|
+
# Get Dataset Get a dataset by id. The auth'ed user must be an admin or owner of the organization to get a dataset.
|
238
238
|
# @param tr_organization [String] The organization id to use for the request
|
239
239
|
# @param tr_dataset [String] The dataset id to use for the request
|
240
240
|
# @param dataset_id [String] The id of the dataset you want to retrieve.
|
@@ -245,8 +245,8 @@ module TrieveRubyClient
|
|
245
245
|
data
|
246
246
|
end
|
247
247
|
|
248
|
-
#
|
249
|
-
#
|
248
|
+
# Get Dataset
|
249
|
+
# Get Dataset Get a dataset by id. The auth'ed user must be an admin or owner of the organization to get a dataset.
|
250
250
|
# @param tr_organization [String] The organization id to use for the request
|
251
251
|
# @param tr_dataset [String] The dataset id to use for the request
|
252
252
|
# @param dataset_id [String] The id of the dataset you want to retrieve.
|
@@ -291,7 +291,7 @@ module TrieveRubyClient
|
|
291
291
|
return_type = opts[:debug_return_type] || 'Dataset'
|
292
292
|
|
293
293
|
# auth_names
|
294
|
-
auth_names = opts[:debug_auth_names] || ['
|
294
|
+
auth_names = opts[:debug_auth_names] || ['ApiKey']
|
295
295
|
|
296
296
|
new_options = opts.merge(
|
297
297
|
:operation => :"DatasetApi.get_dataset",
|
@@ -310,8 +310,8 @@ module TrieveRubyClient
|
|
310
310
|
return data, status_code, headers
|
311
311
|
end
|
312
312
|
|
313
|
-
#
|
314
|
-
#
|
313
|
+
# Get Datasets from Organization
|
314
|
+
# Get Datasets from Organization Get all datasets for an organization. The auth'ed user must be an admin or owner of the organization to get its datasets.
|
315
315
|
# @param tr_organization [String] The organization id to use for the request
|
316
316
|
# @param organization_id [String] id of the organization you want to retrieve datasets for
|
317
317
|
# @param [Hash] opts the optional parameters
|
@@ -321,8 +321,8 @@ module TrieveRubyClient
|
|
321
321
|
data
|
322
322
|
end
|
323
323
|
|
324
|
-
#
|
325
|
-
#
|
324
|
+
# Get Datasets from Organization
|
325
|
+
# Get Datasets from Organization Get all datasets for an organization. The auth'ed user must be an admin or owner of the organization to get its datasets.
|
326
326
|
# @param tr_organization [String] The organization id to use for the request
|
327
327
|
# @param organization_id [String] id of the organization you want to retrieve datasets for
|
328
328
|
# @param [Hash] opts the optional parameters
|
@@ -361,7 +361,7 @@ module TrieveRubyClient
|
|
361
361
|
return_type = opts[:debug_return_type] || 'Array<DatasetAndUsage>'
|
362
362
|
|
363
363
|
# auth_names
|
364
|
-
auth_names = opts[:debug_auth_names] || ['
|
364
|
+
auth_names = opts[:debug_auth_names] || ['ApiKey']
|
365
365
|
|
366
366
|
new_options = opts.merge(
|
367
367
|
:operation => :"DatasetApi.get_datasets_from_organization",
|
@@ -380,8 +380,8 @@ module TrieveRubyClient
|
|
380
380
|
return data, status_code, headers
|
381
381
|
end
|
382
382
|
|
383
|
-
#
|
384
|
-
#
|
383
|
+
# Update Dataset
|
384
|
+
# Update Dataset Update a dataset. The auth'ed user must be an owner of the organization to update a dataset.
|
385
385
|
# @param tr_organization [String] The organization id to use for the request
|
386
386
|
# @param update_dataset_request [UpdateDatasetRequest] JSON request payload to update a dataset
|
387
387
|
# @param [Hash] opts the optional parameters
|
@@ -391,8 +391,8 @@ module TrieveRubyClient
|
|
391
391
|
data
|
392
392
|
end
|
393
393
|
|
394
|
-
#
|
395
|
-
#
|
394
|
+
# Update Dataset
|
395
|
+
# Update Dataset Update a dataset. The auth'ed user must be an owner of the organization to update a dataset.
|
396
396
|
# @param tr_organization [String] The organization id to use for the request
|
397
397
|
# @param update_dataset_request [UpdateDatasetRequest] JSON request payload to update a dataset
|
398
398
|
# @param [Hash] opts the optional parameters
|
@@ -436,7 +436,7 @@ module TrieveRubyClient
|
|
436
436
|
return_type = opts[:debug_return_type] || 'Dataset'
|
437
437
|
|
438
438
|
# auth_names
|
439
|
-
auth_names = opts[:debug_auth_names] || ['
|
439
|
+
auth_names = opts[:debug_auth_names] || ['ApiKey']
|
440
440
|
|
441
441
|
new_options = opts.merge(
|
442
442
|
:operation => :"DatasetApi.update_dataset",
|
@@ -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
|
+
The version of the OpenAPI document: 0.4.0
|
7
7
|
Contact: developers@trieve.ai
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
Generator version: 7.4.0
|
@@ -19,24 +19,24 @@ module TrieveRubyClient
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
|
-
#
|
23
|
-
#
|
22
|
+
# Get events for the dataset
|
23
|
+
# Get events for the dataset Get events for the auth'ed user. Currently, this is only for events belonging to the auth'ed user. Soon, we plan to associate events to datasets instead of users.
|
24
24
|
# @param tr_dataset [String] The dataset id to use for the request
|
25
|
-
# @param
|
25
|
+
# @param get_events_data [GetEventsData] JSON request payload to get events for a dataset
|
26
26
|
# @param [Hash] opts the optional parameters
|
27
27
|
# @return [EventReturn]
|
28
|
-
def get_events(tr_dataset,
|
29
|
-
data, _status_code, _headers = get_events_with_http_info(tr_dataset,
|
28
|
+
def get_events(tr_dataset, get_events_data, opts = {})
|
29
|
+
data, _status_code, _headers = get_events_with_http_info(tr_dataset, get_events_data, opts)
|
30
30
|
data
|
31
31
|
end
|
32
32
|
|
33
|
-
#
|
34
|
-
#
|
33
|
+
# Get events for the dataset
|
34
|
+
# Get events for the dataset Get events for the auth'ed user. Currently, this is only for events belonging to the auth'ed user. Soon, we plan to associate events to datasets instead of users.
|
35
35
|
# @param tr_dataset [String] The dataset id to use for the request
|
36
|
-
# @param
|
36
|
+
# @param get_events_data [GetEventsData] JSON request payload to get events for a dataset
|
37
37
|
# @param [Hash] opts the optional parameters
|
38
38
|
# @return [Array<(EventReturn, Integer, Hash)>] EventReturn data, response status code and response headers
|
39
|
-
def get_events_with_http_info(tr_dataset,
|
39
|
+
def get_events_with_http_info(tr_dataset, get_events_data, opts = {})
|
40
40
|
if @api_client.config.debugging
|
41
41
|
@api_client.config.logger.debug 'Calling API: EventsApi.get_events ...'
|
42
42
|
end
|
@@ -44,12 +44,12 @@ module TrieveRubyClient
|
|
44
44
|
if @api_client.config.client_side_validation && tr_dataset.nil?
|
45
45
|
fail ArgumentError, "Missing the required parameter 'tr_dataset' when calling EventsApi.get_events"
|
46
46
|
end
|
47
|
-
# verify the required parameter '
|
48
|
-
if @api_client.config.client_side_validation &&
|
49
|
-
fail ArgumentError, "Missing the required parameter '
|
47
|
+
# verify the required parameter 'get_events_data' is set
|
48
|
+
if @api_client.config.client_side_validation && get_events_data.nil?
|
49
|
+
fail ArgumentError, "Missing the required parameter 'get_events_data' when calling EventsApi.get_events"
|
50
50
|
end
|
51
51
|
# resource path
|
52
|
-
local_var_path = '/api/events
|
52
|
+
local_var_path = '/api/events'
|
53
53
|
|
54
54
|
# query parameters
|
55
55
|
query_params = opts[:query_params] || {}
|
@@ -58,19 +58,24 @@ module TrieveRubyClient
|
|
58
58
|
header_params = opts[:header_params] || {}
|
59
59
|
# HTTP header 'Accept' (if needed)
|
60
60
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
61
|
+
# HTTP header 'Content-Type'
|
62
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
63
|
+
if !content_type.nil?
|
64
|
+
header_params['Content-Type'] = content_type
|
65
|
+
end
|
61
66
|
header_params[:'TR-Dataset'] = tr_dataset
|
62
67
|
|
63
68
|
# form parameters
|
64
69
|
form_params = opts[:form_params] || {}
|
65
70
|
|
66
71
|
# http body (model)
|
67
|
-
post_body = opts[:debug_body]
|
72
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(get_events_data)
|
68
73
|
|
69
74
|
# return_type
|
70
75
|
return_type = opts[:debug_return_type] || 'EventReturn'
|
71
76
|
|
72
77
|
# auth_names
|
73
|
-
auth_names = opts[:debug_auth_names] || ['
|
78
|
+
auth_names = opts[:debug_auth_names] || ['ApiKey']
|
74
79
|
|
75
80
|
new_options = opts.merge(
|
76
81
|
:operation => :"EventsApi.get_events",
|
@@ -82,7 +87,7 @@ module TrieveRubyClient
|
|
82
87
|
:return_type => return_type
|
83
88
|
)
|
84
89
|
|
85
|
-
data, status_code, headers = @api_client.call_api(:
|
90
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
86
91
|
if @api_client.config.debugging
|
87
92
|
@api_client.config.logger.debug "API called: EventsApi#get_events\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
88
93
|
end
|
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 0.
|
6
|
+
The version of the OpenAPI document: 0.4.0
|
7
7
|
Contact: developers@trieve.ai
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
Generator version: 7.4.0
|
@@ -19,8 +19,8 @@ module TrieveRubyClient
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
|
-
#
|
23
|
-
#
|
22
|
+
# Delete File
|
23
|
+
# Delete File Delete a file from S3 attached to the server based on its id. This will disassociate chunks from the file, but will not delete the chunks. We plan to add support for deleting chunks in a release soon. Auth'ed user must be an admin or owner of the dataset's organization to upload a file.
|
24
24
|
# @param tr_dataset [String] The dataset id to use for the request
|
25
25
|
# @param file_id [String] The id of the file to delete
|
26
26
|
# @param delete_chunks [Boolean] Whether or not to delete the chunks associated with the file
|
@@ -31,8 +31,8 @@ module TrieveRubyClient
|
|
31
31
|
nil
|
32
32
|
end
|
33
33
|
|
34
|
-
#
|
35
|
-
#
|
34
|
+
# Delete File
|
35
|
+
# Delete File Delete a file from S3 attached to the server based on its id. This will disassociate chunks from the file, but will not delete the chunks. We plan to add support for deleting chunks in a release soon. Auth'ed user must be an admin or owner of the dataset's organization to upload a file.
|
36
36
|
# @param tr_dataset [String] The dataset id to use for the request
|
37
37
|
# @param file_id [String] The id of the file to delete
|
38
38
|
# @param delete_chunks [Boolean] Whether or not to delete the chunks associated with the file
|
@@ -77,7 +77,7 @@ module TrieveRubyClient
|
|
77
77
|
return_type = opts[:debug_return_type]
|
78
78
|
|
79
79
|
# auth_names
|
80
|
-
auth_names = opts[:debug_auth_names] || ['
|
80
|
+
auth_names = opts[:debug_auth_names] || ['ApiKey']
|
81
81
|
|
82
82
|
new_options = opts.merge(
|
83
83
|
:operation => :"FileApi.delete_file_handler",
|
@@ -96,8 +96,8 @@ module TrieveRubyClient
|
|
96
96
|
return data, status_code, headers
|
97
97
|
end
|
98
98
|
|
99
|
-
#
|
100
|
-
#
|
99
|
+
# Get Files for Dataset
|
100
|
+
# Get Files for Dataset Get all files which belong to a given dataset specified by the dataset_id parameter. 10 files are returned per page.
|
101
101
|
# @param tr_dataset [String] The dataset id to use for the request
|
102
102
|
# @param dataset_id [String] The id of the dataset to fetch files for.
|
103
103
|
# @param page [Integer] The page number of files you wish to fetch. Each page contains at most 10 files.
|
@@ -108,8 +108,8 @@ module TrieveRubyClient
|
|
108
108
|
data
|
109
109
|
end
|
110
110
|
|
111
|
-
#
|
112
|
-
#
|
111
|
+
# Get Files for Dataset
|
112
|
+
# Get Files for Dataset Get all files which belong to a given dataset specified by the dataset_id parameter. 10 files are returned per page.
|
113
113
|
# @param tr_dataset [String] The dataset id to use for the request
|
114
114
|
# @param dataset_id [String] The id of the dataset to fetch files for.
|
115
115
|
# @param page [Integer] The page number of files you wish to fetch. Each page contains at most 10 files.
|
@@ -157,7 +157,7 @@ module TrieveRubyClient
|
|
157
157
|
return_type = opts[:debug_return_type] || 'Array<File>'
|
158
158
|
|
159
159
|
# auth_names
|
160
|
-
auth_names = opts[:debug_auth_names] || ['
|
160
|
+
auth_names = opts[:debug_auth_names] || ['ApiKey']
|
161
161
|
|
162
162
|
new_options = opts.merge(
|
163
163
|
:operation => :"FileApi.get_dataset_files_handler",
|
@@ -176,8 +176,8 @@ module TrieveRubyClient
|
|
176
176
|
return data, status_code, headers
|
177
177
|
end
|
178
178
|
|
179
|
-
#
|
180
|
-
#
|
179
|
+
# Get File
|
180
|
+
# Get File Download a file from S3 attached to the server based on its id. We plan to add support for getting signed S3 URLs to download from S3 directly in a release soon.
|
181
181
|
# @param tr_dataset [String] The dataset id to use for the request
|
182
182
|
# @param file_id [String] The id of the file to fetch
|
183
183
|
# @param [Hash] opts the optional parameters
|
@@ -187,8 +187,8 @@ module TrieveRubyClient
|
|
187
187
|
data
|
188
188
|
end
|
189
189
|
|
190
|
-
#
|
191
|
-
#
|
190
|
+
# Get File
|
191
|
+
# Get File Download a file from S3 attached to the server based on its id. We plan to add support for getting signed S3 URLs to download from S3 directly in a release soon.
|
192
192
|
# @param tr_dataset [String] The dataset id to use for the request
|
193
193
|
# @param file_id [String] The id of the file to fetch
|
194
194
|
# @param [Hash] opts the optional parameters
|
@@ -227,7 +227,7 @@ module TrieveRubyClient
|
|
227
227
|
return_type = opts[:debug_return_type] || 'FileDTO'
|
228
228
|
|
229
229
|
# auth_names
|
230
|
-
auth_names = opts[:debug_auth_names] || ['
|
230
|
+
auth_names = opts[:debug_auth_names] || ['ApiKey']
|
231
231
|
|
232
232
|
new_options = opts.merge(
|
233
233
|
:operation => :"FileApi.get_file_handler",
|
@@ -246,8 +246,8 @@ module TrieveRubyClient
|
|
246
246
|
return data, status_code, headers
|
247
247
|
end
|
248
248
|
|
249
|
-
#
|
250
|
-
#
|
249
|
+
# Upload File
|
250
|
+
# Upload File Upload a file to S3 attached to the server. The file will be converted to HTML with tika and chunked algorithmically, images will be OCR'ed with tesseract. The resulting chunks will be indexed and searchable. Optionally, you can only upload the file and manually create chunks associated to the file after. See docs.trieve.ai and/or contact us for more details and tips. Auth'ed user must be an admin or owner of the dataset's organization to upload a file.
|
251
251
|
# @param tr_dataset [String] The dataset id to use for the request
|
252
252
|
# @param upload_file_data [UploadFileData] JSON request payload to upload a file
|
253
253
|
# @param [Hash] opts the optional parameters
|
@@ -257,8 +257,8 @@ module TrieveRubyClient
|
|
257
257
|
data
|
258
258
|
end
|
259
259
|
|
260
|
-
#
|
261
|
-
#
|
260
|
+
# Upload File
|
261
|
+
# Upload File Upload a file to S3 attached to the server. The file will be converted to HTML with tika and chunked algorithmically, images will be OCR'ed with tesseract. The resulting chunks will be indexed and searchable. Optionally, you can only upload the file and manually create chunks associated to the file after. See docs.trieve.ai and/or contact us for more details and tips. Auth'ed user must be an admin or owner of the dataset's organization to upload a file.
|
262
262
|
# @param tr_dataset [String] The dataset id to use for the request
|
263
263
|
# @param upload_file_data [UploadFileData] JSON request payload to upload a file
|
264
264
|
# @param [Hash] opts the optional parameters
|
@@ -302,7 +302,7 @@ module TrieveRubyClient
|
|
302
302
|
return_type = opts[:debug_return_type] || 'UploadFileResult'
|
303
303
|
|
304
304
|
# auth_names
|
305
|
-
auth_names = opts[:debug_auth_names] || ['
|
305
|
+
auth_names = opts[:debug_auth_names] || ['ApiKey']
|
306
306
|
|
307
307
|
new_options = opts.merge(
|
308
308
|
:operation => :"FileApi.upload_file_handler",
|
@@ -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
|
+
The version of the OpenAPI document: 0.4.0
|
7
7
|
Contact: developers@trieve.ai
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
Generator version: 7.4.0
|
@@ -19,6 +19,8 @@ module TrieveRubyClient
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
|
+
# Health Check
|
23
|
+
# Health Check Confirmation that the service is healthy and can make embedding vectors
|
22
24
|
# @param [Hash] opts the optional parameters
|
23
25
|
# @return [nil]
|
24
26
|
def health_check(opts = {})
|
@@ -26,6 +28,8 @@ module TrieveRubyClient
|
|
26
28
|
nil
|
27
29
|
end
|
28
30
|
|
31
|
+
# Health Check
|
32
|
+
# Health Check Confirmation that the service is healthy and can make embedding vectors
|
29
33
|
# @param [Hash] opts the optional parameters
|
30
34
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
31
35
|
def health_check_with_http_info(opts = {})
|
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 0.
|
6
|
+
The version of the OpenAPI document: 0.4.0
|
7
7
|
Contact: developers@trieve.ai
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
Generator version: 7.4.0
|
@@ -19,8 +19,8 @@ module TrieveRubyClient
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
|
-
#
|
23
|
-
#
|
22
|
+
# Send Invitation
|
23
|
+
# Send Invitation Invitations act as a way to invite users to join an organization. After a user is invited, they will automatically be added to the organization with the role specified in the invitation once they set their.
|
24
24
|
# @param tr_organization [String] The organization id to use for the request
|
25
25
|
# @param invitation_data [InvitationData] JSON request payload to send an invitation
|
26
26
|
# @param [Hash] opts the optional parameters
|
@@ -30,8 +30,8 @@ module TrieveRubyClient
|
|
30
30
|
nil
|
31
31
|
end
|
32
32
|
|
33
|
-
#
|
34
|
-
#
|
33
|
+
# Send Invitation
|
34
|
+
# Send Invitation Invitations act as a way to invite users to join an organization. After a user is invited, they will automatically be added to the organization with the role specified in the invitation once they set their.
|
35
35
|
# @param tr_organization [String] The organization id to use for the request
|
36
36
|
# @param invitation_data [InvitationData] JSON request payload to send an invitation
|
37
37
|
# @param [Hash] opts the optional parameters
|
@@ -75,7 +75,7 @@ module TrieveRubyClient
|
|
75
75
|
return_type = opts[:debug_return_type]
|
76
76
|
|
77
77
|
# auth_names
|
78
|
-
auth_names = opts[:debug_auth_names] || ['
|
78
|
+
auth_names = opts[:debug_auth_names] || ['ApiKey']
|
79
79
|
|
80
80
|
new_options = opts.merge(
|
81
81
|
:operation => :"InvitationApi.post_invitation",
|
@@ -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
|
+
The version of the OpenAPI document: 0.4.0
|
7
7
|
Contact: developers@trieve.ai
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
Generator version: 7.4.0
|
@@ -19,8 +19,8 @@ module TrieveRubyClient
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
|
-
#
|
23
|
-
#
|
22
|
+
# Create a message
|
23
|
+
# Create a message Create a message. Messages are attached to topics in order to coordinate memory of gen-AI chat sessions. We are considering refactoring this resource of the API soon. Currently, you can only send user messages. If the topic is a RAG topic then the response will include Chunks first on the stream. The structure will look like `[chunks]||mesage`. See docs.trieve.ai for more information.
|
24
24
|
# @param tr_dataset [String] The dataset id to use for the request
|
25
25
|
# @param create_message_data [CreateMessageData] JSON request payload to create a message completion
|
26
26
|
# @param [Hash] opts the optional parameters
|
@@ -30,8 +30,8 @@ module TrieveRubyClient
|
|
30
30
|
data
|
31
31
|
end
|
32
32
|
|
33
|
-
#
|
34
|
-
#
|
33
|
+
# Create a message
|
34
|
+
# Create a message Create a message. Messages are attached to topics in order to coordinate memory of gen-AI chat sessions. We are considering refactoring this resource of the API soon. Currently, you can only send user messages. If the topic is a RAG topic then the response will include Chunks first on the stream. The structure will look like `[chunks]||mesage`. See docs.trieve.ai for more information.
|
35
35
|
# @param tr_dataset [String] The dataset id to use for the request
|
36
36
|
# @param create_message_data [CreateMessageData] JSON request payload to create a message completion
|
37
37
|
# @param [Hash] opts the optional parameters
|
@@ -75,7 +75,7 @@ module TrieveRubyClient
|
|
75
75
|
return_type = opts[:debug_return_type] || 'String'
|
76
76
|
|
77
77
|
# auth_names
|
78
|
-
auth_names = opts[:debug_auth_names] || ['
|
78
|
+
auth_names = opts[:debug_auth_names] || ['ApiKey']
|
79
79
|
|
80
80
|
new_options = opts.merge(
|
81
81
|
:operation => :"MessageApi.create_message_completion_handler",
|
@@ -94,8 +94,8 @@ module TrieveRubyClient
|
|
94
94
|
return data, status_code, headers
|
95
95
|
end
|
96
96
|
|
97
|
-
#
|
98
|
-
#
|
97
|
+
# Edit a message
|
98
|
+
# Edit a message Edit a message which exists within the topic's chat history. This will delete the message and replace it with a new message. The new message will be generated by the AI based on the new content provided in the request body. The response will include Chunks first on the stream if the topic is using RAG. The structure will look like `[chunks]||mesage`. See docs.trieve.ai for more information.
|
99
99
|
# @param tr_dataset [String] The dataset id to use for the request
|
100
100
|
# @param edit_message_data [EditMessageData] JSON request payload to edit a message and get a new stream
|
101
101
|
# @param [Hash] opts the optional parameters
|
@@ -105,8 +105,8 @@ module TrieveRubyClient
|
|
105
105
|
nil
|
106
106
|
end
|
107
107
|
|
108
|
-
#
|
109
|
-
#
|
108
|
+
# Edit a message
|
109
|
+
# Edit a message Edit a message which exists within the topic's chat history. This will delete the message and replace it with a new message. The new message will be generated by the AI based on the new content provided in the request body. The response will include Chunks first on the stream if the topic is using RAG. The structure will look like `[chunks]||mesage`. See docs.trieve.ai for more information.
|
110
110
|
# @param tr_dataset [String] The dataset id to use for the request
|
111
111
|
# @param edit_message_data [EditMessageData] JSON request payload to edit a message and get a new stream
|
112
112
|
# @param [Hash] opts the optional parameters
|
@@ -150,7 +150,7 @@ module TrieveRubyClient
|
|
150
150
|
return_type = opts[:debug_return_type]
|
151
151
|
|
152
152
|
# auth_names
|
153
|
-
auth_names = opts[:debug_auth_names] || ['
|
153
|
+
auth_names = opts[:debug_auth_names] || ['ApiKey']
|
154
154
|
|
155
155
|
new_options = opts.merge(
|
156
156
|
:operation => :"MessageApi.edit_message_handler",
|
@@ -169,8 +169,8 @@ module TrieveRubyClient
|
|
169
169
|
return data, status_code, headers
|
170
170
|
end
|
171
171
|
|
172
|
-
#
|
173
|
-
#
|
172
|
+
# Get all messages for a given topic
|
173
|
+
# Get all messages for a given topic Get all messages for a given topic. If the topic is a RAG topic then the response will include Chunks first on each message. The structure will look like `[chunks]||mesage`. See docs.trieve.ai for more information.
|
174
174
|
# @param tr_dataset [String] The dataset id to use for the request
|
175
175
|
# @param messages_topic_id [String] The ID of the topic to get messages for.
|
176
176
|
# @param [Hash] opts the optional parameters
|
@@ -180,8 +180,8 @@ module TrieveRubyClient
|
|
180
180
|
data
|
181
181
|
end
|
182
182
|
|
183
|
-
#
|
184
|
-
#
|
183
|
+
# Get all messages for a given topic
|
184
|
+
# Get all messages for a given topic Get all messages for a given topic. If the topic is a RAG topic then the response will include Chunks first on each message. The structure will look like `[chunks]||mesage`. See docs.trieve.ai for more information.
|
185
185
|
# @param tr_dataset [String] The dataset id to use for the request
|
186
186
|
# @param messages_topic_id [String] The ID of the topic to get messages for.
|
187
187
|
# @param [Hash] opts the optional parameters
|
@@ -220,7 +220,7 @@ module TrieveRubyClient
|
|
220
220
|
return_type = opts[:debug_return_type] || 'Array<Message>'
|
221
221
|
|
222
222
|
# auth_names
|
223
|
-
auth_names = opts[:debug_auth_names] || ['
|
223
|
+
auth_names = opts[:debug_auth_names] || ['ApiKey']
|
224
224
|
|
225
225
|
new_options = opts.merge(
|
226
226
|
:operation => :"MessageApi.get_all_topic_messages",
|
@@ -239,8 +239,8 @@ module TrieveRubyClient
|
|
239
239
|
return data, status_code, headers
|
240
240
|
end
|
241
241
|
|
242
|
-
#
|
243
|
-
#
|
242
|
+
# Regenerate message
|
243
|
+
# Regenerate message Regenerate the assistant response to the last user message of a topic. This will delete the last message and replace it with a new message. The response will include Chunks first on the stream if the topic is using RAG. The structure will look like `[chunks]||mesage`. See docs.trieve.ai for more information.
|
244
244
|
# @param tr_dataset [String] The dataset id to use for the request
|
245
245
|
# @param regenerate_message_data [RegenerateMessageData] JSON request payload to delete an agent message then regenerate it in a strem
|
246
246
|
# @param [Hash] opts the optional parameters
|
@@ -250,8 +250,8 @@ module TrieveRubyClient
|
|
250
250
|
data
|
251
251
|
end
|
252
252
|
|
253
|
-
#
|
254
|
-
#
|
253
|
+
# Regenerate message
|
254
|
+
# Regenerate message Regenerate the assistant response to the last user message of a topic. This will delete the last message and replace it with a new message. The response will include Chunks first on the stream if the topic is using RAG. The structure will look like `[chunks]||mesage`. See docs.trieve.ai for more information.
|
255
255
|
# @param tr_dataset [String] The dataset id to use for the request
|
256
256
|
# @param regenerate_message_data [RegenerateMessageData] JSON request payload to delete an agent message then regenerate it in a strem
|
257
257
|
# @param [Hash] opts the optional parameters
|
@@ -295,7 +295,7 @@ module TrieveRubyClient
|
|
295
295
|
return_type = opts[:debug_return_type] || 'String'
|
296
296
|
|
297
297
|
# auth_names
|
298
|
-
auth_names = opts[:debug_auth_names] || ['
|
298
|
+
auth_names = opts[:debug_auth_names] || ['ApiKey']
|
299
299
|
|
300
300
|
new_options = opts.merge(
|
301
301
|
:operation => :"MessageApi.regenerate_message_handler",
|