trieve_ruby_client 0.5.0 → 0.6.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/GENERATE_COMMAND.txt +1 -0
- data/README.md +22 -11
- data/docs/AddChunkToGroupData.md +4 -2
- data/docs/AuthApi.md +13 -7
- data/docs/ChunkApi.md +9 -9
- data/docs/ChunkGroup.md +4 -0
- data/docs/ChunkGroupApi.md +36 -27
- data/docs/CreateChunkGroupData.md +4 -0
- data/docs/DatasetApi.md +11 -11
- data/docs/EventsApi.md +2 -2
- data/docs/FileApi.md +3 -3
- 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 +5 -1
- data/docs/RecommendChunksResponseTypes.md +49 -0
- data/docs/RecommendGroupChunkResponseTypes.md +49 -0
- data/docs/RecommendGroupChunksRequest.md +34 -0
- data/docs/ScoreSlimChunks.md +20 -0
- data/docs/SearchChunkData.md +3 -1
- data/docs/SearchChunkResponseTypes.md +49 -0
- data/docs/SearchGroupSlimChunksResult.md +22 -0
- data/docs/SearchOverGroupsData.md +6 -4
- data/docs/SearchOverGroupsResponseTypes.md +49 -0
- data/docs/SearchOverGroupsSlimChunksResponseBody.md +20 -0
- data/docs/SearchSlimChunkQueryResponseBody.md +20 -0
- data/docs/SearchWithinGroupData.md +3 -1
- 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/UpdateChunkGroupData.md +4 -0
- data/docs/UpdateGroupByTrackingIDData.md +4 -0
- data/docs/UpdateUserData.md +1 -7
- data/docs/UserApi.md +9 -9
- data/lib/trieve_ruby_client/api/auth_api.rb +13 -11
- data/lib/trieve_ruby_client/api/chunk_api.rb +7 -7
- data/lib/trieve_ruby_client/api/chunk_group_api.rb +38 -31
- data/lib/trieve_ruby_client/api/dataset_api.rb +17 -22
- data/lib/trieve_ruby_client/api/events_api.rb +3 -3
- data/lib/trieve_ruby_client/api/file_api.rb +5 -5
- data/lib/trieve_ruby_client/api/health_api.rb +1 -1
- data/lib/trieve_ruby_client/api/invitation_api.rb +1 -1
- data/lib/trieve_ruby_client/api/message_api.rb +1 -1
- data/lib/trieve_ruby_client/api/organization_api.rb +1 -1
- data/lib/trieve_ruby_client/api/stripe_api.rb +1 -1
- data/lib/trieve_ruby_client/api/topic_api.rb +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 +17 -12
- data/lib/trieve_ruby_client/models/api_key_dto.rb +1 -1
- data/lib/trieve_ruby_client/models/auth_query.rb +1 -1
- data/lib/trieve_ruby_client/models/batch_queued_chunk_response.rb +1 -1
- data/lib/trieve_ruby_client/models/bookmark_data.rb +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 +22 -2
- data/lib/trieve_ruby_client/models/chunk_group_and_file.rb +1 -1
- data/lib/trieve_ruby_client/models/chunk_metadata.rb +1 -1
- data/lib/trieve_ruby_client/models/chunk_metadata_with_file_data.rb +1 -1
- data/lib/trieve_ruby_client/models/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 +26 -2
- data/lib/trieve_ruby_client/models/create_dataset_request.rb +1 -1
- data/lib/trieve_ruby_client/models/create_message_data.rb +1 -1
- data/lib/trieve_ruby_client/models/create_organization_data.rb +1 -1
- data/lib/trieve_ruby_client/models/create_topic_data.rb +1 -1
- data/lib/trieve_ruby_client/models/dataset.rb +1 -1
- data/lib/trieve_ruby_client/models/dataset_and_usage.rb +1 -1
- data/lib/trieve_ruby_client/models/dataset_dto.rb +1 -1
- data/lib/trieve_ruby_client/models/dataset_usage_count.rb +1 -1
- data/lib/trieve_ruby_client/models/delete_topic_data.rb +1 -1
- data/lib/trieve_ruby_client/models/delete_user_api_key_request.rb +1 -1
- data/lib/trieve_ruby_client/models/edit_message_data.rb +1 -1
- data/lib/trieve_ruby_client/models/error_response_body.rb +1 -1
- data/lib/trieve_ruby_client/models/event.rb +1 -1
- data/lib/trieve_ruby_client/models/event_return.rb +1 -1
- data/lib/trieve_ruby_client/models/field_condition.rb +1 -1
- data/lib/trieve_ruby_client/models/file.rb +1 -1
- data/lib/trieve_ruby_client/models/file_dto.rb +1 -1
- data/lib/trieve_ruby_client/models/generate_chunks_request.rb +1 -1
- data/lib/trieve_ruby_client/models/get_events_data.rb +1 -1
- data/lib/trieve_ruby_client/models/get_groups_for_chunks_data.rb +1 -1
- data/lib/trieve_ruby_client/models/group_data.rb +1 -1
- data/lib/trieve_ruby_client/models/group_score_chunk_dto.rb +12 -2
- data/lib/trieve_ruby_client/models/group_slim_chunks_dto.rb +239 -0
- data/lib/trieve_ruby_client/models/invitation_data.rb +1 -1
- data/lib/trieve_ruby_client/models/match_condition.rb +1 -1
- data/lib/trieve_ruby_client/models/message.rb +1 -1
- data/lib/trieve_ruby_client/models/organization.rb +1 -1
- data/lib/trieve_ruby_client/models/organization_usage_count.rb +1 -1
- data/lib/trieve_ruby_client/models/range.rb +5 -5
- data/lib/trieve_ruby_client/models/range_condition.rb +105 -0
- data/lib/trieve_ruby_client/models/reccomend_group_chunks_request.rb +17 -6
- data/lib/trieve_ruby_client/models/recommend_chunks_request.rb +28 -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/recommend_group_chunks_request.rb +341 -0
- data/lib/trieve_ruby_client/models/regenerate_message_data.rb +1 -1
- data/lib/trieve_ruby_client/models/return_queued_chunk.rb +1 -1
- data/lib/trieve_ruby_client/models/score_chunk_dto.rb +1 -1
- data/lib/trieve_ruby_client/models/score_slim_chunks.rb +239 -0
- data/lib/trieve_ruby_client/models/search_chunk_data.rb +14 -3
- 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 +19 -7
- 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 +14 -3
- data/lib/trieve_ruby_client/models/search_within_group_response_types.rb +105 -0
- data/lib/trieve_ruby_client/models/set_user_api_key_request.rb +1 -1
- data/lib/trieve_ruby_client/models/set_user_api_key_response.rb +1 -1
- data/lib/trieve_ruby_client/models/single_queued_chunk_response.rb +1 -1
- data/lib/trieve_ruby_client/models/slim_chunk_metadata.rb +329 -0
- data/lib/trieve_ruby_client/models/slim_group.rb +1 -1
- data/lib/trieve_ruby_client/models/slim_user.rb +5 -41
- data/lib/trieve_ruby_client/models/stripe_plan.rb +1 -1
- data/lib/trieve_ruby_client/models/suggested_queries_request.rb +1 -1
- data/lib/trieve_ruby_client/models/suggested_queries_response.rb +1 -1
- data/lib/trieve_ruby_client/models/topic.rb +1 -1
- data/lib/trieve_ruby_client/models/update_chunk_by_tracking_id_data.rb +1 -1
- data/lib/trieve_ruby_client/models/update_chunk_data.rb +15 -2
- data/lib/trieve_ruby_client/models/update_chunk_group_data.rb +26 -2
- data/lib/trieve_ruby_client/models/update_dataset_request.rb +1 -1
- data/lib/trieve_ruby_client/models/update_group_by_tracking_id_data.rb +26 -2
- data/lib/trieve_ruby_client/models/update_organization_data.rb +1 -1
- data/lib/trieve_ruby_client/models/update_topic_data.rb +1 -1
- data/lib/trieve_ruby_client/models/update_user_data.rb +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 +14 -3
- data/openapi-generator.yaml +1 -1
- data/openapi.json +679 -261
- data/spec/models/group_slim_chunks_dto_spec.rb +42 -0
- data/spec/models/range_condition_spec.rb +32 -0
- data/spec/models/recommend_chunks_response_types_spec.rb +32 -0
- data/spec/models/recommend_group_chunk_response_types_spec.rb +32 -0
- data/spec/models/recommend_group_chunks_request_spec.rb +84 -0
- data/spec/models/score_slim_chunks_spec.rb +42 -0
- data/spec/models/search_chunk_response_types_spec.rb +32 -0
- data/spec/models/search_group_slim_chunks_result_spec.rb +48 -0
- data/spec/models/search_over_groups_response_types_spec.rb +32 -0
- data/spec/models/search_over_groups_slim_chunks_response_body_spec.rb +42 -0
- data/spec/models/search_slim_chunk_query_response_body_spec.rb +42 -0
- data/spec/models/search_within_group_response_types_spec.rb +32 -0
- data/spec/models/slim_chunk_metadata_spec.rb +90 -0
- data/spec/spec_helper.rb +1 -1
- data/trieve_ruby_client-0.5.0.gem +0 -0
- data/trieve_ruby_client-0.5.7.gem +0 -0
- data/trieve_ruby_client.gemspec +1 -1
- metadata +57 -4
- data/trieve_ruby_client-0.3.5.gem +0 -0
- data/trieve_ruby_client-0.4.0.gem +0 -0
@@ -0,0 +1,36 @@
|
|
1
|
+
# TrieveRubyClient::SlimChunkMetadata
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **created_at** | **Time** | | |
|
8
|
+
| **id** | **String** | | |
|
9
|
+
| **link** | **String** | | [optional] |
|
10
|
+
| **metadata** | **Object** | | [optional] |
|
11
|
+
| **qdrant_point_id** | **String** | | [optional] |
|
12
|
+
| **tag_set** | **String** | | [optional] |
|
13
|
+
| **time_stamp** | **Time** | | [optional] |
|
14
|
+
| **tracking_id** | **String** | | [optional] |
|
15
|
+
| **updated_at** | **Time** | | |
|
16
|
+
| **weight** | **Float** | | |
|
17
|
+
|
18
|
+
## Example
|
19
|
+
|
20
|
+
```ruby
|
21
|
+
require 'trieve_ruby_client'
|
22
|
+
|
23
|
+
instance = TrieveRubyClient::SlimChunkMetadata.new(
|
24
|
+
created_at: null,
|
25
|
+
id: null,
|
26
|
+
link: null,
|
27
|
+
metadata: null,
|
28
|
+
qdrant_point_id: null,
|
29
|
+
tag_set: null,
|
30
|
+
time_stamp: null,
|
31
|
+
tracking_id: null,
|
32
|
+
updated_at: null,
|
33
|
+
weight: null
|
34
|
+
)
|
35
|
+
```
|
36
|
+
|
data/docs/SlimUser.md
CHANGED
@@ -9,9 +9,6 @@
|
|
9
9
|
| **name** | **String** | | [optional] |
|
10
10
|
| **orgs** | [**Array<Organization>**](Organization.md) | | |
|
11
11
|
| **user_orgs** | [**Array<UserOrganization>**](UserOrganization.md) | | |
|
12
|
-
| **username** | **String** | | [optional] |
|
13
|
-
| **visible_email** | **Boolean** | | |
|
14
|
-
| **website** | **String** | | [optional] |
|
15
12
|
|
16
13
|
## Example
|
17
14
|
|
@@ -23,10 +20,7 @@ instance = TrieveRubyClient::SlimUser.new(
|
|
23
20
|
id: null,
|
24
21
|
name: null,
|
25
22
|
orgs: null,
|
26
|
-
user_orgs: null
|
27
|
-
username: null,
|
28
|
-
visible_email: null,
|
29
|
-
website: null
|
23
|
+
user_orgs: null
|
30
24
|
)
|
31
25
|
```
|
32
26
|
|
data/docs/StripeApi.md
CHANGED
data/docs/TopicApi.md
CHANGED
@@ -1,11 +1,11 @@
|
|
1
1
|
# TrieveRubyClient::TopicApi
|
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_topic**](TopicApi.md#create_topic) | **POST** /api/topic | Create Topic |
|
8
|
-
| [**delete_topic**](TopicApi.md#delete_topic) | **DELETE** /api/topic | Delete Topic |
|
8
|
+
| [**delete_topic**](TopicApi.md#delete_topic) | **DELETE** /api/topic/{topic_id} | Delete Topic |
|
9
9
|
| [**get_all_topics_for_user**](TopicApi.md#get_all_topics_for_user) | **GET** /api/topic/user/{user_id} | Get All Topics for User |
|
10
10
|
| [**update_topic**](TopicApi.md#update_topic) | **PUT** /api/topic | Update Topic |
|
11
11
|
|
@@ -85,7 +85,7 @@ end
|
|
85
85
|
|
86
86
|
## delete_topic
|
87
87
|
|
88
|
-
> delete_topic(tr_dataset,
|
88
|
+
> delete_topic(tr_dataset, topic_id)
|
89
89
|
|
90
90
|
Delete Topic
|
91
91
|
|
@@ -106,11 +106,11 @@ end
|
|
106
106
|
|
107
107
|
api_instance = TrieveRubyClient::TopicApi.new
|
108
108
|
tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
|
109
|
-
|
109
|
+
topic_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The id of the topic you want to delete.
|
110
110
|
|
111
111
|
begin
|
112
112
|
# Delete Topic
|
113
|
-
api_instance.delete_topic(tr_dataset,
|
113
|
+
api_instance.delete_topic(tr_dataset, topic_id)
|
114
114
|
rescue TrieveRubyClient::ApiError => e
|
115
115
|
puts "Error when calling TopicApi->delete_topic: #{e}"
|
116
116
|
end
|
@@ -120,12 +120,12 @@ end
|
|
120
120
|
|
121
121
|
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
122
122
|
|
123
|
-
> <Array(nil, Integer, Hash)> delete_topic_with_http_info(tr_dataset,
|
123
|
+
> <Array(nil, Integer, Hash)> delete_topic_with_http_info(tr_dataset, topic_id)
|
124
124
|
|
125
125
|
```ruby
|
126
126
|
begin
|
127
127
|
# Delete Topic
|
128
|
-
data, status_code, headers = api_instance.delete_topic_with_http_info(tr_dataset,
|
128
|
+
data, status_code, headers = api_instance.delete_topic_with_http_info(tr_dataset, topic_id)
|
129
129
|
p status_code # => 2xx
|
130
130
|
p headers # => { ... }
|
131
131
|
p data # => nil
|
@@ -139,7 +139,7 @@ end
|
|
139
139
|
| Name | Type | Description | Notes |
|
140
140
|
| ---- | ---- | ----------- | ----- |
|
141
141
|
| **tr_dataset** | **String** | The dataset id to use for the request | |
|
142
|
-
| **
|
142
|
+
| **topic_id** | **String** | The id of the topic you want to delete. | |
|
143
143
|
|
144
144
|
### Return type
|
145
145
|
|
@@ -151,7 +151,7 @@ nil (empty response body)
|
|
151
151
|
|
152
152
|
### HTTP request headers
|
153
153
|
|
154
|
-
- **Content-Type**:
|
154
|
+
- **Content-Type**: Not defined
|
155
155
|
- **Accept**: application/json
|
156
156
|
|
157
157
|
|
data/docs/UpdateChunkData.md
CHANGED
@@ -10,6 +10,7 @@
|
|
10
10
|
| **group_tracking_ids** | **Array<String>** | Group tracking_ids are the tracking_ids of the groups that the chunk should be placed into. This is useful for when you want to update a chunk and add it to a group or multiple groups in one request. | [optional] |
|
11
11
|
| **link** | **String** | Link of the chunk you want to update. This can also be any string. Frequently, this is a link to the source of the chunk. The link value will not affect the embedding creation. If no link is provided, the existing link will be used. | [optional] |
|
12
12
|
| **metadata** | **Object** | The metadata is a JSON object which can be used to filter chunks. This is useful for when you want to filter chunks by arbitrary metadata. Unlike with tag filtering, there is a performance hit for filtering on metadata. If no metadata is provided, the existing metadata will be used. | [optional] |
|
13
|
+
| **tag_set** | **Array<String>** | Tag set is a list of tags. This can be used to filter chunks by tag. Unlike with metadata filtering, HNSW indices will exist for each tag such that there is not a performance hit for filtering on them. If no tag_set is provided, the existing tag_set will be used. | [optional] |
|
13
14
|
| **time_stamp** | **String** | Time_stamp should be an ISO 8601 combined date and time without timezone. It is used for time window filtering and recency-biasing search results. If no time_stamp is provided, the existing time_stamp will be used. | [optional] |
|
14
15
|
| **tracking_id** | **String** | Tracking_id of the chunk you want to update. This is required to match an existing chunk. | [optional] |
|
15
16
|
| **weight** | **Float** | Weight is a float which can be used to bias search results. This is useful for when you want to bias search results for a chunk. The magnitude only matters relative to other chunks in the chunk's dataset dataset. If no weight is provided, the existing weight will be used. | [optional] |
|
@@ -26,6 +27,7 @@ instance = TrieveRubyClient::UpdateChunkData.new(
|
|
26
27
|
group_tracking_ids: null,
|
27
28
|
link: null,
|
28
29
|
metadata: null,
|
30
|
+
tag_set: null,
|
29
31
|
time_stamp: null,
|
30
32
|
tracking_id: null,
|
31
33
|
weight: null
|
@@ -6,7 +6,9 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **description** | **String** | Description to assign to the chunk_group. Convenience field for you to avoid having to remember what the group is for. If not provided, the description will not be updated. | [optional] |
|
8
8
|
| **group_id** | **String** | Id of the chunk_group to update. | [optional] |
|
9
|
+
| **metadata** | **Object** | Optional metadata to assign to the chunk_group. This is a JSON object that can store any additional information you want to associate with the chunks inside of the chunk_group. | [optional] |
|
9
10
|
| **name** | **String** | Name to assign to the chunk_group. Does not need to be unique. If not provided, the name will not be updated. | [optional] |
|
11
|
+
| **tag_set** | **Array<String>** | Optional tags to assign to the chunk_group. This is a list of strings that can be used to categorize the chunks inside the chunk_group. | [optional] |
|
10
12
|
| **tracking_id** | **String** | Tracking Id of the chunk_group to update. | [optional] |
|
11
13
|
|
12
14
|
## Example
|
@@ -17,7 +19,9 @@ require 'trieve_ruby_client'
|
|
17
19
|
instance = TrieveRubyClient::UpdateChunkGroupData.new(
|
18
20
|
description: null,
|
19
21
|
group_id: null,
|
22
|
+
metadata: null,
|
20
23
|
name: null,
|
24
|
+
tag_set: null,
|
21
25
|
tracking_id: null
|
22
26
|
)
|
23
27
|
```
|
@@ -5,7 +5,9 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **description** | **String** | Description to assign to the chunk_group. Convenience field for you to avoid having to remember what the group is for. If not provided, the description will not be updated. | [optional] |
|
8
|
+
| **metadata** | **Object** | Optional metadata to assign to the chunk_group. This is a JSON object that can store any additional information you want to associate with the chunks inside of the chunk_group. | [optional] |
|
8
9
|
| **name** | **String** | Name to assign to the chunk_group. Does not need to be unique. If not provided, the name will not be updated. | [optional] |
|
10
|
+
| **tag_set** | **Array<String>** | Optional tags to assign to the chunk_group. This is a list of strings that can be used to categorize the chunks inside the chunk_group. | [optional] |
|
9
11
|
| **tracking_id** | **String** | Tracking Id of the chunk_group to update. | |
|
10
12
|
|
11
13
|
## Example
|
@@ -15,7 +17,9 @@ require 'trieve_ruby_client'
|
|
15
17
|
|
16
18
|
instance = TrieveRubyClient::UpdateGroupByTrackingIDData.new(
|
17
19
|
description: null,
|
20
|
+
metadata: null,
|
18
21
|
name: null,
|
22
|
+
tag_set: null,
|
19
23
|
tracking_id: null
|
20
24
|
)
|
21
25
|
```
|
data/docs/UpdateUserData.md
CHANGED
@@ -8,9 +8,6 @@
|
|
8
8
|
| **organization_id** | **String** | The id of the organization to update the user for. | |
|
9
9
|
| **role** | **Integer** | Either 0 (user), 1 (admin), or 2 (owner). If not provided, the current role will be used. The auth'ed user must have a role greater than or equal to the role being assigned. | [optional] |
|
10
10
|
| **user_id** | **String** | The id of the user to update, if not provided, the auth'ed user will be updated. If provided, the auth'ed user must be an admin (1) or owner (2) of the organization. | [optional] |
|
11
|
-
| **username** | **String** | The new username to assign to the user, if not provided, the current username will be used. | [optional] |
|
12
|
-
| **visible_email** | **Boolean** | Determines if the user's email is visible to other users, if not provided, the current value will be used. | [optional] |
|
13
|
-
| **website** | **String** | The new website to assign to the user, if not provided, the current website will be used. Used for linking to the user's personal or company website. | [optional] |
|
14
11
|
|
15
12
|
## Example
|
16
13
|
|
@@ -21,10 +18,7 @@ instance = TrieveRubyClient::UpdateUserData.new(
|
|
21
18
|
name: null,
|
22
19
|
organization_id: null,
|
23
20
|
role: null,
|
24
|
-
user_id: null
|
25
|
-
username: null,
|
26
|
-
visible_email: null,
|
27
|
-
website: null
|
21
|
+
user_id: null
|
28
22
|
)
|
29
23
|
```
|
30
24
|
|
data/docs/UserApi.md
CHANGED
@@ -1,17 +1,17 @@
|
|
1
1
|
# TrieveRubyClient::UserApi
|
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
|
-
| [**delete_user_api_key**](UserApi.md#delete_user_api_key) | **DELETE** /api/user/delete_api_key | Delete User Api Key |
|
7
|
+
| [**delete_user_api_key**](UserApi.md#delete_user_api_key) | **DELETE** /api/user/delete_api_key/{api_key_id} | Delete User Api Key |
|
8
8
|
| [**set_user_api_key**](UserApi.md#set_user_api_key) | **POST** /api/user/set_api_key | Set User Api Key |
|
9
9
|
| [**update_user**](UserApi.md#update_user) | **PUT** /api/user | Update User |
|
10
10
|
|
11
11
|
|
12
12
|
## delete_user_api_key
|
13
13
|
|
14
|
-
> <Array<ApiKeyDTO>> delete_user_api_key(
|
14
|
+
> <Array<ApiKeyDTO>> delete_user_api_key(api_key_id)
|
15
15
|
|
16
16
|
Delete User Api Key
|
17
17
|
|
@@ -31,11 +31,11 @@ TrieveRubyClient.configure do |config|
|
|
31
31
|
end
|
32
32
|
|
33
33
|
api_instance = TrieveRubyClient::UserApi.new
|
34
|
-
|
34
|
+
api_key_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The id of the api key to delete
|
35
35
|
|
36
36
|
begin
|
37
37
|
# Delete User Api Key
|
38
|
-
result = api_instance.delete_user_api_key(
|
38
|
+
result = api_instance.delete_user_api_key(api_key_id)
|
39
39
|
p result
|
40
40
|
rescue TrieveRubyClient::ApiError => e
|
41
41
|
puts "Error when calling UserApi->delete_user_api_key: #{e}"
|
@@ -46,12 +46,12 @@ end
|
|
46
46
|
|
47
47
|
This returns an Array which contains the response data, status code and headers.
|
48
48
|
|
49
|
-
> <Array(<Array<ApiKeyDTO>>, Integer, Hash)> delete_user_api_key_with_http_info(
|
49
|
+
> <Array(<Array<ApiKeyDTO>>, Integer, Hash)> delete_user_api_key_with_http_info(api_key_id)
|
50
50
|
|
51
51
|
```ruby
|
52
52
|
begin
|
53
53
|
# Delete User Api Key
|
54
|
-
data, status_code, headers = api_instance.delete_user_api_key_with_http_info(
|
54
|
+
data, status_code, headers = api_instance.delete_user_api_key_with_http_info(api_key_id)
|
55
55
|
p status_code # => 2xx
|
56
56
|
p headers # => { ... }
|
57
57
|
p data # => <Array<ApiKeyDTO>>
|
@@ -64,7 +64,7 @@ end
|
|
64
64
|
|
65
65
|
| Name | Type | Description | Notes |
|
66
66
|
| ---- | ---- | ----------- | ----- |
|
67
|
-
| **
|
67
|
+
| **api_key_id** | **String** | The id of the api key to delete | |
|
68
68
|
|
69
69
|
### Return type
|
70
70
|
|
@@ -76,7 +76,7 @@ end
|
|
76
76
|
|
77
77
|
### HTTP request headers
|
78
78
|
|
79
|
-
- **Content-Type**:
|
79
|
+
- **Content-Type**: Not defined
|
80
80
|
- **Accept**: application/json
|
81
81
|
|
82
82
|
|
@@ -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.6.0
|
7
7
|
Contact: developers@trieve.ai
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
Generator version: 7.4.0
|
@@ -135,33 +135,35 @@ module TrieveRubyClient
|
|
135
135
|
|
136
136
|
# Login
|
137
137
|
# Login This will redirect you to the OAuth provider for authentication with email/pass, SSO, Google, Github, etc.
|
138
|
-
# @param content [AuthQuery] Query parameters for login to be included as kv pairs after ? on the request URL.
|
139
138
|
# @param [Hash] opts the optional parameters
|
139
|
+
# @option opts [String] :organization_id ID of organization to authenticate into
|
140
|
+
# @option opts [String] :redirect_uri URL to redirect to after successful login
|
141
|
+
# @option opts [String] :inv_code Code sent via email as a result of successful call to send_invitation
|
140
142
|
# @return [nil]
|
141
|
-
def login(
|
142
|
-
login_with_http_info(
|
143
|
+
def login(opts = {})
|
144
|
+
login_with_http_info(opts)
|
143
145
|
nil
|
144
146
|
end
|
145
147
|
|
146
148
|
# Login
|
147
149
|
# Login This will redirect you to the OAuth provider for authentication with email/pass, SSO, Google, Github, etc.
|
148
|
-
# @param content [AuthQuery] Query parameters for login to be included as kv pairs after ? on the request URL.
|
149
150
|
# @param [Hash] opts the optional parameters
|
151
|
+
# @option opts [String] :organization_id ID of organization to authenticate into
|
152
|
+
# @option opts [String] :redirect_uri URL to redirect to after successful login
|
153
|
+
# @option opts [String] :inv_code Code sent via email as a result of successful call to send_invitation
|
150
154
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
151
|
-
def login_with_http_info(
|
155
|
+
def login_with_http_info(opts = {})
|
152
156
|
if @api_client.config.debugging
|
153
157
|
@api_client.config.logger.debug 'Calling API: AuthApi.login ...'
|
154
158
|
end
|
155
|
-
# verify the required parameter 'content' is set
|
156
|
-
if @api_client.config.client_side_validation && content.nil?
|
157
|
-
fail ArgumentError, "Missing the required parameter 'content' when calling AuthApi.login"
|
158
|
-
end
|
159
159
|
# resource path
|
160
160
|
local_var_path = '/api/auth'
|
161
161
|
|
162
162
|
# query parameters
|
163
163
|
query_params = opts[:query_params] || {}
|
164
|
-
query_params[:'
|
164
|
+
query_params[:'organization_id'] = opts[:'organization_id'] if !opts[:'organization_id'].nil?
|
165
|
+
query_params[:'redirect_uri'] = opts[:'redirect_uri'] if !opts[:'redirect_uri'].nil?
|
166
|
+
query_params[:'inv_code'] = opts[:'inv_code'] if !opts[:'inv_code'].nil?
|
165
167
|
|
166
168
|
# header parameters
|
167
169
|
header_params = opts[:header_params] || {}
|
@@ -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.6.0
|
7
7
|
Contact: developers@trieve.ai
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
Generator version: 7.4.0
|
@@ -529,7 +529,7 @@ module TrieveRubyClient
|
|
529
529
|
# @param tr_dataset [String] The dataset id to use for the request
|
530
530
|
# @param recommend_chunks_request [RecommendChunksRequest] JSON request payload to get recommendations of chunks similar to the chunks in the request
|
531
531
|
# @param [Hash] opts the optional parameters
|
532
|
-
# @return [
|
532
|
+
# @return [RecommendChunksResponseTypes]
|
533
533
|
def get_recommended_chunks(tr_dataset, recommend_chunks_request, opts = {})
|
534
534
|
data, _status_code, _headers = get_recommended_chunks_with_http_info(tr_dataset, recommend_chunks_request, opts)
|
535
535
|
data
|
@@ -540,7 +540,7 @@ module TrieveRubyClient
|
|
540
540
|
# @param tr_dataset [String] The dataset id to use for the request
|
541
541
|
# @param recommend_chunks_request [RecommendChunksRequest] JSON request payload to get recommendations of chunks similar to the chunks in the request
|
542
542
|
# @param [Hash] opts the optional parameters
|
543
|
-
# @return [Array<(
|
543
|
+
# @return [Array<(RecommendChunksResponseTypes, Integer, Hash)>] RecommendChunksResponseTypes data, response status code and response headers
|
544
544
|
def get_recommended_chunks_with_http_info(tr_dataset, recommend_chunks_request, opts = {})
|
545
545
|
if @api_client.config.debugging
|
546
546
|
@api_client.config.logger.debug 'Calling API: ChunkApi.get_recommended_chunks ...'
|
@@ -577,7 +577,7 @@ module TrieveRubyClient
|
|
577
577
|
post_body = opts[:debug_body] || @api_client.object_to_http_body(recommend_chunks_request)
|
578
578
|
|
579
579
|
# return_type
|
580
|
-
return_type = opts[:debug_return_type] || '
|
580
|
+
return_type = opts[:debug_return_type] || 'RecommendChunksResponseTypes'
|
581
581
|
|
582
582
|
# auth_names
|
583
583
|
auth_names = opts[:debug_auth_names] || ['ApiKey']
|
@@ -604,7 +604,7 @@ module TrieveRubyClient
|
|
604
604
|
# @param tr_dataset [String] The dataset id to use for the request
|
605
605
|
# @param search_chunk_data [SearchChunkData] JSON request payload to semantically search for chunks (chunks)
|
606
606
|
# @param [Hash] opts the optional parameters
|
607
|
-
# @return [
|
607
|
+
# @return [SearchChunkResponseTypes]
|
608
608
|
def search_chunk(tr_dataset, search_chunk_data, opts = {})
|
609
609
|
data, _status_code, _headers = search_chunk_with_http_info(tr_dataset, search_chunk_data, opts)
|
610
610
|
data
|
@@ -615,7 +615,7 @@ module TrieveRubyClient
|
|
615
615
|
# @param tr_dataset [String] The dataset id to use for the request
|
616
616
|
# @param search_chunk_data [SearchChunkData] JSON request payload to semantically search for chunks (chunks)
|
617
617
|
# @param [Hash] opts the optional parameters
|
618
|
-
# @return [Array<(
|
618
|
+
# @return [Array<(SearchChunkResponseTypes, Integer, Hash)>] SearchChunkResponseTypes data, response status code and response headers
|
619
619
|
def search_chunk_with_http_info(tr_dataset, search_chunk_data, opts = {})
|
620
620
|
if @api_client.config.debugging
|
621
621
|
@api_client.config.logger.debug 'Calling API: ChunkApi.search_chunk ...'
|
@@ -652,7 +652,7 @@ module TrieveRubyClient
|
|
652
652
|
post_body = opts[:debug_body] || @api_client.object_to_http_body(search_chunk_data)
|
653
653
|
|
654
654
|
# return_type
|
655
|
-
return_type = opts[:debug_return_type] || '
|
655
|
+
return_type = opts[:debug_return_type] || 'SearchChunkResponseTypes'
|
656
656
|
|
657
657
|
# auth_names
|
658
658
|
auth_names = opts[:debug_auth_names] || ['ApiKey']
|
@@ -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.6.0
|
7
7
|
Contact: developers@trieve.ai
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
Generator version: 7.4.0
|
@@ -257,7 +257,7 @@ module TrieveRubyClient
|
|
257
257
|
end
|
258
258
|
|
259
259
|
# Delete Group
|
260
|
-
# Delete Group This will delete a chunk_group.
|
260
|
+
# Delete Group This will delete a chunk_group. If you set delete_chunks to true, it will also delete the chunks within the group.
|
261
261
|
# @param tr_dataset [String] The dataset id to use for the request
|
262
262
|
# @param group_id [String] Id of the group you want to fetch.
|
263
263
|
# @param delete_chunks [Boolean] Delete the chunks within the group
|
@@ -269,7 +269,7 @@ module TrieveRubyClient
|
|
269
269
|
end
|
270
270
|
|
271
271
|
# Delete Group
|
272
|
-
# Delete Group This will delete a chunk_group.
|
272
|
+
# Delete Group This will delete a chunk_group. If you set delete_chunks to true, it will also delete the chunks within the group.
|
273
273
|
# @param tr_dataset [String] The dataset id to use for the request
|
274
274
|
# @param group_id [String] Id of the group you want to fetch.
|
275
275
|
# @param delete_chunks [Boolean] Delete the chunks within the group
|
@@ -474,7 +474,7 @@ module TrieveRubyClient
|
|
474
474
|
end
|
475
475
|
|
476
476
|
# Get Chunks in Group
|
477
|
-
# Get Chunks in Group Route to get all chunks for a group. The response is paginated, with each page containing 10 chunks.
|
477
|
+
# Get Chunks in Group Route to get all chunks for a group. The response is paginated, with each page containing 10 chunks. Page is 1-indexed.
|
478
478
|
# @param tr_dataset [String] The dataset id to use for the request
|
479
479
|
# @param group_id [String] Id of the group you want to fetch.
|
480
480
|
# @param page [Integer] The page of chunks to get from the group
|
@@ -486,7 +486,7 @@ module TrieveRubyClient
|
|
486
486
|
end
|
487
487
|
|
488
488
|
# Get Chunks in Group
|
489
|
-
# Get Chunks in Group Route to get all chunks for a group. The response is paginated, with each page containing 10 chunks.
|
489
|
+
# Get Chunks in Group Route to get all chunks for a group. The response is paginated, with each page containing 10 chunks. Page is 1-indexed.
|
490
490
|
# @param tr_dataset [String] The dataset id to use for the request
|
491
491
|
# @param group_id [String] Id of the group you want to fetch.
|
492
492
|
# @param page [Integer] The page of chunks to get from the group
|
@@ -550,7 +550,7 @@ module TrieveRubyClient
|
|
550
550
|
end
|
551
551
|
|
552
552
|
# Get Chunks in Group by Tracking ID
|
553
|
-
# Get Chunks in Group by Tracking ID Route to get all chunks for a group. The response is paginated, with each page containing 10 chunks. Support for custom page size is coming soon.
|
553
|
+
# Get Chunks in Group by Tracking ID Route to get all chunks for a group. The response is paginated, with each page containing 10 chunks. Support for custom page size is coming soon. Page is 1-indexed.
|
554
554
|
# @param tr_dataset [String] The dataset id to use for the request
|
555
555
|
# @param group_tracking_id [String] The id of the group to get the chunks from
|
556
556
|
# @param page [Integer] The page of chunks to get from the group
|
@@ -562,7 +562,7 @@ module TrieveRubyClient
|
|
562
562
|
end
|
563
563
|
|
564
564
|
# Get Chunks in Group by Tracking ID
|
565
|
-
# Get Chunks in Group by Tracking ID Route to get all chunks for a group. The response is paginated, with each page containing 10 chunks. Support for custom page size is coming soon.
|
565
|
+
# Get Chunks in Group by Tracking ID Route to get all chunks for a group. The response is paginated, with each page containing 10 chunks. Support for custom page size is coming soon. Page is 1-indexed.
|
566
566
|
# @param tr_dataset [String] The dataset id to use for the request
|
567
567
|
# @param group_tracking_id [String] The id of the group to get the chunks from
|
568
568
|
# @param page [Integer] The page of chunks to get from the group
|
@@ -777,21 +777,21 @@ module TrieveRubyClient
|
|
777
777
|
# Get Recommended Groups
|
778
778
|
# Get Recommended Groups Route to get recommended groups. This route will return groups which are similar to the groups in the request body.
|
779
779
|
# @param tr_dataset [String] The dataset id to use for the request
|
780
|
-
# @param
|
780
|
+
# @param recommend_group_chunks_request [RecommendGroupChunksRequest] JSON request payload to get recommendations of chunks similar to the chunks in the request
|
781
781
|
# @param [Hash] opts the optional parameters
|
782
|
-
# @return [
|
783
|
-
def get_recommended_groups(tr_dataset,
|
784
|
-
data, _status_code, _headers = get_recommended_groups_with_http_info(tr_dataset,
|
782
|
+
# @return [RecommendGroupChunkResponseTypes]
|
783
|
+
def get_recommended_groups(tr_dataset, recommend_group_chunks_request, opts = {})
|
784
|
+
data, _status_code, _headers = get_recommended_groups_with_http_info(tr_dataset, recommend_group_chunks_request, opts)
|
785
785
|
data
|
786
786
|
end
|
787
787
|
|
788
788
|
# Get Recommended Groups
|
789
789
|
# Get Recommended Groups Route to get recommended groups. This route will return groups which are similar to the groups in the request body.
|
790
790
|
# @param tr_dataset [String] The dataset id to use for the request
|
791
|
-
# @param
|
791
|
+
# @param recommend_group_chunks_request [RecommendGroupChunksRequest] JSON request payload to get recommendations of chunks similar to the chunks in the request
|
792
792
|
# @param [Hash] opts the optional parameters
|
793
|
-
# @return [Array<(
|
794
|
-
def get_recommended_groups_with_http_info(tr_dataset,
|
793
|
+
# @return [Array<(RecommendGroupChunkResponseTypes, Integer, Hash)>] RecommendGroupChunkResponseTypes data, response status code and response headers
|
794
|
+
def get_recommended_groups_with_http_info(tr_dataset, recommend_group_chunks_request, opts = {})
|
795
795
|
if @api_client.config.debugging
|
796
796
|
@api_client.config.logger.debug 'Calling API: ChunkGroupApi.get_recommended_groups ...'
|
797
797
|
end
|
@@ -799,9 +799,9 @@ module TrieveRubyClient
|
|
799
799
|
if @api_client.config.client_side_validation && tr_dataset.nil?
|
800
800
|
fail ArgumentError, "Missing the required parameter 'tr_dataset' when calling ChunkGroupApi.get_recommended_groups"
|
801
801
|
end
|
802
|
-
# verify the required parameter '
|
803
|
-
if @api_client.config.client_side_validation &&
|
804
|
-
fail ArgumentError, "Missing the required parameter '
|
802
|
+
# verify the required parameter 'recommend_group_chunks_request' is set
|
803
|
+
if @api_client.config.client_side_validation && recommend_group_chunks_request.nil?
|
804
|
+
fail ArgumentError, "Missing the required parameter 'recommend_group_chunks_request' when calling ChunkGroupApi.get_recommended_groups"
|
805
805
|
end
|
806
806
|
# resource path
|
807
807
|
local_var_path = '/api/chunk_group/recommend'
|
@@ -824,10 +824,10 @@ module TrieveRubyClient
|
|
824
824
|
form_params = opts[:form_params] || {}
|
825
825
|
|
826
826
|
# http body (model)
|
827
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
827
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(recommend_group_chunks_request)
|
828
828
|
|
829
829
|
# return_type
|
830
|
-
return_type = opts[:debug_return_type] || '
|
830
|
+
return_type = opts[:debug_return_type] || 'RecommendGroupChunkResponseTypes'
|
831
831
|
|
832
832
|
# auth_names
|
833
833
|
auth_names = opts[:debug_auth_names] || ['ApiKey']
|
@@ -853,7 +853,7 @@ module TrieveRubyClient
|
|
853
853
|
# Get Groups for Dataset Fetch the groups which belong to a dataset specified by its id.
|
854
854
|
# @param tr_dataset [String] The dataset id to use for the request
|
855
855
|
# @param dataset_id [String] The id of the dataset to fetch groups for.
|
856
|
-
# @param page [Integer] The page of groups to fetch.
|
856
|
+
# @param page [Integer] The page of groups to fetch. Page is 1-indexed.
|
857
857
|
# @param [Hash] opts the optional parameters
|
858
858
|
# @return [GroupData]
|
859
859
|
def get_specific_dataset_chunk_groups(tr_dataset, dataset_id, page, opts = {})
|
@@ -865,7 +865,7 @@ module TrieveRubyClient
|
|
865
865
|
# Get Groups for Dataset Fetch the groups which belong to a dataset specified by its id.
|
866
866
|
# @param tr_dataset [String] The dataset id to use for the request
|
867
867
|
# @param dataset_id [String] The id of the dataset to fetch groups for.
|
868
|
-
# @param page [Integer] The page of groups to fetch.
|
868
|
+
# @param page [Integer] The page of groups to fetch. Page is 1-indexed.
|
869
869
|
# @param [Hash] opts the optional parameters
|
870
870
|
# @return [Array<(GroupData, Integer, Hash)>] GroupData data, response status code and response headers
|
871
871
|
def get_specific_dataset_chunk_groups_with_http_info(tr_dataset, dataset_id, page, opts = {})
|
@@ -1008,23 +1008,29 @@ module TrieveRubyClient
|
|
1008
1008
|
|
1009
1009
|
# Search Over Groups
|
1010
1010
|
# Search Over Groups This route allows you to get groups as results instead of chunks. Each group returned will have the matching chunks sorted by similarity within the group. This is useful for when you want to get groups of chunks which are similar to the search query. If choosing hybrid search, the results will be re-ranked using BAAI/bge-reranker-large. Compatible with semantic, fulltext, or hybrid search modes.
|
1011
|
+
# @param tr_dataset [String] The dataset id to use for the request
|
1011
1012
|
# @param search_over_groups_data [SearchOverGroupsData] JSON request payload to semantically search over groups
|
1012
1013
|
# @param [Hash] opts the optional parameters
|
1013
|
-
# @return [
|
1014
|
-
def search_over_groups(search_over_groups_data, opts = {})
|
1015
|
-
data, _status_code, _headers = search_over_groups_with_http_info(search_over_groups_data, opts)
|
1014
|
+
# @return [SearchOverGroupsResponseTypes]
|
1015
|
+
def search_over_groups(tr_dataset, search_over_groups_data, opts = {})
|
1016
|
+
data, _status_code, _headers = search_over_groups_with_http_info(tr_dataset, search_over_groups_data, opts)
|
1016
1017
|
data
|
1017
1018
|
end
|
1018
1019
|
|
1019
1020
|
# Search Over Groups
|
1020
1021
|
# Search Over Groups This route allows you to get groups as results instead of chunks. Each group returned will have the matching chunks sorted by similarity within the group. This is useful for when you want to get groups of chunks which are similar to the search query. If choosing hybrid search, the results will be re-ranked using BAAI/bge-reranker-large. Compatible with semantic, fulltext, or hybrid search modes.
|
1022
|
+
# @param tr_dataset [String] The dataset id to use for the request
|
1021
1023
|
# @param search_over_groups_data [SearchOverGroupsData] JSON request payload to semantically search over groups
|
1022
1024
|
# @param [Hash] opts the optional parameters
|
1023
|
-
# @return [Array<(
|
1024
|
-
def search_over_groups_with_http_info(search_over_groups_data, opts = {})
|
1025
|
+
# @return [Array<(SearchOverGroupsResponseTypes, Integer, Hash)>] SearchOverGroupsResponseTypes data, response status code and response headers
|
1026
|
+
def search_over_groups_with_http_info(tr_dataset, search_over_groups_data, opts = {})
|
1025
1027
|
if @api_client.config.debugging
|
1026
1028
|
@api_client.config.logger.debug 'Calling API: ChunkGroupApi.search_over_groups ...'
|
1027
1029
|
end
|
1030
|
+
# verify the required parameter 'tr_dataset' is set
|
1031
|
+
if @api_client.config.client_side_validation && tr_dataset.nil?
|
1032
|
+
fail ArgumentError, "Missing the required parameter 'tr_dataset' when calling ChunkGroupApi.search_over_groups"
|
1033
|
+
end
|
1028
1034
|
# verify the required parameter 'search_over_groups_data' is set
|
1029
1035
|
if @api_client.config.client_side_validation && search_over_groups_data.nil?
|
1030
1036
|
fail ArgumentError, "Missing the required parameter 'search_over_groups_data' when calling ChunkGroupApi.search_over_groups"
|
@@ -1044,6 +1050,7 @@ module TrieveRubyClient
|
|
1044
1050
|
if !content_type.nil?
|
1045
1051
|
header_params['Content-Type'] = content_type
|
1046
1052
|
end
|
1053
|
+
header_params[:'TR-Dataset'] = tr_dataset
|
1047
1054
|
|
1048
1055
|
# form parameters
|
1049
1056
|
form_params = opts[:form_params] || {}
|
@@ -1052,10 +1059,10 @@ module TrieveRubyClient
|
|
1052
1059
|
post_body = opts[:debug_body] || @api_client.object_to_http_body(search_over_groups_data)
|
1053
1060
|
|
1054
1061
|
# return_type
|
1055
|
-
return_type = opts[:debug_return_type] || '
|
1062
|
+
return_type = opts[:debug_return_type] || 'SearchOverGroupsResponseTypes'
|
1056
1063
|
|
1057
1064
|
# auth_names
|
1058
|
-
auth_names = opts[:debug_auth_names] || []
|
1065
|
+
auth_names = opts[:debug_auth_names] || ['ApiKey']
|
1059
1066
|
|
1060
1067
|
new_options = opts.merge(
|
1061
1068
|
:operation => :"ChunkGroupApi.search_over_groups",
|
@@ -1079,7 +1086,7 @@ module TrieveRubyClient
|
|
1079
1086
|
# @param tr_dataset [String] The dataset id to use for the request
|
1080
1087
|
# @param search_within_group_data [SearchWithinGroupData] JSON request payload to semantically search a group
|
1081
1088
|
# @param [Hash] opts the optional parameters
|
1082
|
-
# @return [
|
1089
|
+
# @return [SearchWithinGroupResponseTypes]
|
1083
1090
|
def search_within_group(tr_dataset, search_within_group_data, opts = {})
|
1084
1091
|
data, _status_code, _headers = search_within_group_with_http_info(tr_dataset, search_within_group_data, opts)
|
1085
1092
|
data
|
@@ -1090,7 +1097,7 @@ module TrieveRubyClient
|
|
1090
1097
|
# @param tr_dataset [String] The dataset id to use for the request
|
1091
1098
|
# @param search_within_group_data [SearchWithinGroupData] JSON request payload to semantically search a group
|
1092
1099
|
# @param [Hash] opts the optional parameters
|
1093
|
-
# @return [Array<(
|
1100
|
+
# @return [Array<(SearchWithinGroupResponseTypes, Integer, Hash)>] SearchWithinGroupResponseTypes data, response status code and response headers
|
1094
1101
|
def search_within_group_with_http_info(tr_dataset, search_within_group_data, opts = {})
|
1095
1102
|
if @api_client.config.debugging
|
1096
1103
|
@api_client.config.logger.debug 'Calling API: ChunkGroupApi.search_within_group ...'
|
@@ -1127,7 +1134,7 @@ module TrieveRubyClient
|
|
1127
1134
|
post_body = opts[:debug_body] || @api_client.object_to_http_body(search_within_group_data)
|
1128
1135
|
|
1129
1136
|
# return_type
|
1130
|
-
return_type = opts[:debug_return_type] || '
|
1137
|
+
return_type = opts[:debug_return_type] || 'SearchWithinGroupResponseTypes'
|
1131
1138
|
|
1132
1139
|
# auth_names
|
1133
1140
|
auth_names = opts[:debug_auth_names] || ['ApiKey']
|