trieve_ruby_client 0.5.7 → 0.6.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +16 -20
- data/docs/AddChunkToGroupData.md +4 -2
- data/docs/AuthApi.md +12 -6
- data/docs/BookmarkData.md +1 -1
- data/docs/ChunkApi.md +8 -8
- data/docs/ChunkGroup.md +4 -0
- data/docs/ChunkGroupApi.md +25 -25
- data/docs/ChunkMetadataWithScore.md +44 -0
- data/docs/CreateChunkGroupData.md +5 -1
- data/docs/DatasetApi.md +6 -6
- data/docs/EventsApi.md +1 -1
- data/docs/FileApi.md +2 -2
- data/docs/GetEventsData.md +1 -1
- data/docs/GroupScoreChunk.md +22 -0
- data/docs/GroupScoreSlimChunks.md +20 -0
- data/docs/RecommendChunksRequest.md +3 -1
- data/docs/RecommendGroupChunksRequest.md +34 -0
- data/docs/ScoreChunkDTO.md +1 -1
- data/docs/SearchChunkData.md +1 -3
- data/docs/SearchOverGroupsData.md +3 -5
- data/docs/SearchOverGroupsResults.md +20 -0
- data/docs/SearchOverGroupsSlimResults.md +20 -0
- data/docs/SearchWithinGroupData.md +1 -3
- data/docs/SearchWithinGroupResults.md +22 -0
- data/docs/SearchWithinGroupSlimResults.md +22 -0
- data/docs/SlimChunkMetadataWithScore.md +38 -0
- data/docs/UpdateChunkGroupData.md +4 -0
- data/docs/UpdateGroupByTrackingIDData.md +4 -0
- data/docs/UserApi.md +2 -2
- data/lib/trieve_ruby_client/api/auth_api.rb +13 -11
- data/lib/trieve_ruby_client/api/chunk_api.rb +7 -7
- data/lib/trieve_ruby_client/api/chunk_group_api.rb +27 -27
- data/lib/trieve_ruby_client/api/dataset_api.rb +10 -10
- data/lib/trieve_ruby_client/api/events_api.rb +3 -3
- data/lib/trieve_ruby_client/api/file_api.rb +5 -5
- data/lib/trieve_ruby_client/api/health_api.rb +1 -1
- data/lib/trieve_ruby_client/api/invitation_api.rb +1 -1
- data/lib/trieve_ruby_client/api/message_api.rb +1 -1
- data/lib/trieve_ruby_client/api/organization_api.rb +1 -1
- data/lib/trieve_ruby_client/api/stripe_api.rb +1 -1
- data/lib/trieve_ruby_client/api/topic_api.rb +1 -1
- data/lib/trieve_ruby_client/api/user_api.rb +3 -3
- data/lib/trieve_ruby_client/api_client.rb +1 -1
- data/lib/trieve_ruby_client/api_error.rb +1 -1
- data/lib/trieve_ruby_client/configuration.rb +1 -1
- data/lib/trieve_ruby_client/models/add_chunk_to_group_data.rb +17 -12
- data/lib/trieve_ruby_client/models/api_key_dto.rb +1 -1
- data/lib/trieve_ruby_client/models/auth_query.rb +1 -1
- data/lib/trieve_ruby_client/models/batch_queued_chunk_response.rb +1 -1
- data/lib/trieve_ruby_client/models/bookmark_data.rb +2 -2
- data/lib/trieve_ruby_client/models/bookmark_group_result.rb +1 -1
- data/lib/trieve_ruby_client/models/chat_message_proxy.rb +1 -1
- data/lib/trieve_ruby_client/models/chunk_data.rb +1 -1
- data/lib/trieve_ruby_client/models/chunk_filter.rb +1 -1
- data/lib/trieve_ruby_client/models/chunk_group.rb +22 -2
- data/lib/trieve_ruby_client/models/chunk_group_and_file.rb +1 -1
- data/lib/trieve_ruby_client/models/chunk_metadata.rb +1 -1
- data/lib/trieve_ruby_client/models/chunk_metadata_with_file_data.rb +1 -1
- data/lib/trieve_ruby_client/models/chunk_metadata_with_score.rb +387 -0
- data/lib/trieve_ruby_client/models/client_dataset_configuration.rb +1 -1
- data/lib/trieve_ruby_client/models/create_chunk_data.rb +1 -1
- data/lib/trieve_ruby_client/models/create_chunk_group_data.rb +27 -9
- data/lib/trieve_ruby_client/models/create_dataset_request.rb +1 -1
- data/lib/trieve_ruby_client/models/create_message_data.rb +1 -1
- data/lib/trieve_ruby_client/models/create_organization_data.rb +1 -1
- data/lib/trieve_ruby_client/models/create_topic_data.rb +1 -1
- data/lib/trieve_ruby_client/models/dataset.rb +1 -1
- data/lib/trieve_ruby_client/models/dataset_and_usage.rb +1 -1
- data/lib/trieve_ruby_client/models/dataset_dto.rb +1 -1
- data/lib/trieve_ruby_client/models/dataset_usage_count.rb +1 -1
- data/lib/trieve_ruby_client/models/delete_topic_data.rb +1 -1
- data/lib/trieve_ruby_client/models/delete_user_api_key_request.rb +1 -1
- data/lib/trieve_ruby_client/models/edit_message_data.rb +1 -1
- data/lib/trieve_ruby_client/models/error_response_body.rb +1 -1
- data/lib/trieve_ruby_client/models/event.rb +1 -1
- data/lib/trieve_ruby_client/models/event_return.rb +1 -1
- data/lib/trieve_ruby_client/models/field_condition.rb +1 -1
- data/lib/trieve_ruby_client/models/file.rb +1 -1
- data/lib/trieve_ruby_client/models/file_dto.rb +1 -1
- data/lib/trieve_ruby_client/models/generate_chunks_request.rb +1 -1
- data/lib/trieve_ruby_client/models/get_events_data.rb +2 -2
- data/lib/trieve_ruby_client/models/get_groups_for_chunks_data.rb +1 -1
- data/lib/trieve_ruby_client/models/group_data.rb +1 -1
- data/lib/trieve_ruby_client/models/group_score_chunk.rb +249 -0
- data/lib/trieve_ruby_client/models/group_score_chunk_dto.rb +1 -1
- data/lib/trieve_ruby_client/models/group_score_slim_chunks.rb +239 -0
- data/lib/trieve_ruby_client/models/group_slim_chunks_dto.rb +1 -1
- data/lib/trieve_ruby_client/models/invitation_data.rb +1 -1
- data/lib/trieve_ruby_client/models/match_condition.rb +1 -1
- data/lib/trieve_ruby_client/models/message.rb +1 -1
- data/lib/trieve_ruby_client/models/organization.rb +1 -1
- data/lib/trieve_ruby_client/models/organization_usage_count.rb +1 -1
- data/lib/trieve_ruby_client/models/range.rb +1 -1
- data/lib/trieve_ruby_client/models/range_condition.rb +1 -1
- data/lib/trieve_ruby_client/models/recommend_chunks_request.rb +17 -6
- data/lib/trieve_ruby_client/models/recommend_chunks_response_types.rb +1 -1
- data/lib/trieve_ruby_client/models/recommend_group_chunk_response_types.rb +1 -1
- data/lib/trieve_ruby_client/models/recommend_group_chunks_request.rb +341 -0
- data/lib/trieve_ruby_client/models/regenerate_message_data.rb +1 -1
- data/lib/trieve_ruby_client/models/return_queued_chunk.rb +1 -1
- data/lib/trieve_ruby_client/models/score_chunk_dto.rb +2 -2
- data/lib/trieve_ruby_client/models/score_slim_chunks.rb +1 -1
- data/lib/trieve_ruby_client/models/search_chunk_data.rb +3 -14
- data/lib/trieve_ruby_client/models/search_chunk_query_response_body.rb +1 -1
- data/lib/trieve_ruby_client/models/search_chunk_response_types.rb +1 -1
- data/lib/trieve_ruby_client/models/search_group_slim_chunks_result.rb +1 -1
- data/lib/trieve_ruby_client/models/search_groups_result.rb +1 -1
- data/lib/trieve_ruby_client/models/search_over_groups_data.rb +5 -15
- data/lib/trieve_ruby_client/models/search_over_groups_response_body.rb +1 -1
- data/lib/trieve_ruby_client/models/search_over_groups_response_types.rb +1 -1
- data/lib/trieve_ruby_client/models/search_over_groups_results.rb +239 -0
- data/lib/trieve_ruby_client/models/search_over_groups_slim_chunks_response_body.rb +1 -1
- data/lib/trieve_ruby_client/models/search_over_groups_slim_results.rb +239 -0
- data/lib/trieve_ruby_client/models/search_slim_chunk_query_response_body.rb +1 -1
- data/lib/trieve_ruby_client/models/search_within_group_data.rb +3 -14
- data/lib/trieve_ruby_client/models/search_within_group_response_types.rb +1 -1
- data/lib/trieve_ruby_client/models/search_within_group_results.rb +255 -0
- data/lib/trieve_ruby_client/models/search_within_group_slim_results.rb +255 -0
- data/lib/trieve_ruby_client/models/set_user_api_key_request.rb +1 -1
- data/lib/trieve_ruby_client/models/set_user_api_key_response.rb +1 -1
- data/lib/trieve_ruby_client/models/single_queued_chunk_response.rb +1 -1
- data/lib/trieve_ruby_client/models/slim_chunk_metadata.rb +1 -1
- data/lib/trieve_ruby_client/models/slim_chunk_metadata_with_score.rb +345 -0
- data/lib/trieve_ruby_client/models/slim_group.rb +1 -1
- data/lib/trieve_ruby_client/models/slim_user.rb +1 -1
- data/lib/trieve_ruby_client/models/stripe_plan.rb +1 -1
- data/lib/trieve_ruby_client/models/suggested_queries_request.rb +1 -1
- data/lib/trieve_ruby_client/models/suggested_queries_response.rb +1 -1
- data/lib/trieve_ruby_client/models/topic.rb +1 -1
- data/lib/trieve_ruby_client/models/update_chunk_by_tracking_id_data.rb +1 -1
- data/lib/trieve_ruby_client/models/update_chunk_data.rb +1 -1
- data/lib/trieve_ruby_client/models/update_chunk_group_data.rb +26 -2
- data/lib/trieve_ruby_client/models/update_dataset_request.rb +1 -1
- data/lib/trieve_ruby_client/models/update_group_by_tracking_id_data.rb +26 -2
- data/lib/trieve_ruby_client/models/update_organization_data.rb +1 -1
- data/lib/trieve_ruby_client/models/update_topic_data.rb +1 -1
- data/lib/trieve_ruby_client/models/update_user_data.rb +1 -1
- data/lib/trieve_ruby_client/models/upload_file_data.rb +1 -1
- data/lib/trieve_ruby_client/models/upload_file_result.rb +1 -1
- data/lib/trieve_ruby_client/models/user_organization.rb +1 -1
- data/lib/trieve_ruby_client/version.rb +2 -2
- data/lib/trieve_ruby_client.rb +10 -14
- data/openapi-generator.yaml +1 -1
- data/openapi.json +386 -325
- data/spec/models/chunk_metadata_with_score_spec.rb +114 -0
- data/spec/models/group_score_chunk_spec.rb +48 -0
- data/spec/models/group_score_slim_chunks_spec.rb +42 -0
- data/spec/models/recommend_group_chunks_request_spec.rb +84 -0
- data/spec/models/search_over_groups_results_spec.rb +42 -0
- data/spec/models/search_over_groups_slim_results_spec.rb +42 -0
- data/spec/models/search_within_group_results_spec.rb +48 -0
- data/spec/models/search_within_group_slim_results_spec.rb +48 -0
- data/spec/models/slim_chunk_metadata_with_score_spec.rb +96 -0
- data/spec/spec_helper.rb +1 -1
- data/trieve_ruby_client-0.5.7.gem +0 -0
- data/trieve_ruby_client-0.6.0.gem +0 -0
- data/trieve_ruby_client.gemspec +1 -1
- metadata +40 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: a535668b86dc6d7a9c34dbf5f73599b5cb779ca38d16c4e59dc4fec8bf40dfd3
|
4
|
+
data.tar.gz: dce36c7454918e72708d1cbf0c349175d86438450910502269e1bbc4f918f60e
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
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.
|
10
|
-
- Package version: 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.
|
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.
|
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.
|
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/
|
143
|
-
*TrieveRubyClient::UserApi* | [**set_user_api_key**](docs/UserApi.md#set_user_api_key) | **POST** /api/user/
|
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::
|
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::
|
187
|
-
- [TrieveRubyClient::
|
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)
|
@@ -192,30 +192,26 @@ Class | Method | HTTP request | Description
|
|
192
192
|
- [TrieveRubyClient::OrganizationUsageCount](docs/OrganizationUsageCount.md)
|
193
193
|
- [TrieveRubyClient::Range](docs/Range.md)
|
194
194
|
- [TrieveRubyClient::RangeCondition](docs/RangeCondition.md)
|
195
|
-
- [TrieveRubyClient::ReccomendGroupChunksRequest](docs/ReccomendGroupChunksRequest.md)
|
196
195
|
- [TrieveRubyClient::RecommendChunksRequest](docs/RecommendChunksRequest.md)
|
197
|
-
- [TrieveRubyClient::
|
198
|
-
- [TrieveRubyClient::RecommendGroupChunkResponseTypes](docs/RecommendGroupChunkResponseTypes.md)
|
196
|
+
- [TrieveRubyClient::RecommendGroupChunksRequest](docs/RecommendGroupChunksRequest.md)
|
199
197
|
- [TrieveRubyClient::RegenerateMessageData](docs/RegenerateMessageData.md)
|
200
198
|
- [TrieveRubyClient::ReturnQueuedChunk](docs/ReturnQueuedChunk.md)
|
201
199
|
- [TrieveRubyClient::ScoreChunkDTO](docs/ScoreChunkDTO.md)
|
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::
|
210
|
-
- [TrieveRubyClient::
|
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::
|
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/AddChunkToGroupData.md
CHANGED
@@ -4,7 +4,8 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **chunk_id** | **String** | Id of the chunk to make a member of the group. |
|
7
|
+
| **chunk_id** | **String** | Id of the chunk to make a member of the group. | [optional] |
|
8
|
+
| **tracking_id** | **String** | Tracking Id of the chunk to make a member of the group. | [optional] |
|
8
9
|
|
9
10
|
## Example
|
10
11
|
|
@@ -12,7 +13,8 @@
|
|
12
13
|
require 'trieve_ruby_client'
|
13
14
|
|
14
15
|
instance = TrieveRubyClient::AddChunkToGroupData.new(
|
15
|
-
chunk_id: null
|
16
|
+
chunk_id: null,
|
17
|
+
tracking_id: null
|
16
18
|
)
|
17
19
|
```
|
18
20
|
|
data/docs/AuthApi.md
CHANGED
@@ -141,7 +141,7 @@ This endpoint does not need any parameter.
|
|
141
141
|
|
142
142
|
## login
|
143
143
|
|
144
|
-
> login(
|
144
|
+
> login(opts)
|
145
145
|
|
146
146
|
Login
|
147
147
|
|
@@ -154,11 +154,15 @@ require 'time'
|
|
154
154
|
require 'trieve_ruby_client'
|
155
155
|
|
156
156
|
api_instance = TrieveRubyClient::AuthApi.new
|
157
|
-
|
157
|
+
opts = {
|
158
|
+
organization_id: '38400000-8cf0-11bd-b23e-10b96e4ef00d', # String | ID of organization to authenticate into
|
159
|
+
redirect_uri: 'redirect_uri_example', # String | URL to redirect to after successful login
|
160
|
+
inv_code: '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Code sent via email as a result of successful call to send_invitation
|
161
|
+
}
|
158
162
|
|
159
163
|
begin
|
160
164
|
# Login
|
161
|
-
api_instance.login(
|
165
|
+
api_instance.login(opts)
|
162
166
|
rescue TrieveRubyClient::ApiError => e
|
163
167
|
puts "Error when calling AuthApi->login: #{e}"
|
164
168
|
end
|
@@ -168,12 +172,12 @@ end
|
|
168
172
|
|
169
173
|
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
170
174
|
|
171
|
-
> <Array(nil, Integer, Hash)> login_with_http_info(
|
175
|
+
> <Array(nil, Integer, Hash)> login_with_http_info(opts)
|
172
176
|
|
173
177
|
```ruby
|
174
178
|
begin
|
175
179
|
# Login
|
176
|
-
data, status_code, headers = api_instance.login_with_http_info(
|
180
|
+
data, status_code, headers = api_instance.login_with_http_info(opts)
|
177
181
|
p status_code # => 2xx
|
178
182
|
p headers # => { ... }
|
179
183
|
p data # => nil
|
@@ -186,7 +190,9 @@ end
|
|
186
190
|
|
187
191
|
| Name | Type | Description | Notes |
|
188
192
|
| ---- | ---- | ----------- | ----- |
|
189
|
-
| **
|
193
|
+
| **organization_id** | **String** | ID of organization to authenticate into | [optional] |
|
194
|
+
| **redirect_uri** | **String** | URL to redirect to after successful login | [optional] |
|
195
|
+
| **inv_code** | **String** | Code sent via email as a result of successful call to send_invitation | [optional] |
|
190
196
|
|
191
197
|
### Return type
|
192
198
|
|
data/docs/BookmarkData.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **chunks** | [**Array<
|
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
|
-
> <
|
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(<
|
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 # => <
|
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
|
-
[**
|
590
|
+
[**Array<ChunkMetadataWithScore>**](ChunkMetadataWithScore.md)
|
591
591
|
|
592
592
|
### Authorization
|
593
593
|
|
@@ -601,7 +601,7 @@ end
|
|
601
601
|
|
602
602
|
## search_chunk
|
603
603
|
|
604
|
-
> <
|
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(<
|
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 # => <
|
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
|
-
[**
|
663
|
+
[**SearchChunkQueryResponseBody**](SearchChunkQueryResponseBody.md)
|
664
664
|
|
665
665
|
### Authorization
|
666
666
|
|
data/docs/ChunkGroup.md
CHANGED
@@ -8,7 +8,9 @@
|
|
8
8
|
| **dataset_id** | **String** | | |
|
9
9
|
| **description** | **String** | | |
|
10
10
|
| **id** | **String** | | |
|
11
|
+
| **metadata** | **Object** | | [optional] |
|
11
12
|
| **name** | **String** | | |
|
13
|
+
| **tag_set** | **String** | | [optional] |
|
12
14
|
| **tracking_id** | **String** | | [optional] |
|
13
15
|
| **updated_at** | **Time** | | |
|
14
16
|
|
@@ -22,7 +24,9 @@ instance = TrieveRubyClient::ChunkGroup.new(
|
|
22
24
|
dataset_id: null,
|
23
25
|
description: null,
|
24
26
|
id: null,
|
27
|
+
metadata: null,
|
25
28
|
name: null,
|
29
|
+
tag_set: null,
|
26
30
|
tracking_id: null,
|
27
31
|
updated_at: null
|
28
32
|
)
|
data/docs/ChunkGroupApi.md
CHANGED
@@ -47,7 +47,7 @@ end
|
|
47
47
|
api_instance = TrieveRubyClient::ChunkGroupApi.new
|
48
48
|
tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
|
49
49
|
group_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Id of the group to add the chunk to as a bookmark
|
50
|
-
add_chunk_to_group_data = TrieveRubyClient::AddChunkToGroupData.new
|
50
|
+
add_chunk_to_group_data = TrieveRubyClient::AddChunkToGroupData.new # AddChunkToGroupData | JSON request payload to add a chunk to a group (bookmark it)
|
51
51
|
|
52
52
|
begin
|
53
53
|
# Add Chunk to Group
|
@@ -121,7 +121,7 @@ end
|
|
121
121
|
api_instance = TrieveRubyClient::ChunkGroupApi.new
|
122
122
|
tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
|
123
123
|
tracking_id = 'tracking_id_example' # String | Id of the group to add the chunk to as a bookmark
|
124
|
-
add_chunk_to_group_data = TrieveRubyClient::AddChunkToGroupData.new
|
124
|
+
add_chunk_to_group_data = TrieveRubyClient::AddChunkToGroupData.new # AddChunkToGroupData | JSON request payload to add a chunk to a group (bookmark it)
|
125
125
|
|
126
126
|
begin
|
127
127
|
# Add Chunk to Group by Tracking ID
|
@@ -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({
|
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
|
@@ -250,7 +250,7 @@ end
|
|
250
250
|
|
251
251
|
Delete Group
|
252
252
|
|
253
|
-
Delete Group This will delete a chunk_group.
|
253
|
+
Delete Group This will delete a chunk_group. If you set delete_chunks to true, it will also delete the chunks within the group.
|
254
254
|
|
255
255
|
### Examples
|
256
256
|
|
@@ -469,7 +469,7 @@ end
|
|
469
469
|
|
470
470
|
Get Chunks in Group
|
471
471
|
|
472
|
-
Get Chunks in Group Route to get all chunks for a group. The response is paginated, with each page containing 10 chunks.
|
472
|
+
Get Chunks in Group Route to get all chunks for a group. The response is paginated, with each page containing 10 chunks. Page is 1-indexed.
|
473
473
|
|
474
474
|
### Examples
|
475
475
|
|
@@ -544,7 +544,7 @@ end
|
|
544
544
|
|
545
545
|
Get Chunks in Group by Tracking ID
|
546
546
|
|
547
|
-
Get Chunks in Group by Tracking ID Route to get all chunks for a group. The response is paginated, with each page containing 10 chunks. Support for custom page size is coming soon.
|
547
|
+
Get Chunks in Group by Tracking ID Route to get all chunks for a group. The response is paginated, with each page containing 10 chunks. Support for custom page size is coming soon. Page is 1-indexed.
|
548
548
|
|
549
549
|
### Examples
|
550
550
|
|
@@ -761,7 +761,7 @@ end
|
|
761
761
|
|
762
762
|
## get_recommended_groups
|
763
763
|
|
764
|
-
> <
|
764
|
+
> <Array<GroupScoreChunk>> get_recommended_groups(tr_dataset, recommend_group_chunks_request)
|
765
765
|
|
766
766
|
Get Recommended Groups
|
767
767
|
|
@@ -782,11 +782,11 @@ end
|
|
782
782
|
|
783
783
|
api_instance = TrieveRubyClient::ChunkGroupApi.new
|
784
784
|
tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
|
785
|
-
|
785
|
+
recommend_group_chunks_request = TrieveRubyClient::RecommendGroupChunksRequest.new # RecommendGroupChunksRequest | JSON request payload to get recommendations of chunks similar to the chunks in the request
|
786
786
|
|
787
787
|
begin
|
788
788
|
# Get Recommended Groups
|
789
|
-
result = api_instance.get_recommended_groups(tr_dataset,
|
789
|
+
result = api_instance.get_recommended_groups(tr_dataset, recommend_group_chunks_request)
|
790
790
|
p result
|
791
791
|
rescue TrieveRubyClient::ApiError => e
|
792
792
|
puts "Error when calling ChunkGroupApi->get_recommended_groups: #{e}"
|
@@ -797,15 +797,15 @@ end
|
|
797
797
|
|
798
798
|
This returns an Array which contains the response data, status code and headers.
|
799
799
|
|
800
|
-
> <Array(<
|
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
|
804
804
|
# Get Recommended Groups
|
805
|
-
data, status_code, headers = api_instance.get_recommended_groups_with_http_info(tr_dataset,
|
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 # => <
|
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
|
@@ -816,11 +816,11 @@ end
|
|
816
816
|
| Name | Type | Description | Notes |
|
817
817
|
| ---- | ---- | ----------- | ----- |
|
818
818
|
| **tr_dataset** | **String** | The dataset id to use for the request | |
|
819
|
-
| **
|
819
|
+
| **recommend_group_chunks_request** | [**RecommendGroupChunksRequest**](RecommendGroupChunksRequest.md) | JSON request payload to get recommendations of chunks similar to the chunks in the request | |
|
820
820
|
|
821
821
|
### Return type
|
822
822
|
|
823
|
-
[**
|
823
|
+
[**Array<GroupScoreChunk>**](GroupScoreChunk.md)
|
824
824
|
|
825
825
|
### Authorization
|
826
826
|
|
@@ -856,7 +856,7 @@ end
|
|
856
856
|
api_instance = TrieveRubyClient::ChunkGroupApi.new
|
857
857
|
tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
|
858
858
|
dataset_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The id of the dataset to fetch groups for.
|
859
|
-
page = 789 # Integer | The page of groups to fetch.
|
859
|
+
page = 789 # Integer | The page of groups to fetch. Page is 1-indexed.
|
860
860
|
|
861
861
|
begin
|
862
862
|
# Get Groups for Dataset
|
@@ -891,7 +891,7 @@ end
|
|
891
891
|
| ---- | ---- | ----------- | ----- |
|
892
892
|
| **tr_dataset** | **String** | The dataset id to use for the request | |
|
893
893
|
| **dataset_id** | **String** | The id of the dataset to fetch groups for. | |
|
894
|
-
| **page** | **Integer** | The page of groups to fetch.
|
894
|
+
| **page** | **Integer** | The page of groups to fetch. Page is 1-indexed. | |
|
895
895
|
|
896
896
|
### Return type
|
897
897
|
|
@@ -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({
|
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
|
-
> <
|
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(<
|
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 # => <
|
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
|
-
[**
|
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
|
-
> <
|
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(<
|
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 # => <
|
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
|
-
[**
|
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,8 +4,10 @@
|
|
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
|
+
| **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] |
|
8
9
|
| **name** | **String** | Name to assign to the chunk_group. Does not need to be unique. | |
|
10
|
+
| **tag_set** | **Array<String>** | 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] |
|
9
11
|
| **tracking_id** | **String** | Optional tracking id to assign to the chunk_group. This is a unique identifier for the chunk_group. | [optional] |
|
10
12
|
|
11
13
|
## Example
|
@@ -15,7 +17,9 @@ require 'trieve_ruby_client'
|
|
15
17
|
|
16
18
|
instance = TrieveRubyClient::CreateChunkGroupData.new(
|
17
19
|
description: null,
|
20
|
+
metadata: null,
|
18
21
|
name: null,
|
22
|
+
tag_set: null,
|
19
23
|
tracking_id: null
|
20
24
|
)
|
21
25
|
```
|
data/docs/DatasetApi.md
CHANGED
@@ -87,7 +87,7 @@ end
|
|
87
87
|
|
88
88
|
## delete_dataset
|
89
89
|
|
90
|
-
> delete_dataset(
|
90
|
+
> delete_dataset(tr_dataset, dataset_id)
|
91
91
|
|
92
92
|
Delete Dataset
|
93
93
|
|
@@ -107,12 +107,12 @@ TrieveRubyClient.configure do |config|
|
|
107
107
|
end
|
108
108
|
|
109
109
|
api_instance = TrieveRubyClient::DatasetApi.new
|
110
|
-
|
110
|
+
tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
|
111
111
|
dataset_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The id of the dataset you want to delete.
|
112
112
|
|
113
113
|
begin
|
114
114
|
# Delete Dataset
|
115
|
-
api_instance.delete_dataset(
|
115
|
+
api_instance.delete_dataset(tr_dataset, dataset_id)
|
116
116
|
rescue TrieveRubyClient::ApiError => e
|
117
117
|
puts "Error when calling DatasetApi->delete_dataset: #{e}"
|
118
118
|
end
|
@@ -122,12 +122,12 @@ end
|
|
122
122
|
|
123
123
|
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
124
124
|
|
125
|
-
> <Array(nil, Integer, Hash)> delete_dataset_with_http_info(
|
125
|
+
> <Array(nil, Integer, Hash)> delete_dataset_with_http_info(tr_dataset, dataset_id)
|
126
126
|
|
127
127
|
```ruby
|
128
128
|
begin
|
129
129
|
# Delete Dataset
|
130
|
-
data, status_code, headers = api_instance.delete_dataset_with_http_info(
|
130
|
+
data, status_code, headers = api_instance.delete_dataset_with_http_info(tr_dataset, dataset_id)
|
131
131
|
p status_code # => 2xx
|
132
132
|
p headers # => { ... }
|
133
133
|
p data # => nil
|
@@ -140,7 +140,7 @@ end
|
|
140
140
|
|
141
141
|
| Name | Type | Description | Notes |
|
142
142
|
| ---- | ---- | ----------- | ----- |
|
143
|
-
| **
|
143
|
+
| **tr_dataset** | **String** | The dataset id to use for the request | |
|
144
144
|
| **dataset_id** | **String** | The id of the dataset you want to delete. | |
|
145
145
|
|
146
146
|
### Return type
|
data/docs/EventsApi.md
CHANGED
@@ -13,7 +13,7 @@ All URIs are relative to *https://api.trieve.ai*
|
|
13
13
|
|
14
14
|
Get events for the dataset
|
15
15
|
|
16
|
-
Get events for the dataset Get events for the
|
16
|
+
Get events for the dataset Get events for the dataset specified by the TR-Dataset header.
|
17
17
|
|
18
18
|
### Examples
|
19
19
|
|
data/docs/FileApi.md
CHANGED
@@ -16,7 +16,7 @@ All URIs are relative to *https://api.trieve.ai*
|
|
16
16
|
|
17
17
|
Delete File
|
18
18
|
|
19
|
-
Delete File Delete a file from S3 attached to the server based on its id. This will disassociate chunks from the file, but
|
19
|
+
Delete File Delete a file from S3 attached to the server based on its id. This will disassociate chunks from the file, but only delete them all together if you specify delete_chunks to be true. Auth'ed user must be an admin or owner of the dataset's organization to delete a file.
|
20
20
|
|
21
21
|
### Examples
|
22
22
|
|
@@ -165,7 +165,7 @@ end
|
|
165
165
|
|
166
166
|
Get File
|
167
167
|
|
168
|
-
Get File Download a file
|
168
|
+
Get File Download a file based on its id.
|
169
169
|
|
170
170
|
### Examples
|
171
171
|
|
data/docs/GetEventsData.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **event_types** | **Array<String>** | The types of events to get. Any combination of file_uploaded,
|
7
|
+
| **event_types** | **Array<String>** | 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
|
|