trieve_ruby_client 0.5.7 → 0.6.2
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 +16 -20
- data/docs/AddChunkToGroupData.md +4 -2
- data/docs/AuthApi.md +12 -6
- data/docs/BookmarkData.md +1 -1
- data/docs/ChunkApi.md +8 -8
- data/docs/ChunkGroup.md +4 -0
- data/docs/ChunkGroupApi.md +25 -25
- data/docs/ChunkMetadataWithScore.md +44 -0
- data/docs/CreateChunkGroupData.md +5 -1
- data/docs/DatasetApi.md +6 -6
- data/docs/EventsApi.md +1 -1
- data/docs/FileApi.md +2 -2
- data/docs/GetEventsData.md +1 -1
- data/docs/GroupScoreChunk.md +22 -0
- data/docs/GroupScoreSlimChunks.md +20 -0
- data/docs/RecommendChunksRequest.md +3 -1
- data/docs/RecommendGroupChunksRequest.md +34 -0
- data/docs/ScoreChunkDTO.md +1 -1
- data/docs/SearchChunkData.md +1 -3
- data/docs/SearchOverGroupsData.md +3 -5
- data/docs/SearchOverGroupsResults.md +20 -0
- data/docs/SearchOverGroupsSlimResults.md +20 -0
- data/docs/SearchWithinGroupData.md +1 -3
- data/docs/SearchWithinGroupResults.md +22 -0
- data/docs/SearchWithinGroupSlimResults.md +22 -0
- data/docs/SlimChunkMetadataWithScore.md +38 -0
- data/docs/UpdateChunkGroupData.md +4 -0
- data/docs/UpdateGroupByTrackingIDData.md +4 -0
- data/docs/UserApi.md +2 -2
- data/lib/trieve_ruby_client/api/auth_api.rb +13 -11
- data/lib/trieve_ruby_client/api/chunk_api.rb +7 -7
- data/lib/trieve_ruby_client/api/chunk_group_api.rb +27 -27
- data/lib/trieve_ruby_client/api/dataset_api.rb +10 -10
- data/lib/trieve_ruby_client/api/events_api.rb +3 -3
- data/lib/trieve_ruby_client/api/file_api.rb +5 -5
- data/lib/trieve_ruby_client/api/health_api.rb +1 -1
- data/lib/trieve_ruby_client/api/invitation_api.rb +1 -1
- data/lib/trieve_ruby_client/api/message_api.rb +1 -1
- data/lib/trieve_ruby_client/api/organization_api.rb +1 -1
- data/lib/trieve_ruby_client/api/stripe_api.rb +1 -1
- data/lib/trieve_ruby_client/api/topic_api.rb +1 -1
- data/lib/trieve_ruby_client/api/user_api.rb +3 -3
- 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 +1 -1
- data/lib/trieve_ruby_client/models/add_chunk_to_group_data.rb +17 -12
- data/lib/trieve_ruby_client/models/api_key_dto.rb +1 -1
- data/lib/trieve_ruby_client/models/auth_query.rb +1 -1
- data/lib/trieve_ruby_client/models/batch_queued_chunk_response.rb +1 -1
- data/lib/trieve_ruby_client/models/bookmark_data.rb +2 -2
- 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 +1 -1
- data/lib/trieve_ruby_client/models/chunk_filter.rb +1 -1
- data/lib/trieve_ruby_client/models/chunk_group.rb +22 -2
- 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/chunk_metadata_with_score.rb +387 -0
- data/lib/trieve_ruby_client/models/client_dataset_configuration.rb +1 -1
- data/lib/trieve_ruby_client/models/create_chunk_data.rb +1 -1
- data/lib/trieve_ruby_client/models/create_chunk_group_data.rb +27 -9
- 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_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 +2 -2
- 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.rb +249 -0
- data/lib/trieve_ruby_client/models/group_score_chunk_dto.rb +1 -1
- data/lib/trieve_ruby_client/models/group_score_slim_chunks.rb +239 -0
- data/lib/trieve_ruby_client/models/group_slim_chunks_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/range_condition.rb +1 -1
- data/lib/trieve_ruby_client/models/recommend_chunks_request.rb +17 -6
- data/lib/trieve_ruby_client/models/recommend_chunks_response_types.rb +1 -1
- data/lib/trieve_ruby_client/models/recommend_group_chunk_response_types.rb +1 -1
- data/lib/trieve_ruby_client/models/recommend_group_chunks_request.rb +341 -0
- data/lib/trieve_ruby_client/models/regenerate_message_data.rb +1 -1
- data/lib/trieve_ruby_client/models/return_queued_chunk.rb +1 -1
- data/lib/trieve_ruby_client/models/score_chunk_dto.rb +2 -2
- data/lib/trieve_ruby_client/models/score_slim_chunks.rb +1 -1
- data/lib/trieve_ruby_client/models/search_chunk_data.rb +3 -14
- data/lib/trieve_ruby_client/models/search_chunk_query_response_body.rb +1 -1
- data/lib/trieve_ruby_client/models/search_chunk_response_types.rb +1 -1
- data/lib/trieve_ruby_client/models/search_group_slim_chunks_result.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 +5 -15
- data/lib/trieve_ruby_client/models/search_over_groups_response_body.rb +1 -1
- data/lib/trieve_ruby_client/models/search_over_groups_response_types.rb +1 -1
- data/lib/trieve_ruby_client/models/search_over_groups_results.rb +239 -0
- data/lib/trieve_ruby_client/models/search_over_groups_slim_chunks_response_body.rb +1 -1
- data/lib/trieve_ruby_client/models/search_over_groups_slim_results.rb +239 -0
- data/lib/trieve_ruby_client/models/search_slim_chunk_query_response_body.rb +1 -1
- data/lib/trieve_ruby_client/models/search_within_group_data.rb +3 -14
- data/lib/trieve_ruby_client/models/search_within_group_response_types.rb +1 -1
- data/lib/trieve_ruby_client/models/search_within_group_results.rb +255 -0
- data/lib/trieve_ruby_client/models/search_within_group_slim_results.rb +255 -0
- 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 +1 -1
- data/lib/trieve_ruby_client/models/slim_chunk_metadata.rb +1 -1
- data/lib/trieve_ruby_client/models/slim_chunk_metadata_with_score.rb +345 -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 +26 -2
- 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 +26 -2
- 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 +10 -14
- data/openapi-generator.yaml +1 -1
- data/openapi.json +386 -325
- data/spec/models/chunk_metadata_with_score_spec.rb +114 -0
- data/spec/models/group_score_chunk_spec.rb +48 -0
- data/spec/models/group_score_slim_chunks_spec.rb +42 -0
- data/spec/models/recommend_group_chunks_request_spec.rb +84 -0
- data/spec/models/search_over_groups_results_spec.rb +42 -0
- data/spec/models/search_over_groups_slim_results_spec.rb +42 -0
- data/spec/models/search_within_group_results_spec.rb +48 -0
- data/spec/models/search_within_group_slim_results_spec.rb +48 -0
- data/spec/models/slim_chunk_metadata_with_score_spec.rb +96 -0
- data/spec/spec_helper.rb +1 -1
- data/trieve_ruby_client-0.5.7.gem +0 -0
- data/trieve_ruby_client-0.6.0.gem +0 -0
- data/trieve_ruby_client.gemspec +1 -1
- metadata +40 -2
@@ -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.6.2
|
7
7
|
Contact: developers@trieve.ai
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
Generator version: 7.4.0
|
@@ -257,7 +257,7 @@ module TrieveRubyClient
|
|
257
257
|
end
|
258
258
|
|
259
259
|
# Delete Group
|
260
|
-
# Delete Group This will delete a chunk_group.
|
260
|
+
# Delete Group This will delete a chunk_group. If you set delete_chunks to true, it will also delete the chunks within the group.
|
261
261
|
# @param tr_dataset [String] The dataset id to use for the request
|
262
262
|
# @param group_id [String] Id of the group you want to fetch.
|
263
263
|
# @param delete_chunks [Boolean] Delete the chunks within the group
|
@@ -269,7 +269,7 @@ module TrieveRubyClient
|
|
269
269
|
end
|
270
270
|
|
271
271
|
# Delete Group
|
272
|
-
# Delete Group This will delete a chunk_group.
|
272
|
+
# Delete Group This will delete a chunk_group. If you set delete_chunks to true, it will also delete the chunks within the group.
|
273
273
|
# @param tr_dataset [String] The dataset id to use for the request
|
274
274
|
# @param group_id [String] Id of the group you want to fetch.
|
275
275
|
# @param delete_chunks [Boolean] Delete the chunks within the group
|
@@ -474,7 +474,7 @@ module TrieveRubyClient
|
|
474
474
|
end
|
475
475
|
|
476
476
|
# Get Chunks in Group
|
477
|
-
# Get Chunks in Group Route to get all chunks for a group. The response is paginated, with each page containing 10 chunks.
|
477
|
+
# Get Chunks in Group Route to get all chunks for a group. The response is paginated, with each page containing 10 chunks. Page is 1-indexed.
|
478
478
|
# @param tr_dataset [String] The dataset id to use for the request
|
479
479
|
# @param group_id [String] Id of the group you want to fetch.
|
480
480
|
# @param page [Integer] The page of chunks to get from the group
|
@@ -486,7 +486,7 @@ module TrieveRubyClient
|
|
486
486
|
end
|
487
487
|
|
488
488
|
# Get Chunks in Group
|
489
|
-
# Get Chunks in Group Route to get all chunks for a group. The response is paginated, with each page containing 10 chunks.
|
489
|
+
# Get Chunks in Group Route to get all chunks for a group. The response is paginated, with each page containing 10 chunks. Page is 1-indexed.
|
490
490
|
# @param tr_dataset [String] The dataset id to use for the request
|
491
491
|
# @param group_id [String] Id of the group you want to fetch.
|
492
492
|
# @param page [Integer] The page of chunks to get from the group
|
@@ -550,7 +550,7 @@ module TrieveRubyClient
|
|
550
550
|
end
|
551
551
|
|
552
552
|
# Get Chunks in Group by Tracking ID
|
553
|
-
# Get Chunks in Group by Tracking ID Route to get all chunks for a group. The response is paginated, with each page containing 10 chunks. Support for custom page size is coming soon.
|
553
|
+
# Get Chunks in Group by Tracking ID Route to get all chunks for a group. The response is paginated, with each page containing 10 chunks. Support for custom page size is coming soon. Page is 1-indexed.
|
554
554
|
# @param tr_dataset [String] The dataset id to use for the request
|
555
555
|
# @param group_tracking_id [String] The id of the group to get the chunks from
|
556
556
|
# @param page [Integer] The page of chunks to get from the group
|
@@ -562,7 +562,7 @@ module TrieveRubyClient
|
|
562
562
|
end
|
563
563
|
|
564
564
|
# Get Chunks in Group by Tracking ID
|
565
|
-
# Get Chunks in Group by Tracking ID Route to get all chunks for a group. The response is paginated, with each page containing 10 chunks. Support for custom page size is coming soon.
|
565
|
+
# Get Chunks in Group by Tracking ID Route to get all chunks for a group. The response is paginated, with each page containing 10 chunks. Support for custom page size is coming soon. Page is 1-indexed.
|
566
566
|
# @param tr_dataset [String] The dataset id to use for the request
|
567
567
|
# @param group_tracking_id [String] The id of the group to get the chunks from
|
568
568
|
# @param page [Integer] The page of chunks to get from the group
|
@@ -777,21 +777,21 @@ module TrieveRubyClient
|
|
777
777
|
# Get Recommended Groups
|
778
778
|
# Get Recommended Groups Route to get recommended groups. This route will return groups which are similar to the groups in the request body.
|
779
779
|
# @param tr_dataset [String] The dataset id to use for the request
|
780
|
-
# @param
|
780
|
+
# @param recommend_group_chunks_request [RecommendGroupChunksRequest] JSON request payload to get recommendations of chunks similar to the chunks in the request
|
781
781
|
# @param [Hash] opts the optional parameters
|
782
|
-
# @return [
|
783
|
-
def get_recommended_groups(tr_dataset,
|
784
|
-
data, _status_code, _headers = get_recommended_groups_with_http_info(tr_dataset,
|
782
|
+
# @return [Array<GroupScoreChunk>]
|
783
|
+
def get_recommended_groups(tr_dataset, recommend_group_chunks_request, opts = {})
|
784
|
+
data, _status_code, _headers = get_recommended_groups_with_http_info(tr_dataset, recommend_group_chunks_request, opts)
|
785
785
|
data
|
786
786
|
end
|
787
787
|
|
788
788
|
# Get Recommended Groups
|
789
789
|
# Get Recommended Groups Route to get recommended groups. This route will return groups which are similar to the groups in the request body.
|
790
790
|
# @param tr_dataset [String] The dataset id to use for the request
|
791
|
-
# @param
|
791
|
+
# @param recommend_group_chunks_request [RecommendGroupChunksRequest] JSON request payload to get recommendations of chunks similar to the chunks in the request
|
792
792
|
# @param [Hash] opts the optional parameters
|
793
|
-
# @return [Array<(
|
794
|
-
def get_recommended_groups_with_http_info(tr_dataset,
|
793
|
+
# @return [Array<(Array<GroupScoreChunk>, Integer, Hash)>] Array<GroupScoreChunk> data, response status code and response headers
|
794
|
+
def get_recommended_groups_with_http_info(tr_dataset, recommend_group_chunks_request, opts = {})
|
795
795
|
if @api_client.config.debugging
|
796
796
|
@api_client.config.logger.debug 'Calling API: ChunkGroupApi.get_recommended_groups ...'
|
797
797
|
end
|
@@ -799,9 +799,9 @@ module TrieveRubyClient
|
|
799
799
|
if @api_client.config.client_side_validation && tr_dataset.nil?
|
800
800
|
fail ArgumentError, "Missing the required parameter 'tr_dataset' when calling ChunkGroupApi.get_recommended_groups"
|
801
801
|
end
|
802
|
-
# verify the required parameter '
|
803
|
-
if @api_client.config.client_side_validation &&
|
804
|
-
fail ArgumentError, "Missing the required parameter '
|
802
|
+
# verify the required parameter 'recommend_group_chunks_request' is set
|
803
|
+
if @api_client.config.client_side_validation && recommend_group_chunks_request.nil?
|
804
|
+
fail ArgumentError, "Missing the required parameter 'recommend_group_chunks_request' when calling ChunkGroupApi.get_recommended_groups"
|
805
805
|
end
|
806
806
|
# resource path
|
807
807
|
local_var_path = '/api/chunk_group/recommend'
|
@@ -824,10 +824,10 @@ module TrieveRubyClient
|
|
824
824
|
form_params = opts[:form_params] || {}
|
825
825
|
|
826
826
|
# http body (model)
|
827
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
827
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(recommend_group_chunks_request)
|
828
828
|
|
829
829
|
# return_type
|
830
|
-
return_type = opts[:debug_return_type] || '
|
830
|
+
return_type = opts[:debug_return_type] || 'Array<GroupScoreChunk>'
|
831
831
|
|
832
832
|
# auth_names
|
833
833
|
auth_names = opts[:debug_auth_names] || ['ApiKey']
|
@@ -853,7 +853,7 @@ module TrieveRubyClient
|
|
853
853
|
# Get Groups for Dataset Fetch the groups which belong to a dataset specified by its id.
|
854
854
|
# @param tr_dataset [String] The dataset id to use for the request
|
855
855
|
# @param dataset_id [String] The id of the dataset to fetch groups for.
|
856
|
-
# @param page [Integer] The page of groups to fetch.
|
856
|
+
# @param page [Integer] The page of groups to fetch. Page is 1-indexed.
|
857
857
|
# @param [Hash] opts the optional parameters
|
858
858
|
# @return [GroupData]
|
859
859
|
def get_specific_dataset_chunk_groups(tr_dataset, dataset_id, page, opts = {})
|
@@ -865,7 +865,7 @@ module TrieveRubyClient
|
|
865
865
|
# Get Groups for Dataset Fetch the groups which belong to a dataset specified by its id.
|
866
866
|
# @param tr_dataset [String] The dataset id to use for the request
|
867
867
|
# @param dataset_id [String] The id of the dataset to fetch groups for.
|
868
|
-
# @param page [Integer] The page of groups to fetch.
|
868
|
+
# @param page [Integer] The page of groups to fetch. Page is 1-indexed.
|
869
869
|
# @param [Hash] opts the optional parameters
|
870
870
|
# @return [Array<(GroupData, Integer, Hash)>] GroupData data, response status code and response headers
|
871
871
|
def get_specific_dataset_chunk_groups_with_http_info(tr_dataset, dataset_id, page, opts = {})
|
@@ -1011,7 +1011,7 @@ module TrieveRubyClient
|
|
1011
1011
|
# @param tr_dataset [String] The dataset id to use for the request
|
1012
1012
|
# @param search_over_groups_data [SearchOverGroupsData] JSON request payload to semantically search over groups
|
1013
1013
|
# @param [Hash] opts the optional parameters
|
1014
|
-
# @return [
|
1014
|
+
# @return [SearchOverGroupsResults]
|
1015
1015
|
def search_over_groups(tr_dataset, search_over_groups_data, opts = {})
|
1016
1016
|
data, _status_code, _headers = search_over_groups_with_http_info(tr_dataset, search_over_groups_data, opts)
|
1017
1017
|
data
|
@@ -1022,7 +1022,7 @@ module TrieveRubyClient
|
|
1022
1022
|
# @param tr_dataset [String] The dataset id to use for the request
|
1023
1023
|
# @param search_over_groups_data [SearchOverGroupsData] JSON request payload to semantically search over groups
|
1024
1024
|
# @param [Hash] opts the optional parameters
|
1025
|
-
# @return [Array<(
|
1025
|
+
# @return [Array<(SearchOverGroupsResults, Integer, Hash)>] SearchOverGroupsResults data, response status code and response headers
|
1026
1026
|
def search_over_groups_with_http_info(tr_dataset, search_over_groups_data, opts = {})
|
1027
1027
|
if @api_client.config.debugging
|
1028
1028
|
@api_client.config.logger.debug 'Calling API: ChunkGroupApi.search_over_groups ...'
|
@@ -1059,7 +1059,7 @@ module TrieveRubyClient
|
|
1059
1059
|
post_body = opts[:debug_body] || @api_client.object_to_http_body(search_over_groups_data)
|
1060
1060
|
|
1061
1061
|
# return_type
|
1062
|
-
return_type = opts[:debug_return_type] || '
|
1062
|
+
return_type = opts[:debug_return_type] || 'SearchOverGroupsResults'
|
1063
1063
|
|
1064
1064
|
# auth_names
|
1065
1065
|
auth_names = opts[:debug_auth_names] || ['ApiKey']
|
@@ -1086,7 +1086,7 @@ module TrieveRubyClient
|
|
1086
1086
|
# @param tr_dataset [String] The dataset id to use for the request
|
1087
1087
|
# @param search_within_group_data [SearchWithinGroupData] JSON request payload to semantically search a group
|
1088
1088
|
# @param [Hash] opts the optional parameters
|
1089
|
-
# @return [
|
1089
|
+
# @return [SearchWithinGroupResults]
|
1090
1090
|
def search_within_group(tr_dataset, search_within_group_data, opts = {})
|
1091
1091
|
data, _status_code, _headers = search_within_group_with_http_info(tr_dataset, search_within_group_data, opts)
|
1092
1092
|
data
|
@@ -1097,7 +1097,7 @@ module TrieveRubyClient
|
|
1097
1097
|
# @param tr_dataset [String] The dataset id to use for the request
|
1098
1098
|
# @param search_within_group_data [SearchWithinGroupData] JSON request payload to semantically search a group
|
1099
1099
|
# @param [Hash] opts the optional parameters
|
1100
|
-
# @return [Array<(
|
1100
|
+
# @return [Array<(SearchWithinGroupResults, Integer, Hash)>] SearchWithinGroupResults data, response status code and response headers
|
1101
1101
|
def search_within_group_with_http_info(tr_dataset, search_within_group_data, opts = {})
|
1102
1102
|
if @api_client.config.debugging
|
1103
1103
|
@api_client.config.logger.debug 'Calling API: ChunkGroupApi.search_within_group ...'
|
@@ -1134,7 +1134,7 @@ module TrieveRubyClient
|
|
1134
1134
|
post_body = opts[:debug_body] || @api_client.object_to_http_body(search_within_group_data)
|
1135
1135
|
|
1136
1136
|
# return_type
|
1137
|
-
return_type = opts[:debug_return_type] || '
|
1137
|
+
return_type = opts[:debug_return_type] || 'SearchWithinGroupResults'
|
1138
1138
|
|
1139
1139
|
# auth_names
|
1140
1140
|
auth_names = opts[:debug_auth_names] || ['ApiKey']
|
@@ -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.6.2
|
7
7
|
Contact: developers@trieve.ai
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
Generator version: 7.4.0
|
@@ -96,28 +96,28 @@ module TrieveRubyClient
|
|
96
96
|
|
97
97
|
# Delete Dataset
|
98
98
|
# Delete Dataset Delete a dataset. The auth'ed user must be an owner of the organization to delete a dataset.
|
99
|
-
# @param
|
99
|
+
# @param tr_dataset [String] The dataset id to use for the request
|
100
100
|
# @param dataset_id [String] The id of the dataset you want to delete.
|
101
101
|
# @param [Hash] opts the optional parameters
|
102
102
|
# @return [nil]
|
103
|
-
def delete_dataset(
|
104
|
-
delete_dataset_with_http_info(
|
103
|
+
def delete_dataset(tr_dataset, dataset_id, opts = {})
|
104
|
+
delete_dataset_with_http_info(tr_dataset, dataset_id, opts)
|
105
105
|
nil
|
106
106
|
end
|
107
107
|
|
108
108
|
# Delete Dataset
|
109
109
|
# Delete Dataset Delete a dataset. The auth'ed user must be an owner of the organization to delete a dataset.
|
110
|
-
# @param
|
110
|
+
# @param tr_dataset [String] The dataset id to use for the request
|
111
111
|
# @param dataset_id [String] The id of the dataset you want to delete.
|
112
112
|
# @param [Hash] opts the optional parameters
|
113
113
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
114
|
-
def delete_dataset_with_http_info(
|
114
|
+
def delete_dataset_with_http_info(tr_dataset, dataset_id, opts = {})
|
115
115
|
if @api_client.config.debugging
|
116
116
|
@api_client.config.logger.debug 'Calling API: DatasetApi.delete_dataset ...'
|
117
117
|
end
|
118
|
-
# verify the required parameter '
|
119
|
-
if @api_client.config.client_side_validation &&
|
120
|
-
fail ArgumentError, "Missing the required parameter '
|
118
|
+
# verify the required parameter 'tr_dataset' is set
|
119
|
+
if @api_client.config.client_side_validation && tr_dataset.nil?
|
120
|
+
fail ArgumentError, "Missing the required parameter 'tr_dataset' when calling DatasetApi.delete_dataset"
|
121
121
|
end
|
122
122
|
# verify the required parameter 'dataset_id' is set
|
123
123
|
if @api_client.config.client_side_validation && dataset_id.nil?
|
@@ -133,7 +133,7 @@ module TrieveRubyClient
|
|
133
133
|
header_params = opts[:header_params] || {}
|
134
134
|
# HTTP header 'Accept' (if needed)
|
135
135
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
136
|
-
header_params[:'TR-
|
136
|
+
header_params[:'TR-Dataset'] = tr_dataset
|
137
137
|
|
138
138
|
# form parameters
|
139
139
|
form_params = opts[:form_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
|
+
The version of the OpenAPI document: 0.6.2
|
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
|
# Get events for the dataset
|
23
|
-
# Get events for the dataset Get events for the
|
23
|
+
# Get events for the dataset Get events for the dataset specified by the TR-Dataset header.
|
24
24
|
# @param tr_dataset [String] The dataset id to use for the request
|
25
25
|
# @param get_events_data [GetEventsData] JSON request payload to get events for a dataset
|
26
26
|
# @param [Hash] opts the optional parameters
|
@@ -31,7 +31,7 @@ module TrieveRubyClient
|
|
31
31
|
end
|
32
32
|
|
33
33
|
# Get events for the dataset
|
34
|
-
# Get events for the dataset Get events for the
|
34
|
+
# Get events for the dataset Get events for the dataset specified by the TR-Dataset header.
|
35
35
|
# @param tr_dataset [String] The dataset id to use for the request
|
36
36
|
# @param get_events_data [GetEventsData] JSON request payload to get events for a dataset
|
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.6.2
|
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
|
# 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
|
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
26
|
# @param delete_chunks [Boolean] Whether or not to delete the chunks associated with the file
|
@@ -32,7 +32,7 @@ module TrieveRubyClient
|
|
32
32
|
end
|
33
33
|
|
34
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
|
35
|
+
# 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.
|
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
|
@@ -177,7 +177,7 @@ module TrieveRubyClient
|
|
177
177
|
end
|
178
178
|
|
179
179
|
# Get File
|
180
|
-
# Get File Download a file
|
180
|
+
# Get File Download a file based on its id.
|
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
|
@@ -188,7 +188,7 @@ module TrieveRubyClient
|
|
188
188
|
end
|
189
189
|
|
190
190
|
# Get File
|
191
|
-
# Get File Download a file
|
191
|
+
# Get File Download a file based on its id.
|
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
|
@@ -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.6.2
|
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
|
+
The version of the OpenAPI document: 0.6.2
|
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
|
+
The version of the OpenAPI document: 0.6.2
|
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
|
+
The version of the OpenAPI document: 0.6.2
|
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
|
+
The version of the OpenAPI document: 0.6.2
|
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
|
+
The version of the OpenAPI document: 0.6.2
|
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
|
+
The version of the OpenAPI document: 0.6.2
|
7
7
|
Contact: developers@trieve.ai
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
Generator version: 7.4.0
|
@@ -43,7 +43,7 @@ module TrieveRubyClient
|
|
43
43
|
fail ArgumentError, "Missing the required parameter 'api_key_id' when calling UserApi.delete_user_api_key"
|
44
44
|
end
|
45
45
|
# resource path
|
46
|
-
local_var_path = '/api/user/
|
46
|
+
local_var_path = '/api/user/api_key/{api_key_id}'.sub('{' + 'api_key_id' + '}', CGI.escape(api_key_id.to_s))
|
47
47
|
|
48
48
|
# query parameters
|
49
49
|
query_params = opts[:query_params] || {}
|
@@ -106,7 +106,7 @@ module TrieveRubyClient
|
|
106
106
|
fail ArgumentError, "Missing the required parameter 'set_user_api_key_request' when calling UserApi.set_user_api_key"
|
107
107
|
end
|
108
108
|
# resource path
|
109
|
-
local_var_path = '/api/user/
|
109
|
+
local_var_path = '/api/user/api_key'
|
110
110
|
|
111
111
|
# query parameters
|
112
112
|
query_params = opts[:query_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
|
+
The version of the OpenAPI document: 0.6.2
|
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
|
+
The version of the OpenAPI document: 0.6.2
|
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
|
+
The version of the OpenAPI document: 0.6.2
|
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
|
+
The version of the OpenAPI document: 0.6.2
|
7
7
|
Contact: developers@trieve.ai
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
Generator version: 7.4.0
|
@@ -18,10 +18,14 @@ module TrieveRubyClient
|
|
18
18
|
# Id of the chunk to make a member of the group.
|
19
19
|
attr_accessor :chunk_id
|
20
20
|
|
21
|
+
# Tracking Id of the chunk to make a member of the group.
|
22
|
+
attr_accessor :tracking_id
|
23
|
+
|
21
24
|
# Attribute mapping from ruby-style variable name to JSON key.
|
22
25
|
def self.attribute_map
|
23
26
|
{
|
24
|
-
:'chunk_id' => :'chunk_id'
|
27
|
+
:'chunk_id' => :'chunk_id',
|
28
|
+
:'tracking_id' => :'tracking_id'
|
25
29
|
}
|
26
30
|
end
|
27
31
|
|
@@ -33,13 +37,16 @@ module TrieveRubyClient
|
|
33
37
|
# Attribute type mapping.
|
34
38
|
def self.openapi_types
|
35
39
|
{
|
36
|
-
:'chunk_id' => :'String'
|
40
|
+
:'chunk_id' => :'String',
|
41
|
+
:'tracking_id' => :'String'
|
37
42
|
}
|
38
43
|
end
|
39
44
|
|
40
45
|
# List of attributes with nullable: true
|
41
46
|
def self.openapi_nullable
|
42
47
|
Set.new([
|
48
|
+
:'chunk_id',
|
49
|
+
:'tracking_id'
|
43
50
|
])
|
44
51
|
end
|
45
52
|
|
@@ -60,8 +67,10 @@ module TrieveRubyClient
|
|
60
67
|
|
61
68
|
if attributes.key?(:'chunk_id')
|
62
69
|
self.chunk_id = attributes[:'chunk_id']
|
63
|
-
|
64
|
-
|
70
|
+
end
|
71
|
+
|
72
|
+
if attributes.key?(:'tracking_id')
|
73
|
+
self.tracking_id = attributes[:'tracking_id']
|
65
74
|
end
|
66
75
|
end
|
67
76
|
|
@@ -70,10 +79,6 @@ module TrieveRubyClient
|
|
70
79
|
def list_invalid_properties
|
71
80
|
warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
|
72
81
|
invalid_properties = Array.new
|
73
|
-
if @chunk_id.nil?
|
74
|
-
invalid_properties.push('invalid value for "chunk_id", chunk_id cannot be nil.')
|
75
|
-
end
|
76
|
-
|
77
82
|
invalid_properties
|
78
83
|
end
|
79
84
|
|
@@ -81,7 +86,6 @@ module TrieveRubyClient
|
|
81
86
|
# @return true if the model is valid
|
82
87
|
def valid?
|
83
88
|
warn '[DEPRECATED] the `valid?` method is obsolete'
|
84
|
-
return false if @chunk_id.nil?
|
85
89
|
true
|
86
90
|
end
|
87
91
|
|
@@ -90,7 +94,8 @@ module TrieveRubyClient
|
|
90
94
|
def ==(o)
|
91
95
|
return true if self.equal?(o)
|
92
96
|
self.class == o.class &&
|
93
|
-
chunk_id == o.chunk_id
|
97
|
+
chunk_id == o.chunk_id &&
|
98
|
+
tracking_id == o.tracking_id
|
94
99
|
end
|
95
100
|
|
96
101
|
# @see the `==` method
|
@@ -102,7 +107,7 @@ module TrieveRubyClient
|
|
102
107
|
# Calculates hash code according to all attributes.
|
103
108
|
# @return [Integer] Hash code
|
104
109
|
def hash
|
105
|
-
[chunk_id].hash
|
110
|
+
[chunk_id, tracking_id].hash
|
106
111
|
end
|
107
112
|
|
108
113
|
# Builds the object from hash
|
@@ -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.6.2
|
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
|
+
The version of the OpenAPI document: 0.6.2
|
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
|
+
The version of the OpenAPI document: 0.6.2
|
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
|
+
The version of the OpenAPI document: 0.6.2
|
7
7
|
Contact: developers@trieve.ai
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
Generator version: 7.4.0
|
@@ -38,7 +38,7 @@ module TrieveRubyClient
|
|
38
38
|
# Attribute type mapping.
|
39
39
|
def self.openapi_types
|
40
40
|
{
|
41
|
-
:'chunks' => :'Array<
|
41
|
+
:'chunks' => :'Array<ChunkMetadata>',
|
42
42
|
:'group' => :'ChunkGroup',
|
43
43
|
:'total_pages' => :'Integer'
|
44
44
|
}
|
@@ -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.6.2
|
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
|
+
The version of the OpenAPI document: 0.6.2
|
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
|
+
The version of the OpenAPI document: 0.6.2
|
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
|
+
The version of the OpenAPI document: 0.6.2
|
7
7
|
Contact: developers@trieve.ai
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
Generator version: 7.4.0
|