trieve_ruby_client 0.6.0 → 0.6.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 (138) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +15 -19
  3. data/docs/BookmarkData.md +1 -1
  4. data/docs/ChunkApi.md +9 -9
  5. data/docs/ChunkData.md +2 -0
  6. data/docs/ChunkGroupApi.md +14 -14
  7. data/docs/ChunkMetadataWithScore.md +44 -0
  8. data/docs/CreateChunkGroupData.md +1 -1
  9. data/docs/FileApi.md +1 -1
  10. data/docs/GetEventsData.md +1 -1
  11. data/docs/GroupScoreChunk.md +24 -0
  12. data/docs/GroupScoreSlimChunks.md +20 -0
  13. data/docs/ScoreChunkDTO.md +1 -1
  14. data/docs/SearchOverGroupsResults.md +20 -0
  15. data/docs/SearchOverGroupsSlimResults.md +20 -0
  16. data/docs/SearchWithinGroupResults.md +22 -0
  17. data/docs/SearchWithinGroupSlimResults.md +22 -0
  18. data/docs/SlimChunkMetadataWithScore.md +38 -0
  19. data/docs/UpdateChunkByTrackingIdData.md +2 -0
  20. data/docs/UpdateChunkData.md +2 -0
  21. data/docs/UploadFileData.md +2 -2
  22. data/docs/UserApi.md +2 -2
  23. data/lib/trieve_ruby_client/api/auth_api.rb +1 -1
  24. data/lib/trieve_ruby_client/api/chunk_api.rb +9 -9
  25. data/lib/trieve_ruby_client/api/chunk_group_api.rb +10 -10
  26. data/lib/trieve_ruby_client/api/dataset_api.rb +1 -1
  27. data/lib/trieve_ruby_client/api/events_api.rb +1 -1
  28. data/lib/trieve_ruby_client/api/file_api.rb +1 -1
  29. data/lib/trieve_ruby_client/api/health_api.rb +1 -1
  30. data/lib/trieve_ruby_client/api/invitation_api.rb +1 -1
  31. data/lib/trieve_ruby_client/api/message_api.rb +1 -1
  32. data/lib/trieve_ruby_client/api/organization_api.rb +1 -1
  33. data/lib/trieve_ruby_client/api/stripe_api.rb +1 -1
  34. data/lib/trieve_ruby_client/api/topic_api.rb +1 -1
  35. data/lib/trieve_ruby_client/api/user_api.rb +3 -3
  36. data/lib/trieve_ruby_client/api_client.rb +1 -1
  37. data/lib/trieve_ruby_client/api_error.rb +1 -1
  38. data/lib/trieve_ruby_client/configuration.rb +1 -1
  39. data/lib/trieve_ruby_client/models/add_chunk_to_group_data.rb +1 -1
  40. data/lib/trieve_ruby_client/models/api_key_dto.rb +1 -1
  41. data/lib/trieve_ruby_client/models/auth_query.rb +1 -1
  42. data/lib/trieve_ruby_client/models/batch_queued_chunk_response.rb +1 -1
  43. data/lib/trieve_ruby_client/models/bookmark_data.rb +2 -2
  44. data/lib/trieve_ruby_client/models/bookmark_group_result.rb +1 -1
  45. data/lib/trieve_ruby_client/models/chat_message_proxy.rb +1 -1
  46. data/lib/trieve_ruby_client/models/chunk_data.rb +13 -2
  47. data/lib/trieve_ruby_client/models/chunk_filter.rb +1 -1
  48. data/lib/trieve_ruby_client/models/chunk_group.rb +1 -1
  49. data/lib/trieve_ruby_client/models/chunk_group_and_file.rb +1 -1
  50. data/lib/trieve_ruby_client/models/chunk_metadata.rb +1 -1
  51. data/lib/trieve_ruby_client/models/chunk_metadata_with_score.rb +387 -0
  52. data/lib/trieve_ruby_client/models/client_dataset_configuration.rb +1 -1
  53. data/lib/trieve_ruby_client/models/create_chunk_data.rb +1 -1
  54. data/lib/trieve_ruby_client/models/create_chunk_group_data.rb +2 -8
  55. data/lib/trieve_ruby_client/models/create_dataset_request.rb +1 -1
  56. data/lib/trieve_ruby_client/models/create_message_data.rb +1 -1
  57. data/lib/trieve_ruby_client/models/create_organization_data.rb +1 -1
  58. data/lib/trieve_ruby_client/models/create_topic_data.rb +1 -1
  59. data/lib/trieve_ruby_client/models/dataset.rb +1 -1
  60. data/lib/trieve_ruby_client/models/dataset_and_usage.rb +1 -1
  61. data/lib/trieve_ruby_client/models/dataset_dto.rb +1 -1
  62. data/lib/trieve_ruby_client/models/dataset_usage_count.rb +1 -1
  63. data/lib/trieve_ruby_client/models/delete_topic_data.rb +1 -1
  64. data/lib/trieve_ruby_client/models/delete_user_api_key_request.rb +1 -1
  65. data/lib/trieve_ruby_client/models/edit_message_data.rb +1 -1
  66. data/lib/trieve_ruby_client/models/error_response_body.rb +1 -1
  67. data/lib/trieve_ruby_client/models/event.rb +1 -1
  68. data/lib/trieve_ruby_client/models/event_return.rb +1 -1
  69. data/lib/trieve_ruby_client/models/field_condition.rb +1 -1
  70. data/lib/trieve_ruby_client/models/file.rb +1 -1
  71. data/lib/trieve_ruby_client/models/file_dto.rb +1 -1
  72. data/lib/trieve_ruby_client/models/generate_chunks_request.rb +1 -1
  73. data/lib/trieve_ruby_client/models/get_events_data.rb +2 -2
  74. data/lib/trieve_ruby_client/models/get_groups_for_chunks_data.rb +1 -1
  75. data/lib/trieve_ruby_client/models/group_data.rb +1 -1
  76. data/lib/trieve_ruby_client/models/group_score_chunk.rb +259 -0
  77. data/lib/trieve_ruby_client/models/group_score_slim_chunks.rb +239 -0
  78. data/lib/trieve_ruby_client/models/invitation_data.rb +1 -1
  79. data/lib/trieve_ruby_client/models/match_condition.rb +1 -1
  80. data/lib/trieve_ruby_client/models/message.rb +1 -1
  81. data/lib/trieve_ruby_client/models/organization.rb +1 -1
  82. data/lib/trieve_ruby_client/models/organization_usage_count.rb +1 -1
  83. data/lib/trieve_ruby_client/models/range.rb +1 -1
  84. data/lib/trieve_ruby_client/models/range_condition.rb +1 -1
  85. data/lib/trieve_ruby_client/models/recommend_chunks_request.rb +1 -1
  86. data/lib/trieve_ruby_client/models/recommend_group_chunks_request.rb +1 -1
  87. data/lib/trieve_ruby_client/models/regenerate_message_data.rb +1 -1
  88. data/lib/trieve_ruby_client/models/return_queued_chunk.rb +1 -1
  89. data/lib/trieve_ruby_client/models/score_chunk_dto.rb +2 -2
  90. data/lib/trieve_ruby_client/models/score_slim_chunks.rb +1 -1
  91. data/lib/trieve_ruby_client/models/search_chunk_data.rb +1 -1
  92. data/lib/trieve_ruby_client/models/search_chunk_query_response_body.rb +1 -1
  93. data/lib/trieve_ruby_client/models/search_over_groups_data.rb +1 -1
  94. data/lib/trieve_ruby_client/models/search_over_groups_results.rb +239 -0
  95. data/lib/trieve_ruby_client/models/search_over_groups_slim_results.rb +239 -0
  96. data/lib/trieve_ruby_client/models/search_slim_chunk_query_response_body.rb +1 -1
  97. data/lib/trieve_ruby_client/models/search_within_group_data.rb +1 -1
  98. data/lib/trieve_ruby_client/models/search_within_group_results.rb +255 -0
  99. data/lib/trieve_ruby_client/models/search_within_group_slim_results.rb +255 -0
  100. data/lib/trieve_ruby_client/models/set_user_api_key_request.rb +1 -1
  101. data/lib/trieve_ruby_client/models/set_user_api_key_response.rb +1 -1
  102. data/lib/trieve_ruby_client/models/single_queued_chunk_response.rb +1 -1
  103. data/lib/trieve_ruby_client/models/slim_chunk_metadata.rb +1 -1
  104. data/lib/trieve_ruby_client/models/slim_chunk_metadata_with_score.rb +345 -0
  105. data/lib/trieve_ruby_client/models/slim_group.rb +1 -1
  106. data/lib/trieve_ruby_client/models/slim_user.rb +1 -1
  107. data/lib/trieve_ruby_client/models/stripe_plan.rb +1 -1
  108. data/lib/trieve_ruby_client/models/suggested_queries_request.rb +1 -1
  109. data/lib/trieve_ruby_client/models/suggested_queries_response.rb +1 -1
  110. data/lib/trieve_ruby_client/models/topic.rb +1 -1
  111. data/lib/trieve_ruby_client/models/update_chunk_by_tracking_id_data.rb +13 -2
  112. data/lib/trieve_ruby_client/models/update_chunk_data.rb +13 -2
  113. data/lib/trieve_ruby_client/models/update_chunk_group_data.rb +1 -1
  114. data/lib/trieve_ruby_client/models/update_dataset_request.rb +1 -1
  115. data/lib/trieve_ruby_client/models/update_group_by_tracking_id_data.rb +1 -1
  116. data/lib/trieve_ruby_client/models/update_organization_data.rb +1 -1
  117. data/lib/trieve_ruby_client/models/update_topic_data.rb +1 -1
  118. data/lib/trieve_ruby_client/models/update_user_data.rb +1 -1
  119. data/lib/trieve_ruby_client/models/upload_file_data.rb +13 -19
  120. data/lib/trieve_ruby_client/models/upload_file_result.rb +1 -1
  121. data/lib/trieve_ruby_client/models/user_organization.rb +1 -1
  122. data/lib/trieve_ruby_client/version.rb +2 -2
  123. data/lib/trieve_ruby_client.rb +9 -13
  124. data/openapi-generator.yaml +1 -1
  125. data/openapi.json +279 -198
  126. data/spec/models/chunk_metadata_with_score_spec.rb +114 -0
  127. data/spec/models/group_score_chunk_spec.rb +48 -0
  128. data/spec/models/group_score_slim_chunks_spec.rb +42 -0
  129. data/spec/models/search_over_groups_results_spec.rb +42 -0
  130. data/spec/models/search_over_groups_slim_results_spec.rb +42 -0
  131. data/spec/models/search_within_group_results_spec.rb +48 -0
  132. data/spec/models/search_within_group_slim_results_spec.rb +48 -0
  133. data/spec/models/slim_chunk_metadata_with_score_spec.rb +96 -0
  134. data/spec/spec_helper.rb +1 -1
  135. data/trieve_ruby_client-0.6.0.gem +0 -0
  136. data/trieve_ruby_client-0.6.2.gem +0 -0
  137. data/trieve_ruby_client.gemspec +1 -1
  138. metadata +36 -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.0
6
+ The version of the OpenAPI document: 0.6.7
7
7
  Contact: developers@trieve.ai
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.4.0
@@ -24,12 +24,12 @@ module TrieveRubyClient
24
24
  # Description is an optional convience field so you do not have to remember what the file contains or is about. It will be included on the group resulting from the file which will hold its chunk.
25
25
  attr_accessor :description
26
26
 
27
- # MIME type of the file being uploaded.
28
- attr_accessor :file_mime_type
29
-
30
27
  # Name of the file being uploaded, including the extension.
31
28
  attr_accessor :file_name
32
29
 
30
+ # Group tracking id is an optional field which allows you to specify the tracking id of the group that is created from the file. Chunks created will be created with the tracking id of `group_tracking_id|<index of chunk>`
31
+ attr_accessor :group_tracking_id
32
+
33
33
  # Link to the file. This can also be any string. This can be used to filter when searching for the file's resulting chunks. The link value will not affect embedding creation.
34
34
  attr_accessor :link
35
35
 
@@ -48,8 +48,8 @@ module TrieveRubyClient
48
48
  :'base64_file' => :'base64_file',
49
49
  :'create_chunks' => :'create_chunks',
50
50
  :'description' => :'description',
51
- :'file_mime_type' => :'file_mime_type',
52
51
  :'file_name' => :'file_name',
52
+ :'group_tracking_id' => :'group_tracking_id',
53
53
  :'link' => :'link',
54
54
  :'metadata' => :'metadata',
55
55
  :'tag_set' => :'tag_set',
@@ -68,8 +68,8 @@ module TrieveRubyClient
68
68
  :'base64_file' => :'String',
69
69
  :'create_chunks' => :'Boolean',
70
70
  :'description' => :'String',
71
- :'file_mime_type' => :'String',
72
71
  :'file_name' => :'String',
72
+ :'group_tracking_id' => :'String',
73
73
  :'link' => :'String',
74
74
  :'metadata' => :'Object',
75
75
  :'tag_set' => :'Array<String>',
@@ -82,6 +82,7 @@ module TrieveRubyClient
82
82
  Set.new([
83
83
  :'create_chunks',
84
84
  :'description',
85
+ :'group_tracking_id',
85
86
  :'link',
86
87
  :'metadata',
87
88
  :'tag_set',
@@ -118,18 +119,16 @@ module TrieveRubyClient
118
119
  self.description = attributes[:'description']
119
120
  end
120
121
 
121
- if attributes.key?(:'file_mime_type')
122
- self.file_mime_type = attributes[:'file_mime_type']
123
- else
124
- self.file_mime_type = nil
125
- end
126
-
127
122
  if attributes.key?(:'file_name')
128
123
  self.file_name = attributes[:'file_name']
129
124
  else
130
125
  self.file_name = nil
131
126
  end
132
127
 
128
+ if attributes.key?(:'group_tracking_id')
129
+ self.group_tracking_id = attributes[:'group_tracking_id']
130
+ end
131
+
133
132
  if attributes.key?(:'link')
134
133
  self.link = attributes[:'link']
135
134
  end
@@ -158,10 +157,6 @@ module TrieveRubyClient
158
157
  invalid_properties.push('invalid value for "base64_file", base64_file cannot be nil.')
159
158
  end
160
159
 
161
- if @file_mime_type.nil?
162
- invalid_properties.push('invalid value for "file_mime_type", file_mime_type cannot be nil.')
163
- end
164
-
165
160
  if @file_name.nil?
166
161
  invalid_properties.push('invalid value for "file_name", file_name cannot be nil.')
167
162
  end
@@ -174,7 +169,6 @@ module TrieveRubyClient
174
169
  def valid?
175
170
  warn '[DEPRECATED] the `valid?` method is obsolete'
176
171
  return false if @base64_file.nil?
177
- return false if @file_mime_type.nil?
178
172
  return false if @file_name.nil?
179
173
  true
180
174
  end
@@ -187,8 +181,8 @@ module TrieveRubyClient
187
181
  base64_file == o.base64_file &&
188
182
  create_chunks == o.create_chunks &&
189
183
  description == o.description &&
190
- file_mime_type == o.file_mime_type &&
191
184
  file_name == o.file_name &&
185
+ group_tracking_id == o.group_tracking_id &&
192
186
  link == o.link &&
193
187
  metadata == o.metadata &&
194
188
  tag_set == o.tag_set &&
@@ -204,7 +198,7 @@ module TrieveRubyClient
204
198
  # Calculates hash code according to all attributes.
205
199
  # @return [Integer] Hash code
206
200
  def hash
207
- [base64_file, create_chunks, description, file_mime_type, file_name, link, metadata, tag_set, time_stamp].hash
201
+ [base64_file, create_chunks, description, file_name, group_tracking_id, link, metadata, tag_set, time_stamp].hash
208
202
  end
209
203
 
210
204
  # 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.0
6
+ The version of the OpenAPI document: 0.6.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.6.0
6
+ The version of the OpenAPI document: 0.6.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.6.0
6
+ The version of the OpenAPI document: 0.6.7
7
7
  Contact: developers@trieve.ai
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.4.0
@@ -11,5 +11,5 @@ Generator version: 7.4.0
11
11
  =end
12
12
 
13
13
  module TrieveRubyClient
14
- VERSION = '0.6.0'
14
+ VERSION = '0.6.7'
15
15
  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.0
6
+ The version of the OpenAPI document: 0.6.7
7
7
  Contact: developers@trieve.ai
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.4.0
@@ -29,7 +29,7 @@ require 'trieve_ruby_client/models/chunk_filter'
29
29
  require 'trieve_ruby_client/models/chunk_group'
30
30
  require 'trieve_ruby_client/models/chunk_group_and_file'
31
31
  require 'trieve_ruby_client/models/chunk_metadata'
32
- require 'trieve_ruby_client/models/chunk_metadata_with_file_data'
32
+ require 'trieve_ruby_client/models/chunk_metadata_with_score'
33
33
  require 'trieve_ruby_client/models/client_dataset_configuration'
34
34
  require 'trieve_ruby_client/models/create_chunk_data'
35
35
  require 'trieve_ruby_client/models/create_chunk_group_data'
@@ -54,8 +54,8 @@ require 'trieve_ruby_client/models/generate_chunks_request'
54
54
  require 'trieve_ruby_client/models/get_events_data'
55
55
  require 'trieve_ruby_client/models/get_groups_for_chunks_data'
56
56
  require 'trieve_ruby_client/models/group_data'
57
- require 'trieve_ruby_client/models/group_score_chunk_dto'
58
- require 'trieve_ruby_client/models/group_slim_chunks_dto'
57
+ require 'trieve_ruby_client/models/group_score_chunk'
58
+ require 'trieve_ruby_client/models/group_score_slim_chunks'
59
59
  require 'trieve_ruby_client/models/invitation_data'
60
60
  require 'trieve_ruby_client/models/match_condition'
61
61
  require 'trieve_ruby_client/models/message'
@@ -64,8 +64,6 @@ require 'trieve_ruby_client/models/organization_usage_count'
64
64
  require 'trieve_ruby_client/models/range'
65
65
  require 'trieve_ruby_client/models/range_condition'
66
66
  require 'trieve_ruby_client/models/recommend_chunks_request'
67
- require 'trieve_ruby_client/models/recommend_chunks_response_types'
68
- require 'trieve_ruby_client/models/recommend_group_chunk_response_types'
69
67
  require 'trieve_ruby_client/models/recommend_group_chunks_request'
70
68
  require 'trieve_ruby_client/models/regenerate_message_data'
71
69
  require 'trieve_ruby_client/models/return_queued_chunk'
@@ -73,20 +71,18 @@ require 'trieve_ruby_client/models/score_chunk_dto'
73
71
  require 'trieve_ruby_client/models/score_slim_chunks'
74
72
  require 'trieve_ruby_client/models/search_chunk_data'
75
73
  require 'trieve_ruby_client/models/search_chunk_query_response_body'
76
- require 'trieve_ruby_client/models/search_chunk_response_types'
77
- require 'trieve_ruby_client/models/search_group_slim_chunks_result'
78
- require 'trieve_ruby_client/models/search_groups_result'
79
74
  require 'trieve_ruby_client/models/search_over_groups_data'
80
- require 'trieve_ruby_client/models/search_over_groups_response_body'
81
- require 'trieve_ruby_client/models/search_over_groups_response_types'
82
- require 'trieve_ruby_client/models/search_over_groups_slim_chunks_response_body'
75
+ require 'trieve_ruby_client/models/search_over_groups_results'
76
+ require 'trieve_ruby_client/models/search_over_groups_slim_results'
83
77
  require 'trieve_ruby_client/models/search_slim_chunk_query_response_body'
84
78
  require 'trieve_ruby_client/models/search_within_group_data'
85
- require 'trieve_ruby_client/models/search_within_group_response_types'
79
+ require 'trieve_ruby_client/models/search_within_group_results'
80
+ require 'trieve_ruby_client/models/search_within_group_slim_results'
86
81
  require 'trieve_ruby_client/models/set_user_api_key_request'
87
82
  require 'trieve_ruby_client/models/set_user_api_key_response'
88
83
  require 'trieve_ruby_client/models/single_queued_chunk_response'
89
84
  require 'trieve_ruby_client/models/slim_chunk_metadata'
85
+ require 'trieve_ruby_client/models/slim_chunk_metadata_with_score'
90
86
  require 'trieve_ruby_client/models/slim_group'
91
87
  require 'trieve_ruby_client/models/slim_user'
92
88
  require 'trieve_ruby_client/models/stripe_plan'
@@ -5,5 +5,5 @@ gemHomepage: "https://trieve.ai"
5
5
  gemLicense: "MIT"
6
6
  gemName: "trieve_ruby_client"
7
7
  gemSummary: "Trieve Ruby API client"
8
- gemVersion: "0.6.0"
8
+ gemVersion: "0.6.7"
9
9
  moduleName: "TrieveRubyClient"