trieve_ruby_client 0.6.0 → 0.6.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (132) 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 +8 -8
  5. data/docs/ChunkGroupApi.md +14 -14
  6. data/docs/ChunkMetadataWithScore.md +44 -0
  7. data/docs/CreateChunkGroupData.md +1 -1
  8. data/docs/GetEventsData.md +1 -1
  9. data/docs/GroupScoreChunk.md +22 -0
  10. data/docs/GroupScoreSlimChunks.md +20 -0
  11. data/docs/ScoreChunkDTO.md +1 -1
  12. data/docs/SearchOverGroupsResults.md +20 -0
  13. data/docs/SearchOverGroupsSlimResults.md +20 -0
  14. data/docs/SearchWithinGroupResults.md +22 -0
  15. data/docs/SearchWithinGroupSlimResults.md +22 -0
  16. data/docs/SlimChunkMetadataWithScore.md +38 -0
  17. data/docs/UserApi.md +2 -2
  18. data/lib/trieve_ruby_client/api/auth_api.rb +1 -1
  19. data/lib/trieve_ruby_client/api/chunk_api.rb +7 -7
  20. data/lib/trieve_ruby_client/api/chunk_group_api.rb +10 -10
  21. data/lib/trieve_ruby_client/api/dataset_api.rb +1 -1
  22. data/lib/trieve_ruby_client/api/events_api.rb +1 -1
  23. data/lib/trieve_ruby_client/api/file_api.rb +1 -1
  24. data/lib/trieve_ruby_client/api/health_api.rb +1 -1
  25. data/lib/trieve_ruby_client/api/invitation_api.rb +1 -1
  26. data/lib/trieve_ruby_client/api/message_api.rb +1 -1
  27. data/lib/trieve_ruby_client/api/organization_api.rb +1 -1
  28. data/lib/trieve_ruby_client/api/stripe_api.rb +1 -1
  29. data/lib/trieve_ruby_client/api/topic_api.rb +1 -1
  30. data/lib/trieve_ruby_client/api/user_api.rb +3 -3
  31. data/lib/trieve_ruby_client/api_client.rb +1 -1
  32. data/lib/trieve_ruby_client/api_error.rb +1 -1
  33. data/lib/trieve_ruby_client/configuration.rb +1 -1
  34. data/lib/trieve_ruby_client/models/add_chunk_to_group_data.rb +1 -1
  35. data/lib/trieve_ruby_client/models/api_key_dto.rb +1 -1
  36. data/lib/trieve_ruby_client/models/auth_query.rb +1 -1
  37. data/lib/trieve_ruby_client/models/batch_queued_chunk_response.rb +1 -1
  38. data/lib/trieve_ruby_client/models/bookmark_data.rb +2 -2
  39. data/lib/trieve_ruby_client/models/bookmark_group_result.rb +1 -1
  40. data/lib/trieve_ruby_client/models/chat_message_proxy.rb +1 -1
  41. data/lib/trieve_ruby_client/models/chunk_data.rb +1 -1
  42. data/lib/trieve_ruby_client/models/chunk_filter.rb +1 -1
  43. data/lib/trieve_ruby_client/models/chunk_group.rb +1 -1
  44. data/lib/trieve_ruby_client/models/chunk_group_and_file.rb +1 -1
  45. data/lib/trieve_ruby_client/models/chunk_metadata.rb +1 -1
  46. data/lib/trieve_ruby_client/models/chunk_metadata_with_score.rb +387 -0
  47. data/lib/trieve_ruby_client/models/client_dataset_configuration.rb +1 -1
  48. data/lib/trieve_ruby_client/models/create_chunk_data.rb +1 -1
  49. data/lib/trieve_ruby_client/models/create_chunk_group_data.rb +2 -8
  50. data/lib/trieve_ruby_client/models/create_dataset_request.rb +1 -1
  51. data/lib/trieve_ruby_client/models/create_message_data.rb +1 -1
  52. data/lib/trieve_ruby_client/models/create_organization_data.rb +1 -1
  53. data/lib/trieve_ruby_client/models/create_topic_data.rb +1 -1
  54. data/lib/trieve_ruby_client/models/dataset.rb +1 -1
  55. data/lib/trieve_ruby_client/models/dataset_and_usage.rb +1 -1
  56. data/lib/trieve_ruby_client/models/dataset_dto.rb +1 -1
  57. data/lib/trieve_ruby_client/models/dataset_usage_count.rb +1 -1
  58. data/lib/trieve_ruby_client/models/delete_topic_data.rb +1 -1
  59. data/lib/trieve_ruby_client/models/delete_user_api_key_request.rb +1 -1
  60. data/lib/trieve_ruby_client/models/edit_message_data.rb +1 -1
  61. data/lib/trieve_ruby_client/models/error_response_body.rb +1 -1
  62. data/lib/trieve_ruby_client/models/event.rb +1 -1
  63. data/lib/trieve_ruby_client/models/event_return.rb +1 -1
  64. data/lib/trieve_ruby_client/models/field_condition.rb +1 -1
  65. data/lib/trieve_ruby_client/models/file.rb +1 -1
  66. data/lib/trieve_ruby_client/models/file_dto.rb +1 -1
  67. data/lib/trieve_ruby_client/models/generate_chunks_request.rb +1 -1
  68. data/lib/trieve_ruby_client/models/get_events_data.rb +2 -2
  69. data/lib/trieve_ruby_client/models/get_groups_for_chunks_data.rb +1 -1
  70. data/lib/trieve_ruby_client/models/group_data.rb +1 -1
  71. data/lib/trieve_ruby_client/models/group_score_chunk.rb +249 -0
  72. data/lib/trieve_ruby_client/models/group_score_slim_chunks.rb +239 -0
  73. data/lib/trieve_ruby_client/models/invitation_data.rb +1 -1
  74. data/lib/trieve_ruby_client/models/match_condition.rb +1 -1
  75. data/lib/trieve_ruby_client/models/message.rb +1 -1
  76. data/lib/trieve_ruby_client/models/organization.rb +1 -1
  77. data/lib/trieve_ruby_client/models/organization_usage_count.rb +1 -1
  78. data/lib/trieve_ruby_client/models/range.rb +1 -1
  79. data/lib/trieve_ruby_client/models/range_condition.rb +1 -1
  80. data/lib/trieve_ruby_client/models/recommend_chunks_request.rb +1 -1
  81. data/lib/trieve_ruby_client/models/recommend_group_chunks_request.rb +1 -1
  82. data/lib/trieve_ruby_client/models/regenerate_message_data.rb +1 -1
  83. data/lib/trieve_ruby_client/models/return_queued_chunk.rb +1 -1
  84. data/lib/trieve_ruby_client/models/score_chunk_dto.rb +2 -2
  85. data/lib/trieve_ruby_client/models/score_slim_chunks.rb +1 -1
  86. data/lib/trieve_ruby_client/models/search_chunk_data.rb +1 -1
  87. data/lib/trieve_ruby_client/models/search_chunk_query_response_body.rb +1 -1
  88. data/lib/trieve_ruby_client/models/search_over_groups_data.rb +1 -1
  89. data/lib/trieve_ruby_client/models/search_over_groups_results.rb +239 -0
  90. data/lib/trieve_ruby_client/models/search_over_groups_slim_results.rb +239 -0
  91. data/lib/trieve_ruby_client/models/search_slim_chunk_query_response_body.rb +1 -1
  92. data/lib/trieve_ruby_client/models/search_within_group_data.rb +1 -1
  93. data/lib/trieve_ruby_client/models/search_within_group_results.rb +255 -0
  94. data/lib/trieve_ruby_client/models/search_within_group_slim_results.rb +255 -0
  95. data/lib/trieve_ruby_client/models/set_user_api_key_request.rb +1 -1
  96. data/lib/trieve_ruby_client/models/set_user_api_key_response.rb +1 -1
  97. data/lib/trieve_ruby_client/models/single_queued_chunk_response.rb +1 -1
  98. data/lib/trieve_ruby_client/models/slim_chunk_metadata.rb +1 -1
  99. data/lib/trieve_ruby_client/models/slim_chunk_metadata_with_score.rb +345 -0
  100. data/lib/trieve_ruby_client/models/slim_group.rb +1 -1
  101. data/lib/trieve_ruby_client/models/slim_user.rb +1 -1
  102. data/lib/trieve_ruby_client/models/stripe_plan.rb +1 -1
  103. data/lib/trieve_ruby_client/models/suggested_queries_request.rb +1 -1
  104. data/lib/trieve_ruby_client/models/suggested_queries_response.rb +1 -1
  105. data/lib/trieve_ruby_client/models/topic.rb +1 -1
  106. data/lib/trieve_ruby_client/models/update_chunk_by_tracking_id_data.rb +1 -1
  107. data/lib/trieve_ruby_client/models/update_chunk_data.rb +1 -1
  108. data/lib/trieve_ruby_client/models/update_chunk_group_data.rb +1 -1
  109. data/lib/trieve_ruby_client/models/update_dataset_request.rb +1 -1
  110. data/lib/trieve_ruby_client/models/update_group_by_tracking_id_data.rb +1 -1
  111. data/lib/trieve_ruby_client/models/update_organization_data.rb +1 -1
  112. data/lib/trieve_ruby_client/models/update_topic_data.rb +1 -1
  113. data/lib/trieve_ruby_client/models/update_user_data.rb +1 -1
  114. data/lib/trieve_ruby_client/models/upload_file_data.rb +1 -1
  115. data/lib/trieve_ruby_client/models/upload_file_result.rb +1 -1
  116. data/lib/trieve_ruby_client/models/user_organization.rb +1 -1
  117. data/lib/trieve_ruby_client/version.rb +2 -2
  118. data/lib/trieve_ruby_client.rb +9 -13
  119. data/openapi-generator.yaml +1 -1
  120. data/openapi.json +253 -191
  121. data/spec/models/chunk_metadata_with_score_spec.rb +114 -0
  122. data/spec/models/group_score_chunk_spec.rb +48 -0
  123. data/spec/models/group_score_slim_chunks_spec.rb +42 -0
  124. data/spec/models/search_over_groups_results_spec.rb +42 -0
  125. data/spec/models/search_over_groups_slim_results_spec.rb +42 -0
  126. data/spec/models/search_within_group_results_spec.rb +48 -0
  127. data/spec/models/search_within_group_slim_results_spec.rb +48 -0
  128. data/spec/models/slim_chunk_metadata_with_score_spec.rb +96 -0
  129. data/spec/spec_helper.rb +1 -1
  130. data/trieve_ruby_client-0.6.0.gem +0 -0
  131. data/trieve_ruby_client.gemspec +1 -1
  132. metadata +35 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 2bd762d8a89b0815c978e406a8abb5f797697ae3f39a90c5b57631ddd287e46c
4
- data.tar.gz: eef6e62b91d2025556ede8aa043c2195b6ad6ecf5b2656079af9bf78bc8ff6e3
3
+ metadata.gz: a535668b86dc6d7a9c34dbf5f73599b5cb779ca38d16c4e59dc4fec8bf40dfd3
4
+ data.tar.gz: dce36c7454918e72708d1cbf0c349175d86438450910502269e1bbc4f918f60e
5
5
  SHA512:
6
- metadata.gz: d2f07ed812c2f6724e55ee0c60ca18b322e8473e52135bdcfb46df405277483916f9ef1555ff4c9414b3ec20575d7aad26ff10dac22a1767b977ef37804c562e
7
- data.tar.gz: 32c9b6ba5c2878e054fb2b2b223d0468e2e3dc7c911eb05f30e57f42127b30dc4ed5157ad73c76113fff81911ad0503ce447b782fec8d423de73e5db8c5b46d3
6
+ metadata.gz: ca8dcc93ee03db947a313c5acaa6d1a40897efba991a0bda43f31e76000e69154250878523e9dbe669d854e7a8a6f925282371eb1c0620c8165f1fa73022c72f
7
+ data.tar.gz: 0e8b184949e29720dd63748ac05a6089b8bbefb5e145e2c96265edd2e3329ad77df062b99ef3e4be1a429412b8b0cba01d869409ec62878129d7fe25a79a87e0
data/README.md CHANGED
@@ -6,8 +6,8 @@ Trieve OpenAPI Specification. This document describes all of the operations avai
6
6
 
7
7
  This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
8
8
 
9
- - API version: 0.6.0
10
- - Package version: 0.6.0
9
+ - API version: 0.6.2
10
+ - Package version: 0.6.2
11
11
  - Generator version: 7.4.0
12
12
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
13
13
  For more information, please visit [https://trieve.ai](https://trieve.ai)
@@ -25,16 +25,16 @@ gem build trieve_ruby_client.gemspec
25
25
  Then either install the gem locally:
26
26
 
27
27
  ```shell
28
- gem install ./trieve_ruby_client-0.6.0.gem
28
+ gem install ./trieve_ruby_client-0.6.2.gem
29
29
  ```
30
30
 
31
- (for development, run `gem install --dev ./trieve_ruby_client-0.6.0.gem` to install the development dependencies)
31
+ (for development, run `gem install --dev ./trieve_ruby_client-0.6.2.gem` to install the development dependencies)
32
32
 
33
33
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
34
34
 
35
35
  Finally add this to the Gemfile:
36
36
 
37
- gem 'trieve_ruby_client', '~> 0.6.0'
37
+ gem 'trieve_ruby_client', '~> 0.6.2'
38
38
 
39
39
  ### Install from Git
40
40
 
@@ -139,8 +139,8 @@ Class | Method | HTTP request | Description
139
139
  *TrieveRubyClient::TopicApi* | [**delete_topic**](docs/TopicApi.md#delete_topic) | **DELETE** /api/topic/{topic_id} | Delete Topic
140
140
  *TrieveRubyClient::TopicApi* | [**get_all_topics_for_user**](docs/TopicApi.md#get_all_topics_for_user) | **GET** /api/topic/user/{user_id} | Get All Topics for User
141
141
  *TrieveRubyClient::TopicApi* | [**update_topic**](docs/TopicApi.md#update_topic) | **PUT** /api/topic | Update Topic
142
- *TrieveRubyClient::UserApi* | [**delete_user_api_key**](docs/UserApi.md#delete_user_api_key) | **DELETE** /api/user/delete_api_key/{api_key_id} | Delete User Api Key
143
- *TrieveRubyClient::UserApi* | [**set_user_api_key**](docs/UserApi.md#set_user_api_key) | **POST** /api/user/set_api_key | Set User Api Key
142
+ *TrieveRubyClient::UserApi* | [**delete_user_api_key**](docs/UserApi.md#delete_user_api_key) | **DELETE** /api/user/api_key/{api_key_id} | Delete User Api Key
143
+ *TrieveRubyClient::UserApi* | [**set_user_api_key**](docs/UserApi.md#set_user_api_key) | **POST** /api/user/api_key | Set User Api Key
144
144
  *TrieveRubyClient::UserApi* | [**update_user**](docs/UserApi.md#update_user) | **PUT** /api/user | Update User
145
145
 
146
146
 
@@ -158,7 +158,7 @@ Class | Method | HTTP request | Description
158
158
  - [TrieveRubyClient::ChunkGroup](docs/ChunkGroup.md)
159
159
  - [TrieveRubyClient::ChunkGroupAndFile](docs/ChunkGroupAndFile.md)
160
160
  - [TrieveRubyClient::ChunkMetadata](docs/ChunkMetadata.md)
161
- - [TrieveRubyClient::ChunkMetadataWithFileData](docs/ChunkMetadataWithFileData.md)
161
+ - [TrieveRubyClient::ChunkMetadataWithScore](docs/ChunkMetadataWithScore.md)
162
162
  - [TrieveRubyClient::ClientDatasetConfiguration](docs/ClientDatasetConfiguration.md)
163
163
  - [TrieveRubyClient::CreateChunkData](docs/CreateChunkData.md)
164
164
  - [TrieveRubyClient::CreateChunkGroupData](docs/CreateChunkGroupData.md)
@@ -183,8 +183,8 @@ Class | Method | HTTP request | Description
183
183
  - [TrieveRubyClient::GetEventsData](docs/GetEventsData.md)
184
184
  - [TrieveRubyClient::GetGroupsForChunksData](docs/GetGroupsForChunksData.md)
185
185
  - [TrieveRubyClient::GroupData](docs/GroupData.md)
186
- - [TrieveRubyClient::GroupScoreChunkDTO](docs/GroupScoreChunkDTO.md)
187
- - [TrieveRubyClient::GroupSlimChunksDTO](docs/GroupSlimChunksDTO.md)
186
+ - [TrieveRubyClient::GroupScoreChunk](docs/GroupScoreChunk.md)
187
+ - [TrieveRubyClient::GroupScoreSlimChunks](docs/GroupScoreSlimChunks.md)
188
188
  - [TrieveRubyClient::InvitationData](docs/InvitationData.md)
189
189
  - [TrieveRubyClient::MatchCondition](docs/MatchCondition.md)
190
190
  - [TrieveRubyClient::Message](docs/Message.md)
@@ -193,8 +193,6 @@ Class | Method | HTTP request | Description
193
193
  - [TrieveRubyClient::Range](docs/Range.md)
194
194
  - [TrieveRubyClient::RangeCondition](docs/RangeCondition.md)
195
195
  - [TrieveRubyClient::RecommendChunksRequest](docs/RecommendChunksRequest.md)
196
- - [TrieveRubyClient::RecommendChunksResponseTypes](docs/RecommendChunksResponseTypes.md)
197
- - [TrieveRubyClient::RecommendGroupChunkResponseTypes](docs/RecommendGroupChunkResponseTypes.md)
198
196
  - [TrieveRubyClient::RecommendGroupChunksRequest](docs/RecommendGroupChunksRequest.md)
199
197
  - [TrieveRubyClient::RegenerateMessageData](docs/RegenerateMessageData.md)
200
198
  - [TrieveRubyClient::ReturnQueuedChunk](docs/ReturnQueuedChunk.md)
@@ -202,20 +200,18 @@ Class | Method | HTTP request | Description
202
200
  - [TrieveRubyClient::ScoreSlimChunks](docs/ScoreSlimChunks.md)
203
201
  - [TrieveRubyClient::SearchChunkData](docs/SearchChunkData.md)
204
202
  - [TrieveRubyClient::SearchChunkQueryResponseBody](docs/SearchChunkQueryResponseBody.md)
205
- - [TrieveRubyClient::SearchChunkResponseTypes](docs/SearchChunkResponseTypes.md)
206
- - [TrieveRubyClient::SearchGroupSlimChunksResult](docs/SearchGroupSlimChunksResult.md)
207
- - [TrieveRubyClient::SearchGroupsResult](docs/SearchGroupsResult.md)
208
203
  - [TrieveRubyClient::SearchOverGroupsData](docs/SearchOverGroupsData.md)
209
- - [TrieveRubyClient::SearchOverGroupsResponseBody](docs/SearchOverGroupsResponseBody.md)
210
- - [TrieveRubyClient::SearchOverGroupsResponseTypes](docs/SearchOverGroupsResponseTypes.md)
211
- - [TrieveRubyClient::SearchOverGroupsSlimChunksResponseBody](docs/SearchOverGroupsSlimChunksResponseBody.md)
204
+ - [TrieveRubyClient::SearchOverGroupsResults](docs/SearchOverGroupsResults.md)
205
+ - [TrieveRubyClient::SearchOverGroupsSlimResults](docs/SearchOverGroupsSlimResults.md)
212
206
  - [TrieveRubyClient::SearchSlimChunkQueryResponseBody](docs/SearchSlimChunkQueryResponseBody.md)
213
207
  - [TrieveRubyClient::SearchWithinGroupData](docs/SearchWithinGroupData.md)
214
- - [TrieveRubyClient::SearchWithinGroupResponseTypes](docs/SearchWithinGroupResponseTypes.md)
208
+ - [TrieveRubyClient::SearchWithinGroupResults](docs/SearchWithinGroupResults.md)
209
+ - [TrieveRubyClient::SearchWithinGroupSlimResults](docs/SearchWithinGroupSlimResults.md)
215
210
  - [TrieveRubyClient::SetUserApiKeyRequest](docs/SetUserApiKeyRequest.md)
216
211
  - [TrieveRubyClient::SetUserApiKeyResponse](docs/SetUserApiKeyResponse.md)
217
212
  - [TrieveRubyClient::SingleQueuedChunkResponse](docs/SingleQueuedChunkResponse.md)
218
213
  - [TrieveRubyClient::SlimChunkMetadata](docs/SlimChunkMetadata.md)
214
+ - [TrieveRubyClient::SlimChunkMetadataWithScore](docs/SlimChunkMetadataWithScore.md)
219
215
  - [TrieveRubyClient::SlimGroup](docs/SlimGroup.md)
220
216
  - [TrieveRubyClient::SlimUser](docs/SlimUser.md)
221
217
  - [TrieveRubyClient::StripePlan](docs/StripePlan.md)
data/docs/BookmarkData.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **chunks** | [**Array<ChunkMetadataWithFileData>**](ChunkMetadataWithFileData.md) | | |
7
+ | **chunks** | [**Array<ChunkMetadata>**](ChunkMetadata.md) | | |
8
8
  | **group** | [**ChunkGroup**](ChunkGroup.md) | | |
9
9
  | **total_pages** | **Integer** | | |
10
10
 
data/docs/ChunkApi.md CHANGED
@@ -528,7 +528,7 @@ end
528
528
 
529
529
  ## get_recommended_chunks
530
530
 
531
- > <RecommendChunksResponseTypes> get_recommended_chunks(tr_dataset, recommend_chunks_request)
531
+ > <Array<ChunkMetadataWithScore>> get_recommended_chunks(tr_dataset, recommend_chunks_request)
532
532
 
533
533
  Get Recommended Chunks
534
534
 
@@ -564,7 +564,7 @@ end
564
564
 
565
565
  This returns an Array which contains the response data, status code and headers.
566
566
 
567
- > <Array(<RecommendChunksResponseTypes>, Integer, Hash)> get_recommended_chunks_with_http_info(tr_dataset, recommend_chunks_request)
567
+ > <Array(<Array<ChunkMetadataWithScore>>, Integer, Hash)> get_recommended_chunks_with_http_info(tr_dataset, recommend_chunks_request)
568
568
 
569
569
  ```ruby
570
570
  begin
@@ -572,7 +572,7 @@ begin
572
572
  data, status_code, headers = api_instance.get_recommended_chunks_with_http_info(tr_dataset, recommend_chunks_request)
573
573
  p status_code # => 2xx
574
574
  p headers # => { ... }
575
- p data # => <RecommendChunksResponseTypes>
575
+ p data # => <Array<ChunkMetadataWithScore>>
576
576
  rescue TrieveRubyClient::ApiError => e
577
577
  puts "Error when calling ChunkApi->get_recommended_chunks_with_http_info: #{e}"
578
578
  end
@@ -587,7 +587,7 @@ end
587
587
 
588
588
  ### Return type
589
589
 
590
- [**RecommendChunksResponseTypes**](RecommendChunksResponseTypes.md)
590
+ [**Array&lt;ChunkMetadataWithScore&gt;**](ChunkMetadataWithScore.md)
591
591
 
592
592
  ### Authorization
593
593
 
@@ -601,7 +601,7 @@ end
601
601
 
602
602
  ## search_chunk
603
603
 
604
- > <SearchChunkResponseTypes> search_chunk(tr_dataset, search_chunk_data)
604
+ > <SearchChunkQueryResponseBody> search_chunk(tr_dataset, search_chunk_data)
605
605
 
606
606
  Search
607
607
 
@@ -637,7 +637,7 @@ end
637
637
 
638
638
  This returns an Array which contains the response data, status code and headers.
639
639
 
640
- > <Array(<SearchChunkResponseTypes>, Integer, Hash)> search_chunk_with_http_info(tr_dataset, search_chunk_data)
640
+ > <Array(<SearchChunkQueryResponseBody>, Integer, Hash)> search_chunk_with_http_info(tr_dataset, search_chunk_data)
641
641
 
642
642
  ```ruby
643
643
  begin
@@ -645,7 +645,7 @@ begin
645
645
  data, status_code, headers = api_instance.search_chunk_with_http_info(tr_dataset, search_chunk_data)
646
646
  p status_code # => 2xx
647
647
  p headers # => { ... }
648
- p data # => <SearchChunkResponseTypes>
648
+ p data # => <SearchChunkQueryResponseBody>
649
649
  rescue TrieveRubyClient::ApiError => e
650
650
  puts "Error when calling ChunkApi->search_chunk_with_http_info: #{e}"
651
651
  end
@@ -660,7 +660,7 @@ end
660
660
 
661
661
  ### Return type
662
662
 
663
- [**SearchChunkResponseTypes**](SearchChunkResponseTypes.md)
663
+ [**SearchChunkQueryResponseBody**](SearchChunkQueryResponseBody.md)
664
664
 
665
665
  ### Authorization
666
666
 
@@ -194,7 +194,7 @@ end
194
194
 
195
195
  api_instance = TrieveRubyClient::ChunkGroupApi.new
196
196
  tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
197
- create_chunk_group_data = TrieveRubyClient::CreateChunkGroupData.new({description: 'description_example', name: 'name_example'}) # CreateChunkGroupData | JSON request payload to cretea a chunkGroup
197
+ create_chunk_group_data = TrieveRubyClient::CreateChunkGroupData.new({name: 'name_example'}) # CreateChunkGroupData | JSON request payload to cretea a chunkGroup
198
198
 
199
199
  begin
200
200
  # Create Chunk Group
@@ -761,7 +761,7 @@ end
761
761
 
762
762
  ## get_recommended_groups
763
763
 
764
- > <RecommendGroupChunkResponseTypes> get_recommended_groups(tr_dataset, recommend_group_chunks_request)
764
+ > <Array<GroupScoreChunk>> get_recommended_groups(tr_dataset, recommend_group_chunks_request)
765
765
 
766
766
  Get Recommended Groups
767
767
 
@@ -797,7 +797,7 @@ end
797
797
 
798
798
  This returns an Array which contains the response data, status code and headers.
799
799
 
800
- > <Array(<RecommendGroupChunkResponseTypes>, Integer, Hash)> get_recommended_groups_with_http_info(tr_dataset, recommend_group_chunks_request)
800
+ > <Array(<Array<GroupScoreChunk>>, Integer, Hash)> get_recommended_groups_with_http_info(tr_dataset, recommend_group_chunks_request)
801
801
 
802
802
  ```ruby
803
803
  begin
@@ -805,7 +805,7 @@ begin
805
805
  data, status_code, headers = api_instance.get_recommended_groups_with_http_info(tr_dataset, recommend_group_chunks_request)
806
806
  p status_code # => 2xx
807
807
  p headers # => { ... }
808
- p data # => <RecommendGroupChunkResponseTypes>
808
+ p data # => <Array<GroupScoreChunk>>
809
809
  rescue TrieveRubyClient::ApiError => e
810
810
  puts "Error when calling ChunkGroupApi->get_recommended_groups_with_http_info: #{e}"
811
811
  end
@@ -820,7 +820,7 @@ end
820
820
 
821
821
  ### Return type
822
822
 
823
- [**RecommendGroupChunkResponseTypes**](RecommendGroupChunkResponseTypes.md)
823
+ [**Array&lt;GroupScoreChunk&gt;**](GroupScoreChunk.md)
824
824
 
825
825
  ### Authorization
826
826
 
@@ -931,7 +931,7 @@ end
931
931
  api_instance = TrieveRubyClient::ChunkGroupApi.new
932
932
  tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
933
933
  group_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Id of the group to remove the bookmark'ed chunk from
934
- create_chunk_group_data = TrieveRubyClient::CreateChunkGroupData.new({description: 'description_example', name: 'name_example'}) # CreateChunkGroupData | JSON request payload to cretea a chunkGroup
934
+ create_chunk_group_data = TrieveRubyClient::CreateChunkGroupData.new({name: 'name_example'}) # CreateChunkGroupData | JSON request payload to cretea a chunkGroup
935
935
 
936
936
  begin
937
937
  # Remove Chunk from Group
@@ -983,7 +983,7 @@ nil (empty response body)
983
983
 
984
984
  ## search_over_groups
985
985
 
986
- > <SearchOverGroupsResponseTypes> search_over_groups(tr_dataset, search_over_groups_data)
986
+ > <SearchOverGroupsResults> search_over_groups(tr_dataset, search_over_groups_data)
987
987
 
988
988
  Search Over Groups
989
989
 
@@ -1019,7 +1019,7 @@ end
1019
1019
 
1020
1020
  This returns an Array which contains the response data, status code and headers.
1021
1021
 
1022
- > <Array(<SearchOverGroupsResponseTypes>, Integer, Hash)> search_over_groups_with_http_info(tr_dataset, search_over_groups_data)
1022
+ > <Array(<SearchOverGroupsResults>, Integer, Hash)> search_over_groups_with_http_info(tr_dataset, search_over_groups_data)
1023
1023
 
1024
1024
  ```ruby
1025
1025
  begin
@@ -1027,7 +1027,7 @@ begin
1027
1027
  data, status_code, headers = api_instance.search_over_groups_with_http_info(tr_dataset, search_over_groups_data)
1028
1028
  p status_code # => 2xx
1029
1029
  p headers # => { ... }
1030
- p data # => <SearchOverGroupsResponseTypes>
1030
+ p data # => <SearchOverGroupsResults>
1031
1031
  rescue TrieveRubyClient::ApiError => e
1032
1032
  puts "Error when calling ChunkGroupApi->search_over_groups_with_http_info: #{e}"
1033
1033
  end
@@ -1042,7 +1042,7 @@ end
1042
1042
 
1043
1043
  ### Return type
1044
1044
 
1045
- [**SearchOverGroupsResponseTypes**](SearchOverGroupsResponseTypes.md)
1045
+ [**SearchOverGroupsResults**](SearchOverGroupsResults.md)
1046
1046
 
1047
1047
  ### Authorization
1048
1048
 
@@ -1056,7 +1056,7 @@ end
1056
1056
 
1057
1057
  ## search_within_group
1058
1058
 
1059
- > <SearchWithinGroupResponseTypes> search_within_group(tr_dataset, search_within_group_data)
1059
+ > <SearchWithinGroupResults> search_within_group(tr_dataset, search_within_group_data)
1060
1060
 
1061
1061
  Search Within Group
1062
1062
 
@@ -1092,7 +1092,7 @@ end
1092
1092
 
1093
1093
  This returns an Array which contains the response data, status code and headers.
1094
1094
 
1095
- > <Array(<SearchWithinGroupResponseTypes>, Integer, Hash)> search_within_group_with_http_info(tr_dataset, search_within_group_data)
1095
+ > <Array(<SearchWithinGroupResults>, Integer, Hash)> search_within_group_with_http_info(tr_dataset, search_within_group_data)
1096
1096
 
1097
1097
  ```ruby
1098
1098
  begin
@@ -1100,7 +1100,7 @@ begin
1100
1100
  data, status_code, headers = api_instance.search_within_group_with_http_info(tr_dataset, search_within_group_data)
1101
1101
  p status_code # => 2xx
1102
1102
  p headers # => { ... }
1103
- p data # => <SearchWithinGroupResponseTypes>
1103
+ p data # => <SearchWithinGroupResults>
1104
1104
  rescue TrieveRubyClient::ApiError => e
1105
1105
  puts "Error when calling ChunkGroupApi->search_within_group_with_http_info: #{e}"
1106
1106
  end
@@ -1115,7 +1115,7 @@ end
1115
1115
 
1116
1116
  ### Return type
1117
1117
 
1118
- [**SearchWithinGroupResponseTypes**](SearchWithinGroupResponseTypes.md)
1118
+ [**SearchWithinGroupResults**](SearchWithinGroupResults.md)
1119
1119
 
1120
1120
  ### Authorization
1121
1121
 
@@ -0,0 +1,44 @@
1
+ # TrieveRubyClient::ChunkMetadataWithScore
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **chunk_html** | **String** | | [optional] |
8
+ | **content** | **String** | | |
9
+ | **created_at** | **Time** | | |
10
+ | **dataset_id** | **String** | | |
11
+ | **id** | **String** | | |
12
+ | **link** | **String** | | [optional] |
13
+ | **metadata** | **Object** | | [optional] |
14
+ | **qdrant_point_id** | **String** | | [optional] |
15
+ | **score** | **Float** | | |
16
+ | **tag_set** | **String** | | [optional] |
17
+ | **time_stamp** | **Time** | | [optional] |
18
+ | **tracking_id** | **String** | | [optional] |
19
+ | **updated_at** | **Time** | | |
20
+ | **weight** | **Float** | | |
21
+
22
+ ## Example
23
+
24
+ ```ruby
25
+ require 'trieve_ruby_client'
26
+
27
+ instance = TrieveRubyClient::ChunkMetadataWithScore.new(
28
+ chunk_html: null,
29
+ content: null,
30
+ created_at: null,
31
+ dataset_id: null,
32
+ id: null,
33
+ link: null,
34
+ metadata: null,
35
+ qdrant_point_id: null,
36
+ score: null,
37
+ tag_set: null,
38
+ time_stamp: null,
39
+ tracking_id: null,
40
+ updated_at: null,
41
+ weight: null
42
+ )
43
+ ```
44
+
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **description** | **String** | Description to assign to the chunk_group. Convenience field for you to avoid having to remember what the group is for. | |
7
+ | **description** | **String** | Description to assign to the chunk_group. Convenience field for you to avoid having to remember what the group is for. | [optional] |
8
8
  | **metadata** | **Object** | Optional metadata to assign to the chunk_group. This is a JSON object that can store any additional information you want to associate with the chunks inside of the chunk_group. | [optional] |
9
9
  | **name** | **String** | Name to assign to the chunk_group. Does not need to be unique. | |
10
10
  | **tag_set** | **Array&lt;String&gt;** | Optional tags to assign to the chunk_group. This is a list of strings that can be used to categorize the chunks inside the chunk_group. | [optional] |
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **event_types** | **Array&lt;String&gt;** | The types of events to get. Any combination of file_uploaded, card_uploaded, card_action_failed, or card_updated. Leave undefined to get all events. | [optional] |
7
+ | **event_types** | **Array&lt;String&gt;** | The types of events to get. Any combination of file_uploaded, chunk_uploaded, chunk_action_failed, or chunk_updated. Leave undefined to get all events. | [optional] |
8
8
  | **page** | **Integer** | The page number to get. Default is 1. | [optional] |
9
9
  | **page_size** | **Integer** | The number of items per page. Default is 10. | [optional] |
10
10
 
@@ -0,0 +1,22 @@
1
+ # TrieveRubyClient::GroupScoreChunk
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **group_id** | **String** | | |
8
+ | **group_tracking_id** | **String** | | [optional] |
9
+ | **metadata** | [**Array&lt;ScoreChunkDTO&gt;**](ScoreChunkDTO.md) | | |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'trieve_ruby_client'
15
+
16
+ instance = TrieveRubyClient::GroupScoreChunk.new(
17
+ group_id: null,
18
+ group_tracking_id: null,
19
+ metadata: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,20 @@
1
+ # TrieveRubyClient::GroupScoreSlimChunks
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **group_id** | **String** | | |
8
+ | **metadata** | [**Array&lt;ScoreSlimChunks&gt;**](ScoreSlimChunks.md) | | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'trieve_ruby_client'
14
+
15
+ instance = TrieveRubyClient::GroupScoreSlimChunks.new(
16
+ group_id: null,
17
+ metadata: null
18
+ )
19
+ ```
20
+
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **metadata** | [**Array&lt;ChunkMetadataWithFileData&gt;**](ChunkMetadataWithFileData.md) | | |
7
+ | **metadata** | [**Array&lt;ChunkMetadata&gt;**](ChunkMetadata.md) | | |
8
8
  | **score** | **Float** | | |
9
9
 
10
10
  ## Example
@@ -0,0 +1,20 @@
1
+ # TrieveRubyClient::SearchOverGroupsResults
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **group_chunks** | [**Array&lt;GroupScoreChunk&gt;**](GroupScoreChunk.md) | | |
8
+ | **total_chunk_pages** | **Integer** | | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'trieve_ruby_client'
14
+
15
+ instance = TrieveRubyClient::SearchOverGroupsResults.new(
16
+ group_chunks: null,
17
+ total_chunk_pages: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,20 @@
1
+ # TrieveRubyClient::SearchOverGroupsSlimResults
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **group_chunks** | [**Array&lt;GroupScoreSlimChunks&gt;**](GroupScoreSlimChunks.md) | | |
8
+ | **total_chunk_pages** | **Integer** | | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'trieve_ruby_client'
14
+
15
+ instance = TrieveRubyClient::SearchOverGroupsSlimResults.new(
16
+ group_chunks: null,
17
+ total_chunk_pages: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,22 @@
1
+ # TrieveRubyClient::SearchWithinGroupResults
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **bookmarks** | [**Array&lt;ScoreChunkDTO&gt;**](ScoreChunkDTO.md) | | |
8
+ | **group** | [**ChunkGroup**](ChunkGroup.md) | | |
9
+ | **total_pages** | **Integer** | | |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'trieve_ruby_client'
15
+
16
+ instance = TrieveRubyClient::SearchWithinGroupResults.new(
17
+ bookmarks: null,
18
+ group: null,
19
+ total_pages: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,22 @@
1
+ # TrieveRubyClient::SearchWithinGroupSlimResults
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **bookmarks** | [**Array&lt;ScoreSlimChunks&gt;**](ScoreSlimChunks.md) | | |
8
+ | **group** | [**ChunkGroup**](ChunkGroup.md) | | |
9
+ | **total_pages** | **Integer** | | |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'trieve_ruby_client'
15
+
16
+ instance = TrieveRubyClient::SearchWithinGroupSlimResults.new(
17
+ bookmarks: null,
18
+ group: null,
19
+ total_pages: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,38 @@
1
+ # TrieveRubyClient::SlimChunkMetadataWithScore
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **created_at** | **Time** | | |
8
+ | **id** | **String** | | |
9
+ | **link** | **String** | | [optional] |
10
+ | **metadata** | **Object** | | [optional] |
11
+ | **qdrant_point_id** | **String** | | [optional] |
12
+ | **score** | **Float** | | |
13
+ | **tag_set** | **String** | | [optional] |
14
+ | **time_stamp** | **Time** | | [optional] |
15
+ | **tracking_id** | **String** | | [optional] |
16
+ | **updated_at** | **Time** | | |
17
+ | **weight** | **Float** | | |
18
+
19
+ ## Example
20
+
21
+ ```ruby
22
+ require 'trieve_ruby_client'
23
+
24
+ instance = TrieveRubyClient::SlimChunkMetadataWithScore.new(
25
+ created_at: null,
26
+ id: null,
27
+ link: null,
28
+ metadata: null,
29
+ qdrant_point_id: null,
30
+ score: null,
31
+ tag_set: null,
32
+ time_stamp: null,
33
+ tracking_id: null,
34
+ updated_at: null,
35
+ weight: null
36
+ )
37
+ ```
38
+
data/docs/UserApi.md CHANGED
@@ -4,8 +4,8 @@ All URIs are relative to *https://api.trieve.ai*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
7
- | [**delete_user_api_key**](UserApi.md#delete_user_api_key) | **DELETE** /api/user/delete_api_key/{api_key_id} | Delete User Api Key |
8
- | [**set_user_api_key**](UserApi.md#set_user_api_key) | **POST** /api/user/set_api_key | Set User Api Key |
7
+ | [**delete_user_api_key**](UserApi.md#delete_user_api_key) | **DELETE** /api/user/api_key/{api_key_id} | Delete User Api Key |
8
+ | [**set_user_api_key**](UserApi.md#set_user_api_key) | **POST** /api/user/api_key | Set User Api Key |
9
9
  | [**update_user**](UserApi.md#update_user) | **PUT** /api/user | Update User |
10
10
 
11
11
 
@@ -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.2
7
7
  Contact: developers@trieve.ai
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.4.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
5
5
 
6
- The version of the OpenAPI document: 0.6.0
6
+ The version of the OpenAPI document: 0.6.2
7
7
  Contact: developers@trieve.ai
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.4.0
@@ -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 [RecommendChunksResponseTypes]
532
+ # @return [Array<ChunkMetadataWithScore>]
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<(RecommendChunksResponseTypes, Integer, Hash)>] RecommendChunksResponseTypes data, response status code and response headers
543
+ # @return [Array<(Array<ChunkMetadataWithScore>, Integer, Hash)>] Array<ChunkMetadataWithScore> 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] || 'RecommendChunksResponseTypes'
580
+ return_type = opts[:debug_return_type] || 'Array<ChunkMetadataWithScore>'
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 [SearchChunkResponseTypes]
607
+ # @return [SearchChunkQueryResponseBody]
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<(SearchChunkResponseTypes, Integer, Hash)>] SearchChunkResponseTypes data, response status code and response headers
618
+ # @return [Array<(SearchChunkQueryResponseBody, Integer, Hash)>] SearchChunkQueryResponseBody 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] || 'SearchChunkResponseTypes'
655
+ return_type = opts[:debug_return_type] || 'SearchChunkQueryResponseBody'
656
656
 
657
657
  # auth_names
658
658
  auth_names = opts[:debug_auth_names] || ['ApiKey']