trieve_ruby_client 0.5.0 → 0.5.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/GENERATE_COMMAND.txt +1 -0
- data/README.md +21 -10
- data/docs/AuthApi.md +1 -1
- data/docs/ChunkApi.md +9 -9
- data/docs/ChunkGroupApi.md +25 -16
- data/docs/DatasetApi.md +9 -9
- data/docs/EventsApi.md +1 -1
- data/docs/FileApi.md +1 -1
- data/docs/GroupScoreChunkDTO.md +2 -0
- data/docs/GroupSlimChunksDTO.md +20 -0
- data/docs/HealthApi.md +1 -1
- data/docs/InvitationApi.md +1 -1
- data/docs/MessageApi.md +1 -1
- data/docs/OrganizationApi.md +1 -1
- data/docs/Range.md +4 -4
- data/docs/RangeCondition.md +49 -0
- data/docs/ReccomendGroupChunksRequest.md +3 -1
- data/docs/RecommendChunksRequest.md +3 -1
- data/docs/RecommendChunksResponseTypes.md +49 -0
- data/docs/RecommendGroupChunkResponseTypes.md +49 -0
- data/docs/ScoreSlimChunks.md +20 -0
- data/docs/SearchChunkData.md +4 -0
- data/docs/SearchChunkResponseTypes.md +49 -0
- data/docs/SearchGroupSlimChunksResult.md +22 -0
- data/docs/SearchOverGroupsData.md +5 -1
- data/docs/SearchOverGroupsResponseTypes.md +49 -0
- data/docs/SearchOverGroupsSlimChunksResponseBody.md +20 -0
- data/docs/SearchSlimChunkQueryResponseBody.md +20 -0
- data/docs/SearchWithinGroupData.md +4 -0
- data/docs/SearchWithinGroupResponseTypes.md +49 -0
- data/docs/SlimChunkMetadata.md +36 -0
- data/docs/SlimUser.md +1 -7
- data/docs/StripeApi.md +1 -1
- data/docs/TopicApi.md +9 -9
- data/docs/UpdateChunkData.md +2 -0
- data/docs/UpdateUserData.md +1 -7
- data/docs/UserApi.md +9 -9
- data/lib/trieve_ruby_client/api/auth_api.rb +1 -1
- data/lib/trieve_ruby_client/api/chunk_api.rb +7 -7
- data/lib/trieve_ruby_client/api/chunk_group_api.rb +21 -14
- data/lib/trieve_ruby_client/api/dataset_api.rb +11 -16
- data/lib/trieve_ruby_client/api/events_api.rb +1 -1
- data/lib/trieve_ruby_client/api/file_api.rb +1 -1
- 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 +11 -16
- data/lib/trieve_ruby_client/api/user_api.rb +11 -16
- 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 +7 -7
- data/lib/trieve_ruby_client/models/add_chunk_to_group_data.rb +1 -1
- 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 +1 -1
- 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 +1 -1
- 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/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 +1 -1
- 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 +1 -1
- 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_dto.rb +12 -2
- data/lib/trieve_ruby_client/models/group_slim_chunks_dto.rb +239 -0
- 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 +5 -5
- data/lib/trieve_ruby_client/models/range_condition.rb +105 -0
- data/lib/trieve_ruby_client/models/reccomend_group_chunks_request.rb +17 -6
- data/lib/trieve_ruby_client/models/recommend_chunks_request.rb +17 -6
- data/lib/trieve_ruby_client/models/recommend_chunks_response_types.rb +105 -0
- data/lib/trieve_ruby_client/models/recommend_group_chunk_response_types.rb +105 -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 +1 -1
- data/lib/trieve_ruby_client/models/score_slim_chunks.rb +239 -0
- data/lib/trieve_ruby_client/models/search_chunk_data.rb +24 -2
- 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 +105 -0
- data/lib/trieve_ruby_client/models/search_group_slim_chunks_result.rb +255 -0
- data/lib/trieve_ruby_client/models/search_groups_result.rb +1 -1
- data/lib/trieve_ruby_client/models/search_over_groups_data.rb +27 -5
- 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 +105 -0
- data/lib/trieve_ruby_client/models/search_over_groups_slim_chunks_response_body.rb +239 -0
- data/lib/trieve_ruby_client/models/search_slim_chunk_query_response_body.rb +239 -0
- data/lib/trieve_ruby_client/models/search_within_group_data.rb +24 -2
- data/lib/trieve_ruby_client/models/search_within_group_response_types.rb +105 -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 +329 -0
- data/lib/trieve_ruby_client/models/slim_group.rb +1 -1
- data/lib/trieve_ruby_client/models/slim_user.rb +5 -41
- 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 +15 -2
- data/lib/trieve_ruby_client/models/update_chunk_group_data.rb +1 -1
- 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 +1 -1
- 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 +6 -39
- 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 +13 -2
- data/openapi-generator.yaml +1 -1
- data/openapi.json +636 -217
- data/spec/models/group_slim_chunks_dto_spec.rb +42 -0
- data/spec/models/range_condition_spec.rb +32 -0
- data/spec/models/recommend_chunks_response_types_spec.rb +32 -0
- data/spec/models/recommend_group_chunk_response_types_spec.rb +32 -0
- data/spec/models/score_slim_chunks_spec.rb +42 -0
- data/spec/models/search_chunk_response_types_spec.rb +32 -0
- data/spec/models/search_group_slim_chunks_result_spec.rb +48 -0
- data/spec/models/search_over_groups_response_types_spec.rb +32 -0
- data/spec/models/search_over_groups_slim_chunks_response_body_spec.rb +42 -0
- data/spec/models/search_slim_chunk_query_response_body_spec.rb +42 -0
- data/spec/models/search_within_group_response_types_spec.rb +32 -0
- data/spec/models/slim_chunk_metadata_spec.rb +90 -0
- data/spec/spec_helper.rb +1 -1
- data/trieve_ruby_client-0.5.0.gem +0 -0
- data/trieve_ruby_client.gemspec +1 -1
- metadata +52 -4
- data/trieve_ruby_client-0.3.5.gem +0 -0
- data/trieve_ruby_client-0.4.0.gem +0 -0
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 18478b254543ca42dcece001a1e8993304e962dca71bd8ecd9a9ff2565f6848d
|
4
|
+
data.tar.gz: bcd91779a266e6c098011f911d1bb4455f9d17abbc2772d2988ce8a0aaa5f0b3
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: bc80bd7b9875a1efc352842c6069e5c240c70df26360725f93ce0ca317af4f0097fbffbcd5e93130e21d988287485e468f59eba030d9d2099b8bcf29e141c144
|
7
|
+
data.tar.gz: 4865cc754d50322018810aed7cb5a9d6b0f331e6aa40f7d4aab0f903b598cc51b022634aed8640227e06938cd29d1feb4caf333f673c741cbbd2a3ce22f32705
|
@@ -0,0 +1 @@
|
|
1
|
+
npx @openapitools/openapi-generator-cli generate -i openapi.json -g ruby -c ./openapi-generator.yaml --skip-validate-spec
|
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.5.
|
10
|
-
- Package version: 0.5.
|
9
|
+
- API version: 0.5.7
|
10
|
+
- Package version: 0.5.7
|
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.5.
|
28
|
+
gem install ./trieve_ruby_client-0.5.7.gem
|
29
29
|
```
|
30
30
|
|
31
|
-
(for development, run `gem install --dev ./trieve_ruby_client-0.5.
|
31
|
+
(for development, run `gem install --dev ./trieve_ruby_client-0.5.7.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.5.
|
37
|
+
gem 'trieve_ruby_client', '~> 0.5.7'
|
38
38
|
|
39
39
|
### Install from Git
|
40
40
|
|
@@ -72,7 +72,7 @@ end
|
|
72
72
|
|
73
73
|
## Documentation for API Endpoints
|
74
74
|
|
75
|
-
All URIs are relative to *
|
75
|
+
All URIs are relative to *https://api.trieve.ai*
|
76
76
|
|
77
77
|
Class | Method | HTTP request | Description
|
78
78
|
------------ | ------------- | ------------- | -------------
|
@@ -109,7 +109,7 @@ Class | Method | HTTP request | Description
|
|
109
109
|
*TrieveRubyClient::ChunkGroupApi* | [**update_chunk_group**](docs/ChunkGroupApi.md#update_chunk_group) | **PUT** /api/chunk_group | Update Group
|
110
110
|
*TrieveRubyClient::ChunkGroupApi* | [**update_group_by_tracking_id**](docs/ChunkGroupApi.md#update_group_by_tracking_id) | **PUT** /api/chunk_group/tracking_id/{tracking_id} | Update Group by Tracking ID
|
111
111
|
*TrieveRubyClient::DatasetApi* | [**create_dataset**](docs/DatasetApi.md#create_dataset) | **POST** /api/dataset | Create dataset
|
112
|
-
*TrieveRubyClient::DatasetApi* | [**delete_dataset**](docs/DatasetApi.md#delete_dataset) | **DELETE** /api/dataset | Delete Dataset
|
112
|
+
*TrieveRubyClient::DatasetApi* | [**delete_dataset**](docs/DatasetApi.md#delete_dataset) | **DELETE** /api/dataset/{dataset_id} | Delete Dataset
|
113
113
|
*TrieveRubyClient::DatasetApi* | [**get_client_dataset_config**](docs/DatasetApi.md#get_client_dataset_config) | **GET** /api/dataset/envs | Get Client Configuration
|
114
114
|
*TrieveRubyClient::DatasetApi* | [**get_dataset**](docs/DatasetApi.md#get_dataset) | **GET** /api/dataset/{dataset_id} | Get Dataset
|
115
115
|
*TrieveRubyClient::DatasetApi* | [**get_datasets_from_organization**](docs/DatasetApi.md#get_datasets_from_organization) | **GET** /api/dataset/organization/{organization_id} | Get Datasets from Organization
|
@@ -136,10 +136,10 @@ Class | Method | HTTP request | Description
|
|
136
136
|
*TrieveRubyClient::StripeApi* | [**get_all_plans**](docs/StripeApi.md#get_all_plans) | **GET** /api/stripe/plans | Get All Plans
|
137
137
|
*TrieveRubyClient::StripeApi* | [**update_subscription_plan**](docs/StripeApi.md#update_subscription_plan) | **PATCH** /api/stripe/subscription_plan/{subscription_id}/{plan_id} | Update Subscription Plan
|
138
138
|
*TrieveRubyClient::TopicApi* | [**create_topic**](docs/TopicApi.md#create_topic) | **POST** /api/topic | Create Topic
|
139
|
-
*TrieveRubyClient::TopicApi* | [**delete_topic**](docs/TopicApi.md#delete_topic) | **DELETE** /api/topic | Delete Topic
|
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 | Delete User Api Key
|
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
143
|
*TrieveRubyClient::UserApi* | [**set_user_api_key**](docs/UserApi.md#set_user_api_key) | **POST** /api/user/set_api_key | Set User Api Key
|
144
144
|
*TrieveRubyClient::UserApi* | [**update_user**](docs/UserApi.md#update_user) | **PUT** /api/user | Update User
|
145
145
|
|
@@ -170,7 +170,6 @@ Class | Method | HTTP request | Description
|
|
170
170
|
- [TrieveRubyClient::DatasetAndUsage](docs/DatasetAndUsage.md)
|
171
171
|
- [TrieveRubyClient::DatasetDTO](docs/DatasetDTO.md)
|
172
172
|
- [TrieveRubyClient::DatasetUsageCount](docs/DatasetUsageCount.md)
|
173
|
-
- [TrieveRubyClient::DeleteDatasetRequest](docs/DeleteDatasetRequest.md)
|
174
173
|
- [TrieveRubyClient::DeleteTopicData](docs/DeleteTopicData.md)
|
175
174
|
- [TrieveRubyClient::DeleteUserApiKeyRequest](docs/DeleteUserApiKeyRequest.md)
|
176
175
|
- [TrieveRubyClient::EditMessageData](docs/EditMessageData.md)
|
@@ -185,26 +184,38 @@ Class | Method | HTTP request | Description
|
|
185
184
|
- [TrieveRubyClient::GetGroupsForChunksData](docs/GetGroupsForChunksData.md)
|
186
185
|
- [TrieveRubyClient::GroupData](docs/GroupData.md)
|
187
186
|
- [TrieveRubyClient::GroupScoreChunkDTO](docs/GroupScoreChunkDTO.md)
|
187
|
+
- [TrieveRubyClient::GroupSlimChunksDTO](docs/GroupSlimChunksDTO.md)
|
188
188
|
- [TrieveRubyClient::InvitationData](docs/InvitationData.md)
|
189
189
|
- [TrieveRubyClient::MatchCondition](docs/MatchCondition.md)
|
190
190
|
- [TrieveRubyClient::Message](docs/Message.md)
|
191
191
|
- [TrieveRubyClient::Organization](docs/Organization.md)
|
192
192
|
- [TrieveRubyClient::OrganizationUsageCount](docs/OrganizationUsageCount.md)
|
193
193
|
- [TrieveRubyClient::Range](docs/Range.md)
|
194
|
+
- [TrieveRubyClient::RangeCondition](docs/RangeCondition.md)
|
194
195
|
- [TrieveRubyClient::ReccomendGroupChunksRequest](docs/ReccomendGroupChunksRequest.md)
|
195
196
|
- [TrieveRubyClient::RecommendChunksRequest](docs/RecommendChunksRequest.md)
|
197
|
+
- [TrieveRubyClient::RecommendChunksResponseTypes](docs/RecommendChunksResponseTypes.md)
|
198
|
+
- [TrieveRubyClient::RecommendGroupChunkResponseTypes](docs/RecommendGroupChunkResponseTypes.md)
|
196
199
|
- [TrieveRubyClient::RegenerateMessageData](docs/RegenerateMessageData.md)
|
197
200
|
- [TrieveRubyClient::ReturnQueuedChunk](docs/ReturnQueuedChunk.md)
|
198
201
|
- [TrieveRubyClient::ScoreChunkDTO](docs/ScoreChunkDTO.md)
|
202
|
+
- [TrieveRubyClient::ScoreSlimChunks](docs/ScoreSlimChunks.md)
|
199
203
|
- [TrieveRubyClient::SearchChunkData](docs/SearchChunkData.md)
|
200
204
|
- [TrieveRubyClient::SearchChunkQueryResponseBody](docs/SearchChunkQueryResponseBody.md)
|
205
|
+
- [TrieveRubyClient::SearchChunkResponseTypes](docs/SearchChunkResponseTypes.md)
|
206
|
+
- [TrieveRubyClient::SearchGroupSlimChunksResult](docs/SearchGroupSlimChunksResult.md)
|
201
207
|
- [TrieveRubyClient::SearchGroupsResult](docs/SearchGroupsResult.md)
|
202
208
|
- [TrieveRubyClient::SearchOverGroupsData](docs/SearchOverGroupsData.md)
|
203
209
|
- [TrieveRubyClient::SearchOverGroupsResponseBody](docs/SearchOverGroupsResponseBody.md)
|
210
|
+
- [TrieveRubyClient::SearchOverGroupsResponseTypes](docs/SearchOverGroupsResponseTypes.md)
|
211
|
+
- [TrieveRubyClient::SearchOverGroupsSlimChunksResponseBody](docs/SearchOverGroupsSlimChunksResponseBody.md)
|
212
|
+
- [TrieveRubyClient::SearchSlimChunkQueryResponseBody](docs/SearchSlimChunkQueryResponseBody.md)
|
204
213
|
- [TrieveRubyClient::SearchWithinGroupData](docs/SearchWithinGroupData.md)
|
214
|
+
- [TrieveRubyClient::SearchWithinGroupResponseTypes](docs/SearchWithinGroupResponseTypes.md)
|
205
215
|
- [TrieveRubyClient::SetUserApiKeyRequest](docs/SetUserApiKeyRequest.md)
|
206
216
|
- [TrieveRubyClient::SetUserApiKeyResponse](docs/SetUserApiKeyResponse.md)
|
207
217
|
- [TrieveRubyClient::SingleQueuedChunkResponse](docs/SingleQueuedChunkResponse.md)
|
218
|
+
- [TrieveRubyClient::SlimChunkMetadata](docs/SlimChunkMetadata.md)
|
208
219
|
- [TrieveRubyClient::SlimGroup](docs/SlimGroup.md)
|
209
220
|
- [TrieveRubyClient::SlimUser](docs/SlimUser.md)
|
210
221
|
- [TrieveRubyClient::StripePlan](docs/StripePlan.md)
|
data/docs/AuthApi.md
CHANGED
data/docs/ChunkApi.md
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
# TrieveRubyClient::ChunkApi
|
2
2
|
|
3
|
-
All URIs are relative to *
|
3
|
+
All URIs are relative to *https://api.trieve.ai*
|
4
4
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
@@ -528,7 +528,7 @@ end
|
|
528
528
|
|
529
529
|
## get_recommended_chunks
|
530
530
|
|
531
|
-
> <
|
531
|
+
> <RecommendChunksResponseTypes> 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(<RecommendChunksResponseTypes>, 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 # => <RecommendChunksResponseTypes>
|
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
|
+
[**RecommendChunksResponseTypes**](RecommendChunksResponseTypes.md)
|
591
591
|
|
592
592
|
### Authorization
|
593
593
|
|
@@ -601,7 +601,7 @@ end
|
|
601
601
|
|
602
602
|
## search_chunk
|
603
603
|
|
604
|
-
> <
|
604
|
+
> <SearchChunkResponseTypes> 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(<SearchChunkResponseTypes>, 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 # => <SearchChunkResponseTypes>
|
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
|
+
[**SearchChunkResponseTypes**](SearchChunkResponseTypes.md)
|
664
664
|
|
665
665
|
### Authorization
|
666
666
|
|
data/docs/ChunkGroupApi.md
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
# TrieveRubyClient::ChunkGroupApi
|
2
2
|
|
3
|
-
All URIs are relative to *
|
3
|
+
All URIs are relative to *https://api.trieve.ai*
|
4
4
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
@@ -761,7 +761,7 @@ end
|
|
761
761
|
|
762
762
|
## get_recommended_groups
|
763
763
|
|
764
|
-
> <
|
764
|
+
> <RecommendGroupChunkResponseTypes> get_recommended_groups(tr_dataset, reccomend_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(<
|
800
|
+
> <Array(<RecommendGroupChunkResponseTypes>, Integer, Hash)> get_recommended_groups_with_http_info(tr_dataset, reccomend_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, reccomend_group_chunks_request)
|
806
806
|
p status_code # => 2xx
|
807
807
|
p headers # => { ... }
|
808
|
-
p data # => <
|
808
|
+
p data # => <RecommendGroupChunkResponseTypes>
|
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
|
-
[**
|
823
|
+
[**RecommendGroupChunkResponseTypes**](RecommendGroupChunkResponseTypes.md)
|
824
824
|
|
825
825
|
### Authorization
|
826
826
|
|
@@ -983,7 +983,7 @@ nil (empty response body)
|
|
983
983
|
|
984
984
|
## search_over_groups
|
985
985
|
|
986
|
-
> <
|
986
|
+
> <SearchOverGroupsResponseTypes> search_over_groups(tr_dataset, search_over_groups_data)
|
987
987
|
|
988
988
|
Search Over Groups
|
989
989
|
|
@@ -994,13 +994,21 @@ Search Over Groups This route allows you to get groups as results instead of ch
|
|
994
994
|
```ruby
|
995
995
|
require 'time'
|
996
996
|
require 'trieve_ruby_client'
|
997
|
+
# setup authorization
|
998
|
+
TrieveRubyClient.configure do |config|
|
999
|
+
# Configure API key authorization: ApiKey
|
1000
|
+
config.api_key['ApiKey'] = 'YOUR API KEY'
|
1001
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1002
|
+
# config.api_key_prefix['ApiKey'] = 'Bearer'
|
1003
|
+
end
|
997
1004
|
|
998
1005
|
api_instance = TrieveRubyClient::ChunkGroupApi.new
|
1006
|
+
tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
|
999
1007
|
search_over_groups_data = TrieveRubyClient::SearchOverGroupsData.new({query: 'query_example', search_type: 'search_type_example'}) # SearchOverGroupsData | JSON request payload to semantically search over groups
|
1000
1008
|
|
1001
1009
|
begin
|
1002
1010
|
# Search Over Groups
|
1003
|
-
result = api_instance.search_over_groups(search_over_groups_data)
|
1011
|
+
result = api_instance.search_over_groups(tr_dataset, search_over_groups_data)
|
1004
1012
|
p result
|
1005
1013
|
rescue TrieveRubyClient::ApiError => e
|
1006
1014
|
puts "Error when calling ChunkGroupApi->search_over_groups: #{e}"
|
@@ -1011,15 +1019,15 @@ end
|
|
1011
1019
|
|
1012
1020
|
This returns an Array which contains the response data, status code and headers.
|
1013
1021
|
|
1014
|
-
> <Array(<
|
1022
|
+
> <Array(<SearchOverGroupsResponseTypes>, Integer, Hash)> search_over_groups_with_http_info(tr_dataset, search_over_groups_data)
|
1015
1023
|
|
1016
1024
|
```ruby
|
1017
1025
|
begin
|
1018
1026
|
# Search Over Groups
|
1019
|
-
data, status_code, headers = api_instance.search_over_groups_with_http_info(search_over_groups_data)
|
1027
|
+
data, status_code, headers = api_instance.search_over_groups_with_http_info(tr_dataset, search_over_groups_data)
|
1020
1028
|
p status_code # => 2xx
|
1021
1029
|
p headers # => { ... }
|
1022
|
-
p data # => <
|
1030
|
+
p data # => <SearchOverGroupsResponseTypes>
|
1023
1031
|
rescue TrieveRubyClient::ApiError => e
|
1024
1032
|
puts "Error when calling ChunkGroupApi->search_over_groups_with_http_info: #{e}"
|
1025
1033
|
end
|
@@ -1029,15 +1037,16 @@ end
|
|
1029
1037
|
|
1030
1038
|
| Name | Type | Description | Notes |
|
1031
1039
|
| ---- | ---- | ----------- | ----- |
|
1040
|
+
| **tr_dataset** | **String** | The dataset id to use for the request | |
|
1032
1041
|
| **search_over_groups_data** | [**SearchOverGroupsData**](SearchOverGroupsData.md) | JSON request payload to semantically search over groups | |
|
1033
1042
|
|
1034
1043
|
### Return type
|
1035
1044
|
|
1036
|
-
[**
|
1045
|
+
[**SearchOverGroupsResponseTypes**](SearchOverGroupsResponseTypes.md)
|
1037
1046
|
|
1038
1047
|
### Authorization
|
1039
1048
|
|
1040
|
-
|
1049
|
+
[ApiKey](../README.md#ApiKey)
|
1041
1050
|
|
1042
1051
|
### HTTP request headers
|
1043
1052
|
|
@@ -1047,7 +1056,7 @@ No authorization required
|
|
1047
1056
|
|
1048
1057
|
## search_within_group
|
1049
1058
|
|
1050
|
-
> <
|
1059
|
+
> <SearchWithinGroupResponseTypes> search_within_group(tr_dataset, search_within_group_data)
|
1051
1060
|
|
1052
1061
|
Search Within Group
|
1053
1062
|
|
@@ -1083,7 +1092,7 @@ end
|
|
1083
1092
|
|
1084
1093
|
This returns an Array which contains the response data, status code and headers.
|
1085
1094
|
|
1086
|
-
> <Array(<
|
1095
|
+
> <Array(<SearchWithinGroupResponseTypes>, Integer, Hash)> search_within_group_with_http_info(tr_dataset, search_within_group_data)
|
1087
1096
|
|
1088
1097
|
```ruby
|
1089
1098
|
begin
|
@@ -1091,7 +1100,7 @@ begin
|
|
1091
1100
|
data, status_code, headers = api_instance.search_within_group_with_http_info(tr_dataset, search_within_group_data)
|
1092
1101
|
p status_code # => 2xx
|
1093
1102
|
p headers # => { ... }
|
1094
|
-
p data # => <
|
1103
|
+
p data # => <SearchWithinGroupResponseTypes>
|
1095
1104
|
rescue TrieveRubyClient::ApiError => e
|
1096
1105
|
puts "Error when calling ChunkGroupApi->search_within_group_with_http_info: #{e}"
|
1097
1106
|
end
|
@@ -1106,7 +1115,7 @@ end
|
|
1106
1115
|
|
1107
1116
|
### Return type
|
1108
1117
|
|
1109
|
-
[**
|
1118
|
+
[**SearchWithinGroupResponseTypes**](SearchWithinGroupResponseTypes.md)
|
1110
1119
|
|
1111
1120
|
### Authorization
|
1112
1121
|
|
data/docs/DatasetApi.md
CHANGED
@@ -1,11 +1,11 @@
|
|
1
1
|
# TrieveRubyClient::DatasetApi
|
2
2
|
|
3
|
-
All URIs are relative to *
|
3
|
+
All URIs are relative to *https://api.trieve.ai*
|
4
4
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
7
|
| [**create_dataset**](DatasetApi.md#create_dataset) | **POST** /api/dataset | Create dataset |
|
8
|
-
| [**delete_dataset**](DatasetApi.md#delete_dataset) | **DELETE** /api/dataset | Delete Dataset |
|
8
|
+
| [**delete_dataset**](DatasetApi.md#delete_dataset) | **DELETE** /api/dataset/{dataset_id} | Delete Dataset |
|
9
9
|
| [**get_client_dataset_config**](DatasetApi.md#get_client_dataset_config) | **GET** /api/dataset/envs | Get Client Configuration |
|
10
10
|
| [**get_dataset**](DatasetApi.md#get_dataset) | **GET** /api/dataset/{dataset_id} | Get Dataset |
|
11
11
|
| [**get_datasets_from_organization**](DatasetApi.md#get_datasets_from_organization) | **GET** /api/dataset/organization/{organization_id} | Get Datasets from Organization |
|
@@ -87,7 +87,7 @@ end
|
|
87
87
|
|
88
88
|
## delete_dataset
|
89
89
|
|
90
|
-
> delete_dataset(tr_organization,
|
90
|
+
> delete_dataset(tr_organization, dataset_id)
|
91
91
|
|
92
92
|
Delete Dataset
|
93
93
|
|
@@ -108,11 +108,11 @@ end
|
|
108
108
|
|
109
109
|
api_instance = TrieveRubyClient::DatasetApi.new
|
110
110
|
tr_organization = 'tr_organization_example' # String | The organization 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(tr_organization,
|
115
|
+
api_instance.delete_dataset(tr_organization, 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(tr_organization,
|
125
|
+
> <Array(nil, Integer, Hash)> delete_dataset_with_http_info(tr_organization, 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(tr_organization,
|
130
|
+
data, status_code, headers = api_instance.delete_dataset_with_http_info(tr_organization, dataset_id)
|
131
131
|
p status_code # => 2xx
|
132
132
|
p headers # => { ... }
|
133
133
|
p data # => nil
|
@@ -141,7 +141,7 @@ end
|
|
141
141
|
| Name | Type | Description | Notes |
|
142
142
|
| ---- | ---- | ----------- | ----- |
|
143
143
|
| **tr_organization** | **String** | The organization 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
|
147
147
|
|
@@ -153,7 +153,7 @@ nil (empty response body)
|
|
153
153
|
|
154
154
|
### HTTP request headers
|
155
155
|
|
156
|
-
- **Content-Type**:
|
156
|
+
- **Content-Type**: Not defined
|
157
157
|
- **Accept**: application/json
|
158
158
|
|
159
159
|
|
data/docs/EventsApi.md
CHANGED
data/docs/FileApi.md
CHANGED
data/docs/GroupScoreChunkDTO.md
CHANGED
@@ -5,6 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **group_id** | **String** | | |
|
8
|
+
| **group_tracking_id** | **String** | | [optional] |
|
8
9
|
| **metadata** | [**Array<ScoreChunkDTO>**](ScoreChunkDTO.md) | | |
|
9
10
|
|
10
11
|
## Example
|
@@ -14,6 +15,7 @@ require 'trieve_ruby_client'
|
|
14
15
|
|
15
16
|
instance = TrieveRubyClient::GroupScoreChunkDTO.new(
|
16
17
|
group_id: null,
|
18
|
+
group_tracking_id: null,
|
17
19
|
metadata: null
|
18
20
|
)
|
19
21
|
```
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# TrieveRubyClient::GroupSlimChunksDTO
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **group_id** | **String** | | |
|
8
|
+
| **metadata** | [**Array<ScoreSlimChunks>**](ScoreSlimChunks.md) | | |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'trieve_ruby_client'
|
14
|
+
|
15
|
+
instance = TrieveRubyClient::GroupSlimChunksDTO.new(
|
16
|
+
group_id: null,
|
17
|
+
metadata: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
data/docs/HealthApi.md
CHANGED
data/docs/InvitationApi.md
CHANGED
data/docs/MessageApi.md
CHANGED
data/docs/OrganizationApi.md
CHANGED
data/docs/Range.md
CHANGED
@@ -4,10 +4,10 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **gt** | **
|
8
|
-
| **gte** | **
|
9
|
-
| **lt** | **
|
10
|
-
| **lte** | **
|
7
|
+
| **gt** | [**RangeCondition**](RangeCondition.md) | | [optional] |
|
8
|
+
| **gte** | [**RangeCondition**](RangeCondition.md) | | [optional] |
|
9
|
+
| **lt** | [**RangeCondition**](RangeCondition.md) | | [optional] |
|
10
|
+
| **lte** | [**RangeCondition**](RangeCondition.md) | | [optional] |
|
11
11
|
|
12
12
|
## Example
|
13
13
|
|
@@ -0,0 +1,49 @@
|
|
1
|
+
# TrieveRubyClient::RangeCondition
|
2
|
+
|
3
|
+
## Class instance methods
|
4
|
+
|
5
|
+
### `openapi_one_of`
|
6
|
+
|
7
|
+
Returns the list of classes defined in oneOf.
|
8
|
+
|
9
|
+
#### Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'trieve_ruby_client'
|
13
|
+
|
14
|
+
TrieveRubyClient::RangeCondition.openapi_one_of
|
15
|
+
# =>
|
16
|
+
# [
|
17
|
+
# :'Float',
|
18
|
+
# :'String'
|
19
|
+
# ]
|
20
|
+
```
|
21
|
+
|
22
|
+
### build
|
23
|
+
|
24
|
+
Find the appropriate object from the `openapi_one_of` list and casts the data into it.
|
25
|
+
|
26
|
+
#### Example
|
27
|
+
|
28
|
+
```ruby
|
29
|
+
require 'trieve_ruby_client'
|
30
|
+
|
31
|
+
TrieveRubyClient::RangeCondition.build(data)
|
32
|
+
# => #<Float:0x00007fdd4aab02a0>
|
33
|
+
|
34
|
+
TrieveRubyClient::RangeCondition.build(data_that_doesnt_match)
|
35
|
+
# => nil
|
36
|
+
```
|
37
|
+
|
38
|
+
#### Parameters
|
39
|
+
|
40
|
+
| Name | Type | Description |
|
41
|
+
| ---- | ---- | ----------- |
|
42
|
+
| **data** | **Mixed** | data to be matched against the list of oneOf items |
|
43
|
+
|
44
|
+
#### Return type
|
45
|
+
|
46
|
+
- `Float`
|
47
|
+
- `String`
|
48
|
+
- `nil` (if no type matches)
|
49
|
+
|
@@ -11,6 +11,7 @@
|
|
11
11
|
| **negative_group_tracking_ids** | **Array<String>** | The ids of the groups to be used as negative examples for the recommendation. The groups in this array will be used to filter out similar groups. | [optional] |
|
12
12
|
| **positive_group_ids** | **Array<String>** | 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. | [optional] |
|
13
13
|
| **positive_group_tracking_ids** | **Array<String>** | 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. | [optional] |
|
14
|
+
| **slim_chunks** | **Boolean** | 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. | [optional] |
|
14
15
|
|
15
16
|
## Example
|
16
17
|
|
@@ -24,7 +25,8 @@ instance = TrieveRubyClient::ReccomendGroupChunksRequest.new(
|
|
24
25
|
negative_group_ids: null,
|
25
26
|
negative_group_tracking_ids: null,
|
26
27
|
positive_group_ids: null,
|
27
|
-
positive_group_tracking_ids: null
|
28
|
+
positive_group_tracking_ids: null,
|
29
|
+
slim_chunks: null
|
28
30
|
)
|
29
31
|
```
|
30
32
|
|
@@ -10,6 +10,7 @@
|
|
10
10
|
| **negative_tracking_ids** | **Array<String>** | The tracking_ids of the chunks to be used as negative examples for the recommendation. The chunks in this array will be used to filter out similar chunks. | [optional] |
|
11
11
|
| **positive_chunk_ids** | **Array<String>** | The 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. | [optional] |
|
12
12
|
| **positive_tracking_ids** | **Array<String>** | 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. | [optional] |
|
13
|
+
| **slim_chunks** | **Boolean** | 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. | [optional] |
|
13
14
|
|
14
15
|
## Example
|
15
16
|
|
@@ -22,7 +23,8 @@ instance = TrieveRubyClient::RecommendChunksRequest.new(
|
|
22
23
|
negative_chunk_ids: null,
|
23
24
|
negative_tracking_ids: null,
|
24
25
|
positive_chunk_ids: null,
|
25
|
-
positive_tracking_ids: null
|
26
|
+
positive_tracking_ids: null,
|
27
|
+
slim_chunks: null
|
26
28
|
)
|
27
29
|
```
|
28
30
|
|