trieve_ruby_client 0.4.0 → 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 +13 -13
- data/docs/AddChunkToGroupData.md +1 -1
- data/docs/ChunkApi.md +25 -29
- data/docs/ChunkGroupApi.md +26 -32
- data/docs/GetEventsData.md +1 -1
- data/lib/trieve_ruby_client/api/auth_api.rb +1 -1
- data/lib/trieve_ruby_client/api/chunk_api.rb +28 -32
- data/lib/trieve_ruby_client/api/chunk_group_api.rb +36 -46
- data/lib/trieve_ruby_client/api/dataset_api.rb +1 -1
- 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 +1 -1
- data/lib/trieve_ruby_client/api/user_api.rb +1 -1
- 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 +2 -2
- 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_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 +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_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 +1 -1
- 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 +1 -1
- 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 +1 -1
- data/openapi-generator.yaml +1 -1
- data/openapi.json +111 -173
- 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 +1 -1
- data/spec/models/batch_queued_chunk_response_spec.rb +1 -1
- 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 +1 -1
- 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 +1 -1
- 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 +1 -1
- 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.4.0.gem +0 -0
- data/trieve_ruby_client.gemspec +1 -1
- metadata +3 -6
- data/docs/StripeSubscription.md +0 -30
- data/lib/trieve_ruby_client/models/stripe_subscription.rb +0 -311
- data/spec/models/stripe_subscription_spec.rb +0 -72
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
|
|
@@ -80,24 +80,24 @@ Class | Method | HTTP request | Description
|
|
80
80
|
*TrieveRubyClient::AuthApi* | [**get_me**](docs/AuthApi.md#get_me) | **GET** /api/auth/me | Get Me
|
81
81
|
*TrieveRubyClient::AuthApi* | [**login**](docs/AuthApi.md#login) | **GET** /api/auth | Login
|
82
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 Chunk
|
83
|
+
*TrieveRubyClient::ChunkApi* | [**create_chunk**](docs/ChunkApi.md#create_chunk) | **POST** /api/chunk | Create or Upsert Chunk or Chunks
|
84
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/{
|
85
|
+
*TrieveRubyClient::ChunkApi* | [**delete_chunk**](docs/ChunkApi.md#delete_chunk) | **DELETE** /api/chunk/{chunk_id} | Delete Chunk
|
86
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
|
88
|
-
*TrieveRubyClient::ChunkApi* | [**get_chunk_by_id**](docs/ChunkApi.md#get_chunk_by_id) | **GET** /api/chunk/{
|
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
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
90
|
*TrieveRubyClient::ChunkApi* | [**get_recommended_chunks**](docs/ChunkApi.md#get_recommended_chunks) | **POST** /api/chunk/recommend | Get Recommended Chunks
|
91
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
|
92
|
+
*TrieveRubyClient::ChunkApi* | [**update_chunk**](docs/ChunkApi.md#update_chunk) | **PUT** /api/chunk | Update Chunk
|
93
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
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
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
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/{
|
97
|
+
*TrieveRubyClient::ChunkGroupApi* | [**delete_chunk_group**](docs/ChunkGroupApi.md#delete_chunk_group) | **DELETE** /api/chunk_group/{group_id} | Delete Group
|
98
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/{
|
100
|
-
*TrieveRubyClient::ChunkGroupApi* | [**get_chunks_in_group**](docs/ChunkGroupApi.md#get_chunks_in_group) | **GET** /api/chunk_group/{
|
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
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
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
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
|
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/ChunkApi.md
CHANGED
@@ -4,16 +4,16 @@ All URIs are relative to *http://localhost:8090*
|
|
4
4
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
|
-
| [**create_chunk**](ChunkApi.md#create_chunk) | **POST** /api/chunk | Create Chunk |
|
7
|
+
| [**create_chunk**](ChunkApi.md#create_chunk) | **POST** /api/chunk | Create or Upsert Chunk or Chunks |
|
8
8
|
| [**create_suggested_queries_handler**](ChunkApi.md#create_suggested_queries_handler) | **POST** /api/chunk/gen_suggestions | Generate suggested queries |
|
9
|
-
| [**delete_chunk**](ChunkApi.md#delete_chunk) | **DELETE** /api/chunk/{
|
9
|
+
| [**delete_chunk**](ChunkApi.md#delete_chunk) | **DELETE** /api/chunk/{chunk_id} | Delete Chunk |
|
10
10
|
| [**delete_chunk_by_tracking_id**](ChunkApi.md#delete_chunk_by_tracking_id) | **DELETE** /api/chunk/tracking_id/{tracking_id} | Delete Chunk By Tracking Id |
|
11
|
-
| [**generate_off_chunks**](ChunkApi.md#generate_off_chunks) | **POST** /api/chunk/generate | RAG on
|
12
|
-
| [**get_chunk_by_id**](ChunkApi.md#get_chunk_by_id) | **GET** /api/chunk/{
|
11
|
+
| [**generate_off_chunks**](ChunkApi.md#generate_off_chunks) | **POST** /api/chunk/generate | RAG on Specified Chunks |
|
12
|
+
| [**get_chunk_by_id**](ChunkApi.md#get_chunk_by_id) | **GET** /api/chunk/{chunk_id} | Get Chunk By Id |
|
13
13
|
| [**get_chunk_by_tracking_id**](ChunkApi.md#get_chunk_by_tracking_id) | **GET** /api/chunk/tracking_id/{tracking_id} | Get Chunk By Tracking Id |
|
14
14
|
| [**get_recommended_chunks**](ChunkApi.md#get_recommended_chunks) | **POST** /api/chunk/recommend | Get Recommended Chunks |
|
15
15
|
| [**search_chunk**](ChunkApi.md#search_chunk) | **POST** /api/chunk/search | Search |
|
16
|
-
| [**update_chunk**](ChunkApi.md#update_chunk) | **PUT** /api/chunk
|
16
|
+
| [**update_chunk**](ChunkApi.md#update_chunk) | **PUT** /api/chunk | Update Chunk |
|
17
17
|
| [**update_chunk_by_tracking_id**](ChunkApi.md#update_chunk_by_tracking_id) | **PUT** /api/chunk/tracking_id/update | Update Chunk By Tracking Id |
|
18
18
|
|
19
19
|
|
@@ -21,9 +21,9 @@ All URIs are relative to *http://localhost:8090*
|
|
21
21
|
|
22
22
|
> <ReturnQueuedChunk> create_chunk(tr_dataset, create_chunk_data)
|
23
23
|
|
24
|
-
Create Chunk
|
24
|
+
Create or Upsert Chunk or Chunks
|
25
25
|
|
26
|
-
Create Chunk Create a new chunk. If the chunk has the same tracking_id as an existing chunk, the request will fail. Once a chunk is created, it can be searched for using the search endpoint.
|
26
|
+
Create or Upsert Chunk or Chunks Create a new chunk. If the chunk has the same tracking_id as an existing chunk, the request will fail. Once a chunk is created, it can be searched for using the search endpoint.
|
27
27
|
|
28
28
|
### Examples
|
29
29
|
|
@@ -43,7 +43,7 @@ tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the reque
|
|
43
43
|
create_chunk_data = nil # CreateChunkData | JSON request payload to create a new chunk (chunk)
|
44
44
|
|
45
45
|
begin
|
46
|
-
# Create Chunk
|
46
|
+
# Create or Upsert Chunk or Chunks
|
47
47
|
result = api_instance.create_chunk(tr_dataset, create_chunk_data)
|
48
48
|
p result
|
49
49
|
rescue TrieveRubyClient::ApiError => e
|
@@ -59,7 +59,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
59
59
|
|
60
60
|
```ruby
|
61
61
|
begin
|
62
|
-
# Create Chunk
|
62
|
+
# Create or Upsert Chunk or Chunks
|
63
63
|
data, status_code, headers = api_instance.create_chunk_with_http_info(tr_dataset, create_chunk_data)
|
64
64
|
p status_code # => 2xx
|
65
65
|
p headers # => { ... }
|
@@ -165,7 +165,7 @@ end
|
|
165
165
|
|
166
166
|
## delete_chunk
|
167
167
|
|
168
|
-
> delete_chunk(tr_dataset,
|
168
|
+
> delete_chunk(tr_dataset, chunk_id)
|
169
169
|
|
170
170
|
Delete Chunk
|
171
171
|
|
@@ -186,12 +186,11 @@ end
|
|
186
186
|
|
187
187
|
api_instance = TrieveRubyClient::ChunkApi.new
|
188
188
|
tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
|
189
|
-
|
190
|
-
chunk_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Id of the chunk you want to fetch. This can be either the chunk_id or the tracking_id.
|
189
|
+
chunk_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Id of the chunk you want to fetch.
|
191
190
|
|
192
191
|
begin
|
193
192
|
# Delete Chunk
|
194
|
-
api_instance.delete_chunk(tr_dataset,
|
193
|
+
api_instance.delete_chunk(tr_dataset, chunk_id)
|
195
194
|
rescue TrieveRubyClient::ApiError => e
|
196
195
|
puts "Error when calling ChunkApi->delete_chunk: #{e}"
|
197
196
|
end
|
@@ -201,12 +200,12 @@ end
|
|
201
200
|
|
202
201
|
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
203
202
|
|
204
|
-
> <Array(nil, Integer, Hash)> delete_chunk_with_http_info(tr_dataset,
|
203
|
+
> <Array(nil, Integer, Hash)> delete_chunk_with_http_info(tr_dataset, chunk_id)
|
205
204
|
|
206
205
|
```ruby
|
207
206
|
begin
|
208
207
|
# Delete Chunk
|
209
|
-
data, status_code, headers = api_instance.delete_chunk_with_http_info(tr_dataset,
|
208
|
+
data, status_code, headers = api_instance.delete_chunk_with_http_info(tr_dataset, chunk_id)
|
210
209
|
p status_code # => 2xx
|
211
210
|
p headers # => { ... }
|
212
211
|
p data # => nil
|
@@ -220,8 +219,7 @@ end
|
|
220
219
|
| Name | Type | Description | Notes |
|
221
220
|
| ---- | ---- | ----------- | ----- |
|
222
221
|
| **tr_dataset** | **String** | The dataset id to use for the request | |
|
223
|
-
| **
|
224
|
-
| **chunk_id** | **String** | Id of the chunk you want to fetch. This can be either the chunk_id or the tracking_id. | |
|
222
|
+
| **chunk_id** | **String** | Id of the chunk you want to fetch. | |
|
225
223
|
|
226
224
|
### Return type
|
227
225
|
|
@@ -313,9 +311,9 @@ nil (empty response body)
|
|
313
311
|
|
314
312
|
> String generate_off_chunks(tr_dataset, generate_chunks_request)
|
315
313
|
|
316
|
-
RAG on
|
314
|
+
RAG on Specified Chunks
|
317
315
|
|
318
|
-
RAG on
|
316
|
+
RAG on Specified Chunks This endpoint exists as an alternative to the topic+message concept where our API handles chat memory. With this endpoint, the user is responsible for providing the context window and the prompt. See more in the \"search before generate\" page at docs.trieve.ai.
|
319
317
|
|
320
318
|
### Examples
|
321
319
|
|
@@ -335,7 +333,7 @@ tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the reque
|
|
335
333
|
generate_chunks_request = TrieveRubyClient::GenerateChunksRequest.new({chunk_ids: ['chunk_ids_example'], prev_messages: [TrieveRubyClient::ChatMessageProxy.new({content: 'content_example', role: 'role_example'})]}) # GenerateChunksRequest | JSON request payload to perform RAG on some chunks (chunks)
|
336
334
|
|
337
335
|
begin
|
338
|
-
# RAG on
|
336
|
+
# RAG on Specified Chunks
|
339
337
|
result = api_instance.generate_off_chunks(tr_dataset, generate_chunks_request)
|
340
338
|
p result
|
341
339
|
rescue TrieveRubyClient::ApiError => e
|
@@ -351,7 +349,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
351
349
|
|
352
350
|
```ruby
|
353
351
|
begin
|
354
|
-
# RAG on
|
352
|
+
# RAG on Specified Chunks
|
355
353
|
data, status_code, headers = api_instance.generate_off_chunks_with_http_info(tr_dataset, generate_chunks_request)
|
356
354
|
p status_code # => 2xx
|
357
355
|
p headers # => { ... }
|
@@ -384,7 +382,7 @@ end
|
|
384
382
|
|
385
383
|
## get_chunk_by_id
|
386
384
|
|
387
|
-
> <ChunkMetadata> get_chunk_by_id(tr_dataset,
|
385
|
+
> <ChunkMetadata> get_chunk_by_id(tr_dataset, chunk_id)
|
388
386
|
|
389
387
|
Get Chunk By Id
|
390
388
|
|
@@ -405,12 +403,11 @@ end
|
|
405
403
|
|
406
404
|
api_instance = TrieveRubyClient::ChunkApi.new
|
407
405
|
tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
|
408
|
-
|
409
|
-
chunk_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Id of the chunk you want to fetch. This can be either the chunk_id or the tracking_id.
|
406
|
+
chunk_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Id of the chunk you want to fetch.
|
410
407
|
|
411
408
|
begin
|
412
409
|
# Get Chunk By Id
|
413
|
-
result = api_instance.get_chunk_by_id(tr_dataset,
|
410
|
+
result = api_instance.get_chunk_by_id(tr_dataset, chunk_id)
|
414
411
|
p result
|
415
412
|
rescue TrieveRubyClient::ApiError => e
|
416
413
|
puts "Error when calling ChunkApi->get_chunk_by_id: #{e}"
|
@@ -421,12 +418,12 @@ end
|
|
421
418
|
|
422
419
|
This returns an Array which contains the response data, status code and headers.
|
423
420
|
|
424
|
-
> <Array(<ChunkMetadata>, Integer, Hash)> get_chunk_by_id_with_http_info(tr_dataset,
|
421
|
+
> <Array(<ChunkMetadata>, Integer, Hash)> get_chunk_by_id_with_http_info(tr_dataset, chunk_id)
|
425
422
|
|
426
423
|
```ruby
|
427
424
|
begin
|
428
425
|
# Get Chunk By Id
|
429
|
-
data, status_code, headers = api_instance.get_chunk_by_id_with_http_info(tr_dataset,
|
426
|
+
data, status_code, headers = api_instance.get_chunk_by_id_with_http_info(tr_dataset, chunk_id)
|
430
427
|
p status_code # => 2xx
|
431
428
|
p headers # => { ... }
|
432
429
|
p data # => <ChunkMetadata>
|
@@ -440,8 +437,7 @@ end
|
|
440
437
|
| Name | Type | Description | Notes |
|
441
438
|
| ---- | ---- | ----------- | ----- |
|
442
439
|
| **tr_dataset** | **String** | The dataset id to use for the request | |
|
443
|
-
| **
|
444
|
-
| **chunk_id** | **String** | Id of the chunk you want to fetch. This can be either the chunk_id or the tracking_id. | |
|
440
|
+
| **chunk_id** | **String** | Id of the chunk you want to fetch. | |
|
445
441
|
|
446
442
|
### Return type
|
447
443
|
|
data/docs/ChunkGroupApi.md
CHANGED
@@ -7,10 +7,10 @@ All URIs are relative to *http://localhost:8090*
|
|
7
7
|
| [**add_chunk_to_group**](ChunkGroupApi.md#add_chunk_to_group) | **POST** /api/chunk_group/chunk/{group_id} | Add Chunk to Group |
|
8
8
|
| [**add_chunk_to_group_by_tracking_id**](ChunkGroupApi.md#add_chunk_to_group_by_tracking_id) | **POST** /api/chunk_group/tracking_id/{tracking_id} | Add Chunk to Group by Tracking ID |
|
9
9
|
| [**create_chunk_group**](ChunkGroupApi.md#create_chunk_group) | **POST** /api/chunk_group | Create Chunk Group |
|
10
|
-
| [**delete_chunk_group**](ChunkGroupApi.md#delete_chunk_group) | **DELETE** /api/chunk_group/{
|
10
|
+
| [**delete_chunk_group**](ChunkGroupApi.md#delete_chunk_group) | **DELETE** /api/chunk_group/{group_id} | Delete Group |
|
11
11
|
| [**delete_group_by_tracking_id**](ChunkGroupApi.md#delete_group_by_tracking_id) | **DELETE** /api/chunk_group/tracking_id/{tracking_id} | Delete Group by Tracking ID |
|
12
|
-
| [**get_chunk_group**](ChunkGroupApi.md#get_chunk_group) | **GET** /api/chunk_group/{
|
13
|
-
| [**get_chunks_in_group**](ChunkGroupApi.md#get_chunks_in_group) | **GET** /api/chunk_group/{
|
12
|
+
| [**get_chunk_group**](ChunkGroupApi.md#get_chunk_group) | **GET** /api/chunk_group/{group_id} | Get Group |
|
13
|
+
| [**get_chunks_in_group**](ChunkGroupApi.md#get_chunks_in_group) | **GET** /api/chunk_group/{group_id}/{page} | Get Chunks in Group |
|
14
14
|
| [**get_chunks_in_group_by_tracking_id**](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 |
|
15
15
|
| [**get_group_by_tracking_id**](ChunkGroupApi.md#get_group_by_tracking_id) | **GET** /api/chunk_group/tracking_id/{tracking_id} | Get Group by Tracking ID |
|
16
16
|
| [**get_groups_chunk_is_in**](ChunkGroupApi.md#get_groups_chunk_is_in) | **POST** /api/chunk_group/chunks | Get Groups for Chunks |
|
@@ -29,7 +29,7 @@ All URIs are relative to *http://localhost:8090*
|
|
29
29
|
|
30
30
|
Add Chunk to Group
|
31
31
|
|
32
|
-
Add Chunk to Group Route to add a chunk to a group
|
32
|
+
Add Chunk to Group Route to add a chunk to a group.
|
33
33
|
|
34
34
|
### Examples
|
35
35
|
|
@@ -103,7 +103,7 @@ nil (empty response body)
|
|
103
103
|
|
104
104
|
Add Chunk to Group by Tracking ID
|
105
105
|
|
106
|
-
Add Chunk to Group by Tracking ID Route to add a chunk to a group by tracking id.
|
106
|
+
Add Chunk to Group by Tracking ID Route to add a chunk to a group by tracking id.
|
107
107
|
|
108
108
|
### Examples
|
109
109
|
|
@@ -177,7 +177,7 @@ nil (empty response body)
|
|
177
177
|
|
178
178
|
Create Chunk Group
|
179
179
|
|
180
|
-
Create Chunk Group Create a new chunk_group.
|
180
|
+
Create Chunk Group Create a new chunk_group. This is a way to group chunks together. If you try to create a chunk_group with the same tracking_id as an existing chunk_group, this operation will fail.
|
181
181
|
|
182
182
|
### Examples
|
183
183
|
|
@@ -246,7 +246,7 @@ end
|
|
246
246
|
|
247
247
|
## delete_chunk_group
|
248
248
|
|
249
|
-
> delete_chunk_group(tr_dataset,
|
249
|
+
> delete_chunk_group(tr_dataset, group_id, delete_chunks)
|
250
250
|
|
251
251
|
Delete Group
|
252
252
|
|
@@ -267,13 +267,12 @@ end
|
|
267
267
|
|
268
268
|
api_instance = TrieveRubyClient::ChunkGroupApi.new
|
269
269
|
tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
|
270
|
-
|
271
|
-
group_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Id of the group you want to fetch. This can be either the group_id or the tracking_id. If both are provided, the group_id will be used.
|
270
|
+
group_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Id of the group you want to fetch.
|
272
271
|
delete_chunks = true # Boolean | Delete the chunks within the group
|
273
272
|
|
274
273
|
begin
|
275
274
|
# Delete Group
|
276
|
-
api_instance.delete_chunk_group(tr_dataset,
|
275
|
+
api_instance.delete_chunk_group(tr_dataset, group_id, delete_chunks)
|
277
276
|
rescue TrieveRubyClient::ApiError => e
|
278
277
|
puts "Error when calling ChunkGroupApi->delete_chunk_group: #{e}"
|
279
278
|
end
|
@@ -283,12 +282,12 @@ end
|
|
283
282
|
|
284
283
|
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
285
284
|
|
286
|
-
> <Array(nil, Integer, Hash)> delete_chunk_group_with_http_info(tr_dataset,
|
285
|
+
> <Array(nil, Integer, Hash)> delete_chunk_group_with_http_info(tr_dataset, group_id, delete_chunks)
|
287
286
|
|
288
287
|
```ruby
|
289
288
|
begin
|
290
289
|
# Delete Group
|
291
|
-
data, status_code, headers = api_instance.delete_chunk_group_with_http_info(tr_dataset,
|
290
|
+
data, status_code, headers = api_instance.delete_chunk_group_with_http_info(tr_dataset, group_id, delete_chunks)
|
292
291
|
p status_code # => 2xx
|
293
292
|
p headers # => { ... }
|
294
293
|
p data # => nil
|
@@ -302,8 +301,7 @@ end
|
|
302
301
|
| Name | Type | Description | Notes |
|
303
302
|
| ---- | ---- | ----------- | ----- |
|
304
303
|
| **tr_dataset** | **String** | The dataset id to use for the request | |
|
305
|
-
| **
|
306
|
-
| **group_id** | **String** | Id of the group you want to fetch. This can be either the group_id or the tracking_id. If both are provided, the group_id will be used. | |
|
304
|
+
| **group_id** | **String** | Id of the group you want to fetch. | |
|
307
305
|
| **delete_chunks** | **Boolean** | Delete the chunks within the group | |
|
308
306
|
|
309
307
|
### Return type
|
@@ -394,7 +392,7 @@ nil (empty response body)
|
|
394
392
|
|
395
393
|
## get_chunk_group
|
396
394
|
|
397
|
-
> <ChunkGroup> get_chunk_group(tr_dataset,
|
395
|
+
> <ChunkGroup> get_chunk_group(tr_dataset, group_id)
|
398
396
|
|
399
397
|
Get Group
|
400
398
|
|
@@ -415,12 +413,11 @@ end
|
|
415
413
|
|
416
414
|
api_instance = TrieveRubyClient::ChunkGroupApi.new
|
417
415
|
tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
|
418
|
-
|
419
|
-
group_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Id of the group you want to fetch. This can be either the group_id or the tracking_id.
|
416
|
+
group_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Id of the group you want to fetch.
|
420
417
|
|
421
418
|
begin
|
422
419
|
# Get Group
|
423
|
-
result = api_instance.get_chunk_group(tr_dataset,
|
420
|
+
result = api_instance.get_chunk_group(tr_dataset, group_id)
|
424
421
|
p result
|
425
422
|
rescue TrieveRubyClient::ApiError => e
|
426
423
|
puts "Error when calling ChunkGroupApi->get_chunk_group: #{e}"
|
@@ -431,12 +428,12 @@ end
|
|
431
428
|
|
432
429
|
This returns an Array which contains the response data, status code and headers.
|
433
430
|
|
434
|
-
> <Array(<ChunkGroup>, Integer, Hash)> get_chunk_group_with_http_info(tr_dataset,
|
431
|
+
> <Array(<ChunkGroup>, Integer, Hash)> get_chunk_group_with_http_info(tr_dataset, group_id)
|
435
432
|
|
436
433
|
```ruby
|
437
434
|
begin
|
438
435
|
# Get Group
|
439
|
-
data, status_code, headers = api_instance.get_chunk_group_with_http_info(tr_dataset,
|
436
|
+
data, status_code, headers = api_instance.get_chunk_group_with_http_info(tr_dataset, group_id)
|
440
437
|
p status_code # => 2xx
|
441
438
|
p headers # => { ... }
|
442
439
|
p data # => <ChunkGroup>
|
@@ -450,8 +447,7 @@ end
|
|
450
447
|
| Name | Type | Description | Notes |
|
451
448
|
| ---- | ---- | ----------- | ----- |
|
452
449
|
| **tr_dataset** | **String** | The dataset id to use for the request | |
|
453
|
-
| **
|
454
|
-
| **group_id** | **String** | Id of the group you want to fetch. This can be either the group_id or the tracking_id. | |
|
450
|
+
| **group_id** | **String** | Id of the group you want to fetch. | |
|
455
451
|
|
456
452
|
### Return type
|
457
453
|
|
@@ -469,7 +465,7 @@ end
|
|
469
465
|
|
470
466
|
## get_chunks_in_group
|
471
467
|
|
472
|
-
> <BookmarkData> get_chunks_in_group(tr_dataset,
|
468
|
+
> <BookmarkData> get_chunks_in_group(tr_dataset, group_id, page)
|
473
469
|
|
474
470
|
Get Chunks in Group
|
475
471
|
|
@@ -490,13 +486,12 @@ end
|
|
490
486
|
|
491
487
|
api_instance = TrieveRubyClient::ChunkGroupApi.new
|
492
488
|
tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
|
493
|
-
|
494
|
-
group_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Id of the group you want to fetch. This can be either the group_id or the tracking_id. If both are provided, the group_id will be used.
|
489
|
+
group_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Id of the group you want to fetch.
|
495
490
|
page = 789 # Integer | The page of chunks to get from the group
|
496
491
|
|
497
492
|
begin
|
498
493
|
# Get Chunks in Group
|
499
|
-
result = api_instance.get_chunks_in_group(tr_dataset,
|
494
|
+
result = api_instance.get_chunks_in_group(tr_dataset, group_id, page)
|
500
495
|
p result
|
501
496
|
rescue TrieveRubyClient::ApiError => e
|
502
497
|
puts "Error when calling ChunkGroupApi->get_chunks_in_group: #{e}"
|
@@ -507,12 +502,12 @@ end
|
|
507
502
|
|
508
503
|
This returns an Array which contains the response data, status code and headers.
|
509
504
|
|
510
|
-
> <Array(<BookmarkData>, Integer, Hash)> get_chunks_in_group_with_http_info(tr_dataset,
|
505
|
+
> <Array(<BookmarkData>, Integer, Hash)> get_chunks_in_group_with_http_info(tr_dataset, group_id, page)
|
511
506
|
|
512
507
|
```ruby
|
513
508
|
begin
|
514
509
|
# Get Chunks in Group
|
515
|
-
data, status_code, headers = api_instance.get_chunks_in_group_with_http_info(tr_dataset,
|
510
|
+
data, status_code, headers = api_instance.get_chunks_in_group_with_http_info(tr_dataset, group_id, page)
|
516
511
|
p status_code # => 2xx
|
517
512
|
p headers # => { ... }
|
518
513
|
p data # => <BookmarkData>
|
@@ -526,8 +521,7 @@ end
|
|
526
521
|
| Name | Type | Description | Notes |
|
527
522
|
| ---- | ---- | ----------- | ----- |
|
528
523
|
| **tr_dataset** | **String** | The dataset id to use for the request | |
|
529
|
-
| **
|
530
|
-
| **group_id** | **String** | Id of the group you want to fetch. This can be either the group_id or the tracking_id. If both are provided, the group_id will be used. | |
|
524
|
+
| **group_id** | **String** | Id of the group you want to fetch. | |
|
531
525
|
| **page** | **Integer** | The page of chunks to get from the group | |
|
532
526
|
|
533
527
|
### Return type
|
@@ -567,7 +561,7 @@ end
|
|
567
561
|
|
568
562
|
api_instance = TrieveRubyClient::ChunkGroupApi.new
|
569
563
|
tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
|
570
|
-
group_tracking_id = '
|
564
|
+
group_tracking_id = 'group_tracking_id_example' # String | The id of the group to get the chunks from
|
571
565
|
page = 789 # Integer | The page of chunks to get from the group
|
572
566
|
|
573
567
|
begin
|
@@ -1130,7 +1124,7 @@ end
|
|
1130
1124
|
|
1131
1125
|
Update Group
|
1132
1126
|
|
1133
|
-
Update Group Update a chunk_group.
|
1127
|
+
Update Group Update a chunk_group. If you try to change the tracking_id to one that already exists, this operation will fail.
|
1134
1128
|
|
1135
1129
|
### Examples
|
1136
1130
|
|
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
|
7
|
+
| **event_types** | **Array<String>** | The types of events to get. Any combination of file_uploaded, card_uploaded, card_action_failed, or card_updated. Leave undefined to get all events. | [optional] |
|
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
|
|
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 0.
|
6
|
+
The version of the OpenAPI document: 0.5.0
|
7
7
|
Contact: developers@trieve.ai
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
Generator version: 7.4.0
|