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.
- checksums.yaml +4 -4
- data/README.md +78 -74
- data/docs/AddChunkToGroupData.md +1 -1
- data/docs/AuthApi.md +28 -34
- data/docs/AuthQuery.md +22 -0
- data/docs/BatchQueuedChunkResponse.md +20 -0
- data/docs/ChunkApi.md +69 -147
- data/docs/ChunkData.md +42 -0
- data/docs/ChunkGroupApi.md +168 -90
- data/docs/CreateChunkData.md +41 -34
- data/docs/DatasetApi.md +31 -31
- data/docs/EventsApi.md +13 -13
- data/docs/FileApi.md +21 -21
- data/docs/GetEventsData.md +22 -0
- data/docs/HealthApi.md +6 -4
- data/docs/InvitationApi.md +6 -6
- data/docs/MessageApi.md +21 -21
- data/docs/OrganizationApi.md +31 -31
- data/docs/ReturnQueuedChunk.md +39 -10
- data/docs/SingleQueuedChunkResponse.md +20 -0
- data/docs/StripeApi.md +21 -13
- data/docs/TopicApi.md +21 -21
- data/docs/UserApi.md +16 -16
- data/lib/trieve_ruby_client/api/auth_api.rb +27 -34
- data/lib/trieve_ruby_client/api/chunk_api.rb +64 -143
- data/lib/trieve_ruby_client/api/chunk_group_api.rb +153 -75
- data/lib/trieve_ruby_client/api/dataset_api.rb +25 -25
- data/lib/trieve_ruby_client/api/events_api.rb +21 -16
- data/lib/trieve_ruby_client/api/file_api.rb +17 -17
- data/lib/trieve_ruby_client/api/health_api.rb +5 -1
- data/lib/trieve_ruby_client/api/invitation_api.rb +5 -5
- data/lib/trieve_ruby_client/api/message_api.rb +17 -17
- data/lib/trieve_ruby_client/api/organization_api.rb +25 -25
- data/lib/trieve_ruby_client/api/stripe_api.rb +17 -1
- data/lib/trieve_ruby_client/api/topic_api.rb +17 -17
- data/lib/trieve_ruby_client/api/user_api.rb +13 -13
- 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 -4
- data/lib/trieve_ruby_client/models/add_chunk_to_group_data.rb +2 -2
- data/lib/trieve_ruby_client/models/api_key_dto.rb +1 -1
- data/lib/trieve_ruby_client/models/{stripe_subscription.rb → auth_query.rb} +23 -96
- 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/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 +1 -1
- data/openapi.json +1196 -849
- data/spec/api/auth_api_spec.rb +16 -18
- data/spec/api/chunk_api_spec.rb +30 -43
- data/spec/api/chunk_group_api_spec.rb +54 -33
- data/spec/api/dataset_api_spec.rb +19 -19
- data/spec/api/events_api_spec.rb +10 -10
- data/spec/api/file_api_spec.rb +15 -15
- data/spec/api/health_api_spec.rb +9 -7
- data/spec/api/invitation_api_spec.rb +9 -9
- data/spec/api/message_api_spec.rb +15 -15
- data/spec/api/organization_api_spec.rb +19 -19
- data/spec/api/stripe_api_spec.rb +15 -7
- data/spec/api/topic_api_spec.rb +15 -15
- data/spec/api/user_api_spec.rb +13 -13
- data/spec/models/add_chunk_to_group_data_spec.rb +8 -8
- data/spec/models/api_key_dto_spec.rb +8 -8
- data/spec/models/auth_query_spec.rb +48 -0
- data/spec/models/batch_queued_chunk_response_spec.rb +42 -0
- data/spec/models/bookmark_data_spec.rb +8 -8
- data/spec/models/bookmark_group_result_spec.rb +8 -8
- data/spec/models/chat_message_proxy_spec.rb +8 -8
- data/spec/models/chunk_data_spec.rb +108 -0
- data/spec/models/chunk_filter_spec.rb +8 -8
- data/spec/models/chunk_group_and_file_spec.rb +8 -8
- data/spec/models/chunk_group_spec.rb +8 -8
- data/spec/models/chunk_metadata_spec.rb +8 -8
- data/spec/models/chunk_metadata_with_file_data_spec.rb +8 -8
- data/spec/models/client_dataset_configuration_spec.rb +8 -8
- data/spec/models/create_chunk_data_spec.rb +11 -87
- data/spec/models/create_chunk_group_data_spec.rb +8 -8
- data/spec/models/create_dataset_request_spec.rb +8 -8
- data/spec/models/create_message_data_spec.rb +8 -8
- data/spec/models/create_organization_data_spec.rb +8 -8
- data/spec/models/create_topic_data_spec.rb +8 -8
- data/spec/models/dataset_and_usage_spec.rb +8 -8
- data/spec/models/dataset_dto_spec.rb +8 -8
- data/spec/models/dataset_spec.rb +8 -8
- data/spec/models/dataset_usage_count_spec.rb +8 -8
- data/spec/models/delete_dataset_request_spec.rb +8 -8
- data/spec/models/delete_topic_data_spec.rb +8 -8
- data/spec/models/delete_user_api_key_request_spec.rb +8 -8
- data/spec/models/edit_message_data_spec.rb +8 -8
- data/spec/models/error_response_body_spec.rb +8 -8
- data/spec/models/event_return_spec.rb +8 -8
- data/spec/models/event_spec.rb +8 -8
- data/spec/models/field_condition_spec.rb +8 -8
- data/spec/models/file_dto_spec.rb +8 -8
- data/spec/models/file_spec.rb +8 -8
- data/spec/models/generate_chunks_request_spec.rb +8 -8
- data/spec/models/get_events_data_spec.rb +48 -0
- data/spec/models/get_groups_for_chunks_data_spec.rb +8 -8
- data/spec/models/group_data_spec.rb +8 -8
- data/spec/models/group_score_chunk_dto_spec.rb +8 -8
- data/spec/models/invitation_data_spec.rb +8 -8
- data/spec/models/match_condition_spec.rb +6 -6
- data/spec/models/message_spec.rb +8 -8
- data/spec/models/organization_spec.rb +8 -8
- data/spec/models/organization_usage_count_spec.rb +8 -8
- data/spec/models/range_spec.rb +8 -8
- data/spec/models/reccomend_group_chunks_request_spec.rb +8 -8
- data/spec/models/recommend_chunks_request_spec.rb +8 -8
- data/spec/models/regenerate_message_data_spec.rb +8 -8
- data/spec/models/return_queued_chunk_spec.rb +11 -21
- data/spec/models/score_chunk_dto_spec.rb +8 -8
- data/spec/models/search_chunk_data_spec.rb +8 -8
- data/spec/models/search_chunk_query_response_body_spec.rb +8 -8
- data/spec/models/search_groups_result_spec.rb +8 -8
- data/spec/models/search_over_groups_data_spec.rb +8 -8
- data/spec/models/search_over_groups_response_body_spec.rb +8 -8
- data/spec/models/search_within_group_data_spec.rb +8 -8
- data/spec/models/set_user_api_key_request_spec.rb +8 -8
- data/spec/models/set_user_api_key_response_spec.rb +8 -8
- data/spec/models/single_queued_chunk_response_spec.rb +42 -0
- data/spec/models/slim_group_spec.rb +8 -8
- data/spec/models/slim_user_spec.rb +8 -8
- data/spec/models/stripe_plan_spec.rb +8 -8
- data/spec/models/suggested_queries_request_spec.rb +8 -8
- data/spec/models/suggested_queries_response_spec.rb +8 -8
- data/spec/models/topic_spec.rb +8 -8
- data/spec/models/update_chunk_by_tracking_id_data_spec.rb +20 -8
- data/spec/models/update_chunk_data_spec.rb +20 -8
- data/spec/models/update_chunk_group_data_spec.rb +14 -8
- data/spec/models/update_dataset_request_spec.rb +8 -8
- data/spec/models/update_group_by_tracking_id_data_spec.rb +8 -8
- data/spec/models/update_organization_data_spec.rb +8 -8
- data/spec/models/update_topic_data_spec.rb +8 -8
- data/spec/models/update_user_data_spec.rb +8 -8
- data/spec/models/upload_file_data_spec.rb +8 -8
- data/spec/models/upload_file_result_spec.rb +8 -8
- data/spec/models/user_organization_spec.rb +8 -8
- data/spec/spec_helper.rb +1 -1
- data/trieve_ruby_client-0.3.5.gem +0 -0
- data/trieve_ruby_client-0.4.0.gem +0 -0
- data/trieve_ruby_client.gemspec +1 -1
- metadata +24 -8
- data/docs/StripeSubscription.md +0 -30
- data/spec/models/stripe_subscription_spec.rb +0 -72
- data/trieve_ruby_client-0.3.4.gem +0 -0
- data/trieve_ruby_client-0.3.41.gem +0 -0
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 0.
|
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,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,13 +58,18 @@ module TrieveRubyClient
|
|
58
58
|
header_params = opts[:header_params] || {}
|
59
59
|
# HTTP header 'Accept' (if needed)
|
60
60
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
61
|
+
# HTTP header 'Content-Type'
|
62
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
63
|
+
if !content_type.nil?
|
64
|
+
header_params['Content-Type'] = content_type
|
65
|
+
end
|
61
66
|
header_params[:'TR-Dataset'] = tr_dataset
|
62
67
|
|
63
68
|
# form parameters
|
64
69
|
form_params = opts[:form_params] || {}
|
65
70
|
|
66
71
|
# http body (model)
|
67
|
-
post_body = opts[:debug_body]
|
72
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(get_events_data)
|
68
73
|
|
69
74
|
# return_type
|
70
75
|
return_type = opts[:debug_return_type] || 'EventReturn'
|
@@ -82,7 +87,7 @@ module TrieveRubyClient
|
|
82
87
|
:return_type => return_type
|
83
88
|
)
|
84
89
|
|
85
|
-
data, status_code, headers = @api_client.call_api(:
|
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.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
|
-
#
|
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
|
@@ -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.
|
@@ -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
|
@@ -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
|
@@ -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.5.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.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
|
-
#
|
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
|
@@ -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.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
|
-
#
|
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
|
@@ -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
|
@@ -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
|
@@ -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
|
@@ -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.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
|
-
#
|
23
|
-
#
|
22
|
+
# Create Organization
|
23
|
+
# Create Organization Create a new organization. The auth'ed user who creates the organization will be the default owner of the organization.
|
24
24
|
# @param create_organization_data [CreateOrganizationData] The organization data that you want to create
|
25
25
|
# @param [Hash] opts the optional parameters
|
26
26
|
# @return [Organization]
|
@@ -29,8 +29,8 @@ module TrieveRubyClient
|
|
29
29
|
data
|
30
30
|
end
|
31
31
|
|
32
|
-
#
|
33
|
-
#
|
32
|
+
# Create Organization
|
33
|
+
# Create Organization Create a new organization. The auth'ed user who creates the organization will be the default owner of the organization.
|
34
34
|
# @param create_organization_data [CreateOrganizationData] The organization data that you want to create
|
35
35
|
# @param [Hash] opts the optional parameters
|
36
36
|
# @return [Array<(Organization, Integer, Hash)>] Organization data, response status code and response headers
|
@@ -87,8 +87,8 @@ module TrieveRubyClient
|
|
87
87
|
return data, status_code, headers
|
88
88
|
end
|
89
89
|
|
90
|
-
#
|
91
|
-
#
|
90
|
+
# Delete Organization
|
91
|
+
# Delete Organization Delete an organization by its id. The auth'ed user must be an owner of the organization to delete it.
|
92
92
|
# @param tr_organization [String] The organization id to use for the request
|
93
93
|
# @param organization_id [String] The id of the organization you want to fetch.
|
94
94
|
# @param [Hash] opts the optional parameters
|
@@ -98,8 +98,8 @@ module TrieveRubyClient
|
|
98
98
|
data
|
99
99
|
end
|
100
100
|
|
101
|
-
#
|
102
|
-
#
|
101
|
+
# Delete Organization
|
102
|
+
# Delete Organization Delete an organization by its id. The auth'ed user must be an owner of the organization to delete it.
|
103
103
|
# @param tr_organization [String] The organization id to use for the request
|
104
104
|
# @param organization_id [String] The id of the organization you want to fetch.
|
105
105
|
# @param [Hash] opts the optional parameters
|
@@ -157,8 +157,8 @@ module TrieveRubyClient
|
|
157
157
|
return data, status_code, headers
|
158
158
|
end
|
159
159
|
|
160
|
-
#
|
161
|
-
#
|
160
|
+
# Get Organization
|
161
|
+
# Get Organization Fetch the details of an organization by its id. The auth'ed user must be an admin or owner of the organization to fetch it.
|
162
162
|
# @param tr_organization [String] The organization id to use for the request
|
163
163
|
# @param organization_id [String] The id of the organization you want to fetch.
|
164
164
|
# @param [Hash] opts the optional parameters
|
@@ -168,8 +168,8 @@ module TrieveRubyClient
|
|
168
168
|
data
|
169
169
|
end
|
170
170
|
|
171
|
-
#
|
172
|
-
#
|
171
|
+
# Get Organization
|
172
|
+
# Get Organization Fetch the details of an organization by its id. The auth'ed user must be an admin or owner of the organization to fetch it.
|
173
173
|
# @param tr_organization [String] The organization id to use for the request
|
174
174
|
# @param organization_id [String] The id of the organization you want to fetch.
|
175
175
|
# @param [Hash] opts the optional parameters
|
@@ -227,8 +227,8 @@ module TrieveRubyClient
|
|
227
227
|
return data, status_code, headers
|
228
228
|
end
|
229
229
|
|
230
|
-
#
|
231
|
-
#
|
230
|
+
# Get Organization Usage
|
231
|
+
# Get Organization Usage Fetch the current usage specification of an organization by its id. The auth'ed user must be an admin or owner of the organization to fetch it.
|
232
232
|
# @param tr_organization [String] The organization id to use for the request
|
233
233
|
# @param organization_id [String] The id of the organization you want to fetch the usage of.
|
234
234
|
# @param [Hash] opts the optional parameters
|
@@ -238,8 +238,8 @@ module TrieveRubyClient
|
|
238
238
|
data
|
239
239
|
end
|
240
240
|
|
241
|
-
#
|
242
|
-
#
|
241
|
+
# Get Organization Usage
|
242
|
+
# Get Organization Usage Fetch the current usage specification of an organization by its id. The auth'ed user must be an admin or owner of the organization to fetch it.
|
243
243
|
# @param tr_organization [String] The organization id to use for the request
|
244
244
|
# @param organization_id [String] The id of the organization you want to fetch the usage of.
|
245
245
|
# @param [Hash] opts the optional parameters
|
@@ -297,8 +297,8 @@ module TrieveRubyClient
|
|
297
297
|
return data, status_code, headers
|
298
298
|
end
|
299
299
|
|
300
|
-
#
|
301
|
-
#
|
300
|
+
# Get Organization Users
|
301
|
+
# Get Organization Users Fetch the users of an organization by its id. The auth'ed user must be an admin or owner of the organization to fetch it.
|
302
302
|
# @param tr_organization [String] The organization id to use for the request
|
303
303
|
# @param organization_id [String] The id of the organization you want to fetch the users of.
|
304
304
|
# @param [Hash] opts the optional parameters
|
@@ -308,8 +308,8 @@ module TrieveRubyClient
|
|
308
308
|
data
|
309
309
|
end
|
310
310
|
|
311
|
-
#
|
312
|
-
#
|
311
|
+
# Get Organization Users
|
312
|
+
# Get Organization Users Fetch the users of an organization by its id. The auth'ed user must be an admin or owner of the organization to fetch it.
|
313
313
|
# @param tr_organization [String] The organization id to use for the request
|
314
314
|
# @param organization_id [String] The id of the organization you want to fetch the users of.
|
315
315
|
# @param [Hash] opts the optional parameters
|
@@ -367,8 +367,8 @@ module TrieveRubyClient
|
|
367
367
|
return data, status_code, headers
|
368
368
|
end
|
369
369
|
|
370
|
-
#
|
371
|
-
#
|
370
|
+
# Update Organization
|
371
|
+
# Update Organization Update an organization. Only the owner of the organization can update it.
|
372
372
|
# @param tr_organization [String] The organization id to use for the request
|
373
373
|
# @param update_organization_data [UpdateOrganizationData] The organization data that you want to update
|
374
374
|
# @param [Hash] opts the optional parameters
|
@@ -378,8 +378,8 @@ module TrieveRubyClient
|
|
378
378
|
data
|
379
379
|
end
|
380
380
|
|
381
|
-
#
|
382
|
-
#
|
381
|
+
# Update Organization
|
382
|
+
# Update Organization Update an organization. Only the owner of the organization can update it.
|
383
383
|
# @param tr_organization [String] The organization id to use for the request
|
384
384
|
# @param update_organization_data [UpdateOrganizationData] The organization data that you want to update
|
385
385
|
# @param [Hash] opts the optional parameters
|
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 0.
|
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,6 +19,8 @@ module TrieveRubyClient
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
|
+
# Cancel Subscription
|
23
|
+
# Cancel Subscription Cancel a subscription by its id
|
22
24
|
# @param tr_organization [String] The organization id to use for the request
|
23
25
|
# @param subscription_id [String] id of the subscription you want to cancel
|
24
26
|
# @param [Hash] opts the optional parameters
|
@@ -28,6 +30,8 @@ module TrieveRubyClient
|
|
28
30
|
nil
|
29
31
|
end
|
30
32
|
|
33
|
+
# Cancel Subscription
|
34
|
+
# Cancel Subscription Cancel a subscription by its id
|
31
35
|
# @param tr_organization [String] The organization id to use for the request
|
32
36
|
# @param subscription_id [String] id of the subscription you want to cancel
|
33
37
|
# @param [Hash] opts the optional parameters
|
@@ -85,6 +89,8 @@ module TrieveRubyClient
|
|
85
89
|
return data, status_code, headers
|
86
90
|
end
|
87
91
|
|
92
|
+
# Checkout
|
93
|
+
# Checkout Get a direct link to the stripe checkout page for the plan and organization
|
88
94
|
# @param plan_id [String] id of the plan you want to subscribe to
|
89
95
|
# @param organization_id [String] id of the organization you want to subscribe to the plan
|
90
96
|
# @param [Hash] opts the optional parameters
|
@@ -94,6 +100,8 @@ module TrieveRubyClient
|
|
94
100
|
nil
|
95
101
|
end
|
96
102
|
|
103
|
+
# Checkout
|
104
|
+
# Checkout Get a direct link to the stripe checkout page for the plan and organization
|
97
105
|
# @param plan_id [String] id of the plan you want to subscribe to
|
98
106
|
# @param organization_id [String] id of the organization you want to subscribe to the plan
|
99
107
|
# @param [Hash] opts the optional parameters
|
@@ -150,6 +158,8 @@ module TrieveRubyClient
|
|
150
158
|
return data, status_code, headers
|
151
159
|
end
|
152
160
|
|
161
|
+
# Get All Plans
|
162
|
+
# Get All Plans Get a list of all plans
|
153
163
|
# @param [Hash] opts the optional parameters
|
154
164
|
# @return [Array<StripePlan>]
|
155
165
|
def get_all_plans(opts = {})
|
@@ -157,6 +167,8 @@ module TrieveRubyClient
|
|
157
167
|
data
|
158
168
|
end
|
159
169
|
|
170
|
+
# Get All Plans
|
171
|
+
# Get All Plans Get a list of all plans
|
160
172
|
# @param [Hash] opts the optional parameters
|
161
173
|
# @return [Array<(Array<StripePlan>, Integer, Hash)>] Array<StripePlan> data, response status code and response headers
|
162
174
|
def get_all_plans_with_http_info(opts = {})
|
@@ -203,6 +215,8 @@ module TrieveRubyClient
|
|
203
215
|
return data, status_code, headers
|
204
216
|
end
|
205
217
|
|
218
|
+
# Update Subscription Plan
|
219
|
+
# Update Subscription Plan Update a subscription to a new plan
|
206
220
|
# @param tr_organization [String] The organization id to use for the request
|
207
221
|
# @param subscription_id [String] id of the subscription you want to update
|
208
222
|
# @param plan_id [String] id of the plan you want to subscribe to
|
@@ -213,6 +227,8 @@ module TrieveRubyClient
|
|
213
227
|
nil
|
214
228
|
end
|
215
229
|
|
230
|
+
# Update Subscription Plan
|
231
|
+
# Update Subscription Plan Update a subscription to a new plan
|
216
232
|
# @param tr_organization [String] The organization id to use for the request
|
217
233
|
# @param subscription_id [String] id of the subscription you want to update
|
218
234
|
# @param plan_id [String] id of the plan you want to subscribe to
|