trieve_ruby_client 0.6.7 → 0.7.2
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 +7 -7
- data/docs/ChunkData.md +0 -2
- data/docs/ClientDatasetConfiguration.md +2 -0
- data/docs/CreateDatasetRequest.md +3 -1
- data/docs/CreateTopicData.md +3 -1
- data/docs/Dataset.md +2 -0
- data/docs/DatasetApi.md +1 -1
- data/docs/DatasetDTO.md +2 -0
- data/docs/FileApi.md +4 -6
- data/docs/GetEventsData.md +1 -1
- data/docs/RecommendChunksRequest.md +2 -0
- data/docs/RecommendGroupChunksRequest.md +2 -0
- data/docs/Topic.md +3 -3
- data/docs/TopicApi.md +17 -17
- data/docs/UpdateDatasetRequest.md +4 -2
- data/docs/UpdateUserOrgRoleData.md +22 -0
- data/docs/UserApi.md +9 -10
- data/lib/trieve_ruby_client/api/auth_api.rb +1 -1
- data/lib/trieve_ruby_client/api/chunk_api.rb +1 -1
- data/lib/trieve_ruby_client/api/chunk_group_api.rb +1 -1
- 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 +4 -11
- 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 +20 -20
- data/lib/trieve_ruby_client/api/user_api.rb +14 -14
- 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 +1 -1
- data/lib/trieve_ruby_client/models/api_key_dto.rb +1 -1
- data/lib/trieve_ruby_client/models/auth_query.rb +1 -1
- data/lib/trieve_ruby_client/models/batch_queued_chunk_response.rb +1 -1
- data/lib/trieve_ruby_client/models/bookmark_data.rb +1 -1
- data/lib/trieve_ruby_client/models/bookmark_group_result.rb +1 -1
- data/lib/trieve_ruby_client/models/chat_message_proxy.rb +1 -1
- data/lib/trieve_ruby_client/models/chunk_data.rb +2 -13
- 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_score.rb +1 -1
- data/lib/trieve_ruby_client/models/client_dataset_configuration.rb +18 -2
- 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 +17 -6
- 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 +23 -6
- data/lib/trieve_ruby_client/models/dataset.rb +12 -2
- data/lib/trieve_ruby_client/models/dataset_and_usage.rb +1 -1
- data/lib/trieve_ruby_client/models/dataset_dto.rb +12 -2
- 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 +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.rb +1 -1
- data/lib/trieve_ruby_client/models/group_score_slim_chunks.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/range_condition.rb +1 -1
- data/lib/trieve_ruby_client/models/recommend_chunks_request.rb +13 -2
- data/lib/trieve_ruby_client/models/recommend_group_chunks_request.rb +13 -2
- 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 +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_over_groups_data.rb +1 -1
- data/lib/trieve_ruby_client/models/search_over_groups_results.rb +1 -1
- data/lib/trieve_ruby_client/models/search_over_groups_slim_results.rb +1 -1
- data/lib/trieve_ruby_client/models/search_slim_chunk_query_response_body.rb +1 -1
- data/lib/trieve_ruby_client/models/search_within_group_data.rb +1 -1
- data/lib/trieve_ruby_client/models/search_within_group_results.rb +1 -1
- data/lib/trieve_ruby_client/models/search_within_group_slim_results.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_chunk_metadata.rb +1 -1
- data/lib/trieve_ruby_client/models/slim_chunk_metadata_with_score.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 +21 -21
- 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 +18 -13
- 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/update_user_org_role_data.rb +250 -0
- 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 +2 -2
- data/openapi-generator.yaml +1 -1
- data/openapi.json +71 -60
- data/spec/models/update_user_org_role_data_spec.rb +48 -0
- data/spec/spec_helper.rb +1 -1
- data/trieve_ruby_client-0.6.7.gem +0 -0
- data/trieve_ruby_client-0.6.9.gem +0 -0
- data/trieve_ruby_client.gemspec +1 -1
- metadata +8 -2
@@ -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.7.2
|
7
7
|
Contact: developers@trieve.ai
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
Generator version: 7.4.0
|
@@ -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.7.2
|
7
7
|
Contact: developers@trieve.ai
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
Generator version: 7.4.0
|
@@ -20,7 +20,7 @@ module TrieveRubyClient
|
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
22
|
# Create Topic
|
23
|
-
# Create Topic Create a new chat topic. Topics are attached to a
|
23
|
+
# Create Topic Create a new chat topic. Topics are attached to a owner_id's and act as a coordinator for conversation message history of gen-AI chat sessions.
|
24
24
|
# @param tr_dataset [String] The dataset id to use for the request
|
25
25
|
# @param create_topic_data [CreateTopicData] JSON request payload to create chat topic
|
26
26
|
# @param [Hash] opts the optional parameters
|
@@ -31,7 +31,7 @@ module TrieveRubyClient
|
|
31
31
|
end
|
32
32
|
|
33
33
|
# Create Topic
|
34
|
-
# Create Topic Create a new chat topic. Topics are attached to a
|
34
|
+
# Create Topic Create a new chat topic. Topics are attached to a owner_id's and act as a coordinator for conversation message history of gen-AI chat sessions.
|
35
35
|
# @param tr_dataset [String] The dataset id to use for the request
|
36
36
|
# @param create_topic_data [CreateTopicData] JSON request payload to create chat topic
|
37
37
|
# @param [Hash] opts the optional parameters
|
@@ -164,37 +164,37 @@ module TrieveRubyClient
|
|
164
164
|
return data, status_code, headers
|
165
165
|
end
|
166
166
|
|
167
|
-
# Get All Topics for
|
168
|
-
# Get All Topics for
|
169
|
-
# @param
|
167
|
+
# Get All Topics for Owner ID
|
168
|
+
# Get All Topics for Owner ID Get all topics belonging to an arbitary owner_id. This is useful for managing message history and chat sessions. It is common to use a browser fingerprint or your user's id as the owner_id.
|
169
|
+
# @param owner_id [String] The owner_id to get topics of; A common approach is to use a browser fingerprint or your user's id
|
170
170
|
# @param tr_dataset [String] The dataset id to use for the request
|
171
171
|
# @param [Hash] opts the optional parameters
|
172
172
|
# @return [Array<Topic>]
|
173
|
-
def
|
174
|
-
data, _status_code, _headers =
|
173
|
+
def get_all_topics_for_owner_id(owner_id, tr_dataset, opts = {})
|
174
|
+
data, _status_code, _headers = get_all_topics_for_owner_id_with_http_info(owner_id, tr_dataset, opts)
|
175
175
|
data
|
176
176
|
end
|
177
177
|
|
178
|
-
# Get All Topics for
|
179
|
-
# Get All Topics for
|
180
|
-
# @param
|
178
|
+
# Get All Topics for Owner ID
|
179
|
+
# Get All Topics for Owner ID Get all topics belonging to an arbitary owner_id. This is useful for managing message history and chat sessions. It is common to use a browser fingerprint or your user's id as the owner_id.
|
180
|
+
# @param owner_id [String] The owner_id to get topics of; A common approach is to use a browser fingerprint or your user's id
|
181
181
|
# @param tr_dataset [String] The dataset id to use for the request
|
182
182
|
# @param [Hash] opts the optional parameters
|
183
183
|
# @return [Array<(Array<Topic>, Integer, Hash)>] Array<Topic> data, response status code and response headers
|
184
|
-
def
|
184
|
+
def get_all_topics_for_owner_id_with_http_info(owner_id, tr_dataset, opts = {})
|
185
185
|
if @api_client.config.debugging
|
186
|
-
@api_client.config.logger.debug 'Calling API: TopicApi.
|
186
|
+
@api_client.config.logger.debug 'Calling API: TopicApi.get_all_topics_for_owner_id ...'
|
187
187
|
end
|
188
|
-
# verify the required parameter '
|
189
|
-
if @api_client.config.client_side_validation &&
|
190
|
-
fail ArgumentError, "Missing the required parameter '
|
188
|
+
# verify the required parameter 'owner_id' is set
|
189
|
+
if @api_client.config.client_side_validation && owner_id.nil?
|
190
|
+
fail ArgumentError, "Missing the required parameter 'owner_id' when calling TopicApi.get_all_topics_for_owner_id"
|
191
191
|
end
|
192
192
|
# verify the required parameter 'tr_dataset' is set
|
193
193
|
if @api_client.config.client_side_validation && tr_dataset.nil?
|
194
|
-
fail ArgumentError, "Missing the required parameter 'tr_dataset' when calling TopicApi.
|
194
|
+
fail ArgumentError, "Missing the required parameter 'tr_dataset' when calling TopicApi.get_all_topics_for_owner_id"
|
195
195
|
end
|
196
196
|
# resource path
|
197
|
-
local_var_path = '/api/topic/
|
197
|
+
local_var_path = '/api/topic/owner/{owner_id}'.sub('{' + 'owner_id' + '}', CGI.escape(owner_id.to_s))
|
198
198
|
|
199
199
|
# query parameters
|
200
200
|
query_params = opts[:query_params] || {}
|
@@ -218,7 +218,7 @@ module TrieveRubyClient
|
|
218
218
|
auth_names = opts[:debug_auth_names] || ['ApiKey']
|
219
219
|
|
220
220
|
new_options = opts.merge(
|
221
|
-
:operation => :"TopicApi.
|
221
|
+
:operation => :"TopicApi.get_all_topics_for_owner_id",
|
222
222
|
:header_params => header_params,
|
223
223
|
:query_params => query_params,
|
224
224
|
:form_params => form_params,
|
@@ -229,7 +229,7 @@ module TrieveRubyClient
|
|
229
229
|
|
230
230
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
231
231
|
if @api_client.config.debugging
|
232
|
-
@api_client.config.logger.debug "API called: TopicApi#
|
232
|
+
@api_client.config.logger.debug "API called: TopicApi#get_all_topics_for_owner_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
233
233
|
end
|
234
234
|
return data, status_code, headers
|
235
235
|
end
|
@@ -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.7.2
|
7
7
|
Contact: developers@trieve.ai
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
Generator version: 7.4.0
|
@@ -152,26 +152,26 @@ module TrieveRubyClient
|
|
152
152
|
|
153
153
|
# Update User
|
154
154
|
# Update User Update a user's information. If the user_id is not provided, the auth'ed user will be updated. If the user_id is provided, the auth'ed user must be an admin (1) or owner (2) of the organization.
|
155
|
-
# @param
|
155
|
+
# @param update_user_org_role_data [UpdateUserOrgRoleData] JSON request payload to update user information for the auth'ed user
|
156
156
|
# @param [Hash] opts the optional parameters
|
157
|
-
# @return [
|
158
|
-
def update_user(
|
159
|
-
|
160
|
-
|
157
|
+
# @return [nil]
|
158
|
+
def update_user(update_user_org_role_data, opts = {})
|
159
|
+
update_user_with_http_info(update_user_org_role_data, opts)
|
160
|
+
nil
|
161
161
|
end
|
162
162
|
|
163
163
|
# Update User
|
164
164
|
# Update User Update a user's information. If the user_id is not provided, the auth'ed user will be updated. If the user_id is provided, the auth'ed user must be an admin (1) or owner (2) of the organization.
|
165
|
-
# @param
|
165
|
+
# @param update_user_org_role_data [UpdateUserOrgRoleData] JSON request payload to update user information for the auth'ed user
|
166
166
|
# @param [Hash] opts the optional parameters
|
167
|
-
# @return [Array<(
|
168
|
-
def update_user_with_http_info(
|
167
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
168
|
+
def update_user_with_http_info(update_user_org_role_data, opts = {})
|
169
169
|
if @api_client.config.debugging
|
170
170
|
@api_client.config.logger.debug 'Calling API: UserApi.update_user ...'
|
171
171
|
end
|
172
|
-
# verify the required parameter '
|
173
|
-
if @api_client.config.client_side_validation &&
|
174
|
-
fail ArgumentError, "Missing the required parameter '
|
172
|
+
# verify the required parameter 'update_user_org_role_data' is set
|
173
|
+
if @api_client.config.client_side_validation && update_user_org_role_data.nil?
|
174
|
+
fail ArgumentError, "Missing the required parameter 'update_user_org_role_data' when calling UserApi.update_user"
|
175
175
|
end
|
176
176
|
# resource path
|
177
177
|
local_var_path = '/api/user'
|
@@ -193,10 +193,10 @@ module TrieveRubyClient
|
|
193
193
|
form_params = opts[:form_params] || {}
|
194
194
|
|
195
195
|
# http body (model)
|
196
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
196
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(update_user_org_role_data)
|
197
197
|
|
198
198
|
# return_type
|
199
|
-
return_type = opts[:debug_return_type]
|
199
|
+
return_type = opts[:debug_return_type]
|
200
200
|
|
201
201
|
# auth_names
|
202
202
|
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.7.2
|
7
7
|
Contact: developers@trieve.ai
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
Generator version: 7.4.0
|
@@ -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.7.2
|
7
7
|
Contact: developers@trieve.ai
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
Generator version: 7.4.0
|
@@ -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.7.2
|
7
7
|
Contact: developers@trieve.ai
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
Generator version: 7.4.0
|
@@ -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.7.2
|
7
7
|
Contact: developers@trieve.ai
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
Generator version: 7.4.0
|
@@ -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.7.2
|
7
7
|
Contact: developers@trieve.ai
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
Generator version: 7.4.0
|
@@ -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.7.2
|
7
7
|
Contact: developers@trieve.ai
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
Generator version: 7.4.0
|
@@ -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.7.2
|
7
7
|
Contact: developers@trieve.ai
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
Generator version: 7.4.0
|
@@ -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.7.2
|
7
7
|
Contact: developers@trieve.ai
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
Generator version: 7.4.0
|
@@ -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.7.2
|
7
7
|
Contact: developers@trieve.ai
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
Generator version: 7.4.0
|
@@ -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.7.2
|
7
7
|
Contact: developers@trieve.ai
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
Generator version: 7.4.0
|
@@ -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.7.2
|
7
7
|
Contact: developers@trieve.ai
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
Generator version: 7.4.0
|
@@ -24,9 +24,6 @@ module TrieveRubyClient
|
|
24
24
|
# Convert HTML to raw text before processing to avoid adding noise to the vector embeddings. By default this is true. If you are using HTML content that you want to be included in the vector embeddings, set this to false.
|
25
25
|
attr_accessor :convert_html_to_text
|
26
26
|
|
27
|
-
# File_uuid is the uuid of the file that the chunk is associated with. This is used to associate chunks with files. This is useful for when you want to delete a file and all of its associated chunks.
|
28
|
-
attr_accessor :file_id
|
29
|
-
|
30
27
|
# Group ids are the ids of the groups that the chunk should be placed into. This is useful for when you want to create a chunk and add it to a group or multiple groups in one request. Necessary because this route queues the chunk for ingestion and the chunk may not exist yet immediately after response.
|
31
28
|
attr_accessor :group_ids
|
32
29
|
|
@@ -63,7 +60,6 @@ module TrieveRubyClient
|
|
63
60
|
:'chunk_html' => :'chunk_html',
|
64
61
|
:'chunk_vector' => :'chunk_vector',
|
65
62
|
:'convert_html_to_text' => :'convert_html_to_text',
|
66
|
-
:'file_id' => :'file_id',
|
67
63
|
:'group_ids' => :'group_ids',
|
68
64
|
:'group_tracking_ids' => :'group_tracking_ids',
|
69
65
|
:'link' => :'link',
|
@@ -88,7 +84,6 @@ module TrieveRubyClient
|
|
88
84
|
:'chunk_html' => :'String',
|
89
85
|
:'chunk_vector' => :'Array<Float>',
|
90
86
|
:'convert_html_to_text' => :'Boolean',
|
91
|
-
:'file_id' => :'String',
|
92
87
|
:'group_ids' => :'Array<String>',
|
93
88
|
:'group_tracking_ids' => :'Array<String>',
|
94
89
|
:'link' => :'String',
|
@@ -108,7 +103,6 @@ module TrieveRubyClient
|
|
108
103
|
:'chunk_html',
|
109
104
|
:'chunk_vector',
|
110
105
|
:'convert_html_to_text',
|
111
|
-
:'file_id',
|
112
106
|
:'group_ids',
|
113
107
|
:'group_tracking_ids',
|
114
108
|
:'link',
|
@@ -151,10 +145,6 @@ module TrieveRubyClient
|
|
151
145
|
self.convert_html_to_text = attributes[:'convert_html_to_text']
|
152
146
|
end
|
153
147
|
|
154
|
-
if attributes.key?(:'file_id')
|
155
|
-
self.file_id = attributes[:'file_id']
|
156
|
-
end
|
157
|
-
|
158
148
|
if attributes.key?(:'group_ids')
|
159
149
|
if (value = attributes[:'group_ids']).is_a?(Array)
|
160
150
|
self.group_ids = value
|
@@ -225,7 +215,6 @@ module TrieveRubyClient
|
|
225
215
|
chunk_html == o.chunk_html &&
|
226
216
|
chunk_vector == o.chunk_vector &&
|
227
217
|
convert_html_to_text == o.convert_html_to_text &&
|
228
|
-
file_id == o.file_id &&
|
229
218
|
group_ids == o.group_ids &&
|
230
219
|
group_tracking_ids == o.group_tracking_ids &&
|
231
220
|
link == o.link &&
|
@@ -247,7 +236,7 @@ module TrieveRubyClient
|
|
247
236
|
# Calculates hash code according to all attributes.
|
248
237
|
# @return [Integer] Hash code
|
249
238
|
def hash
|
250
|
-
[chunk_html, chunk_vector, convert_html_to_text,
|
239
|
+
[chunk_html, chunk_vector, convert_html_to_text, group_ids, group_tracking_ids, link, metadata, split_avg, tag_set, time_stamp, tracking_id, upsert_by_tracking_id, weight].hash
|
251
240
|
end
|
252
241
|
|
253
242
|
# Builds the object from hash
|
@@ -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.7.2
|
7
7
|
Contact: developers@trieve.ai
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
Generator version: 7.4.0
|
@@ -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.7.2
|
7
7
|
Contact: developers@trieve.ai
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
Generator version: 7.4.0
|
@@ -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.7.2
|
7
7
|
Contact: developers@trieve.ai
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
Generator version: 7.4.0
|
@@ -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.7.2
|
7
7
|
Contact: developers@trieve.ai
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
Generator version: 7.4.0
|
@@ -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.7.2
|
7
7
|
Contact: developers@trieve.ai
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
Generator version: 7.4.0
|
@@ -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.7.2
|
7
7
|
Contact: developers@trieve.ai
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
Generator version: 7.4.0
|
@@ -27,6 +27,8 @@ module TrieveRubyClient
|
|
27
27
|
|
28
28
|
attr_accessor :frontmatter_vals
|
29
29
|
|
30
|
+
attr_accessor :image_metadata_key
|
31
|
+
|
30
32
|
attr_accessor :image_range_end_key
|
31
33
|
|
32
34
|
attr_accessor :image_range_start_key
|
@@ -46,6 +48,7 @@ module TrieveRubyClient
|
|
46
48
|
:'file_name_key' => :'FILE_NAME_KEY',
|
47
49
|
:'filter_items' => :'FILTER_ITEMS',
|
48
50
|
:'frontmatter_vals' => :'FRONTMATTER_VALS',
|
51
|
+
:'image_metadata_key' => :'IMAGE_METADATA_KEY',
|
49
52
|
:'image_range_end_key' => :'IMAGE_RANGE_END_KEY',
|
50
53
|
:'image_range_start_key' => :'IMAGE_RANGE_START_KEY',
|
51
54
|
:'lines_before_show_more' => :'LINES_BEFORE_SHOW_MORE',
|
@@ -68,6 +71,7 @@ module TrieveRubyClient
|
|
68
71
|
:'file_name_key' => :'String',
|
69
72
|
:'filter_items' => :'Object',
|
70
73
|
:'frontmatter_vals' => :'String',
|
74
|
+
:'image_metadata_key' => :'String',
|
71
75
|
:'image_range_end_key' => :'String',
|
72
76
|
:'image_range_start_key' => :'String',
|
73
77
|
:'lines_before_show_more' => :'Integer',
|
@@ -133,6 +137,12 @@ module TrieveRubyClient
|
|
133
137
|
self.frontmatter_vals = attributes[:'frontmatter_vals']
|
134
138
|
end
|
135
139
|
|
140
|
+
if attributes.key?(:'image_metadata_key')
|
141
|
+
self.image_metadata_key = attributes[:'image_metadata_key']
|
142
|
+
else
|
143
|
+
self.image_metadata_key = nil
|
144
|
+
end
|
145
|
+
|
136
146
|
if attributes.key?(:'image_range_end_key')
|
137
147
|
self.image_range_end_key = attributes[:'image_range_end_key']
|
138
148
|
end
|
@@ -163,6 +173,10 @@ module TrieveRubyClient
|
|
163
173
|
invalid_properties.push('invalid value for "file_name_key", file_name_key cannot be nil.')
|
164
174
|
end
|
165
175
|
|
176
|
+
if @image_metadata_key.nil?
|
177
|
+
invalid_properties.push('invalid value for "image_metadata_key", image_metadata_key cannot be nil.')
|
178
|
+
end
|
179
|
+
|
166
180
|
if !@lines_before_show_more.nil? && @lines_before_show_more < 0
|
167
181
|
invalid_properties.push('invalid value for "lines_before_show_more", must be greater than or equal to 0.')
|
168
182
|
end
|
@@ -175,6 +189,7 @@ module TrieveRubyClient
|
|
175
189
|
def valid?
|
176
190
|
warn '[DEPRECATED] the `valid?` method is obsolete'
|
177
191
|
return false if @file_name_key.nil?
|
192
|
+
return false if @image_metadata_key.nil?
|
178
193
|
return false if !@lines_before_show_more.nil? && @lines_before_show_more < 0
|
179
194
|
true
|
180
195
|
end
|
@@ -200,6 +215,7 @@ module TrieveRubyClient
|
|
200
215
|
file_name_key == o.file_name_key &&
|
201
216
|
filter_items == o.filter_items &&
|
202
217
|
frontmatter_vals == o.frontmatter_vals &&
|
218
|
+
image_metadata_key == o.image_metadata_key &&
|
203
219
|
image_range_end_key == o.image_range_end_key &&
|
204
220
|
image_range_start_key == o.image_range_start_key &&
|
205
221
|
lines_before_show_more == o.lines_before_show_more &&
|
@@ -216,7 +232,7 @@ module TrieveRubyClient
|
|
216
232
|
# Calculates hash code according to all attributes.
|
217
233
|
# @return [Integer] Hash code
|
218
234
|
def hash
|
219
|
-
[create_chunk_feature, date_range_value, document_upload_feature, file_name_key, filter_items, frontmatter_vals, image_range_end_key, image_range_start_key, lines_before_show_more, search_queries, suggested_queries].hash
|
235
|
+
[create_chunk_feature, date_range_value, document_upload_feature, file_name_key, filter_items, frontmatter_vals, image_metadata_key, image_range_end_key, image_range_start_key, lines_before_show_more, search_queries, suggested_queries].hash
|
220
236
|
end
|
221
237
|
|
222
238
|
# Builds the object from hash
|
@@ -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.7.2
|
7
7
|
Contact: developers@trieve.ai
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
Generator version: 7.4.0
|
@@ -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.7.2
|
7
7
|
Contact: developers@trieve.ai
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
Generator version: 7.4.0
|
@@ -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.7.2
|
7
7
|
Contact: developers@trieve.ai
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
Generator version: 7.4.0
|
@@ -27,13 +27,17 @@ module TrieveRubyClient
|
|
27
27
|
# Server configuration for the dataset, can be arbitrary JSON. We recommend setting to `{}` to start. See docs.trieve.ai for more information or adjust with the admin dashboard.
|
28
28
|
attr_accessor :server_configuration
|
29
29
|
|
30
|
+
# Optional tracking ID for the dataset. Can be used to track the dataset in external systems.
|
31
|
+
attr_accessor :tracking_id
|
32
|
+
|
30
33
|
# Attribute mapping from ruby-style variable name to JSON key.
|
31
34
|
def self.attribute_map
|
32
35
|
{
|
33
36
|
:'client_configuration' => :'client_configuration',
|
34
37
|
:'dataset_name' => :'dataset_name',
|
35
38
|
:'organization_id' => :'organization_id',
|
36
|
-
:'server_configuration' => :'server_configuration'
|
39
|
+
:'server_configuration' => :'server_configuration',
|
40
|
+
:'tracking_id' => :'tracking_id'
|
37
41
|
}
|
38
42
|
end
|
39
43
|
|
@@ -48,7 +52,8 @@ module TrieveRubyClient
|
|
48
52
|
:'client_configuration' => :'Object',
|
49
53
|
:'dataset_name' => :'String',
|
50
54
|
:'organization_id' => :'String',
|
51
|
-
:'server_configuration' => :'Object'
|
55
|
+
:'server_configuration' => :'Object',
|
56
|
+
:'tracking_id' => :'String'
|
52
57
|
}
|
53
58
|
end
|
54
59
|
|
@@ -56,7 +61,8 @@ module TrieveRubyClient
|
|
56
61
|
def self.openapi_nullable
|
57
62
|
Set.new([
|
58
63
|
:'client_configuration',
|
59
|
-
:'server_configuration'
|
64
|
+
:'server_configuration',
|
65
|
+
:'tracking_id'
|
60
66
|
])
|
61
67
|
end
|
62
68
|
|
@@ -98,6 +104,10 @@ module TrieveRubyClient
|
|
98
104
|
else
|
99
105
|
self.server_configuration = nil
|
100
106
|
end
|
107
|
+
|
108
|
+
if attributes.key?(:'tracking_id')
|
109
|
+
self.tracking_id = attributes[:'tracking_id']
|
110
|
+
end
|
101
111
|
end
|
102
112
|
|
103
113
|
# Show invalid properties with the reasons. Usually used together with valid?
|
@@ -133,7 +143,8 @@ module TrieveRubyClient
|
|
133
143
|
client_configuration == o.client_configuration &&
|
134
144
|
dataset_name == o.dataset_name &&
|
135
145
|
organization_id == o.organization_id &&
|
136
|
-
server_configuration == o.server_configuration
|
146
|
+
server_configuration == o.server_configuration &&
|
147
|
+
tracking_id == o.tracking_id
|
137
148
|
end
|
138
149
|
|
139
150
|
# @see the `==` method
|
@@ -145,7 +156,7 @@ module TrieveRubyClient
|
|
145
156
|
# Calculates hash code according to all attributes.
|
146
157
|
# @return [Integer] Hash code
|
147
158
|
def hash
|
148
|
-
[client_configuration, dataset_name, organization_id, server_configuration].hash
|
159
|
+
[client_configuration, dataset_name, organization_id, server_configuration, tracking_id].hash
|
149
160
|
end
|
150
161
|
|
151
162
|
# Builds the object from hash
|
@@ -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.7.2
|
7
7
|
Contact: developers@trieve.ai
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
Generator version: 7.4.0
|
@@ -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.7.2
|
7
7
|
Contact: developers@trieve.ai
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
Generator version: 7.4.0
|