trieve_ruby_client 0.6.2 → 0.6.9

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 (124) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +5 -5
  3. data/docs/ChunkApi.md +1 -1
  4. data/docs/ChunkData.md +2 -0
  5. data/docs/CreateDatasetRequest.md +3 -1
  6. data/docs/Dataset.md +2 -0
  7. data/docs/DatasetApi.md +1 -1
  8. data/docs/DatasetDTO.md +2 -0
  9. data/docs/FileApi.md +1 -1
  10. data/docs/GroupScoreChunk.md +2 -0
  11. data/docs/RecommendChunksRequest.md +2 -0
  12. data/docs/RecommendGroupChunksRequest.md +2 -0
  13. data/docs/UpdateChunkByTrackingIdData.md +2 -0
  14. data/docs/UpdateChunkData.md +2 -0
  15. data/docs/UpdateDatasetRequest.md +4 -2
  16. data/docs/UploadFileData.md +2 -2
  17. data/lib/trieve_ruby_client/api/auth_api.rb +1 -1
  18. data/lib/trieve_ruby_client/api/chunk_api.rb +3 -3
  19. data/lib/trieve_ruby_client/api/chunk_group_api.rb +1 -1
  20. data/lib/trieve_ruby_client/api/dataset_api.rb +1 -1
  21. data/lib/trieve_ruby_client/api/events_api.rb +1 -1
  22. data/lib/trieve_ruby_client/api/file_api.rb +1 -1
  23. data/lib/trieve_ruby_client/api/health_api.rb +1 -1
  24. data/lib/trieve_ruby_client/api/invitation_api.rb +1 -1
  25. data/lib/trieve_ruby_client/api/message_api.rb +1 -1
  26. data/lib/trieve_ruby_client/api/organization_api.rb +1 -1
  27. data/lib/trieve_ruby_client/api/stripe_api.rb +1 -1
  28. data/lib/trieve_ruby_client/api/topic_api.rb +1 -1
  29. data/lib/trieve_ruby_client/api/user_api.rb +1 -1
  30. data/lib/trieve_ruby_client/api_client.rb +1 -1
  31. data/lib/trieve_ruby_client/api_error.rb +1 -1
  32. data/lib/trieve_ruby_client/configuration.rb +1 -1
  33. data/lib/trieve_ruby_client/models/add_chunk_to_group_data.rb +1 -1
  34. data/lib/trieve_ruby_client/models/api_key_dto.rb +1 -1
  35. data/lib/trieve_ruby_client/models/auth_query.rb +1 -1
  36. data/lib/trieve_ruby_client/models/batch_queued_chunk_response.rb +1 -1
  37. data/lib/trieve_ruby_client/models/bookmark_data.rb +1 -1
  38. data/lib/trieve_ruby_client/models/bookmark_group_result.rb +1 -1
  39. data/lib/trieve_ruby_client/models/chat_message_proxy.rb +1 -1
  40. data/lib/trieve_ruby_client/models/chunk_data.rb +13 -2
  41. data/lib/trieve_ruby_client/models/chunk_filter.rb +1 -1
  42. data/lib/trieve_ruby_client/models/chunk_group.rb +1 -1
  43. data/lib/trieve_ruby_client/models/chunk_group_and_file.rb +1 -1
  44. data/lib/trieve_ruby_client/models/chunk_metadata.rb +1 -1
  45. data/lib/trieve_ruby_client/models/chunk_metadata_with_score.rb +1 -1
  46. data/lib/trieve_ruby_client/models/client_dataset_configuration.rb +1 -1
  47. data/lib/trieve_ruby_client/models/create_chunk_data.rb +1 -1
  48. data/lib/trieve_ruby_client/models/create_chunk_group_data.rb +1 -1
  49. data/lib/trieve_ruby_client/models/create_dataset_request.rb +17 -6
  50. data/lib/trieve_ruby_client/models/create_message_data.rb +1 -1
  51. data/lib/trieve_ruby_client/models/create_organization_data.rb +1 -1
  52. data/lib/trieve_ruby_client/models/create_topic_data.rb +1 -1
  53. data/lib/trieve_ruby_client/models/dataset.rb +12 -2
  54. data/lib/trieve_ruby_client/models/dataset_and_usage.rb +1 -1
  55. data/lib/trieve_ruby_client/models/dataset_dto.rb +12 -2
  56. data/lib/trieve_ruby_client/models/dataset_usage_count.rb +1 -1
  57. data/lib/trieve_ruby_client/models/delete_topic_data.rb +1 -1
  58. data/lib/trieve_ruby_client/models/delete_user_api_key_request.rb +1 -1
  59. data/lib/trieve_ruby_client/models/edit_message_data.rb +1 -1
  60. data/lib/trieve_ruby_client/models/error_response_body.rb +1 -1
  61. data/lib/trieve_ruby_client/models/event.rb +1 -1
  62. data/lib/trieve_ruby_client/models/event_return.rb +1 -1
  63. data/lib/trieve_ruby_client/models/field_condition.rb +1 -1
  64. data/lib/trieve_ruby_client/models/file.rb +1 -1
  65. data/lib/trieve_ruby_client/models/file_dto.rb +1 -1
  66. data/lib/trieve_ruby_client/models/generate_chunks_request.rb +1 -1
  67. data/lib/trieve_ruby_client/models/get_events_data.rb +1 -1
  68. data/lib/trieve_ruby_client/models/get_groups_for_chunks_data.rb +1 -1
  69. data/lib/trieve_ruby_client/models/group_data.rb +1 -1
  70. data/lib/trieve_ruby_client/models/group_score_chunk.rb +12 -2
  71. data/lib/trieve_ruby_client/models/group_score_slim_chunks.rb +1 -1
  72. data/lib/trieve_ruby_client/models/invitation_data.rb +1 -1
  73. data/lib/trieve_ruby_client/models/match_condition.rb +1 -1
  74. data/lib/trieve_ruby_client/models/message.rb +1 -1
  75. data/lib/trieve_ruby_client/models/organization.rb +1 -1
  76. data/lib/trieve_ruby_client/models/organization_usage_count.rb +1 -1
  77. data/lib/trieve_ruby_client/models/range.rb +1 -1
  78. data/lib/trieve_ruby_client/models/range_condition.rb +1 -1
  79. data/lib/trieve_ruby_client/models/recommend_chunks_request.rb +13 -2
  80. data/lib/trieve_ruby_client/models/recommend_group_chunks_request.rb +13 -2
  81. data/lib/trieve_ruby_client/models/regenerate_message_data.rb +1 -1
  82. data/lib/trieve_ruby_client/models/return_queued_chunk.rb +1 -1
  83. data/lib/trieve_ruby_client/models/score_chunk_dto.rb +1 -1
  84. data/lib/trieve_ruby_client/models/score_slim_chunks.rb +1 -1
  85. data/lib/trieve_ruby_client/models/search_chunk_data.rb +1 -1
  86. data/lib/trieve_ruby_client/models/search_chunk_query_response_body.rb +1 -1
  87. data/lib/trieve_ruby_client/models/search_over_groups_data.rb +1 -1
  88. data/lib/trieve_ruby_client/models/search_over_groups_results.rb +1 -1
  89. data/lib/trieve_ruby_client/models/search_over_groups_slim_results.rb +1 -1
  90. data/lib/trieve_ruby_client/models/search_slim_chunk_query_response_body.rb +1 -1
  91. data/lib/trieve_ruby_client/models/search_within_group_data.rb +1 -1
  92. data/lib/trieve_ruby_client/models/search_within_group_results.rb +1 -1
  93. data/lib/trieve_ruby_client/models/search_within_group_slim_results.rb +1 -1
  94. data/lib/trieve_ruby_client/models/set_user_api_key_request.rb +1 -1
  95. data/lib/trieve_ruby_client/models/set_user_api_key_response.rb +1 -1
  96. data/lib/trieve_ruby_client/models/single_queued_chunk_response.rb +1 -1
  97. data/lib/trieve_ruby_client/models/slim_chunk_metadata.rb +1 -1
  98. data/lib/trieve_ruby_client/models/slim_chunk_metadata_with_score.rb +1 -1
  99. data/lib/trieve_ruby_client/models/slim_group.rb +1 -1
  100. data/lib/trieve_ruby_client/models/slim_user.rb +1 -1
  101. data/lib/trieve_ruby_client/models/stripe_plan.rb +1 -1
  102. data/lib/trieve_ruby_client/models/suggested_queries_request.rb +1 -1
  103. data/lib/trieve_ruby_client/models/suggested_queries_response.rb +1 -1
  104. data/lib/trieve_ruby_client/models/topic.rb +1 -1
  105. data/lib/trieve_ruby_client/models/update_chunk_by_tracking_id_data.rb +13 -2
  106. data/lib/trieve_ruby_client/models/update_chunk_data.rb +13 -2
  107. data/lib/trieve_ruby_client/models/update_chunk_group_data.rb +1 -1
  108. data/lib/trieve_ruby_client/models/update_dataset_request.rb +18 -13
  109. data/lib/trieve_ruby_client/models/update_group_by_tracking_id_data.rb +1 -1
  110. data/lib/trieve_ruby_client/models/update_organization_data.rb +1 -1
  111. data/lib/trieve_ruby_client/models/update_topic_data.rb +1 -1
  112. data/lib/trieve_ruby_client/models/update_user_data.rb +1 -1
  113. data/lib/trieve_ruby_client/models/upload_file_data.rb +13 -19
  114. data/lib/trieve_ruby_client/models/upload_file_result.rb +1 -1
  115. data/lib/trieve_ruby_client/models/user_organization.rb +1 -1
  116. data/lib/trieve_ruby_client/version.rb +2 -2
  117. data/lib/trieve_ruby_client.rb +1 -1
  118. data/openapi-generator.yaml +1 -1
  119. data/openapi.json +59 -12
  120. data/spec/spec_helper.rb +1 -1
  121. data/trieve_ruby_client-0.6.2.gem +0 -0
  122. data/trieve_ruby_client-0.6.7.gem +0 -0
  123. data/trieve_ruby_client.gemspec +1 -1
  124. metadata +4 -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.2
6
+ The version of the OpenAPI document: 0.6.9
7
7
  Contact: developers@trieve.ai
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.4.0
@@ -32,6 +32,9 @@ module TrieveRubyClient
32
32
  # The tracking_ids of the chunks to be used as positive examples for the recommendation. The chunks in this array will be used to find similar chunks.
33
33
  attr_accessor :positive_tracking_ids
34
34
 
35
+ # The type of recommendation to make. This lets you choose whether to recommend based off of `semantic` or `fulltext` similarity. The default is `semantic`.
36
+ attr_accessor :recommend_type
37
+
35
38
  # Set slim_chunks to true to avoid returning the content and chunk_html of the chunks. This is useful for when you want to reduce amount of data over the wire for latency improvement. Default is false.
36
39
  attr_accessor :slim_chunks
37
40
 
@@ -47,6 +50,7 @@ module TrieveRubyClient
47
50
  :'negative_tracking_ids' => :'negative_tracking_ids',
48
51
  :'positive_chunk_ids' => :'positive_chunk_ids',
49
52
  :'positive_tracking_ids' => :'positive_tracking_ids',
53
+ :'recommend_type' => :'recommend_type',
50
54
  :'slim_chunks' => :'slim_chunks',
51
55
  :'strategy' => :'strategy'
52
56
  }
@@ -66,6 +70,7 @@ module TrieveRubyClient
66
70
  :'negative_tracking_ids' => :'Array<String>',
67
71
  :'positive_chunk_ids' => :'Array<String>',
68
72
  :'positive_tracking_ids' => :'Array<String>',
73
+ :'recommend_type' => :'String',
69
74
  :'slim_chunks' => :'Boolean',
70
75
  :'strategy' => :'String'
71
76
  }
@@ -80,6 +85,7 @@ module TrieveRubyClient
80
85
  :'negative_tracking_ids',
81
86
  :'positive_chunk_ids',
82
87
  :'positive_tracking_ids',
88
+ :'recommend_type',
83
89
  :'slim_chunks',
84
90
  :'strategy'
85
91
  ])
@@ -132,6 +138,10 @@ module TrieveRubyClient
132
138
  end
133
139
  end
134
140
 
141
+ if attributes.key?(:'recommend_type')
142
+ self.recommend_type = attributes[:'recommend_type']
143
+ end
144
+
135
145
  if attributes.key?(:'slim_chunks')
136
146
  self.slim_chunks = attributes[:'slim_chunks']
137
147
  end
@@ -182,6 +192,7 @@ module TrieveRubyClient
182
192
  negative_tracking_ids == o.negative_tracking_ids &&
183
193
  positive_chunk_ids == o.positive_chunk_ids &&
184
194
  positive_tracking_ids == o.positive_tracking_ids &&
195
+ recommend_type == o.recommend_type &&
185
196
  slim_chunks == o.slim_chunks &&
186
197
  strategy == o.strategy
187
198
  end
@@ -195,7 +206,7 @@ module TrieveRubyClient
195
206
  # Calculates hash code according to all attributes.
196
207
  # @return [Integer] Hash code
197
208
  def hash
198
- [filters, limit, negative_chunk_ids, negative_tracking_ids, positive_chunk_ids, positive_tracking_ids, slim_chunks, strategy].hash
209
+ [filters, limit, negative_chunk_ids, negative_tracking_ids, positive_chunk_ids, positive_tracking_ids, recommend_type, slim_chunks, strategy].hash
199
210
  end
200
211
 
201
212
  # 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.2
6
+ The version of the OpenAPI document: 0.6.9
7
7
  Contact: developers@trieve.ai
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.4.0
@@ -35,6 +35,9 @@ module TrieveRubyClient
35
35
  # The ids of the groups to be used as positive examples for the recommendation. The groups in this array will be used to find similar groups.
36
36
  attr_accessor :positive_group_tracking_ids
37
37
 
38
+ # The type of recommendation to make. This lets you choose whether to recommend based off of `semantic` or `fulltext` similarity. The default is `semantic`.
39
+ attr_accessor :recommend_type
40
+
38
41
  # Set slim_chunks to true to avoid returning the content and chunk_html of the chunks. This is useful for when you want to reduce amount of data over the wire for latency improvement. Default is false.
39
42
  attr_accessor :slim_chunks
40
43
 
@@ -51,6 +54,7 @@ module TrieveRubyClient
51
54
  :'negative_group_tracking_ids' => :'negative_group_tracking_ids',
52
55
  :'positive_group_ids' => :'positive_group_ids',
53
56
  :'positive_group_tracking_ids' => :'positive_group_tracking_ids',
57
+ :'recommend_type' => :'recommend_type',
54
58
  :'slim_chunks' => :'slim_chunks',
55
59
  :'strategy' => :'strategy'
56
60
  }
@@ -71,6 +75,7 @@ module TrieveRubyClient
71
75
  :'negative_group_tracking_ids' => :'Array<String>',
72
76
  :'positive_group_ids' => :'Array<String>',
73
77
  :'positive_group_tracking_ids' => :'Array<String>',
78
+ :'recommend_type' => :'String',
74
79
  :'slim_chunks' => :'Boolean',
75
80
  :'strategy' => :'String'
76
81
  }
@@ -86,6 +91,7 @@ module TrieveRubyClient
86
91
  :'negative_group_tracking_ids',
87
92
  :'positive_group_ids',
88
93
  :'positive_group_tracking_ids',
94
+ :'recommend_type',
89
95
  :'slim_chunks',
90
96
  :'strategy'
91
97
  ])
@@ -142,6 +148,10 @@ module TrieveRubyClient
142
148
  end
143
149
  end
144
150
 
151
+ if attributes.key?(:'recommend_type')
152
+ self.recommend_type = attributes[:'recommend_type']
153
+ end
154
+
145
155
  if attributes.key?(:'slim_chunks')
146
156
  self.slim_chunks = attributes[:'slim_chunks']
147
157
  end
@@ -208,6 +218,7 @@ module TrieveRubyClient
208
218
  negative_group_tracking_ids == o.negative_group_tracking_ids &&
209
219
  positive_group_ids == o.positive_group_ids &&
210
220
  positive_group_tracking_ids == o.positive_group_tracking_ids &&
221
+ recommend_type == o.recommend_type &&
211
222
  slim_chunks == o.slim_chunks &&
212
223
  strategy == o.strategy
213
224
  end
@@ -221,7 +232,7 @@ module TrieveRubyClient
221
232
  # Calculates hash code according to all attributes.
222
233
  # @return [Integer] Hash code
223
234
  def hash
224
- [filters, group_size, limit, negative_group_ids, negative_group_tracking_ids, positive_group_ids, positive_group_tracking_ids, slim_chunks, strategy].hash
235
+ [filters, group_size, limit, negative_group_ids, negative_group_tracking_ids, positive_group_ids, positive_group_tracking_ids, recommend_type, slim_chunks, strategy].hash
225
236
  end
226
237
 
227
238
  # 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.2
6
+ The version of the OpenAPI document: 0.6.9
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.2
6
+ The version of the OpenAPI document: 0.6.9
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.2
6
+ The version of the OpenAPI document: 0.6.9
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.2
6
+ The version of the OpenAPI document: 0.6.9
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.2
6
+ The version of the OpenAPI document: 0.6.9
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.2
6
+ The version of the OpenAPI document: 0.6.9
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.2
6
+ The version of the OpenAPI document: 0.6.9
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.2
6
+ The version of the OpenAPI document: 0.6.9
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.2
6
+ The version of the OpenAPI document: 0.6.9
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.2
6
+ The version of the OpenAPI document: 0.6.9
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.2
6
+ The version of the OpenAPI document: 0.6.9
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.2
6
+ The version of the OpenAPI document: 0.6.9
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.2
6
+ The version of the OpenAPI document: 0.6.9
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.2
6
+ The version of the OpenAPI document: 0.6.9
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.2
6
+ The version of the OpenAPI document: 0.6.9
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.2
6
+ The version of the OpenAPI document: 0.6.9
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.2
6
+ The version of the OpenAPI document: 0.6.9
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.2
6
+ The version of the OpenAPI document: 0.6.9
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.2
6
+ The version of the OpenAPI document: 0.6.9
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.2
6
+ The version of the OpenAPI document: 0.6.9
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.2
6
+ The version of the OpenAPI document: 0.6.9
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.2
6
+ The version of the OpenAPI document: 0.6.9
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.2
6
+ The version of the OpenAPI document: 0.6.9
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.2
6
+ The version of the OpenAPI document: 0.6.9
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.2
6
+ The version of the OpenAPI document: 0.6.9
7
7
  Contact: developers@trieve.ai
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.4.0
@@ -18,6 +18,9 @@ module TrieveRubyClient
18
18
  # HTML content of the chunk you want to update. This can also be plaintext. The innerText of the HTML will be used to create the embedding vector. The point of using HTML is for convienience, as some users have applications where users submit HTML content. If no chunk_html is provided, the existing chunk_html will be used.
19
19
  attr_accessor :chunk_html
20
20
 
21
+ # Convert HTML to raw text before processing to avoid adding noise to the vector embeddings. By default this is true. If you are using HTML content that you want to be included in the vector embeddings, set this to false.
22
+ attr_accessor :convert_html_to_text
23
+
21
24
  # Group ids are the ids of the groups that the chunk should be placed into. This is useful for when you want to update a chunk and add it to a group or multiple groups in one request.
22
25
  attr_accessor :group_ids
23
26
 
@@ -43,6 +46,7 @@ module TrieveRubyClient
43
46
  def self.attribute_map
44
47
  {
45
48
  :'chunk_html' => :'chunk_html',
49
+ :'convert_html_to_text' => :'convert_html_to_text',
46
50
  :'group_ids' => :'group_ids',
47
51
  :'group_tracking_ids' => :'group_tracking_ids',
48
52
  :'link' => :'link',
@@ -62,6 +66,7 @@ module TrieveRubyClient
62
66
  def self.openapi_types
63
67
  {
64
68
  :'chunk_html' => :'String',
69
+ :'convert_html_to_text' => :'Boolean',
65
70
  :'group_ids' => :'Array<String>',
66
71
  :'group_tracking_ids' => :'Array<String>',
67
72
  :'link' => :'String',
@@ -76,6 +81,7 @@ module TrieveRubyClient
76
81
  def self.openapi_nullable
77
82
  Set.new([
78
83
  :'chunk_html',
84
+ :'convert_html_to_text',
79
85
  :'group_ids',
80
86
  :'group_tracking_ids',
81
87
  :'link',
@@ -104,6 +110,10 @@ module TrieveRubyClient
104
110
  self.chunk_html = attributes[:'chunk_html']
105
111
  end
106
112
 
113
+ if attributes.key?(:'convert_html_to_text')
114
+ self.convert_html_to_text = attributes[:'convert_html_to_text']
115
+ end
116
+
107
117
  if attributes.key?(:'group_ids')
108
118
  if (value = attributes[:'group_ids']).is_a?(Array)
109
119
  self.group_ids = value
@@ -165,6 +175,7 @@ module TrieveRubyClient
165
175
  return true if self.equal?(o)
166
176
  self.class == o.class &&
167
177
  chunk_html == o.chunk_html &&
178
+ convert_html_to_text == o.convert_html_to_text &&
168
179
  group_ids == o.group_ids &&
169
180
  group_tracking_ids == o.group_tracking_ids &&
170
181
  link == o.link &&
@@ -183,7 +194,7 @@ module TrieveRubyClient
183
194
  # Calculates hash code according to all attributes.
184
195
  # @return [Integer] Hash code
185
196
  def hash
186
- [chunk_html, group_ids, group_tracking_ids, link, metadata, time_stamp, tracking_id, weight].hash
197
+ [chunk_html, convert_html_to_text, group_ids, group_tracking_ids, link, metadata, time_stamp, tracking_id, weight].hash
187
198
  end
188
199
 
189
200
  # 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.2
6
+ The version of the OpenAPI document: 0.6.9
7
7
  Contact: developers@trieve.ai
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.4.0
@@ -21,6 +21,9 @@ module TrieveRubyClient
21
21
  # Id of the chunk you want to update. You can provide either the chunk_id or the tracking_id. If both are provided, the chunk_id will be used.
22
22
  attr_accessor :chunk_id
23
23
 
24
+ # Convert HTML to raw text before processing to avoid adding noise to the vector embeddings. By default this is true. If you are using HTML content that you want to be included in the vector embeddings, set this to false.
25
+ attr_accessor :convert_html_to_text
26
+
24
27
  # Group ids are the ids of the groups that the chunk should be placed into. This is useful for when you want to update a chunk and add it to a group or multiple groups in one request.
25
28
  attr_accessor :group_ids
26
29
 
@@ -50,6 +53,7 @@ module TrieveRubyClient
50
53
  {
51
54
  :'chunk_html' => :'chunk_html',
52
55
  :'chunk_id' => :'chunk_id',
56
+ :'convert_html_to_text' => :'convert_html_to_text',
53
57
  :'group_ids' => :'group_ids',
54
58
  :'group_tracking_ids' => :'group_tracking_ids',
55
59
  :'link' => :'link',
@@ -71,6 +75,7 @@ module TrieveRubyClient
71
75
  {
72
76
  :'chunk_html' => :'String',
73
77
  :'chunk_id' => :'String',
78
+ :'convert_html_to_text' => :'Boolean',
74
79
  :'group_ids' => :'Array<String>',
75
80
  :'group_tracking_ids' => :'Array<String>',
76
81
  :'link' => :'String',
@@ -87,6 +92,7 @@ module TrieveRubyClient
87
92
  Set.new([
88
93
  :'chunk_html',
89
94
  :'chunk_id',
95
+ :'convert_html_to_text',
90
96
  :'group_ids',
91
97
  :'group_tracking_ids',
92
98
  :'link',
@@ -121,6 +127,10 @@ module TrieveRubyClient
121
127
  self.chunk_id = attributes[:'chunk_id']
122
128
  end
123
129
 
130
+ if attributes.key?(:'convert_html_to_text')
131
+ self.convert_html_to_text = attributes[:'convert_html_to_text']
132
+ end
133
+
124
134
  if attributes.key?(:'group_ids')
125
135
  if (value = attributes[:'group_ids']).is_a?(Array)
126
136
  self.group_ids = value
@@ -182,6 +192,7 @@ module TrieveRubyClient
182
192
  self.class == o.class &&
183
193
  chunk_html == o.chunk_html &&
184
194
  chunk_id == o.chunk_id &&
195
+ convert_html_to_text == o.convert_html_to_text &&
185
196
  group_ids == o.group_ids &&
186
197
  group_tracking_ids == o.group_tracking_ids &&
187
198
  link == o.link &&
@@ -201,7 +212,7 @@ module TrieveRubyClient
201
212
  # Calculates hash code according to all attributes.
202
213
  # @return [Integer] Hash code
203
214
  def hash
204
- [chunk_html, chunk_id, group_ids, group_tracking_ids, link, metadata, tag_set, time_stamp, tracking_id, weight].hash
215
+ [chunk_html, chunk_id, convert_html_to_text, group_ids, group_tracking_ids, link, metadata, tag_set, time_stamp, tracking_id, weight].hash
205
216
  end
206
217
 
207
218
  # 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.2
6
+ The version of the OpenAPI document: 0.6.9
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.2
6
+ The version of the OpenAPI document: 0.6.9
7
7
  Contact: developers@trieve.ai
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.4.0
@@ -27,13 +27,17 @@ module TrieveRubyClient
27
27
  # The new server configuration of the dataset, can be arbitrary JSON. See docs.trieve.ai for more information. If not provided, the server configuration will not be updated.
28
28
  attr_accessor :server_configuration
29
29
 
30
+ # tracking ID for the dataset. Can be used to track the dataset in external systems.
31
+ attr_accessor :tracking_id
32
+
30
33
  # Attribute mapping from ruby-style variable name to JSON key.
31
34
  def self.attribute_map
32
35
  {
33
36
  :'client_configuration' => :'client_configuration',
34
37
  :'dataset_id' => :'dataset_id',
35
38
  :'dataset_name' => :'dataset_name',
36
- :'server_configuration' => :'server_configuration'
39
+ :'server_configuration' => :'server_configuration',
40
+ :'tracking_id' => :'tracking_id'
37
41
  }
38
42
  end
39
43
 
@@ -48,7 +52,8 @@ module TrieveRubyClient
48
52
  :'client_configuration' => :'Object',
49
53
  :'dataset_id' => :'String',
50
54
  :'dataset_name' => :'String',
51
- :'server_configuration' => :'Object'
55
+ :'server_configuration' => :'Object',
56
+ :'tracking_id' => :'String'
52
57
  }
53
58
  end
54
59
 
@@ -56,8 +61,10 @@ module TrieveRubyClient
56
61
  def self.openapi_nullable
57
62
  Set.new([
58
63
  :'client_configuration',
64
+ :'dataset_id',
59
65
  :'dataset_name',
60
- :'server_configuration'
66
+ :'server_configuration',
67
+ :'tracking_id'
61
68
  ])
62
69
  end
63
70
 
@@ -82,8 +89,6 @@ module TrieveRubyClient
82
89
 
83
90
  if attributes.key?(:'dataset_id')
84
91
  self.dataset_id = attributes[:'dataset_id']
85
- else
86
- self.dataset_id = nil
87
92
  end
88
93
 
89
94
  if attributes.key?(:'dataset_name')
@@ -93,6 +98,10 @@ module TrieveRubyClient
93
98
  if attributes.key?(:'server_configuration')
94
99
  self.server_configuration = attributes[:'server_configuration']
95
100
  end
101
+
102
+ if attributes.key?(:'tracking_id')
103
+ self.tracking_id = attributes[:'tracking_id']
104
+ end
96
105
  end
97
106
 
98
107
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -100,10 +109,6 @@ module TrieveRubyClient
100
109
  def list_invalid_properties
101
110
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
102
111
  invalid_properties = Array.new
103
- if @dataset_id.nil?
104
- invalid_properties.push('invalid value for "dataset_id", dataset_id cannot be nil.')
105
- end
106
-
107
112
  invalid_properties
108
113
  end
109
114
 
@@ -111,7 +116,6 @@ module TrieveRubyClient
111
116
  # @return true if the model is valid
112
117
  def valid?
113
118
  warn '[DEPRECATED] the `valid?` method is obsolete'
114
- return false if @dataset_id.nil?
115
119
  true
116
120
  end
117
121
 
@@ -123,7 +127,8 @@ module TrieveRubyClient
123
127
  client_configuration == o.client_configuration &&
124
128
  dataset_id == o.dataset_id &&
125
129
  dataset_name == o.dataset_name &&
126
- server_configuration == o.server_configuration
130
+ server_configuration == o.server_configuration &&
131
+ tracking_id == o.tracking_id
127
132
  end
128
133
 
129
134
  # @see the `==` method
@@ -135,7 +140,7 @@ module TrieveRubyClient
135
140
  # Calculates hash code according to all attributes.
136
141
  # @return [Integer] Hash code
137
142
  def hash
138
- [client_configuration, dataset_id, dataset_name, server_configuration].hash
143
+ [client_configuration, dataset_id, dataset_name, server_configuration, tracking_id].hash
139
144
  end
140
145
 
141
146
  # 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.2
6
+ The version of the OpenAPI document: 0.6.9
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.2
6
+ The version of the OpenAPI document: 0.6.9
7
7
  Contact: developers@trieve.ai
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.4.0