trieve_ruby_client 0.5.0 → 0.5.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (163) hide show
  1. checksums.yaml +4 -4
  2. data/GENERATE_COMMAND.txt +1 -0
  3. data/README.md +21 -10
  4. data/docs/AuthApi.md +1 -1
  5. data/docs/ChunkApi.md +9 -9
  6. data/docs/ChunkGroupApi.md +25 -16
  7. data/docs/DatasetApi.md +9 -9
  8. data/docs/EventsApi.md +1 -1
  9. data/docs/FileApi.md +1 -1
  10. data/docs/GroupScoreChunkDTO.md +2 -0
  11. data/docs/GroupSlimChunksDTO.md +20 -0
  12. data/docs/HealthApi.md +1 -1
  13. data/docs/InvitationApi.md +1 -1
  14. data/docs/MessageApi.md +1 -1
  15. data/docs/OrganizationApi.md +1 -1
  16. data/docs/Range.md +4 -4
  17. data/docs/RangeCondition.md +49 -0
  18. data/docs/ReccomendGroupChunksRequest.md +3 -1
  19. data/docs/RecommendChunksRequest.md +3 -1
  20. data/docs/RecommendChunksResponseTypes.md +49 -0
  21. data/docs/RecommendGroupChunkResponseTypes.md +49 -0
  22. data/docs/ScoreSlimChunks.md +20 -0
  23. data/docs/SearchChunkData.md +4 -0
  24. data/docs/SearchChunkResponseTypes.md +49 -0
  25. data/docs/SearchGroupSlimChunksResult.md +22 -0
  26. data/docs/SearchOverGroupsData.md +5 -1
  27. data/docs/SearchOverGroupsResponseTypes.md +49 -0
  28. data/docs/SearchOverGroupsSlimChunksResponseBody.md +20 -0
  29. data/docs/SearchSlimChunkQueryResponseBody.md +20 -0
  30. data/docs/SearchWithinGroupData.md +4 -0
  31. data/docs/SearchWithinGroupResponseTypes.md +49 -0
  32. data/docs/SlimChunkMetadata.md +36 -0
  33. data/docs/SlimUser.md +1 -7
  34. data/docs/StripeApi.md +1 -1
  35. data/docs/TopicApi.md +9 -9
  36. data/docs/UpdateChunkData.md +2 -0
  37. data/docs/UpdateUserData.md +1 -7
  38. data/docs/UserApi.md +9 -9
  39. data/lib/trieve_ruby_client/api/auth_api.rb +1 -1
  40. data/lib/trieve_ruby_client/api/chunk_api.rb +7 -7
  41. data/lib/trieve_ruby_client/api/chunk_group_api.rb +21 -14
  42. data/lib/trieve_ruby_client/api/dataset_api.rb +11 -16
  43. data/lib/trieve_ruby_client/api/events_api.rb +1 -1
  44. data/lib/trieve_ruby_client/api/file_api.rb +1 -1
  45. data/lib/trieve_ruby_client/api/health_api.rb +1 -1
  46. data/lib/trieve_ruby_client/api/invitation_api.rb +1 -1
  47. data/lib/trieve_ruby_client/api/message_api.rb +1 -1
  48. data/lib/trieve_ruby_client/api/organization_api.rb +1 -1
  49. data/lib/trieve_ruby_client/api/stripe_api.rb +1 -1
  50. data/lib/trieve_ruby_client/api/topic_api.rb +11 -16
  51. data/lib/trieve_ruby_client/api/user_api.rb +11 -16
  52. data/lib/trieve_ruby_client/api_client.rb +1 -1
  53. data/lib/trieve_ruby_client/api_error.rb +1 -1
  54. data/lib/trieve_ruby_client/configuration.rb +7 -7
  55. data/lib/trieve_ruby_client/models/add_chunk_to_group_data.rb +1 -1
  56. data/lib/trieve_ruby_client/models/api_key_dto.rb +1 -1
  57. data/lib/trieve_ruby_client/models/auth_query.rb +1 -1
  58. data/lib/trieve_ruby_client/models/batch_queued_chunk_response.rb +1 -1
  59. data/lib/trieve_ruby_client/models/bookmark_data.rb +1 -1
  60. data/lib/trieve_ruby_client/models/bookmark_group_result.rb +1 -1
  61. data/lib/trieve_ruby_client/models/chat_message_proxy.rb +1 -1
  62. data/lib/trieve_ruby_client/models/chunk_data.rb +1 -1
  63. data/lib/trieve_ruby_client/models/chunk_filter.rb +1 -1
  64. data/lib/trieve_ruby_client/models/chunk_group.rb +1 -1
  65. data/lib/trieve_ruby_client/models/chunk_group_and_file.rb +1 -1
  66. data/lib/trieve_ruby_client/models/chunk_metadata.rb +1 -1
  67. data/lib/trieve_ruby_client/models/chunk_metadata_with_file_data.rb +1 -1
  68. data/lib/trieve_ruby_client/models/client_dataset_configuration.rb +1 -1
  69. data/lib/trieve_ruby_client/models/create_chunk_data.rb +1 -1
  70. data/lib/trieve_ruby_client/models/create_chunk_group_data.rb +1 -1
  71. data/lib/trieve_ruby_client/models/create_dataset_request.rb +1 -1
  72. data/lib/trieve_ruby_client/models/create_message_data.rb +1 -1
  73. data/lib/trieve_ruby_client/models/create_organization_data.rb +1 -1
  74. data/lib/trieve_ruby_client/models/create_topic_data.rb +1 -1
  75. data/lib/trieve_ruby_client/models/dataset.rb +1 -1
  76. data/lib/trieve_ruby_client/models/dataset_and_usage.rb +1 -1
  77. data/lib/trieve_ruby_client/models/dataset_dto.rb +1 -1
  78. data/lib/trieve_ruby_client/models/dataset_usage_count.rb +1 -1
  79. data/lib/trieve_ruby_client/models/delete_topic_data.rb +1 -1
  80. data/lib/trieve_ruby_client/models/delete_user_api_key_request.rb +1 -1
  81. data/lib/trieve_ruby_client/models/edit_message_data.rb +1 -1
  82. data/lib/trieve_ruby_client/models/error_response_body.rb +1 -1
  83. data/lib/trieve_ruby_client/models/event.rb +1 -1
  84. data/lib/trieve_ruby_client/models/event_return.rb +1 -1
  85. data/lib/trieve_ruby_client/models/field_condition.rb +1 -1
  86. data/lib/trieve_ruby_client/models/file.rb +1 -1
  87. data/lib/trieve_ruby_client/models/file_dto.rb +1 -1
  88. data/lib/trieve_ruby_client/models/generate_chunks_request.rb +1 -1
  89. data/lib/trieve_ruby_client/models/get_events_data.rb +1 -1
  90. data/lib/trieve_ruby_client/models/get_groups_for_chunks_data.rb +1 -1
  91. data/lib/trieve_ruby_client/models/group_data.rb +1 -1
  92. data/lib/trieve_ruby_client/models/group_score_chunk_dto.rb +12 -2
  93. data/lib/trieve_ruby_client/models/group_slim_chunks_dto.rb +239 -0
  94. data/lib/trieve_ruby_client/models/invitation_data.rb +1 -1
  95. data/lib/trieve_ruby_client/models/match_condition.rb +1 -1
  96. data/lib/trieve_ruby_client/models/message.rb +1 -1
  97. data/lib/trieve_ruby_client/models/organization.rb +1 -1
  98. data/lib/trieve_ruby_client/models/organization_usage_count.rb +1 -1
  99. data/lib/trieve_ruby_client/models/range.rb +5 -5
  100. data/lib/trieve_ruby_client/models/range_condition.rb +105 -0
  101. data/lib/trieve_ruby_client/models/reccomend_group_chunks_request.rb +17 -6
  102. data/lib/trieve_ruby_client/models/recommend_chunks_request.rb +17 -6
  103. data/lib/trieve_ruby_client/models/recommend_chunks_response_types.rb +105 -0
  104. data/lib/trieve_ruby_client/models/recommend_group_chunk_response_types.rb +105 -0
  105. data/lib/trieve_ruby_client/models/regenerate_message_data.rb +1 -1
  106. data/lib/trieve_ruby_client/models/return_queued_chunk.rb +1 -1
  107. data/lib/trieve_ruby_client/models/score_chunk_dto.rb +1 -1
  108. data/lib/trieve_ruby_client/models/score_slim_chunks.rb +239 -0
  109. data/lib/trieve_ruby_client/models/search_chunk_data.rb +24 -2
  110. data/lib/trieve_ruby_client/models/search_chunk_query_response_body.rb +1 -1
  111. data/lib/trieve_ruby_client/models/search_chunk_response_types.rb +105 -0
  112. data/lib/trieve_ruby_client/models/search_group_slim_chunks_result.rb +255 -0
  113. data/lib/trieve_ruby_client/models/search_groups_result.rb +1 -1
  114. data/lib/trieve_ruby_client/models/search_over_groups_data.rb +27 -5
  115. data/lib/trieve_ruby_client/models/search_over_groups_response_body.rb +1 -1
  116. data/lib/trieve_ruby_client/models/search_over_groups_response_types.rb +105 -0
  117. data/lib/trieve_ruby_client/models/search_over_groups_slim_chunks_response_body.rb +239 -0
  118. data/lib/trieve_ruby_client/models/search_slim_chunk_query_response_body.rb +239 -0
  119. data/lib/trieve_ruby_client/models/search_within_group_data.rb +24 -2
  120. data/lib/trieve_ruby_client/models/search_within_group_response_types.rb +105 -0
  121. data/lib/trieve_ruby_client/models/set_user_api_key_request.rb +1 -1
  122. data/lib/trieve_ruby_client/models/set_user_api_key_response.rb +1 -1
  123. data/lib/trieve_ruby_client/models/single_queued_chunk_response.rb +1 -1
  124. data/lib/trieve_ruby_client/models/slim_chunk_metadata.rb +329 -0
  125. data/lib/trieve_ruby_client/models/slim_group.rb +1 -1
  126. data/lib/trieve_ruby_client/models/slim_user.rb +5 -41
  127. data/lib/trieve_ruby_client/models/stripe_plan.rb +1 -1
  128. data/lib/trieve_ruby_client/models/suggested_queries_request.rb +1 -1
  129. data/lib/trieve_ruby_client/models/suggested_queries_response.rb +1 -1
  130. data/lib/trieve_ruby_client/models/topic.rb +1 -1
  131. data/lib/trieve_ruby_client/models/update_chunk_by_tracking_id_data.rb +1 -1
  132. data/lib/trieve_ruby_client/models/update_chunk_data.rb +15 -2
  133. data/lib/trieve_ruby_client/models/update_chunk_group_data.rb +1 -1
  134. data/lib/trieve_ruby_client/models/update_dataset_request.rb +1 -1
  135. data/lib/trieve_ruby_client/models/update_group_by_tracking_id_data.rb +1 -1
  136. data/lib/trieve_ruby_client/models/update_organization_data.rb +1 -1
  137. data/lib/trieve_ruby_client/models/update_topic_data.rb +1 -1
  138. data/lib/trieve_ruby_client/models/update_user_data.rb +6 -39
  139. data/lib/trieve_ruby_client/models/upload_file_data.rb +1 -1
  140. data/lib/trieve_ruby_client/models/upload_file_result.rb +1 -1
  141. data/lib/trieve_ruby_client/models/user_organization.rb +1 -1
  142. data/lib/trieve_ruby_client/version.rb +2 -2
  143. data/lib/trieve_ruby_client.rb +13 -2
  144. data/openapi-generator.yaml +1 -1
  145. data/openapi.json +636 -217
  146. data/spec/models/group_slim_chunks_dto_spec.rb +42 -0
  147. data/spec/models/range_condition_spec.rb +32 -0
  148. data/spec/models/recommend_chunks_response_types_spec.rb +32 -0
  149. data/spec/models/recommend_group_chunk_response_types_spec.rb +32 -0
  150. data/spec/models/score_slim_chunks_spec.rb +42 -0
  151. data/spec/models/search_chunk_response_types_spec.rb +32 -0
  152. data/spec/models/search_group_slim_chunks_result_spec.rb +48 -0
  153. data/spec/models/search_over_groups_response_types_spec.rb +32 -0
  154. data/spec/models/search_over_groups_slim_chunks_response_body_spec.rb +42 -0
  155. data/spec/models/search_slim_chunk_query_response_body_spec.rb +42 -0
  156. data/spec/models/search_within_group_response_types_spec.rb +32 -0
  157. data/spec/models/slim_chunk_metadata_spec.rb +90 -0
  158. data/spec/spec_helper.rb +1 -1
  159. data/trieve_ruby_client-0.5.0.gem +0 -0
  160. data/trieve_ruby_client.gemspec +1 -1
  161. metadata +52 -4
  162. data/trieve_ruby_client-0.3.5.gem +0 -0
  163. data/trieve_ruby_client-0.4.0.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.5.0
6
+ The version of the OpenAPI document: 0.5.7
7
7
  Contact: developers@trieve.ai
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.4.0
@@ -529,7 +529,7 @@ module TrieveRubyClient
529
529
  # @param tr_dataset [String] The dataset id to use for the request
530
530
  # @param recommend_chunks_request [RecommendChunksRequest] JSON request payload to get recommendations of chunks similar to the chunks in the request
531
531
  # @param [Hash] opts the optional parameters
532
- # @return [Array<ChunkMetadataWithFileData>]
532
+ # @return [RecommendChunksResponseTypes]
533
533
  def get_recommended_chunks(tr_dataset, recommend_chunks_request, opts = {})
534
534
  data, _status_code, _headers = get_recommended_chunks_with_http_info(tr_dataset, recommend_chunks_request, opts)
535
535
  data
@@ -540,7 +540,7 @@ module TrieveRubyClient
540
540
  # @param tr_dataset [String] The dataset id to use for the request
541
541
  # @param recommend_chunks_request [RecommendChunksRequest] JSON request payload to get recommendations of chunks similar to the chunks in the request
542
542
  # @param [Hash] opts the optional parameters
543
- # @return [Array<(Array<ChunkMetadataWithFileData>, Integer, Hash)>] Array<ChunkMetadataWithFileData> data, response status code and response headers
543
+ # @return [Array<(RecommendChunksResponseTypes, Integer, Hash)>] RecommendChunksResponseTypes data, response status code and response headers
544
544
  def get_recommended_chunks_with_http_info(tr_dataset, recommend_chunks_request, opts = {})
545
545
  if @api_client.config.debugging
546
546
  @api_client.config.logger.debug 'Calling API: ChunkApi.get_recommended_chunks ...'
@@ -577,7 +577,7 @@ module TrieveRubyClient
577
577
  post_body = opts[:debug_body] || @api_client.object_to_http_body(recommend_chunks_request)
578
578
 
579
579
  # return_type
580
- return_type = opts[:debug_return_type] || 'Array<ChunkMetadataWithFileData>'
580
+ return_type = opts[:debug_return_type] || 'RecommendChunksResponseTypes'
581
581
 
582
582
  # auth_names
583
583
  auth_names = opts[:debug_auth_names] || ['ApiKey']
@@ -604,7 +604,7 @@ module TrieveRubyClient
604
604
  # @param tr_dataset [String] The dataset id to use for the request
605
605
  # @param search_chunk_data [SearchChunkData] JSON request payload to semantically search for chunks (chunks)
606
606
  # @param [Hash] opts the optional parameters
607
- # @return [SearchChunkQueryResponseBody]
607
+ # @return [SearchChunkResponseTypes]
608
608
  def search_chunk(tr_dataset, search_chunk_data, opts = {})
609
609
  data, _status_code, _headers = search_chunk_with_http_info(tr_dataset, search_chunk_data, opts)
610
610
  data
@@ -615,7 +615,7 @@ module TrieveRubyClient
615
615
  # @param tr_dataset [String] The dataset id to use for the request
616
616
  # @param search_chunk_data [SearchChunkData] JSON request payload to semantically search for chunks (chunks)
617
617
  # @param [Hash] opts the optional parameters
618
- # @return [Array<(SearchChunkQueryResponseBody, Integer, Hash)>] SearchChunkQueryResponseBody data, response status code and response headers
618
+ # @return [Array<(SearchChunkResponseTypes, Integer, Hash)>] SearchChunkResponseTypes data, response status code and response headers
619
619
  def search_chunk_with_http_info(tr_dataset, search_chunk_data, opts = {})
620
620
  if @api_client.config.debugging
621
621
  @api_client.config.logger.debug 'Calling API: ChunkApi.search_chunk ...'
@@ -652,7 +652,7 @@ module TrieveRubyClient
652
652
  post_body = opts[:debug_body] || @api_client.object_to_http_body(search_chunk_data)
653
653
 
654
654
  # return_type
655
- return_type = opts[:debug_return_type] || 'SearchChunkQueryResponseBody'
655
+ return_type = opts[:debug_return_type] || 'SearchChunkResponseTypes'
656
656
 
657
657
  # auth_names
658
658
  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.5.0
6
+ The version of the OpenAPI document: 0.5.7
7
7
  Contact: developers@trieve.ai
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.4.0
@@ -779,7 +779,7 @@ module TrieveRubyClient
779
779
  # @param tr_dataset [String] The dataset id to use for the request
780
780
  # @param reccomend_group_chunks_request [ReccomendGroupChunksRequest] 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 [Array<GroupScoreChunkDTO>]
782
+ # @return [RecommendGroupChunkResponseTypes]
783
783
  def get_recommended_groups(tr_dataset, reccomend_group_chunks_request, opts = {})
784
784
  data, _status_code, _headers = get_recommended_groups_with_http_info(tr_dataset, reccomend_group_chunks_request, opts)
785
785
  data
@@ -790,7 +790,7 @@ module TrieveRubyClient
790
790
  # @param tr_dataset [String] The dataset id to use for the request
791
791
  # @param reccomend_group_chunks_request [ReccomendGroupChunksRequest] 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<(Array<GroupScoreChunkDTO>, Integer, Hash)>] Array<GroupScoreChunkDTO> data, response status code and response headers
793
+ # @return [Array<(RecommendGroupChunkResponseTypes, Integer, Hash)>] RecommendGroupChunkResponseTypes data, response status code and response headers
794
794
  def get_recommended_groups_with_http_info(tr_dataset, reccomend_group_chunks_request, opts = {})
795
795
  if @api_client.config.debugging
796
796
  @api_client.config.logger.debug 'Calling API: ChunkGroupApi.get_recommended_groups ...'
@@ -827,7 +827,7 @@ module TrieveRubyClient
827
827
  post_body = opts[:debug_body] || @api_client.object_to_http_body(reccomend_group_chunks_request)
828
828
 
829
829
  # return_type
830
- return_type = opts[:debug_return_type] || 'Array<GroupScoreChunkDTO>'
830
+ return_type = opts[:debug_return_type] || 'RecommendGroupChunkResponseTypes'
831
831
 
832
832
  # auth_names
833
833
  auth_names = opts[:debug_auth_names] || ['ApiKey']
@@ -1008,23 +1008,29 @@ module TrieveRubyClient
1008
1008
 
1009
1009
  # Search Over Groups
1010
1010
  # Search Over Groups This route allows you to get groups as results instead of chunks. Each group returned will have the matching chunks sorted by similarity within the group. This is useful for when you want to get groups of chunks which are similar to the search query. If choosing hybrid search, the results will be re-ranked using BAAI/bge-reranker-large. Compatible with semantic, fulltext, or hybrid search modes.
1011
+ # @param tr_dataset [String] The dataset id to use for the request
1011
1012
  # @param search_over_groups_data [SearchOverGroupsData] JSON request payload to semantically search over groups
1012
1013
  # @param [Hash] opts the optional parameters
1013
- # @return [SearchOverGroupsResponseBody]
1014
- def search_over_groups(search_over_groups_data, opts = {})
1015
- data, _status_code, _headers = search_over_groups_with_http_info(search_over_groups_data, opts)
1014
+ # @return [SearchOverGroupsResponseTypes]
1015
+ def search_over_groups(tr_dataset, search_over_groups_data, opts = {})
1016
+ data, _status_code, _headers = search_over_groups_with_http_info(tr_dataset, search_over_groups_data, opts)
1016
1017
  data
1017
1018
  end
1018
1019
 
1019
1020
  # Search Over Groups
1020
1021
  # Search Over Groups This route allows you to get groups as results instead of chunks. Each group returned will have the matching chunks sorted by similarity within the group. This is useful for when you want to get groups of chunks which are similar to the search query. If choosing hybrid search, the results will be re-ranked using BAAI/bge-reranker-large. Compatible with semantic, fulltext, or hybrid search modes.
1022
+ # @param tr_dataset [String] The dataset id to use for the request
1021
1023
  # @param search_over_groups_data [SearchOverGroupsData] JSON request payload to semantically search over groups
1022
1024
  # @param [Hash] opts the optional parameters
1023
- # @return [Array<(SearchOverGroupsResponseBody, Integer, Hash)>] SearchOverGroupsResponseBody data, response status code and response headers
1024
- def search_over_groups_with_http_info(search_over_groups_data, opts = {})
1025
+ # @return [Array<(SearchOverGroupsResponseTypes, Integer, Hash)>] SearchOverGroupsResponseTypes data, response status code and response headers
1026
+ def search_over_groups_with_http_info(tr_dataset, search_over_groups_data, opts = {})
1025
1027
  if @api_client.config.debugging
1026
1028
  @api_client.config.logger.debug 'Calling API: ChunkGroupApi.search_over_groups ...'
1027
1029
  end
1030
+ # verify the required parameter 'tr_dataset' is set
1031
+ if @api_client.config.client_side_validation && tr_dataset.nil?
1032
+ fail ArgumentError, "Missing the required parameter 'tr_dataset' when calling ChunkGroupApi.search_over_groups"
1033
+ end
1028
1034
  # verify the required parameter 'search_over_groups_data' is set
1029
1035
  if @api_client.config.client_side_validation && search_over_groups_data.nil?
1030
1036
  fail ArgumentError, "Missing the required parameter 'search_over_groups_data' when calling ChunkGroupApi.search_over_groups"
@@ -1044,6 +1050,7 @@ module TrieveRubyClient
1044
1050
  if !content_type.nil?
1045
1051
  header_params['Content-Type'] = content_type
1046
1052
  end
1053
+ header_params[:'TR-Dataset'] = tr_dataset
1047
1054
 
1048
1055
  # form parameters
1049
1056
  form_params = opts[:form_params] || {}
@@ -1052,10 +1059,10 @@ module TrieveRubyClient
1052
1059
  post_body = opts[:debug_body] || @api_client.object_to_http_body(search_over_groups_data)
1053
1060
 
1054
1061
  # return_type
1055
- return_type = opts[:debug_return_type] || 'SearchOverGroupsResponseBody'
1062
+ return_type = opts[:debug_return_type] || 'SearchOverGroupsResponseTypes'
1056
1063
 
1057
1064
  # auth_names
1058
- auth_names = opts[:debug_auth_names] || []
1065
+ auth_names = opts[:debug_auth_names] || ['ApiKey']
1059
1066
 
1060
1067
  new_options = opts.merge(
1061
1068
  :operation => :"ChunkGroupApi.search_over_groups",
@@ -1079,7 +1086,7 @@ module TrieveRubyClient
1079
1086
  # @param tr_dataset [String] The dataset id to use for the request
1080
1087
  # @param search_within_group_data [SearchWithinGroupData] JSON request payload to semantically search a group
1081
1088
  # @param [Hash] opts the optional parameters
1082
- # @return [SearchGroupsResult]
1089
+ # @return [SearchWithinGroupResponseTypes]
1083
1090
  def search_within_group(tr_dataset, search_within_group_data, opts = {})
1084
1091
  data, _status_code, _headers = search_within_group_with_http_info(tr_dataset, search_within_group_data, opts)
1085
1092
  data
@@ -1090,7 +1097,7 @@ module TrieveRubyClient
1090
1097
  # @param tr_dataset [String] The dataset id to use for the request
1091
1098
  # @param search_within_group_data [SearchWithinGroupData] JSON request payload to semantically search a group
1092
1099
  # @param [Hash] opts the optional parameters
1093
- # @return [Array<(SearchGroupsResult, Integer, Hash)>] SearchGroupsResult data, response status code and response headers
1100
+ # @return [Array<(SearchWithinGroupResponseTypes, Integer, Hash)>] SearchWithinGroupResponseTypes data, response status code and response headers
1094
1101
  def search_within_group_with_http_info(tr_dataset, search_within_group_data, opts = {})
1095
1102
  if @api_client.config.debugging
1096
1103
  @api_client.config.logger.debug 'Calling API: ChunkGroupApi.search_within_group ...'
@@ -1127,7 +1134,7 @@ module TrieveRubyClient
1127
1134
  post_body = opts[:debug_body] || @api_client.object_to_http_body(search_within_group_data)
1128
1135
 
1129
1136
  # return_type
1130
- return_type = opts[:debug_return_type] || 'SearchGroupsResult'
1137
+ return_type = opts[:debug_return_type] || 'SearchWithinGroupResponseTypes'
1131
1138
 
1132
1139
  # auth_names
1133
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.5.0
6
+ The version of the OpenAPI document: 0.5.7
7
7
  Contact: developers@trieve.ai
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.4.0
@@ -97,21 +97,21 @@ module TrieveRubyClient
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
99
  # @param tr_organization [String] The organization id to use for the request
100
- # @param delete_dataset_request [DeleteDatasetRequest] JSON request payload to delete a dataset
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(tr_organization, delete_dataset_request, opts = {})
104
- delete_dataset_with_http_info(tr_organization, delete_dataset_request, opts)
103
+ def delete_dataset(tr_organization, dataset_id, opts = {})
104
+ delete_dataset_with_http_info(tr_organization, dataset_id, opts)
105
105
  nil
106
106
  end
107
107
 
108
108
  # Delete Dataset
109
109
  # Delete Dataset Delete a dataset. The auth&#39;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
- # @param delete_dataset_request [DeleteDatasetRequest] JSON request payload to delete a dataset
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(tr_organization, delete_dataset_request, opts = {})
114
+ def delete_dataset_with_http_info(tr_organization, 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
@@ -119,12 +119,12 @@ module TrieveRubyClient
119
119
  if @api_client.config.client_side_validation && tr_organization.nil?
120
120
  fail ArgumentError, "Missing the required parameter 'tr_organization' when calling DatasetApi.delete_dataset"
121
121
  end
122
- # verify the required parameter 'delete_dataset_request' is set
123
- if @api_client.config.client_side_validation && delete_dataset_request.nil?
124
- fail ArgumentError, "Missing the required parameter 'delete_dataset_request' when calling DatasetApi.delete_dataset"
122
+ # verify the required parameter 'dataset_id' is set
123
+ if @api_client.config.client_side_validation && dataset_id.nil?
124
+ fail ArgumentError, "Missing the required parameter 'dataset_id' when calling DatasetApi.delete_dataset"
125
125
  end
126
126
  # resource path
127
- local_var_path = '/api/dataset'
127
+ local_var_path = '/api/dataset/{dataset_id}'.sub('{' + 'dataset_id' + '}', CGI.escape(dataset_id.to_s))
128
128
 
129
129
  # query parameters
130
130
  query_params = opts[:query_params] || {}
@@ -133,18 +133,13 @@ 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
- # HTTP header 'Content-Type'
137
- content_type = @api_client.select_header_content_type(['application/json'])
138
- if !content_type.nil?
139
- header_params['Content-Type'] = content_type
140
- end
141
136
  header_params[:'TR-Organization'] = tr_organization
142
137
 
143
138
  # form parameters
144
139
  form_params = opts[:form_params] || {}
145
140
 
146
141
  # http body (model)
147
- post_body = opts[:debug_body] || @api_client.object_to_http_body(delete_dataset_request)
142
+ post_body = opts[:debug_body]
148
143
 
149
144
  # return_type
150
145
  return_type = opts[:debug_return_type]
@@ -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.5.0
6
+ The version of the OpenAPI document: 0.5.7
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.5.0
6
+ The version of the OpenAPI document: 0.5.7
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.5.0
6
+ The version of the OpenAPI document: 0.5.7
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.5.0
6
+ The version of the OpenAPI document: 0.5.7
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.5.0
6
+ The version of the OpenAPI document: 0.5.7
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.5.0
6
+ The version of the OpenAPI document: 0.5.7
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.5.0
6
+ The version of the OpenAPI document: 0.5.7
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.5.0
6
+ The version of the OpenAPI document: 0.5.7
7
7
  Contact: developers@trieve.ai
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.4.0
@@ -97,21 +97,21 @@ module TrieveRubyClient
97
97
  # Delete Topic
98
98
  # Delete Topic Delete an existing chat topic. When a topic is deleted, all associated chat messages are also deleted.
99
99
  # @param tr_dataset [String] The dataset id to use for the request
100
- # @param delete_topic_data [DeleteTopicData] JSON request payload to delete a chat topic
100
+ # @param topic_id [String] The id of the topic you want to delete.
101
101
  # @param [Hash] opts the optional parameters
102
102
  # @return [nil]
103
- def delete_topic(tr_dataset, delete_topic_data, opts = {})
104
- delete_topic_with_http_info(tr_dataset, delete_topic_data, opts)
103
+ def delete_topic(tr_dataset, topic_id, opts = {})
104
+ delete_topic_with_http_info(tr_dataset, topic_id, opts)
105
105
  nil
106
106
  end
107
107
 
108
108
  # Delete Topic
109
109
  # Delete Topic Delete an existing chat topic. When a topic is deleted, all associated chat messages are also deleted.
110
110
  # @param tr_dataset [String] The dataset id to use for the request
111
- # @param delete_topic_data [DeleteTopicData] JSON request payload to delete a chat topic
111
+ # @param topic_id [String] The id of the topic 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_topic_with_http_info(tr_dataset, delete_topic_data, opts = {})
114
+ def delete_topic_with_http_info(tr_dataset, topic_id, opts = {})
115
115
  if @api_client.config.debugging
116
116
  @api_client.config.logger.debug 'Calling API: TopicApi.delete_topic ...'
117
117
  end
@@ -119,12 +119,12 @@ module TrieveRubyClient
119
119
  if @api_client.config.client_side_validation && tr_dataset.nil?
120
120
  fail ArgumentError, "Missing the required parameter 'tr_dataset' when calling TopicApi.delete_topic"
121
121
  end
122
- # verify the required parameter 'delete_topic_data' is set
123
- if @api_client.config.client_side_validation && delete_topic_data.nil?
124
- fail ArgumentError, "Missing the required parameter 'delete_topic_data' when calling TopicApi.delete_topic"
122
+ # verify the required parameter 'topic_id' is set
123
+ if @api_client.config.client_side_validation && topic_id.nil?
124
+ fail ArgumentError, "Missing the required parameter 'topic_id' when calling TopicApi.delete_topic"
125
125
  end
126
126
  # resource path
127
- local_var_path = '/api/topic'
127
+ local_var_path = '/api/topic/{topic_id}'.sub('{' + 'topic_id' + '}', CGI.escape(topic_id.to_s))
128
128
 
129
129
  # query parameters
130
130
  query_params = opts[:query_params] || {}
@@ -133,18 +133,13 @@ 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
- # HTTP header 'Content-Type'
137
- content_type = @api_client.select_header_content_type(['application/json'])
138
- if !content_type.nil?
139
- header_params['Content-Type'] = content_type
140
- end
141
136
  header_params[:'TR-Dataset'] = tr_dataset
142
137
 
143
138
  # form parameters
144
139
  form_params = opts[:form_params] || {}
145
140
 
146
141
  # http body (model)
147
- post_body = opts[:debug_body] || @api_client.object_to_http_body(delete_topic_data)
142
+ post_body = opts[:debug_body]
148
143
 
149
144
  # return_type
150
145
  return_type = opts[:debug_return_type]
@@ -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.5.0
6
+ The version of the OpenAPI document: 0.5.7
7
7
  Contact: developers@trieve.ai
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.4.0
@@ -21,29 +21,29 @@ module TrieveRubyClient
21
21
  end
22
22
  # Delete User Api Key
23
23
  # Delete User Api Key Delete an api key for the auth'ed user.
24
- # @param delete_user_api_key_request [DeleteUserApiKeyRequest] JSON request payload to delete a user api key
24
+ # @param api_key_id [String] The id of the api key to delete
25
25
  # @param [Hash] opts the optional parameters
26
26
  # @return [Array<ApiKeyDTO>]
27
- def delete_user_api_key(delete_user_api_key_request, opts = {})
28
- data, _status_code, _headers = delete_user_api_key_with_http_info(delete_user_api_key_request, opts)
27
+ def delete_user_api_key(api_key_id, opts = {})
28
+ data, _status_code, _headers = delete_user_api_key_with_http_info(api_key_id, opts)
29
29
  data
30
30
  end
31
31
 
32
32
  # Delete User Api Key
33
33
  # Delete User Api Key Delete an api key for the auth&#39;ed user.
34
- # @param delete_user_api_key_request [DeleteUserApiKeyRequest] JSON request payload to delete a user api key
34
+ # @param api_key_id [String] The id of the api key to delete
35
35
  # @param [Hash] opts the optional parameters
36
36
  # @return [Array<(Array<ApiKeyDTO>, Integer, Hash)>] Array<ApiKeyDTO> data, response status code and response headers
37
- def delete_user_api_key_with_http_info(delete_user_api_key_request, opts = {})
37
+ def delete_user_api_key_with_http_info(api_key_id, opts = {})
38
38
  if @api_client.config.debugging
39
39
  @api_client.config.logger.debug 'Calling API: UserApi.delete_user_api_key ...'
40
40
  end
41
- # verify the required parameter 'delete_user_api_key_request' is set
42
- if @api_client.config.client_side_validation && delete_user_api_key_request.nil?
43
- fail ArgumentError, "Missing the required parameter 'delete_user_api_key_request' when calling UserApi.delete_user_api_key"
41
+ # verify the required parameter 'api_key_id' is set
42
+ if @api_client.config.client_side_validation && api_key_id.nil?
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/delete_api_key'
46
+ local_var_path = '/api/user/delete_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] || {}
@@ -52,17 +52,12 @@ module TrieveRubyClient
52
52
  header_params = opts[:header_params] || {}
53
53
  # HTTP header 'Accept' (if needed)
54
54
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
55
- # HTTP header 'Content-Type'
56
- content_type = @api_client.select_header_content_type(['application/json'])
57
- if !content_type.nil?
58
- header_params['Content-Type'] = content_type
59
- end
60
55
 
61
56
  # form parameters
62
57
  form_params = opts[:form_params] || {}
63
58
 
64
59
  # http body (model)
65
- post_body = opts[:debug_body] || @api_client.object_to_http_body(delete_user_api_key_request)
60
+ post_body = opts[:debug_body]
66
61
 
67
62
  # return_type
68
63
  return_type = opts[:debug_return_type] || 'Array<ApiKeyDTO>'
@@ -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.5.0
6
+ The version of the OpenAPI document: 0.5.7
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.5.0
6
+ The version of the OpenAPI document: 0.5.7
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.5.0
6
+ The version of the OpenAPI document: 0.5.7
7
7
  Contact: developers@trieve.ai
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.4.0
@@ -149,8 +149,8 @@ module TrieveRubyClient
149
149
  attr_accessor :force_ending_format
150
150
 
151
151
  def initialize
152
- @scheme = 'http'
153
- @host = 'localhost:8090'
152
+ @scheme = 'https'
153
+ @host = 'api.trieve.ai'
154
154
  @base_path = ''
155
155
  @server_index = nil
156
156
  @server_operation_index = {}
@@ -247,13 +247,13 @@ module TrieveRubyClient
247
247
  # Returns an array of Server setting
248
248
  def server_settings
249
249
  [
250
- {
251
- url: "http://localhost:8090",
252
- description: "Local development server",
253
- },
254
250
  {
255
251
  url: "https://api.trieve.ai",
256
252
  description: "Production server",
253
+ },
254
+ {
255
+ url: "http://localhost:8090",
256
+ description: "Local development server",
257
257
  }
258
258
  ]
259
259
  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.5.0
6
+ The version of the OpenAPI document: 0.5.7
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.5.0
6
+ The version of the OpenAPI document: 0.5.7
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.5.0
6
+ The version of the OpenAPI document: 0.5.7
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.5.0
6
+ The version of the OpenAPI document: 0.5.7
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.5.0
6
+ The version of the OpenAPI document: 0.5.7
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.5.0
6
+ The version of the OpenAPI document: 0.5.7
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.5.0
6
+ The version of the OpenAPI document: 0.5.7
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.5.0
6
+ The version of the OpenAPI document: 0.5.7
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.5.0
6
+ The version of the OpenAPI document: 0.5.7
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.5.0
6
+ The version of the OpenAPI document: 0.5.7
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.5.0
6
+ The version of the OpenAPI document: 0.5.7
7
7
  Contact: developers@trieve.ai
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.4.0