trieve_ruby_client 0.3.5 → 0.5.0
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 +78 -74
- data/docs/AddChunkToGroupData.md +1 -1
- data/docs/AuthApi.md +28 -34
- data/docs/AuthQuery.md +22 -0
- data/docs/BatchQueuedChunkResponse.md +20 -0
- data/docs/ChunkApi.md +69 -147
- data/docs/ChunkData.md +42 -0
- data/docs/ChunkGroupApi.md +168 -90
- data/docs/CreateChunkData.md +41 -34
- data/docs/DatasetApi.md +31 -31
- data/docs/EventsApi.md +13 -13
- data/docs/FileApi.md +21 -21
- data/docs/GetEventsData.md +22 -0
- data/docs/HealthApi.md +6 -4
- data/docs/InvitationApi.md +6 -6
- data/docs/MessageApi.md +21 -21
- data/docs/OrganizationApi.md +31 -31
- data/docs/ReturnQueuedChunk.md +39 -10
- data/docs/SingleQueuedChunkResponse.md +20 -0
- data/docs/StripeApi.md +21 -13
- data/docs/TopicApi.md +21 -21
- data/docs/UserApi.md +16 -16
- data/lib/trieve_ruby_client/api/auth_api.rb +27 -34
- data/lib/trieve_ruby_client/api/chunk_api.rb +64 -143
- data/lib/trieve_ruby_client/api/chunk_group_api.rb +153 -75
- data/lib/trieve_ruby_client/api/dataset_api.rb +25 -25
- data/lib/trieve_ruby_client/api/events_api.rb +21 -16
- data/lib/trieve_ruby_client/api/file_api.rb +17 -17
- data/lib/trieve_ruby_client/api/health_api.rb +5 -1
- data/lib/trieve_ruby_client/api/invitation_api.rb +5 -5
- data/lib/trieve_ruby_client/api/message_api.rb +17 -17
- data/lib/trieve_ruby_client/api/organization_api.rb +25 -25
- data/lib/trieve_ruby_client/api/stripe_api.rb +17 -1
- data/lib/trieve_ruby_client/api/topic_api.rb +17 -17
- data/lib/trieve_ruby_client/api/user_api.rb +13 -13
- 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 +8 -4
- data/lib/trieve_ruby_client/models/add_chunk_to_group_data.rb +2 -2
- data/lib/trieve_ruby_client/models/api_key_dto.rb +1 -1
- data/lib/trieve_ruby_client/models/{stripe_subscription.rb → auth_query.rb} +23 -96
- data/lib/trieve_ruby_client/models/batch_queued_chunk_response.rb +240 -0
- 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 +356 -0
- 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 +79 -330
- 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_dataset_request.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 +240 -0
- 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 +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/reccomend_group_chunks_request.rb +1 -1
- data/lib/trieve_ruby_client/models/recommend_chunks_request.rb +1 -1
- data/lib/trieve_ruby_client/models/regenerate_message_data.rb +1 -1
- data/lib/trieve_ruby_client/models/return_queued_chunk.rb +75 -207
- data/lib/trieve_ruby_client/models/score_chunk_dto.rb +1 -1
- data/lib/trieve_ruby_client/models/search_chunk_data.rb +1 -1
- data/lib/trieve_ruby_client/models/search_chunk_query_response_body.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 +1 -1
- data/lib/trieve_ruby_client/models/search_over_groups_response_body.rb +1 -1
- data/lib/trieve_ruby_client/models/search_within_group_data.rb +1 -1
- 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 +238 -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 +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 +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 +6 -2
- data/openapi-generator.yaml +1 -1
- data/openapi.json +1196 -849
- data/spec/api/auth_api_spec.rb +16 -18
- data/spec/api/chunk_api_spec.rb +30 -43
- data/spec/api/chunk_group_api_spec.rb +54 -33
- data/spec/api/dataset_api_spec.rb +19 -19
- data/spec/api/events_api_spec.rb +10 -10
- data/spec/api/file_api_spec.rb +15 -15
- data/spec/api/health_api_spec.rb +9 -7
- data/spec/api/invitation_api_spec.rb +9 -9
- data/spec/api/message_api_spec.rb +15 -15
- data/spec/api/organization_api_spec.rb +19 -19
- data/spec/api/stripe_api_spec.rb +15 -7
- data/spec/api/topic_api_spec.rb +15 -15
- data/spec/api/user_api_spec.rb +13 -13
- data/spec/models/add_chunk_to_group_data_spec.rb +8 -8
- data/spec/models/api_key_dto_spec.rb +8 -8
- data/spec/models/auth_query_spec.rb +48 -0
- data/spec/models/batch_queued_chunk_response_spec.rb +42 -0
- data/spec/models/bookmark_data_spec.rb +8 -8
- data/spec/models/bookmark_group_result_spec.rb +8 -8
- data/spec/models/chat_message_proxy_spec.rb +8 -8
- data/spec/models/chunk_data_spec.rb +108 -0
- data/spec/models/chunk_filter_spec.rb +8 -8
- data/spec/models/chunk_group_and_file_spec.rb +8 -8
- data/spec/models/chunk_group_spec.rb +8 -8
- data/spec/models/chunk_metadata_spec.rb +8 -8
- data/spec/models/chunk_metadata_with_file_data_spec.rb +8 -8
- data/spec/models/client_dataset_configuration_spec.rb +8 -8
- data/spec/models/create_chunk_data_spec.rb +11 -87
- data/spec/models/create_chunk_group_data_spec.rb +8 -8
- data/spec/models/create_dataset_request_spec.rb +8 -8
- data/spec/models/create_message_data_spec.rb +8 -8
- data/spec/models/create_organization_data_spec.rb +8 -8
- data/spec/models/create_topic_data_spec.rb +8 -8
- data/spec/models/dataset_and_usage_spec.rb +8 -8
- data/spec/models/dataset_dto_spec.rb +8 -8
- data/spec/models/dataset_spec.rb +8 -8
- data/spec/models/dataset_usage_count_spec.rb +8 -8
- data/spec/models/delete_dataset_request_spec.rb +8 -8
- data/spec/models/delete_topic_data_spec.rb +8 -8
- data/spec/models/delete_user_api_key_request_spec.rb +8 -8
- data/spec/models/edit_message_data_spec.rb +8 -8
- data/spec/models/error_response_body_spec.rb +8 -8
- data/spec/models/event_return_spec.rb +8 -8
- data/spec/models/event_spec.rb +8 -8
- data/spec/models/field_condition_spec.rb +8 -8
- data/spec/models/file_dto_spec.rb +8 -8
- data/spec/models/file_spec.rb +8 -8
- data/spec/models/generate_chunks_request_spec.rb +8 -8
- data/spec/models/get_events_data_spec.rb +48 -0
- data/spec/models/get_groups_for_chunks_data_spec.rb +8 -8
- data/spec/models/group_data_spec.rb +8 -8
- data/spec/models/group_score_chunk_dto_spec.rb +8 -8
- data/spec/models/invitation_data_spec.rb +8 -8
- data/spec/models/match_condition_spec.rb +6 -6
- data/spec/models/message_spec.rb +8 -8
- data/spec/models/organization_spec.rb +8 -8
- data/spec/models/organization_usage_count_spec.rb +8 -8
- data/spec/models/range_spec.rb +8 -8
- data/spec/models/reccomend_group_chunks_request_spec.rb +8 -8
- data/spec/models/recommend_chunks_request_spec.rb +8 -8
- data/spec/models/regenerate_message_data_spec.rb +8 -8
- data/spec/models/return_queued_chunk_spec.rb +11 -21
- data/spec/models/score_chunk_dto_spec.rb +8 -8
- data/spec/models/search_chunk_data_spec.rb +8 -8
- data/spec/models/search_chunk_query_response_body_spec.rb +8 -8
- data/spec/models/search_groups_result_spec.rb +8 -8
- data/spec/models/search_over_groups_data_spec.rb +8 -8
- data/spec/models/search_over_groups_response_body_spec.rb +8 -8
- data/spec/models/search_within_group_data_spec.rb +8 -8
- data/spec/models/set_user_api_key_request_spec.rb +8 -8
- data/spec/models/set_user_api_key_response_spec.rb +8 -8
- data/spec/models/single_queued_chunk_response_spec.rb +42 -0
- data/spec/models/slim_group_spec.rb +8 -8
- data/spec/models/slim_user_spec.rb +8 -8
- data/spec/models/stripe_plan_spec.rb +8 -8
- data/spec/models/suggested_queries_request_spec.rb +8 -8
- data/spec/models/suggested_queries_response_spec.rb +8 -8
- data/spec/models/topic_spec.rb +8 -8
- data/spec/models/update_chunk_by_tracking_id_data_spec.rb +20 -8
- data/spec/models/update_chunk_data_spec.rb +20 -8
- data/spec/models/update_chunk_group_data_spec.rb +14 -8
- data/spec/models/update_dataset_request_spec.rb +8 -8
- data/spec/models/update_group_by_tracking_id_data_spec.rb +8 -8
- data/spec/models/update_organization_data_spec.rb +8 -8
- data/spec/models/update_topic_data_spec.rb +8 -8
- data/spec/models/update_user_data_spec.rb +8 -8
- data/spec/models/upload_file_data_spec.rb +8 -8
- data/spec/models/upload_file_result_spec.rb +8 -8
- data/spec/models/user_organization_spec.rb +8 -8
- data/spec/spec_helper.rb +1 -1
- data/trieve_ruby_client-0.3.5.gem +0 -0
- data/trieve_ruby_client-0.4.0.gem +0 -0
- data/trieve_ruby_client.gemspec +1 -1
- metadata +24 -8
- data/docs/StripeSubscription.md +0 -30
- data/spec/models/stripe_subscription_spec.rb +0 -72
- data/trieve_ruby_client-0.3.4.gem +0 -0
- data/trieve_ruby_client-0.3.41.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: e0f6247ccf8bd2317f17f1cff845cdc1babf31f3fe83f85725a67f24c59912ca
|
4
|
+
data.tar.gz: c2b40080de68df5761287386a67483b264dfdb9a036d4c0dfe8294b3361ecc10
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: b4f6ef5058ebc160e85f702217bf55e09426dcf8772bf17a7d8211d96d586f9442aa58d57982791d410fb489ed856fb8e4db0b4cf6c81e992da599e2514aae93
|
7
|
+
data.tar.gz: b3b6d16e25289e56bec18fa7e0cbbe4af70cc5f74ea8a7e6d205f22a60f954453d5c9550abbaa98a33041d5747e7a8f8eeb1b50960a0be23e7ab6353249eb2ec
|
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.5.0
|
10
|
+
- Package version: 0.5.0
|
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.5.0.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.5.0.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.5.0'
|
38
38
|
|
39
39
|
### Install from Git
|
40
40
|
|
@@ -61,7 +61,7 @@ require 'trieve_ruby_client'
|
|
61
61
|
api_instance = TrieveRubyClient::AuthApi.new
|
62
62
|
|
63
63
|
begin
|
64
|
-
#
|
64
|
+
#OpenID Connect callback
|
65
65
|
result = api_instance.callback
|
66
66
|
p result
|
67
67
|
rescue TrieveRubyClient::ApiError => e
|
@@ -72,85 +72,88 @@ end
|
|
72
72
|
|
73
73
|
## Documentation for API Endpoints
|
74
74
|
|
75
|
-
All URIs are relative to *http://localhost*
|
75
|
+
All URIs are relative to *http://localhost:8090*
|
76
76
|
|
77
77
|
Class | Method | HTTP request | Description
|
78
78
|
------------ | ------------- | ------------- | -------------
|
79
|
-
*TrieveRubyClient::AuthApi* | [**callback**](docs/AuthApi.md#callback) | **GET** /api/auth/callback |
|
80
|
-
*TrieveRubyClient::AuthApi* | [**get_me**](docs/AuthApi.md#get_me) | **GET** /api/auth/me |
|
81
|
-
*TrieveRubyClient::AuthApi* | [**login**](docs/AuthApi.md#login) | **GET** /api/auth |
|
82
|
-
*TrieveRubyClient::AuthApi* | [**logout**](docs/AuthApi.md#logout) | **DELETE** /api/auth |
|
83
|
-
*TrieveRubyClient::ChunkApi* | [**
|
84
|
-
*TrieveRubyClient::ChunkApi* | [**
|
85
|
-
*TrieveRubyClient::ChunkApi* | [**
|
86
|
-
*TrieveRubyClient::ChunkApi* | [**
|
87
|
-
*TrieveRubyClient::ChunkApi* | [**
|
88
|
-
*TrieveRubyClient::ChunkApi* | [**
|
89
|
-
*TrieveRubyClient::ChunkApi* | [**
|
90
|
-
*TrieveRubyClient::ChunkApi* | [**
|
91
|
-
*TrieveRubyClient::ChunkApi* | [**
|
92
|
-
*TrieveRubyClient::ChunkApi* | [**
|
93
|
-
*TrieveRubyClient::ChunkApi* | [**
|
94
|
-
*TrieveRubyClient::
|
95
|
-
*TrieveRubyClient::ChunkGroupApi* | [**
|
96
|
-
*TrieveRubyClient::ChunkGroupApi* | [**
|
97
|
-
*TrieveRubyClient::ChunkGroupApi* | [**
|
98
|
-
*TrieveRubyClient::ChunkGroupApi* | [**
|
99
|
-
*TrieveRubyClient::ChunkGroupApi* | [**
|
100
|
-
*TrieveRubyClient::ChunkGroupApi* | [**get_chunks_in_group**](docs/ChunkGroupApi.md#get_chunks_in_group) | **GET** /api/chunk_group/{
|
101
|
-
*TrieveRubyClient::ChunkGroupApi* | [**get_chunks_in_group_by_tracking_id**](docs/ChunkGroupApi.md#get_chunks_in_group_by_tracking_id) | **GET** /api/chunk_group/tracking_id/{group_tracking_id}/{page} |
|
102
|
-
*TrieveRubyClient::ChunkGroupApi* | [**get_group_by_tracking_id**](docs/ChunkGroupApi.md#get_group_by_tracking_id) | **GET** /api/chunk_group/tracking_id/{tracking_id} |
|
103
|
-
*TrieveRubyClient::ChunkGroupApi* | [**get_groups_chunk_is_in**](docs/ChunkGroupApi.md#get_groups_chunk_is_in) | **POST** /api/chunk_group/chunks |
|
104
|
-
*TrieveRubyClient::ChunkGroupApi* | [**get_recommended_groups**](docs/ChunkGroupApi.md#get_recommended_groups) | **POST** /api/chunk_group/recommend |
|
105
|
-
*TrieveRubyClient::ChunkGroupApi* | [**get_specific_dataset_chunk_groups**](docs/ChunkGroupApi.md#get_specific_dataset_chunk_groups) | **GET** /api/dataset/groups/{dataset_id}/{page} |
|
106
|
-
*TrieveRubyClient::ChunkGroupApi* | [**remove_chunk_from_group**](docs/ChunkGroupApi.md#remove_chunk_from_group) | **DELETE** /api/chunk_group/chunk/{group_id} |
|
107
|
-
*TrieveRubyClient::ChunkGroupApi* | [**search_over_groups**](docs/ChunkGroupApi.md#search_over_groups) | **POST** /api/chunk_group/group_oriented_search |
|
108
|
-
*TrieveRubyClient::ChunkGroupApi* | [**search_within_group**](docs/ChunkGroupApi.md#search_within_group) | **POST** /api/chunk_group/search |
|
109
|
-
*TrieveRubyClient::ChunkGroupApi* | [**update_chunk_group**](docs/ChunkGroupApi.md#update_chunk_group) | **PUT** /api/chunk_group |
|
110
|
-
*TrieveRubyClient::ChunkGroupApi* | [**update_group_by_tracking_id**](docs/ChunkGroupApi.md#update_group_by_tracking_id) | **PUT** /api/chunk_group/tracking_id/{tracking_id} |
|
111
|
-
*TrieveRubyClient::DatasetApi* | [**create_dataset**](docs/DatasetApi.md#create_dataset) | **POST** /api/dataset |
|
112
|
-
*TrieveRubyClient::DatasetApi* | [**delete_dataset**](docs/DatasetApi.md#delete_dataset) | **DELETE** /api/dataset |
|
113
|
-
*TrieveRubyClient::DatasetApi* | [**get_client_dataset_config**](docs/DatasetApi.md#get_client_dataset_config) | **GET** /api/dataset/envs |
|
114
|
-
*TrieveRubyClient::DatasetApi* | [**get_dataset**](docs/DatasetApi.md#get_dataset) | **GET** /api/dataset/{dataset_id} |
|
115
|
-
*TrieveRubyClient::DatasetApi* | [**get_datasets_from_organization**](docs/DatasetApi.md#get_datasets_from_organization) | **GET** /api/dataset/organization/{organization_id} |
|
116
|
-
*TrieveRubyClient::DatasetApi* | [**update_dataset**](docs/DatasetApi.md#update_dataset) | **PUT** /api/dataset |
|
117
|
-
*TrieveRubyClient::EventsApi* | [**get_events**](docs/EventsApi.md#get_events) | **
|
118
|
-
*TrieveRubyClient::FileApi* | [**delete_file_handler**](docs/FileApi.md#delete_file_handler) | **DELETE** /api/file/{file_id} |
|
119
|
-
*TrieveRubyClient::FileApi* | [**get_dataset_files_handler**](docs/FileApi.md#get_dataset_files_handler) | **GET** /api/dataset/files/{dataset_id}/{page} |
|
120
|
-
*TrieveRubyClient::FileApi* | [**get_file_handler**](docs/FileApi.md#get_file_handler) | **GET** /api/file/{file_id} |
|
121
|
-
*TrieveRubyClient::FileApi* | [**upload_file_handler**](docs/FileApi.md#upload_file_handler) | **POST** /api/file |
|
122
|
-
*TrieveRubyClient::HealthApi* | [**health_check**](docs/HealthApi.md#health_check) | **GET** /api/health |
|
123
|
-
*TrieveRubyClient::InvitationApi* | [**post_invitation**](docs/InvitationApi.md#post_invitation) | **POST** /api/invitation |
|
124
|
-
*TrieveRubyClient::MessageApi* | [**create_message_completion_handler**](docs/MessageApi.md#create_message_completion_handler) | **POST** /api/message |
|
125
|
-
*TrieveRubyClient::MessageApi* | [**edit_message_handler**](docs/MessageApi.md#edit_message_handler) | **PUT** /api/message |
|
126
|
-
*TrieveRubyClient::MessageApi* | [**get_all_topic_messages**](docs/MessageApi.md#get_all_topic_messages) | **GET** /api/messages/{messages_topic_id} |
|
127
|
-
*TrieveRubyClient::MessageApi* | [**regenerate_message_handler**](docs/MessageApi.md#regenerate_message_handler) | **DELETE** /api/message |
|
128
|
-
*TrieveRubyClient::OrganizationApi* | [**create_organization**](docs/OrganizationApi.md#create_organization) | **POST** /api/organization |
|
129
|
-
*TrieveRubyClient::OrganizationApi* | [**delete_organization_by_id**](docs/OrganizationApi.md#delete_organization_by_id) | **DELETE** /api/organization/{organization_id} |
|
130
|
-
*TrieveRubyClient::OrganizationApi* | [**get_organization_by_id**](docs/OrganizationApi.md#get_organization_by_id) | **GET** /api/organization/{organization_id} |
|
131
|
-
*TrieveRubyClient::OrganizationApi* | [**get_organization_usage**](docs/OrganizationApi.md#get_organization_usage) | **GET** /api/organization/usage/{organization_id} |
|
132
|
-
*TrieveRubyClient::OrganizationApi* | [**get_organization_users**](docs/OrganizationApi.md#get_organization_users) | **GET** /api/organization/users/{organization_id} |
|
133
|
-
*TrieveRubyClient::OrganizationApi* | [**update_organization**](docs/OrganizationApi.md#update_organization) | **PUT** /api/organization |
|
134
|
-
*TrieveRubyClient::StripeApi* | [**cancel_subscription**](docs/StripeApi.md#cancel_subscription) | **DELETE** /api/stripe/subscription/{subscription_id} |
|
135
|
-
*TrieveRubyClient::StripeApi* | [**direct_to_payment_link**](docs/StripeApi.md#direct_to_payment_link) | **GET** /api/stripe/payment_link/{plan_id}/{organization_id} |
|
136
|
-
*TrieveRubyClient::StripeApi* | [**get_all_plans**](docs/StripeApi.md#get_all_plans) | **GET** /api/stripe/plans |
|
137
|
-
*TrieveRubyClient::StripeApi* | [**update_subscription_plan**](docs/StripeApi.md#update_subscription_plan) | **PATCH** /api/stripe/subscription_plan/{subscription_id}/{plan_id} |
|
138
|
-
*TrieveRubyClient::TopicApi* | [**create_topic**](docs/TopicApi.md#create_topic) | **POST** /api/topic |
|
139
|
-
*TrieveRubyClient::TopicApi* | [**delete_topic**](docs/TopicApi.md#delete_topic) | **DELETE** /api/topic |
|
140
|
-
*TrieveRubyClient::TopicApi* | [**get_all_topics_for_user**](docs/TopicApi.md#get_all_topics_for_user) | **GET** /api/topic/user/{user_id} |
|
141
|
-
*TrieveRubyClient::TopicApi* | [**update_topic**](docs/TopicApi.md#update_topic) | **PUT** /api/topic |
|
142
|
-
*TrieveRubyClient::UserApi* | [**delete_user_api_key**](docs/UserApi.md#delete_user_api_key) | **DELETE** /api/user/delete_api_key |
|
143
|
-
*TrieveRubyClient::UserApi* | [**set_user_api_key**](docs/UserApi.md#set_user_api_key) | **POST** /api/user/set_api_key |
|
144
|
-
*TrieveRubyClient::UserApi* | [**update_user**](docs/UserApi.md#update_user) | **PUT** /api/user |
|
79
|
+
*TrieveRubyClient::AuthApi* | [**callback**](docs/AuthApi.md#callback) | **GET** /api/auth/callback | OpenID Connect callback
|
80
|
+
*TrieveRubyClient::AuthApi* | [**get_me**](docs/AuthApi.md#get_me) | **GET** /api/auth/me | Get Me
|
81
|
+
*TrieveRubyClient::AuthApi* | [**login**](docs/AuthApi.md#login) | **GET** /api/auth | Login
|
82
|
+
*TrieveRubyClient::AuthApi* | [**logout**](docs/AuthApi.md#logout) | **DELETE** /api/auth | Logout
|
83
|
+
*TrieveRubyClient::ChunkApi* | [**create_chunk**](docs/ChunkApi.md#create_chunk) | **POST** /api/chunk | Create or Upsert Chunk or Chunks
|
84
|
+
*TrieveRubyClient::ChunkApi* | [**create_suggested_queries_handler**](docs/ChunkApi.md#create_suggested_queries_handler) | **POST** /api/chunk/gen_suggestions | Generate suggested queries
|
85
|
+
*TrieveRubyClient::ChunkApi* | [**delete_chunk**](docs/ChunkApi.md#delete_chunk) | **DELETE** /api/chunk/{chunk_id} | Delete Chunk
|
86
|
+
*TrieveRubyClient::ChunkApi* | [**delete_chunk_by_tracking_id**](docs/ChunkApi.md#delete_chunk_by_tracking_id) | **DELETE** /api/chunk/tracking_id/{tracking_id} | Delete Chunk By Tracking Id
|
87
|
+
*TrieveRubyClient::ChunkApi* | [**generate_off_chunks**](docs/ChunkApi.md#generate_off_chunks) | **POST** /api/chunk/generate | RAG on Specified Chunks
|
88
|
+
*TrieveRubyClient::ChunkApi* | [**get_chunk_by_id**](docs/ChunkApi.md#get_chunk_by_id) | **GET** /api/chunk/{chunk_id} | Get Chunk By Id
|
89
|
+
*TrieveRubyClient::ChunkApi* | [**get_chunk_by_tracking_id**](docs/ChunkApi.md#get_chunk_by_tracking_id) | **GET** /api/chunk/tracking_id/{tracking_id} | Get Chunk By Tracking Id
|
90
|
+
*TrieveRubyClient::ChunkApi* | [**get_recommended_chunks**](docs/ChunkApi.md#get_recommended_chunks) | **POST** /api/chunk/recommend | Get Recommended Chunks
|
91
|
+
*TrieveRubyClient::ChunkApi* | [**search_chunk**](docs/ChunkApi.md#search_chunk) | **POST** /api/chunk/search | Search
|
92
|
+
*TrieveRubyClient::ChunkApi* | [**update_chunk**](docs/ChunkApi.md#update_chunk) | **PUT** /api/chunk | Update Chunk
|
93
|
+
*TrieveRubyClient::ChunkApi* | [**update_chunk_by_tracking_id**](docs/ChunkApi.md#update_chunk_by_tracking_id) | **PUT** /api/chunk/tracking_id/update | Update Chunk By Tracking Id
|
94
|
+
*TrieveRubyClient::ChunkGroupApi* | [**add_chunk_to_group**](docs/ChunkGroupApi.md#add_chunk_to_group) | **POST** /api/chunk_group/chunk/{group_id} | Add Chunk to Group
|
95
|
+
*TrieveRubyClient::ChunkGroupApi* | [**add_chunk_to_group_by_tracking_id**](docs/ChunkGroupApi.md#add_chunk_to_group_by_tracking_id) | **POST** /api/chunk_group/tracking_id/{tracking_id} | Add Chunk to Group by Tracking ID
|
96
|
+
*TrieveRubyClient::ChunkGroupApi* | [**create_chunk_group**](docs/ChunkGroupApi.md#create_chunk_group) | **POST** /api/chunk_group | Create Chunk Group
|
97
|
+
*TrieveRubyClient::ChunkGroupApi* | [**delete_chunk_group**](docs/ChunkGroupApi.md#delete_chunk_group) | **DELETE** /api/chunk_group/{group_id} | Delete Group
|
98
|
+
*TrieveRubyClient::ChunkGroupApi* | [**delete_group_by_tracking_id**](docs/ChunkGroupApi.md#delete_group_by_tracking_id) | **DELETE** /api/chunk_group/tracking_id/{tracking_id} | Delete Group by Tracking ID
|
99
|
+
*TrieveRubyClient::ChunkGroupApi* | [**get_chunk_group**](docs/ChunkGroupApi.md#get_chunk_group) | **GET** /api/chunk_group/{group_id} | Get Group
|
100
|
+
*TrieveRubyClient::ChunkGroupApi* | [**get_chunks_in_group**](docs/ChunkGroupApi.md#get_chunks_in_group) | **GET** /api/chunk_group/{group_id}/{page} | Get Chunks in Group
|
101
|
+
*TrieveRubyClient::ChunkGroupApi* | [**get_chunks_in_group_by_tracking_id**](docs/ChunkGroupApi.md#get_chunks_in_group_by_tracking_id) | **GET** /api/chunk_group/tracking_id/{group_tracking_id}/{page} | Get Chunks in Group by Tracking ID
|
102
|
+
*TrieveRubyClient::ChunkGroupApi* | [**get_group_by_tracking_id**](docs/ChunkGroupApi.md#get_group_by_tracking_id) | **GET** /api/chunk_group/tracking_id/{tracking_id} | Get Group by Tracking ID
|
103
|
+
*TrieveRubyClient::ChunkGroupApi* | [**get_groups_chunk_is_in**](docs/ChunkGroupApi.md#get_groups_chunk_is_in) | **POST** /api/chunk_group/chunks | Get Groups for Chunks
|
104
|
+
*TrieveRubyClient::ChunkGroupApi* | [**get_recommended_groups**](docs/ChunkGroupApi.md#get_recommended_groups) | **POST** /api/chunk_group/recommend | Get Recommended Groups
|
105
|
+
*TrieveRubyClient::ChunkGroupApi* | [**get_specific_dataset_chunk_groups**](docs/ChunkGroupApi.md#get_specific_dataset_chunk_groups) | **GET** /api/dataset/groups/{dataset_id}/{page} | Get Groups for Dataset
|
106
|
+
*TrieveRubyClient::ChunkGroupApi* | [**remove_chunk_from_group**](docs/ChunkGroupApi.md#remove_chunk_from_group) | **DELETE** /api/chunk_group/chunk/{group_id} | Remove Chunk from Group
|
107
|
+
*TrieveRubyClient::ChunkGroupApi* | [**search_over_groups**](docs/ChunkGroupApi.md#search_over_groups) | **POST** /api/chunk_group/group_oriented_search | Search Over Groups
|
108
|
+
*TrieveRubyClient::ChunkGroupApi* | [**search_within_group**](docs/ChunkGroupApi.md#search_within_group) | **POST** /api/chunk_group/search | Search Within Group
|
109
|
+
*TrieveRubyClient::ChunkGroupApi* | [**update_chunk_group**](docs/ChunkGroupApi.md#update_chunk_group) | **PUT** /api/chunk_group | Update Group
|
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
|
+
*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
|
113
|
+
*TrieveRubyClient::DatasetApi* | [**get_client_dataset_config**](docs/DatasetApi.md#get_client_dataset_config) | **GET** /api/dataset/envs | Get Client Configuration
|
114
|
+
*TrieveRubyClient::DatasetApi* | [**get_dataset**](docs/DatasetApi.md#get_dataset) | **GET** /api/dataset/{dataset_id} | Get Dataset
|
115
|
+
*TrieveRubyClient::DatasetApi* | [**get_datasets_from_organization**](docs/DatasetApi.md#get_datasets_from_organization) | **GET** /api/dataset/organization/{organization_id} | Get Datasets from Organization
|
116
|
+
*TrieveRubyClient::DatasetApi* | [**update_dataset**](docs/DatasetApi.md#update_dataset) | **PUT** /api/dataset | Update Dataset
|
117
|
+
*TrieveRubyClient::EventsApi* | [**get_events**](docs/EventsApi.md#get_events) | **POST** /api/events | Get events for the dataset
|
118
|
+
*TrieveRubyClient::FileApi* | [**delete_file_handler**](docs/FileApi.md#delete_file_handler) | **DELETE** /api/file/{file_id} | Delete File
|
119
|
+
*TrieveRubyClient::FileApi* | [**get_dataset_files_handler**](docs/FileApi.md#get_dataset_files_handler) | **GET** /api/dataset/files/{dataset_id}/{page} | Get Files for Dataset
|
120
|
+
*TrieveRubyClient::FileApi* | [**get_file_handler**](docs/FileApi.md#get_file_handler) | **GET** /api/file/{file_id} | Get File
|
121
|
+
*TrieveRubyClient::FileApi* | [**upload_file_handler**](docs/FileApi.md#upload_file_handler) | **POST** /api/file | Upload File
|
122
|
+
*TrieveRubyClient::HealthApi* | [**health_check**](docs/HealthApi.md#health_check) | **GET** /api/health | Health Check
|
123
|
+
*TrieveRubyClient::InvitationApi* | [**post_invitation**](docs/InvitationApi.md#post_invitation) | **POST** /api/invitation | Send Invitation
|
124
|
+
*TrieveRubyClient::MessageApi* | [**create_message_completion_handler**](docs/MessageApi.md#create_message_completion_handler) | **POST** /api/message | Create a message
|
125
|
+
*TrieveRubyClient::MessageApi* | [**edit_message_handler**](docs/MessageApi.md#edit_message_handler) | **PUT** /api/message | Edit a message
|
126
|
+
*TrieveRubyClient::MessageApi* | [**get_all_topic_messages**](docs/MessageApi.md#get_all_topic_messages) | **GET** /api/messages/{messages_topic_id} | Get all messages for a given topic
|
127
|
+
*TrieveRubyClient::MessageApi* | [**regenerate_message_handler**](docs/MessageApi.md#regenerate_message_handler) | **DELETE** /api/message | Regenerate message
|
128
|
+
*TrieveRubyClient::OrganizationApi* | [**create_organization**](docs/OrganizationApi.md#create_organization) | **POST** /api/organization | Create Organization
|
129
|
+
*TrieveRubyClient::OrganizationApi* | [**delete_organization_by_id**](docs/OrganizationApi.md#delete_organization_by_id) | **DELETE** /api/organization/{organization_id} | Delete Organization
|
130
|
+
*TrieveRubyClient::OrganizationApi* | [**get_organization_by_id**](docs/OrganizationApi.md#get_organization_by_id) | **GET** /api/organization/{organization_id} | Get Organization
|
131
|
+
*TrieveRubyClient::OrganizationApi* | [**get_organization_usage**](docs/OrganizationApi.md#get_organization_usage) | **GET** /api/organization/usage/{organization_id} | Get Organization Usage
|
132
|
+
*TrieveRubyClient::OrganizationApi* | [**get_organization_users**](docs/OrganizationApi.md#get_organization_users) | **GET** /api/organization/users/{organization_id} | Get Organization Users
|
133
|
+
*TrieveRubyClient::OrganizationApi* | [**update_organization**](docs/OrganizationApi.md#update_organization) | **PUT** /api/organization | Update Organization
|
134
|
+
*TrieveRubyClient::StripeApi* | [**cancel_subscription**](docs/StripeApi.md#cancel_subscription) | **DELETE** /api/stripe/subscription/{subscription_id} | Cancel Subscription
|
135
|
+
*TrieveRubyClient::StripeApi* | [**direct_to_payment_link**](docs/StripeApi.md#direct_to_payment_link) | **GET** /api/stripe/payment_link/{plan_id}/{organization_id} | Checkout
|
136
|
+
*TrieveRubyClient::StripeApi* | [**get_all_plans**](docs/StripeApi.md#get_all_plans) | **GET** /api/stripe/plans | Get All Plans
|
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
|
+
*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
|
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
|
+
*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
|
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
|
+
*TrieveRubyClient::UserApi* | [**update_user**](docs/UserApi.md#update_user) | **PUT** /api/user | Update User
|
145
145
|
|
146
146
|
|
147
147
|
## Documentation for Models
|
148
148
|
|
149
149
|
- [TrieveRubyClient::AddChunkToGroupData](docs/AddChunkToGroupData.md)
|
150
150
|
- [TrieveRubyClient::ApiKeyDTO](docs/ApiKeyDTO.md)
|
151
|
+
- [TrieveRubyClient::AuthQuery](docs/AuthQuery.md)
|
152
|
+
- [TrieveRubyClient::BatchQueuedChunkResponse](docs/BatchQueuedChunkResponse.md)
|
151
153
|
- [TrieveRubyClient::BookmarkData](docs/BookmarkData.md)
|
152
154
|
- [TrieveRubyClient::BookmarkGroupResult](docs/BookmarkGroupResult.md)
|
153
155
|
- [TrieveRubyClient::ChatMessageProxy](docs/ChatMessageProxy.md)
|
156
|
+
- [TrieveRubyClient::ChunkData](docs/ChunkData.md)
|
154
157
|
- [TrieveRubyClient::ChunkFilter](docs/ChunkFilter.md)
|
155
158
|
- [TrieveRubyClient::ChunkGroup](docs/ChunkGroup.md)
|
156
159
|
- [TrieveRubyClient::ChunkGroupAndFile](docs/ChunkGroupAndFile.md)
|
@@ -178,6 +181,7 @@ Class | Method | HTTP request | Description
|
|
178
181
|
- [TrieveRubyClient::File](docs/File.md)
|
179
182
|
- [TrieveRubyClient::FileDTO](docs/FileDTO.md)
|
180
183
|
- [TrieveRubyClient::GenerateChunksRequest](docs/GenerateChunksRequest.md)
|
184
|
+
- [TrieveRubyClient::GetEventsData](docs/GetEventsData.md)
|
181
185
|
- [TrieveRubyClient::GetGroupsForChunksData](docs/GetGroupsForChunksData.md)
|
182
186
|
- [TrieveRubyClient::GroupData](docs/GroupData.md)
|
183
187
|
- [TrieveRubyClient::GroupScoreChunkDTO](docs/GroupScoreChunkDTO.md)
|
@@ -200,10 +204,10 @@ Class | Method | HTTP request | Description
|
|
200
204
|
- [TrieveRubyClient::SearchWithinGroupData](docs/SearchWithinGroupData.md)
|
201
205
|
- [TrieveRubyClient::SetUserApiKeyRequest](docs/SetUserApiKeyRequest.md)
|
202
206
|
- [TrieveRubyClient::SetUserApiKeyResponse](docs/SetUserApiKeyResponse.md)
|
207
|
+
- [TrieveRubyClient::SingleQueuedChunkResponse](docs/SingleQueuedChunkResponse.md)
|
203
208
|
- [TrieveRubyClient::SlimGroup](docs/SlimGroup.md)
|
204
209
|
- [TrieveRubyClient::SlimUser](docs/SlimUser.md)
|
205
210
|
- [TrieveRubyClient::StripePlan](docs/StripePlan.md)
|
206
|
-
- [TrieveRubyClient::StripeSubscription](docs/StripeSubscription.md)
|
207
211
|
- [TrieveRubyClient::SuggestedQueriesRequest](docs/SuggestedQueriesRequest.md)
|
208
212
|
- [TrieveRubyClient::SuggestedQueriesResponse](docs/SuggestedQueriesResponse.md)
|
209
213
|
- [TrieveRubyClient::Topic](docs/Topic.md)
|
data/docs/AddChunkToGroupData.md
CHANGED
@@ -4,7 +4,7 @@
|
|
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. | |
|
8
8
|
|
9
9
|
## Example
|
10
10
|
|
data/docs/AuthApi.md
CHANGED
@@ -1,22 +1,22 @@
|
|
1
1
|
# TrieveRubyClient::AuthApi
|
2
2
|
|
3
|
-
All URIs are relative to *http://localhost*
|
3
|
+
All URIs are relative to *http://localhost:8090*
|
4
4
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
|
-
| [**callback**](AuthApi.md#callback) | **GET** /api/auth/callback |
|
8
|
-
| [**get_me**](AuthApi.md#get_me) | **GET** /api/auth/me |
|
9
|
-
| [**login**](AuthApi.md#login) | **GET** /api/auth |
|
10
|
-
| [**logout**](AuthApi.md#logout) | **DELETE** /api/auth |
|
7
|
+
| [**callback**](AuthApi.md#callback) | **GET** /api/auth/callback | OpenID Connect callback |
|
8
|
+
| [**get_me**](AuthApi.md#get_me) | **GET** /api/auth/me | Get Me |
|
9
|
+
| [**login**](AuthApi.md#login) | **GET** /api/auth | Login |
|
10
|
+
| [**logout**](AuthApi.md#logout) | **DELETE** /api/auth | Logout |
|
11
11
|
|
12
12
|
|
13
13
|
## callback
|
14
14
|
|
15
15
|
> <SlimUser> callback
|
16
16
|
|
17
|
-
|
17
|
+
OpenID Connect callback
|
18
18
|
|
19
|
-
|
19
|
+
OpenID Connect callback This is the callback route for the OAuth provider, it should not be called directly. Redirects to browser with set-cookie header.
|
20
20
|
|
21
21
|
### Examples
|
22
22
|
|
@@ -27,7 +27,7 @@ require 'trieve_ruby_client'
|
|
27
27
|
api_instance = TrieveRubyClient::AuthApi.new
|
28
28
|
|
29
29
|
begin
|
30
|
-
#
|
30
|
+
# OpenID Connect callback
|
31
31
|
result = api_instance.callback
|
32
32
|
p result
|
33
33
|
rescue TrieveRubyClient::ApiError => e
|
@@ -43,7 +43,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
43
43
|
|
44
44
|
```ruby
|
45
45
|
begin
|
46
|
-
#
|
46
|
+
# OpenID Connect callback
|
47
47
|
data, status_code, headers = api_instance.callback_with_http_info
|
48
48
|
p status_code # => 2xx
|
49
49
|
p headers # => { ... }
|
@@ -75,9 +75,9 @@ No authorization required
|
|
75
75
|
|
76
76
|
> <SlimUser> get_me
|
77
77
|
|
78
|
-
|
78
|
+
Get Me
|
79
79
|
|
80
|
-
|
80
|
+
Get Me Get the user corresponding to your current auth credentials.
|
81
81
|
|
82
82
|
### Examples
|
83
83
|
|
@@ -95,7 +95,7 @@ end
|
|
95
95
|
api_instance = TrieveRubyClient::AuthApi.new
|
96
96
|
|
97
97
|
begin
|
98
|
-
#
|
98
|
+
# Get Me
|
99
99
|
result = api_instance.get_me
|
100
100
|
p result
|
101
101
|
rescue TrieveRubyClient::ApiError => e
|
@@ -111,7 +111,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
111
111
|
|
112
112
|
```ruby
|
113
113
|
begin
|
114
|
-
#
|
114
|
+
# Get Me
|
115
115
|
data, status_code, headers = api_instance.get_me_with_http_info
|
116
116
|
p status_code # => 2xx
|
117
117
|
p headers # => { ... }
|
@@ -141,11 +141,11 @@ This endpoint does not need any parameter.
|
|
141
141
|
|
142
142
|
## login
|
143
143
|
|
144
|
-
> login(
|
144
|
+
> login(content)
|
145
145
|
|
146
|
-
|
146
|
+
Login
|
147
147
|
|
148
|
-
|
148
|
+
Login This will redirect you to the OAuth provider for authentication with email/pass, SSO, Google, Github, etc.
|
149
149
|
|
150
150
|
### Examples
|
151
151
|
|
@@ -154,15 +154,11 @@ require 'time'
|
|
154
154
|
require 'trieve_ruby_client'
|
155
155
|
|
156
156
|
api_instance = TrieveRubyClient::AuthApi.new
|
157
|
-
|
158
|
-
inv_code: '38400000-8cf0-11bd-b23e-10b96e4ef00d', # String | Code sent via email as a result of successful call to send_invitation
|
159
|
-
organization_id: '38400000-8cf0-11bd-b23e-10b96e4ef00d', # String | ID of organization to authenticate into
|
160
|
-
redirect_uri: 'redirect_uri_example' # String | URL to redirect to after successful login
|
161
|
-
}
|
157
|
+
content = TrieveRubyClient::AuthQuery.new # AuthQuery | Query parameters for login to be included as kv pairs after ? on the request URL.
|
162
158
|
|
163
159
|
begin
|
164
|
-
#
|
165
|
-
api_instance.login(
|
160
|
+
# Login
|
161
|
+
api_instance.login(content)
|
166
162
|
rescue TrieveRubyClient::ApiError => e
|
167
163
|
puts "Error when calling AuthApi->login: #{e}"
|
168
164
|
end
|
@@ -172,12 +168,12 @@ end
|
|
172
168
|
|
173
169
|
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
174
170
|
|
175
|
-
> <Array(nil, Integer, Hash)> login_with_http_info(
|
171
|
+
> <Array(nil, Integer, Hash)> login_with_http_info(content)
|
176
172
|
|
177
173
|
```ruby
|
178
174
|
begin
|
179
|
-
#
|
180
|
-
data, status_code, headers = api_instance.login_with_http_info(
|
175
|
+
# Login
|
176
|
+
data, status_code, headers = api_instance.login_with_http_info(content)
|
181
177
|
p status_code # => 2xx
|
182
178
|
p headers # => { ... }
|
183
179
|
p data # => nil
|
@@ -190,9 +186,7 @@ end
|
|
190
186
|
|
191
187
|
| Name | Type | Description | Notes |
|
192
188
|
| ---- | ---- | ----------- | ----- |
|
193
|
-
| **
|
194
|
-
| **organization_id** | **String** | ID of organization to authenticate into | [optional] |
|
195
|
-
| **redirect_uri** | **String** | URL to redirect to after successful login | [optional] |
|
189
|
+
| **content** | [**AuthQuery**](.md) | Query parameters for login to be included as kv pairs after ? on the request URL. | |
|
196
190
|
|
197
191
|
### Return type
|
198
192
|
|
@@ -204,7 +198,7 @@ No authorization required
|
|
204
198
|
|
205
199
|
### HTTP request headers
|
206
200
|
|
207
|
-
- **Content-Type**:
|
201
|
+
- **Content-Type**: Not defined
|
208
202
|
- **Accept**: application/json
|
209
203
|
|
210
204
|
|
@@ -212,9 +206,9 @@ No authorization required
|
|
212
206
|
|
213
207
|
> logout
|
214
208
|
|
215
|
-
|
209
|
+
Logout
|
216
210
|
|
217
|
-
|
211
|
+
Logout Invalidate your current auth credential stored typically stored in a cookie. This does not invalidate your API key.
|
218
212
|
|
219
213
|
### Examples
|
220
214
|
|
@@ -225,7 +219,7 @@ require 'trieve_ruby_client'
|
|
225
219
|
api_instance = TrieveRubyClient::AuthApi.new
|
226
220
|
|
227
221
|
begin
|
228
|
-
#
|
222
|
+
# Logout
|
229
223
|
api_instance.logout
|
230
224
|
rescue TrieveRubyClient::ApiError => e
|
231
225
|
puts "Error when calling AuthApi->logout: #{e}"
|
@@ -240,7 +234,7 @@ This returns an Array which contains the response data (`nil` in this case), sta
|
|
240
234
|
|
241
235
|
```ruby
|
242
236
|
begin
|
243
|
-
#
|
237
|
+
# Logout
|
244
238
|
data, status_code, headers = api_instance.logout_with_http_info
|
245
239
|
p status_code # => 2xx
|
246
240
|
p headers # => { ... }
|
data/docs/AuthQuery.md
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
# TrieveRubyClient::AuthQuery
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **inv_code** | **String** | Code sent via email as a result of successful call to send_invitation | [optional] |
|
8
|
+
| **organization_id** | **String** | ID of organization to authenticate into | [optional] |
|
9
|
+
| **redirect_uri** | **String** | URL to redirect to after successful login | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'trieve_ruby_client'
|
15
|
+
|
16
|
+
instance = TrieveRubyClient::AuthQuery.new(
|
17
|
+
inv_code: null,
|
18
|
+
organization_id: null,
|
19
|
+
redirect_uri: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# TrieveRubyClient::BatchQueuedChunkResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **chunk_metadata** | [**Array<ChunkMetadata>**](ChunkMetadata.md) | | |
|
8
|
+
| **pos_in_queue** | **Integer** | The current position the last access item is in the queue | |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'trieve_ruby_client'
|
14
|
+
|
15
|
+
instance = TrieveRubyClient::BatchQueuedChunkResponse.new(
|
16
|
+
chunk_metadata: null,
|
17
|
+
pos_in_queue: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|