trieve_ruby_client 0.4.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 +29 -18
- data/docs/AddChunkToGroupData.md +1 -1
- data/docs/AuthApi.md +1 -1
- data/docs/ChunkApi.md +34 -38
- data/docs/ChunkGroupApi.md +51 -48
- data/docs/DatasetApi.md +9 -9
- data/docs/EventsApi.md +1 -1
- data/docs/FileApi.md +1 -1
- data/docs/GetEventsData.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 +34 -38
- data/lib/trieve_ruby_client/api/chunk_group_api.rb +56 -59
- 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 +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 +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/{stripe_subscription.rb → slim_chunk_metadata.rb} +75 -57
- 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 +692 -335
- 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/group_slim_chunks_dto_spec.rb +42 -0
- 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_condition_spec.rb +32 -0
- 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/recommend_chunks_response_types_spec.rb +32 -0
- data/spec/models/recommend_group_chunk_response_types_spec.rb +32 -0
- 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/score_slim_chunks_spec.rb +42 -0
- 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_chunk_response_types_spec.rb +32 -0
- data/spec/models/search_group_slim_chunks_result_spec.rb +48 -0
- 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_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_data_spec.rb +8 -8
- data/spec/models/search_within_group_response_types_spec.rb +32 -0
- 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/{stripe_subscription_spec.rb → slim_chunk_metadata_spec.rb} +33 -15
- 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.5.0.gem +0 -0
- data/trieve_ruby_client.gemspec +1 -1
- metadata +52 -7
- data/docs/StripeSubscription.md +0 -30
- data/trieve_ruby_client-0.3.5.gem +0 -0
data/docs/ChunkGroupApi.md
CHANGED
@@ -1,16 +1,16 @@
|
|
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
|
| ------ | ------------ | ----------- |
|
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
|
@@ -767,7 +761,7 @@ end
|
|
767
761
|
|
768
762
|
## get_recommended_groups
|
769
763
|
|
770
|
-
> <
|
764
|
+
> <RecommendGroupChunkResponseTypes> get_recommended_groups(tr_dataset, reccomend_group_chunks_request)
|
771
765
|
|
772
766
|
Get Recommended Groups
|
773
767
|
|
@@ -803,7 +797,7 @@ end
|
|
803
797
|
|
804
798
|
This returns an Array which contains the response data, status code and headers.
|
805
799
|
|
806
|
-
> <Array(<
|
800
|
+
> <Array(<RecommendGroupChunkResponseTypes>, Integer, Hash)> get_recommended_groups_with_http_info(tr_dataset, reccomend_group_chunks_request)
|
807
801
|
|
808
802
|
```ruby
|
809
803
|
begin
|
@@ -811,7 +805,7 @@ begin
|
|
811
805
|
data, status_code, headers = api_instance.get_recommended_groups_with_http_info(tr_dataset, reccomend_group_chunks_request)
|
812
806
|
p status_code # => 2xx
|
813
807
|
p headers # => { ... }
|
814
|
-
p data # => <
|
808
|
+
p data # => <RecommendGroupChunkResponseTypes>
|
815
809
|
rescue TrieveRubyClient::ApiError => e
|
816
810
|
puts "Error when calling ChunkGroupApi->get_recommended_groups_with_http_info: #{e}"
|
817
811
|
end
|
@@ -826,7 +820,7 @@ end
|
|
826
820
|
|
827
821
|
### Return type
|
828
822
|
|
829
|
-
[**
|
823
|
+
[**RecommendGroupChunkResponseTypes**](RecommendGroupChunkResponseTypes.md)
|
830
824
|
|
831
825
|
### Authorization
|
832
826
|
|
@@ -989,7 +983,7 @@ nil (empty response body)
|
|
989
983
|
|
990
984
|
## search_over_groups
|
991
985
|
|
992
|
-
> <
|
986
|
+
> <SearchOverGroupsResponseTypes> search_over_groups(tr_dataset, search_over_groups_data)
|
993
987
|
|
994
988
|
Search Over Groups
|
995
989
|
|
@@ -1000,13 +994,21 @@ Search Over Groups This route allows you to get groups as results instead of ch
|
|
1000
994
|
```ruby
|
1001
995
|
require 'time'
|
1002
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
|
1003
1004
|
|
1004
1005
|
api_instance = TrieveRubyClient::ChunkGroupApi.new
|
1006
|
+
tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
|
1005
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
|
1006
1008
|
|
1007
1009
|
begin
|
1008
1010
|
# Search Over Groups
|
1009
|
-
result = api_instance.search_over_groups(search_over_groups_data)
|
1011
|
+
result = api_instance.search_over_groups(tr_dataset, search_over_groups_data)
|
1010
1012
|
p result
|
1011
1013
|
rescue TrieveRubyClient::ApiError => e
|
1012
1014
|
puts "Error when calling ChunkGroupApi->search_over_groups: #{e}"
|
@@ -1017,15 +1019,15 @@ end
|
|
1017
1019
|
|
1018
1020
|
This returns an Array which contains the response data, status code and headers.
|
1019
1021
|
|
1020
|
-
> <Array(<
|
1022
|
+
> <Array(<SearchOverGroupsResponseTypes>, Integer, Hash)> search_over_groups_with_http_info(tr_dataset, search_over_groups_data)
|
1021
1023
|
|
1022
1024
|
```ruby
|
1023
1025
|
begin
|
1024
1026
|
# Search Over Groups
|
1025
|
-
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)
|
1026
1028
|
p status_code # => 2xx
|
1027
1029
|
p headers # => { ... }
|
1028
|
-
p data # => <
|
1030
|
+
p data # => <SearchOverGroupsResponseTypes>
|
1029
1031
|
rescue TrieveRubyClient::ApiError => e
|
1030
1032
|
puts "Error when calling ChunkGroupApi->search_over_groups_with_http_info: #{e}"
|
1031
1033
|
end
|
@@ -1035,15 +1037,16 @@ end
|
|
1035
1037
|
|
1036
1038
|
| Name | Type | Description | Notes |
|
1037
1039
|
| ---- | ---- | ----------- | ----- |
|
1040
|
+
| **tr_dataset** | **String** | The dataset id to use for the request | |
|
1038
1041
|
| **search_over_groups_data** | [**SearchOverGroupsData**](SearchOverGroupsData.md) | JSON request payload to semantically search over groups | |
|
1039
1042
|
|
1040
1043
|
### Return type
|
1041
1044
|
|
1042
|
-
[**
|
1045
|
+
[**SearchOverGroupsResponseTypes**](SearchOverGroupsResponseTypes.md)
|
1043
1046
|
|
1044
1047
|
### Authorization
|
1045
1048
|
|
1046
|
-
|
1049
|
+
[ApiKey](../README.md#ApiKey)
|
1047
1050
|
|
1048
1051
|
### HTTP request headers
|
1049
1052
|
|
@@ -1053,7 +1056,7 @@ No authorization required
|
|
1053
1056
|
|
1054
1057
|
## search_within_group
|
1055
1058
|
|
1056
|
-
> <
|
1059
|
+
> <SearchWithinGroupResponseTypes> search_within_group(tr_dataset, search_within_group_data)
|
1057
1060
|
|
1058
1061
|
Search Within Group
|
1059
1062
|
|
@@ -1089,7 +1092,7 @@ end
|
|
1089
1092
|
|
1090
1093
|
This returns an Array which contains the response data, status code and headers.
|
1091
1094
|
|
1092
|
-
> <Array(<
|
1095
|
+
> <Array(<SearchWithinGroupResponseTypes>, Integer, Hash)> search_within_group_with_http_info(tr_dataset, search_within_group_data)
|
1093
1096
|
|
1094
1097
|
```ruby
|
1095
1098
|
begin
|
@@ -1097,7 +1100,7 @@ begin
|
|
1097
1100
|
data, status_code, headers = api_instance.search_within_group_with_http_info(tr_dataset, search_within_group_data)
|
1098
1101
|
p status_code # => 2xx
|
1099
1102
|
p headers # => { ... }
|
1100
|
-
p data # => <
|
1103
|
+
p data # => <SearchWithinGroupResponseTypes>
|
1101
1104
|
rescue TrieveRubyClient::ApiError => e
|
1102
1105
|
puts "Error when calling ChunkGroupApi->search_within_group_with_http_info: #{e}"
|
1103
1106
|
end
|
@@ -1112,7 +1115,7 @@ end
|
|
1112
1115
|
|
1113
1116
|
### Return type
|
1114
1117
|
|
1115
|
-
[**
|
1118
|
+
[**SearchWithinGroupResponseTypes**](SearchWithinGroupResponseTypes.md)
|
1116
1119
|
|
1117
1120
|
### Authorization
|
1118
1121
|
|
@@ -1130,7 +1133,7 @@ end
|
|
1130
1133
|
|
1131
1134
|
Update Group
|
1132
1135
|
|
1133
|
-
Update Group Update a chunk_group.
|
1136
|
+
Update Group Update a chunk_group. If you try to change the tracking_id to one that already exists, this operation will fail.
|
1134
1137
|
|
1135
1138
|
### Examples
|
1136
1139
|
|
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/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
|
|
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
|
|