trieve_ruby_client 0.6.0 → 0.6.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/README.md +15 -19
- data/docs/BookmarkData.md +1 -1
- data/docs/ChunkApi.md +9 -9
- data/docs/ChunkData.md +2 -0
- data/docs/ChunkGroupApi.md +14 -14
- data/docs/ChunkMetadataWithScore.md +44 -0
- data/docs/CreateChunkGroupData.md +1 -1
- data/docs/FileApi.md +1 -1
- data/docs/GetEventsData.md +1 -1
- data/docs/GroupScoreChunk.md +24 -0
- data/docs/GroupScoreSlimChunks.md +20 -0
- data/docs/ScoreChunkDTO.md +1 -1
- data/docs/SearchOverGroupsResults.md +20 -0
- data/docs/SearchOverGroupsSlimResults.md +20 -0
- data/docs/SearchWithinGroupResults.md +22 -0
- data/docs/SearchWithinGroupSlimResults.md +22 -0
- data/docs/SlimChunkMetadataWithScore.md +38 -0
- data/docs/UpdateChunkByTrackingIdData.md +2 -0
- data/docs/UpdateChunkData.md +2 -0
- data/docs/UploadFileData.md +2 -2
- data/docs/UserApi.md +2 -2
- data/lib/trieve_ruby_client/api/auth_api.rb +1 -1
- data/lib/trieve_ruby_client/api/chunk_api.rb +9 -9
- data/lib/trieve_ruby_client/api/chunk_group_api.rb +10 -10
- data/lib/trieve_ruby_client/api/dataset_api.rb +1 -1
- data/lib/trieve_ruby_client/api/events_api.rb +1 -1
- data/lib/trieve_ruby_client/api/file_api.rb +1 -1
- data/lib/trieve_ruby_client/api/health_api.rb +1 -1
- data/lib/trieve_ruby_client/api/invitation_api.rb +1 -1
- data/lib/trieve_ruby_client/api/message_api.rb +1 -1
- data/lib/trieve_ruby_client/api/organization_api.rb +1 -1
- data/lib/trieve_ruby_client/api/stripe_api.rb +1 -1
- data/lib/trieve_ruby_client/api/topic_api.rb +1 -1
- data/lib/trieve_ruby_client/api/user_api.rb +3 -3
- 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 +2 -2
- 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 +13 -2
- 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 +387 -0
- 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 +2 -8
- 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 +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 +259 -0
- data/lib/trieve_ruby_client/models/group_score_slim_chunks.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 +1 -1
- data/lib/trieve_ruby_client/models/range_condition.rb +1 -1
- data/lib/trieve_ruby_client/models/recommend_chunks_request.rb +1 -1
- data/lib/trieve_ruby_client/models/recommend_group_chunks_request.rb +1 -1
- data/lib/trieve_ruby_client/models/regenerate_message_data.rb +1 -1
- data/lib/trieve_ruby_client/models/return_queued_chunk.rb +1 -1
- data/lib/trieve_ruby_client/models/score_chunk_dto.rb +2 -2
- 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 +239 -0
- data/lib/trieve_ruby_client/models/search_over_groups_slim_results.rb +239 -0
- 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 +255 -0
- data/lib/trieve_ruby_client/models/search_within_group_slim_results.rb +255 -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 +1 -1
- data/lib/trieve_ruby_client/models/slim_chunk_metadata_with_score.rb +345 -0
- data/lib/trieve_ruby_client/models/slim_group.rb +1 -1
- data/lib/trieve_ruby_client/models/slim_user.rb +1 -1
- data/lib/trieve_ruby_client/models/stripe_plan.rb +1 -1
- data/lib/trieve_ruby_client/models/suggested_queries_request.rb +1 -1
- data/lib/trieve_ruby_client/models/suggested_queries_response.rb +1 -1
- data/lib/trieve_ruby_client/models/topic.rb +1 -1
- data/lib/trieve_ruby_client/models/update_chunk_by_tracking_id_data.rb +13 -2
- data/lib/trieve_ruby_client/models/update_chunk_data.rb +13 -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 +1 -1
- data/lib/trieve_ruby_client/models/upload_file_data.rb +13 -19
- 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 +9 -13
- data/openapi-generator.yaml +1 -1
- data/openapi.json +279 -198
- data/spec/models/chunk_metadata_with_score_spec.rb +114 -0
- data/spec/models/group_score_chunk_spec.rb +48 -0
- data/spec/models/group_score_slim_chunks_spec.rb +42 -0
- data/spec/models/search_over_groups_results_spec.rb +42 -0
- data/spec/models/search_over_groups_slim_results_spec.rb +42 -0
- data/spec/models/search_within_group_results_spec.rb +48 -0
- data/spec/models/search_within_group_slim_results_spec.rb +48 -0
- data/spec/models/slim_chunk_metadata_with_score_spec.rb +96 -0
- data/spec/spec_helper.rb +1 -1
- data/trieve_ruby_client-0.6.0.gem +0 -0
- data/trieve_ruby_client-0.6.2.gem +0 -0
- data/trieve_ruby_client.gemspec +1 -1
- metadata +36 -2
data/docs/UserApi.md
CHANGED
@@ -4,8 +4,8 @@ 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/
|
8
|
-
| [**set_user_api_key**](UserApi.md#set_user_api_key) | **POST** /api/user/
|
7
|
+
| [**delete_user_api_key**](UserApi.md#delete_user_api_key) | **DELETE** /api/user/api_key/{api_key_id} | Delete User Api Key |
|
8
|
+
| [**set_user_api_key**](UserApi.md#set_user_api_key) | **POST** /api/user/api_key | Set User Api Key |
|
9
9
|
| [**update_user**](UserApi.md#update_user) | **PUT** /api/user | Update User |
|
10
10
|
|
11
11
|
|
@@ -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.
|
6
|
+
The version of the OpenAPI document: 0.6.7
|
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.
|
6
|
+
The version of the OpenAPI document: 0.6.7
|
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 [Array<ChunkMetadataWithScore>]
|
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<(Array<ChunkMetadataWithScore>, Integer, Hash)>] Array<ChunkMetadataWithScore> 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] || 'Array<ChunkMetadataWithScore>'
|
581
581
|
|
582
582
|
# auth_names
|
583
583
|
auth_names = opts[:debug_auth_names] || ['ApiKey']
|
@@ -600,22 +600,22 @@ module TrieveRubyClient
|
|
600
600
|
end
|
601
601
|
|
602
602
|
# Search
|
603
|
-
# Search This route provides the primary search functionality for the API. It can be used to search for chunks by semantic similarity, full-text similarity, or a combination of both. Results' `chunk_html` values will be modified with `<b>` tags for sub-sentence highlighting.
|
603
|
+
# Search This route provides the primary search functionality for the API. It can be used to search for chunks by semantic similarity, full-text similarity, or a combination of both. Results' `chunk_html` values will be modified with `<b><mark>` tags for sub-sentence highlighting.
|
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 [SearchChunkQueryResponseBody]
|
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
|
611
611
|
end
|
612
612
|
|
613
613
|
# Search
|
614
|
-
# Search This route provides the primary search functionality for the API. It can be used to search for chunks by semantic similarity, full-text similarity, or a combination of both. Results' `chunk_html` values will be modified with `<b>` tags for sub-sentence highlighting.
|
614
|
+
# Search This route provides the primary search functionality for the API. It can be used to search for chunks by semantic similarity, full-text similarity, or a combination of both. Results' `chunk_html` values will be modified with `<b><mark>` tags for sub-sentence highlighting.
|
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<(SearchChunkQueryResponseBody, Integer, Hash)>] SearchChunkQueryResponseBody 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] || 'SearchChunkQueryResponseBody'
|
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.
|
6
|
+
The version of the OpenAPI document: 0.6.7
|
7
7
|
Contact: developers@trieve.ai
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
Generator version: 7.4.0
|
@@ -779,7 +779,7 @@ module TrieveRubyClient
|
|
779
779
|
# @param tr_dataset [String] The dataset id to use for the request
|
780
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 [
|
782
|
+
# @return [Array<GroupScoreChunk>]
|
783
783
|
def get_recommended_groups(tr_dataset, recommend_group_chunks_request, opts = {})
|
784
784
|
data, _status_code, _headers = get_recommended_groups_with_http_info(tr_dataset, recommend_group_chunks_request, opts)
|
785
785
|
data
|
@@ -790,7 +790,7 @@ module TrieveRubyClient
|
|
790
790
|
# @param tr_dataset [String] The dataset id to use for the request
|
791
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<(
|
793
|
+
# @return [Array<(Array<GroupScoreChunk>, Integer, Hash)>] Array<GroupScoreChunk> data, response status code and response headers
|
794
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 ...'
|
@@ -827,7 +827,7 @@ module TrieveRubyClient
|
|
827
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] || 'Array<GroupScoreChunk>'
|
831
831
|
|
832
832
|
# auth_names
|
833
833
|
auth_names = opts[:debug_auth_names] || ['ApiKey']
|
@@ -1011,7 +1011,7 @@ module TrieveRubyClient
|
|
1011
1011
|
# @param tr_dataset [String] The dataset id to use for the request
|
1012
1012
|
# @param search_over_groups_data [SearchOverGroupsData] JSON request payload to semantically search over groups
|
1013
1013
|
# @param [Hash] opts the optional parameters
|
1014
|
-
# @return [
|
1014
|
+
# @return [SearchOverGroupsResults]
|
1015
1015
|
def search_over_groups(tr_dataset, search_over_groups_data, opts = {})
|
1016
1016
|
data, _status_code, _headers = search_over_groups_with_http_info(tr_dataset, search_over_groups_data, opts)
|
1017
1017
|
data
|
@@ -1022,7 +1022,7 @@ module TrieveRubyClient
|
|
1022
1022
|
# @param tr_dataset [String] The dataset id to use for the request
|
1023
1023
|
# @param search_over_groups_data [SearchOverGroupsData] JSON request payload to semantically search over groups
|
1024
1024
|
# @param [Hash] opts the optional parameters
|
1025
|
-
# @return [Array<(
|
1025
|
+
# @return [Array<(SearchOverGroupsResults, Integer, Hash)>] SearchOverGroupsResults data, response status code and response headers
|
1026
1026
|
def search_over_groups_with_http_info(tr_dataset, search_over_groups_data, opts = {})
|
1027
1027
|
if @api_client.config.debugging
|
1028
1028
|
@api_client.config.logger.debug 'Calling API: ChunkGroupApi.search_over_groups ...'
|
@@ -1059,7 +1059,7 @@ module TrieveRubyClient
|
|
1059
1059
|
post_body = opts[:debug_body] || @api_client.object_to_http_body(search_over_groups_data)
|
1060
1060
|
|
1061
1061
|
# return_type
|
1062
|
-
return_type = opts[:debug_return_type] || '
|
1062
|
+
return_type = opts[:debug_return_type] || 'SearchOverGroupsResults'
|
1063
1063
|
|
1064
1064
|
# auth_names
|
1065
1065
|
auth_names = opts[:debug_auth_names] || ['ApiKey']
|
@@ -1086,7 +1086,7 @@ module TrieveRubyClient
|
|
1086
1086
|
# @param tr_dataset [String] The dataset id to use for the request
|
1087
1087
|
# @param search_within_group_data [SearchWithinGroupData] JSON request payload to semantically search a group
|
1088
1088
|
# @param [Hash] opts the optional parameters
|
1089
|
-
# @return [
|
1089
|
+
# @return [SearchWithinGroupResults]
|
1090
1090
|
def search_within_group(tr_dataset, search_within_group_data, opts = {})
|
1091
1091
|
data, _status_code, _headers = search_within_group_with_http_info(tr_dataset, search_within_group_data, opts)
|
1092
1092
|
data
|
@@ -1097,7 +1097,7 @@ module TrieveRubyClient
|
|
1097
1097
|
# @param tr_dataset [String] The dataset id to use for the request
|
1098
1098
|
# @param search_within_group_data [SearchWithinGroupData] JSON request payload to semantically search a group
|
1099
1099
|
# @param [Hash] opts the optional parameters
|
1100
|
-
# @return [Array<(
|
1100
|
+
# @return [Array<(SearchWithinGroupResults, Integer, Hash)>] SearchWithinGroupResults data, response status code and response headers
|
1101
1101
|
def search_within_group_with_http_info(tr_dataset, search_within_group_data, opts = {})
|
1102
1102
|
if @api_client.config.debugging
|
1103
1103
|
@api_client.config.logger.debug 'Calling API: ChunkGroupApi.search_within_group ...'
|
@@ -1134,7 +1134,7 @@ module TrieveRubyClient
|
|
1134
1134
|
post_body = opts[:debug_body] || @api_client.object_to_http_body(search_within_group_data)
|
1135
1135
|
|
1136
1136
|
# return_type
|
1137
|
-
return_type = opts[:debug_return_type] || '
|
1137
|
+
return_type = opts[:debug_return_type] || 'SearchWithinGroupResults'
|
1138
1138
|
|
1139
1139
|
# auth_names
|
1140
1140
|
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.
|
6
|
+
The version of the OpenAPI document: 0.6.7
|
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.
|
6
|
+
The version of the OpenAPI document: 0.6.7
|
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.
|
6
|
+
The version of the OpenAPI document: 0.6.7
|
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.
|
6
|
+
The version of the OpenAPI document: 0.6.7
|
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.
|
6
|
+
The version of the OpenAPI document: 0.6.7
|
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.
|
6
|
+
The version of the OpenAPI document: 0.6.7
|
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.
|
6
|
+
The version of the OpenAPI document: 0.6.7
|
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.
|
6
|
+
The version of the OpenAPI document: 0.6.7
|
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.
|
6
|
+
The version of the OpenAPI document: 0.6.7
|
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.
|
6
|
+
The version of the OpenAPI document: 0.6.7
|
7
7
|
Contact: developers@trieve.ai
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
Generator version: 7.4.0
|
@@ -43,7 +43,7 @@ module TrieveRubyClient
|
|
43
43
|
fail ArgumentError, "Missing the required parameter 'api_key_id' when calling UserApi.delete_user_api_key"
|
44
44
|
end
|
45
45
|
# resource path
|
46
|
-
local_var_path = '/api/user/
|
46
|
+
local_var_path = '/api/user/api_key/{api_key_id}'.sub('{' + 'api_key_id' + '}', CGI.escape(api_key_id.to_s))
|
47
47
|
|
48
48
|
# query parameters
|
49
49
|
query_params = opts[:query_params] || {}
|
@@ -106,7 +106,7 @@ module TrieveRubyClient
|
|
106
106
|
fail ArgumentError, "Missing the required parameter 'set_user_api_key_request' when calling UserApi.set_user_api_key"
|
107
107
|
end
|
108
108
|
# resource path
|
109
|
-
local_var_path = '/api/user/
|
109
|
+
local_var_path = '/api/user/api_key'
|
110
110
|
|
111
111
|
# query parameters
|
112
112
|
query_params = opts[:query_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.
|
6
|
+
The version of the OpenAPI document: 0.6.7
|
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.
|
6
|
+
The version of the OpenAPI document: 0.6.7
|
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.
|
6
|
+
The version of the OpenAPI document: 0.6.7
|
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.
|
6
|
+
The version of the OpenAPI document: 0.6.7
|
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.
|
6
|
+
The version of the OpenAPI document: 0.6.7
|
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.
|
6
|
+
The version of the OpenAPI document: 0.6.7
|
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.
|
6
|
+
The version of the OpenAPI document: 0.6.7
|
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.
|
6
|
+
The version of the OpenAPI document: 0.6.7
|
7
7
|
Contact: developers@trieve.ai
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
Generator version: 7.4.0
|
@@ -38,7 +38,7 @@ module TrieveRubyClient
|
|
38
38
|
# Attribute type mapping.
|
39
39
|
def self.openapi_types
|
40
40
|
{
|
41
|
-
:'chunks' => :'Array<
|
41
|
+
:'chunks' => :'Array<ChunkMetadata>',
|
42
42
|
:'group' => :'ChunkGroup',
|
43
43
|
:'total_pages' => :'Integer'
|
44
44
|
}
|
@@ -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.
|
6
|
+
The version of the OpenAPI document: 0.6.7
|
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.
|
6
|
+
The version of the OpenAPI document: 0.6.7
|
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.
|
6
|
+
The version of the OpenAPI document: 0.6.7
|
7
7
|
Contact: developers@trieve.ai
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
Generator version: 7.4.0
|
@@ -21,6 +21,9 @@ module TrieveRubyClient
|
|
21
21
|
# Chunk_vector is a vector of floats which can be used instead of generating a new embedding. This is useful for when you are using a pre-embedded dataset. If this is not provided, the innerText of the chunk_html will be used to create the embedding.
|
22
22
|
attr_accessor :chunk_vector
|
23
23
|
|
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
|
+
attr_accessor :convert_html_to_text
|
26
|
+
|
24
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.
|
25
28
|
attr_accessor :file_id
|
26
29
|
|
@@ -59,6 +62,7 @@ module TrieveRubyClient
|
|
59
62
|
{
|
60
63
|
:'chunk_html' => :'chunk_html',
|
61
64
|
:'chunk_vector' => :'chunk_vector',
|
65
|
+
:'convert_html_to_text' => :'convert_html_to_text',
|
62
66
|
:'file_id' => :'file_id',
|
63
67
|
:'group_ids' => :'group_ids',
|
64
68
|
:'group_tracking_ids' => :'group_tracking_ids',
|
@@ -83,6 +87,7 @@ module TrieveRubyClient
|
|
83
87
|
{
|
84
88
|
:'chunk_html' => :'String',
|
85
89
|
:'chunk_vector' => :'Array<Float>',
|
90
|
+
:'convert_html_to_text' => :'Boolean',
|
86
91
|
:'file_id' => :'String',
|
87
92
|
:'group_ids' => :'Array<String>',
|
88
93
|
:'group_tracking_ids' => :'Array<String>',
|
@@ -102,6 +107,7 @@ module TrieveRubyClient
|
|
102
107
|
Set.new([
|
103
108
|
:'chunk_html',
|
104
109
|
:'chunk_vector',
|
110
|
+
:'convert_html_to_text',
|
105
111
|
:'file_id',
|
106
112
|
:'group_ids',
|
107
113
|
:'group_tracking_ids',
|
@@ -141,6 +147,10 @@ module TrieveRubyClient
|
|
141
147
|
end
|
142
148
|
end
|
143
149
|
|
150
|
+
if attributes.key?(:'convert_html_to_text')
|
151
|
+
self.convert_html_to_text = attributes[:'convert_html_to_text']
|
152
|
+
end
|
153
|
+
|
144
154
|
if attributes.key?(:'file_id')
|
145
155
|
self.file_id = attributes[:'file_id']
|
146
156
|
end
|
@@ -214,6 +224,7 @@ module TrieveRubyClient
|
|
214
224
|
self.class == o.class &&
|
215
225
|
chunk_html == o.chunk_html &&
|
216
226
|
chunk_vector == o.chunk_vector &&
|
227
|
+
convert_html_to_text == o.convert_html_to_text &&
|
217
228
|
file_id == o.file_id &&
|
218
229
|
group_ids == o.group_ids &&
|
219
230
|
group_tracking_ids == o.group_tracking_ids &&
|
@@ -236,7 +247,7 @@ module TrieveRubyClient
|
|
236
247
|
# Calculates hash code according to all attributes.
|
237
248
|
# @return [Integer] Hash code
|
238
249
|
def hash
|
239
|
-
[chunk_html, chunk_vector, file_id, group_ids, group_tracking_ids, link, metadata, split_avg, tag_set, time_stamp, tracking_id, upsert_by_tracking_id, weight].hash
|
250
|
+
[chunk_html, chunk_vector, convert_html_to_text, file_id, group_ids, group_tracking_ids, link, metadata, split_avg, tag_set, time_stamp, tracking_id, upsert_by_tracking_id, weight].hash
|
240
251
|
end
|
241
252
|
|
242
253
|
# 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.
|
6
|
+
The version of the OpenAPI document: 0.6.7
|
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.
|
6
|
+
The version of the OpenAPI document: 0.6.7
|
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.
|
6
|
+
The version of the OpenAPI document: 0.6.7
|
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.
|
6
|
+
The version of the OpenAPI document: 0.6.7
|
7
7
|
Contact: developers@trieve.ai
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
Generator version: 7.4.0
|