trieve_ruby_client 0.7.2 → 0.7.6
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 -6
- data/docs/ChunkApi.md +158 -10
- data/docs/ChunkData.md +2 -0
- data/docs/ChunkMetadata.md +2 -0
- data/docs/CreateMessageData.md +0 -2
- data/docs/CreateTopicData.md +0 -2
- data/docs/EditMessageData.md +0 -2
- data/docs/FieldCondition.md +6 -0
- data/docs/GenerateChunksRequest.md +0 -2
- data/docs/GeoInfo.md +20 -0
- data/docs/GeoTypes.md +49 -0
- data/docs/GetChunksData.md +18 -0
- data/docs/GetTrackingChunksData.md +18 -0
- data/docs/LocationBoundingBox.md +20 -0
- data/docs/LocationPolygon.md +20 -0
- data/docs/LocationRadius.md +20 -0
- data/docs/RangeCondition.md +2 -0
- data/docs/RegenerateMessageData.md +0 -2
- data/docs/SlimChunkMetadata.md +4 -0
- data/docs/UpdateChunkData.md +2 -0
- data/lib/trieve_ruby_client/api/auth_api.rb +1 -1
- data/lib/trieve_ruby_client/api/chunk_api.rb +161 -11
- 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 +1 -1
- data/lib/trieve_ruby_client/api/health_api.rb +1 -1
- data/lib/trieve_ruby_client/api/invitation_api.rb +1 -1
- data/lib/trieve_ruby_client/api/message_api.rb +1 -1
- data/lib/trieve_ruby_client/api/organization_api.rb +1 -1
- data/lib/trieve_ruby_client/api/stripe_api.rb +1 -1
- data/lib/trieve_ruby_client/api/topic_api.rb +1 -1
- data/lib/trieve_ruby_client/api/user_api.rb +1 -1
- data/lib/trieve_ruby_client/api_client.rb +1 -1
- data/lib/trieve_ruby_client/api_error.rb +1 -1
- data/lib/trieve_ruby_client/configuration.rb +1 -1
- data/lib/trieve_ruby_client/models/add_chunk_to_group_data.rb +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 +12 -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 +12 -2
- data/lib/trieve_ruby_client/models/chunk_metadata_with_score.rb +1 -1
- data/lib/trieve_ruby_client/models/client_dataset_configuration.rb +1 -1
- data/lib/trieve_ruby_client/models/create_chunk_data.rb +1 -1
- data/lib/trieve_ruby_client/models/create_chunk_group_data.rb +1 -1
- data/lib/trieve_ruby_client/models/create_dataset_request.rb +1 -1
- data/lib/trieve_ruby_client/models/create_message_data.rb +2 -13
- data/lib/trieve_ruby_client/models/create_organization_data.rb +1 -1
- data/lib/trieve_ruby_client/models/create_topic_data.rb +2 -13
- 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 +2 -13
- 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 +32 -2
- 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 +2 -13
- data/lib/trieve_ruby_client/models/geo_info.rb +237 -0
- data/lib/trieve_ruby_client/models/geo_types.rb +105 -0
- data/lib/trieve_ruby_client/models/get_chunks_data.rb +223 -0
- 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/get_tracking_chunks_data.rb +223 -0
- 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/location_bounding_box.rb +237 -0
- data/lib/trieve_ruby_client/models/location_polygon.rb +235 -0
- data/lib/trieve_ruby_client/models/location_radius.rb +237 -0
- 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 +2 -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 +2 -13
- 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 +28 -2
- 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 +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 +12 -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_org_role_data.rb +1 -1
- data/lib/trieve_ruby_client/models/upload_file_data.rb +1 -1
- data/lib/trieve_ruby_client/models/upload_file_result.rb +1 -1
- data/lib/trieve_ruby_client/models/user_organization.rb +1 -1
- data/lib/trieve_ruby_client/version.rb +2 -2
- data/lib/trieve_ruby_client.rb +8 -1
- data/openapi-generator.yaml +1 -1
- data/openapi.json +322 -28
- data/spec/models/geo_info_spec.rb +42 -0
- data/spec/models/geo_types_spec.rb +32 -0
- data/spec/models/get_chunks_data_spec.rb +36 -0
- data/spec/models/get_tracking_chunks_data_spec.rb +36 -0
- data/spec/models/location_bounding_box_spec.rb +42 -0
- data/spec/models/location_polygon_spec.rb +42 -0
- data/spec/models/location_radius_spec.rb +42 -0
- data/spec/spec_helper.rb +1 -1
- data/trieve_ruby_client-0.7.2.gem +0 -0
- data/trieve_ruby_client.gemspec +1 -1
- metadata +31 -2
data/docs/UpdateChunkData.md
CHANGED
@@ -10,6 +10,7 @@
|
|
10
10
|
| **group_ids** | **Array<String>** | Group ids are the 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
|
| **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] |
|
12
12
|
| **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] |
|
13
|
+
| **location** | [**GeoInfo**](GeoInfo.md) | | [optional] |
|
13
14
|
| **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] |
|
14
15
|
| **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] |
|
15
16
|
| **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] |
|
@@ -28,6 +29,7 @@ instance = TrieveRubyClient::UpdateChunkData.new(
|
|
28
29
|
group_ids: null,
|
29
30
|
group_tracking_ids: null,
|
30
31
|
link: null,
|
32
|
+
location: null,
|
31
33
|
metadata: null,
|
32
34
|
tag_set: null,
|
33
35
|
time_stamp: null,
|
@@ -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.7.
|
6
|
+
The version of the OpenAPI document: 0.7.6
|
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.7.
|
6
|
+
The version of the OpenAPI document: 0.7.6
|
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 or Upsert Chunk or Chunks
|
23
|
-
# Create or Upsert Chunk or Chunks Create a new chunk. If the chunk has the same tracking_id as an existing chunk, the request will fail. Once a chunk is created, it can be searched for using the search endpoint.
|
23
|
+
# Create or Upsert Chunk or Chunks Create a new chunk. If the chunk has the same tracking_id as an existing chunk, the request will fail. Once a chunk is created, it can be searched for using the search endpoint. If uploading in bulk, the maximum amount of chunks that can be uploaded at once is 120 chunks.
|
24
24
|
# @param tr_dataset [String] The dataset id to use for the request
|
25
25
|
# @param create_chunk_data [CreateChunkData] JSON request payload to create a new chunk (chunk)
|
26
26
|
# @param [Hash] opts the optional parameters
|
@@ -31,7 +31,7 @@ module TrieveRubyClient
|
|
31
31
|
end
|
32
32
|
|
33
33
|
# Create or Upsert Chunk or Chunks
|
34
|
-
# Create or Upsert Chunk or Chunks Create a new chunk. If the chunk has the same tracking_id as an existing chunk, the request will fail. Once a chunk is created, it can be searched for using the search endpoint.
|
34
|
+
# Create or Upsert Chunk or Chunks Create a new chunk. If the chunk has the same tracking_id as an existing chunk, the request will fail. Once a chunk is created, it can be searched for using the search endpoint. If uploading in bulk, the maximum amount of chunks that can be uploaded at once is 120 chunks.
|
35
35
|
# @param tr_dataset [String] The dataset id to use for the request
|
36
36
|
# @param create_chunk_data [CreateChunkData] JSON request payload to create a new chunk (chunk)
|
37
37
|
# @param [Hash] opts the optional parameters
|
@@ -524,6 +524,156 @@ module TrieveRubyClient
|
|
524
524
|
return data, status_code, headers
|
525
525
|
end
|
526
526
|
|
527
|
+
# Get Chunks By Ids
|
528
|
+
# Get Chunks By Ids Get multiple chunks by multiple ids.
|
529
|
+
# @param tr_dataset [String] The dataset id to use for the request
|
530
|
+
# @param get_chunks_data [GetChunksData] JSON request payload to get the chunks in the request
|
531
|
+
# @param [Hash] opts the optional parameters
|
532
|
+
# @return [Array<ChunkMetadata>]
|
533
|
+
def get_chunks_by_ids(tr_dataset, get_chunks_data, opts = {})
|
534
|
+
data, _status_code, _headers = get_chunks_by_ids_with_http_info(tr_dataset, get_chunks_data, opts)
|
535
|
+
data
|
536
|
+
end
|
537
|
+
|
538
|
+
# Get Chunks By Ids
|
539
|
+
# Get Chunks By Ids Get multiple chunks by multiple ids.
|
540
|
+
# @param tr_dataset [String] The dataset id to use for the request
|
541
|
+
# @param get_chunks_data [GetChunksData] JSON request payload to get the chunks in the request
|
542
|
+
# @param [Hash] opts the optional parameters
|
543
|
+
# @return [Array<(Array<ChunkMetadata>, Integer, Hash)>] Array<ChunkMetadata> data, response status code and response headers
|
544
|
+
def get_chunks_by_ids_with_http_info(tr_dataset, get_chunks_data, opts = {})
|
545
|
+
if @api_client.config.debugging
|
546
|
+
@api_client.config.logger.debug 'Calling API: ChunkApi.get_chunks_by_ids ...'
|
547
|
+
end
|
548
|
+
# verify the required parameter 'tr_dataset' is set
|
549
|
+
if @api_client.config.client_side_validation && tr_dataset.nil?
|
550
|
+
fail ArgumentError, "Missing the required parameter 'tr_dataset' when calling ChunkApi.get_chunks_by_ids"
|
551
|
+
end
|
552
|
+
# verify the required parameter 'get_chunks_data' is set
|
553
|
+
if @api_client.config.client_side_validation && get_chunks_data.nil?
|
554
|
+
fail ArgumentError, "Missing the required parameter 'get_chunks_data' when calling ChunkApi.get_chunks_by_ids"
|
555
|
+
end
|
556
|
+
# resource path
|
557
|
+
local_var_path = '/api/chunks'
|
558
|
+
|
559
|
+
# query parameters
|
560
|
+
query_params = opts[:query_params] || {}
|
561
|
+
|
562
|
+
# header parameters
|
563
|
+
header_params = opts[:header_params] || {}
|
564
|
+
# HTTP header 'Accept' (if needed)
|
565
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
566
|
+
# HTTP header 'Content-Type'
|
567
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
568
|
+
if !content_type.nil?
|
569
|
+
header_params['Content-Type'] = content_type
|
570
|
+
end
|
571
|
+
header_params[:'TR-Dataset'] = tr_dataset
|
572
|
+
|
573
|
+
# form parameters
|
574
|
+
form_params = opts[:form_params] || {}
|
575
|
+
|
576
|
+
# http body (model)
|
577
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(get_chunks_data)
|
578
|
+
|
579
|
+
# return_type
|
580
|
+
return_type = opts[:debug_return_type] || 'Array<ChunkMetadata>'
|
581
|
+
|
582
|
+
# auth_names
|
583
|
+
auth_names = opts[:debug_auth_names] || ['ApiKey']
|
584
|
+
|
585
|
+
new_options = opts.merge(
|
586
|
+
:operation => :"ChunkApi.get_chunks_by_ids",
|
587
|
+
:header_params => header_params,
|
588
|
+
:query_params => query_params,
|
589
|
+
:form_params => form_params,
|
590
|
+
:body => post_body,
|
591
|
+
:auth_names => auth_names,
|
592
|
+
:return_type => return_type
|
593
|
+
)
|
594
|
+
|
595
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
596
|
+
if @api_client.config.debugging
|
597
|
+
@api_client.config.logger.debug "API called: ChunkApi#get_chunks_by_ids\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
598
|
+
end
|
599
|
+
return data, status_code, headers
|
600
|
+
end
|
601
|
+
|
602
|
+
# Get Chunks By TrackingIds
|
603
|
+
# Get Chunks By TrackingIds Get multiple chunks by ids.
|
604
|
+
# @param tr_dataset [String] The dataset id to use for the request
|
605
|
+
# @param get_tracking_chunks_data [GetTrackingChunksData] JSON request payload to get the chunks in the request
|
606
|
+
# @param [Hash] opts the optional parameters
|
607
|
+
# @return [ChunkMetadata]
|
608
|
+
def get_chunks_by_tracking_ids(tr_dataset, get_tracking_chunks_data, opts = {})
|
609
|
+
data, _status_code, _headers = get_chunks_by_tracking_ids_with_http_info(tr_dataset, get_tracking_chunks_data, opts)
|
610
|
+
data
|
611
|
+
end
|
612
|
+
|
613
|
+
# Get Chunks By TrackingIds
|
614
|
+
# Get Chunks By TrackingIds Get multiple chunks by ids.
|
615
|
+
# @param tr_dataset [String] The dataset id to use for the request
|
616
|
+
# @param get_tracking_chunks_data [GetTrackingChunksData] JSON request payload to get the chunks in the request
|
617
|
+
# @param [Hash] opts the optional parameters
|
618
|
+
# @return [Array<(ChunkMetadata, Integer, Hash)>] ChunkMetadata data, response status code and response headers
|
619
|
+
def get_chunks_by_tracking_ids_with_http_info(tr_dataset, get_tracking_chunks_data, opts = {})
|
620
|
+
if @api_client.config.debugging
|
621
|
+
@api_client.config.logger.debug 'Calling API: ChunkApi.get_chunks_by_tracking_ids ...'
|
622
|
+
end
|
623
|
+
# verify the required parameter 'tr_dataset' is set
|
624
|
+
if @api_client.config.client_side_validation && tr_dataset.nil?
|
625
|
+
fail ArgumentError, "Missing the required parameter 'tr_dataset' when calling ChunkApi.get_chunks_by_tracking_ids"
|
626
|
+
end
|
627
|
+
# verify the required parameter 'get_tracking_chunks_data' is set
|
628
|
+
if @api_client.config.client_side_validation && get_tracking_chunks_data.nil?
|
629
|
+
fail ArgumentError, "Missing the required parameter 'get_tracking_chunks_data' when calling ChunkApi.get_chunks_by_tracking_ids"
|
630
|
+
end
|
631
|
+
# resource path
|
632
|
+
local_var_path = '/api/chunks/tracking'
|
633
|
+
|
634
|
+
# query parameters
|
635
|
+
query_params = opts[:query_params] || {}
|
636
|
+
|
637
|
+
# header parameters
|
638
|
+
header_params = opts[:header_params] || {}
|
639
|
+
# HTTP header 'Accept' (if needed)
|
640
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
641
|
+
# HTTP header 'Content-Type'
|
642
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
643
|
+
if !content_type.nil?
|
644
|
+
header_params['Content-Type'] = content_type
|
645
|
+
end
|
646
|
+
header_params[:'TR-Dataset'] = tr_dataset
|
647
|
+
|
648
|
+
# form parameters
|
649
|
+
form_params = opts[:form_params] || {}
|
650
|
+
|
651
|
+
# http body (model)
|
652
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(get_tracking_chunks_data)
|
653
|
+
|
654
|
+
# return_type
|
655
|
+
return_type = opts[:debug_return_type] || 'ChunkMetadata'
|
656
|
+
|
657
|
+
# auth_names
|
658
|
+
auth_names = opts[:debug_auth_names] || ['ApiKey']
|
659
|
+
|
660
|
+
new_options = opts.merge(
|
661
|
+
:operation => :"ChunkApi.get_chunks_by_tracking_ids",
|
662
|
+
:header_params => header_params,
|
663
|
+
:query_params => query_params,
|
664
|
+
:form_params => form_params,
|
665
|
+
:body => post_body,
|
666
|
+
:auth_names => auth_names,
|
667
|
+
:return_type => return_type
|
668
|
+
)
|
669
|
+
|
670
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
671
|
+
if @api_client.config.debugging
|
672
|
+
@api_client.config.logger.debug "API called: ChunkApi#get_chunks_by_tracking_ids\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
673
|
+
end
|
674
|
+
return data, status_code, headers
|
675
|
+
end
|
676
|
+
|
527
677
|
# Get Recommended Chunks
|
528
678
|
# Get Recommended Chunks Get recommendations of chunks similar to the chunks in the request. Think about this as a feature similar to the \"add to playlist\" recommendation feature on Spotify. This request pairs especially well with our groups endpoint.
|
529
679
|
# @param tr_dataset [String] The dataset id to use for the request
|
@@ -605,8 +755,8 @@ module TrieveRubyClient
|
|
605
755
|
# @param search_chunk_data [SearchChunkData] JSON request payload to semantically search for chunks (chunks)
|
606
756
|
# @param [Hash] opts the optional parameters
|
607
757
|
# @return [SearchChunkQueryResponseBody]
|
608
|
-
def
|
609
|
-
data, _status_code, _headers =
|
758
|
+
def search_chunks(tr_dataset, search_chunk_data, opts = {})
|
759
|
+
data, _status_code, _headers = search_chunks_with_http_info(tr_dataset, search_chunk_data, opts)
|
610
760
|
data
|
611
761
|
end
|
612
762
|
|
@@ -616,17 +766,17 @@ module TrieveRubyClient
|
|
616
766
|
# @param search_chunk_data [SearchChunkData] JSON request payload to semantically search for chunks (chunks)
|
617
767
|
# @param [Hash] opts the optional parameters
|
618
768
|
# @return [Array<(SearchChunkQueryResponseBody, Integer, Hash)>] SearchChunkQueryResponseBody data, response status code and response headers
|
619
|
-
def
|
769
|
+
def search_chunks_with_http_info(tr_dataset, search_chunk_data, opts = {})
|
620
770
|
if @api_client.config.debugging
|
621
|
-
@api_client.config.logger.debug 'Calling API: ChunkApi.
|
771
|
+
@api_client.config.logger.debug 'Calling API: ChunkApi.search_chunks ...'
|
622
772
|
end
|
623
773
|
# verify the required parameter 'tr_dataset' is set
|
624
774
|
if @api_client.config.client_side_validation && tr_dataset.nil?
|
625
|
-
fail ArgumentError, "Missing the required parameter 'tr_dataset' when calling ChunkApi.
|
775
|
+
fail ArgumentError, "Missing the required parameter 'tr_dataset' when calling ChunkApi.search_chunks"
|
626
776
|
end
|
627
777
|
# verify the required parameter 'search_chunk_data' is set
|
628
778
|
if @api_client.config.client_side_validation && search_chunk_data.nil?
|
629
|
-
fail ArgumentError, "Missing the required parameter 'search_chunk_data' when calling ChunkApi.
|
779
|
+
fail ArgumentError, "Missing the required parameter 'search_chunk_data' when calling ChunkApi.search_chunks"
|
630
780
|
end
|
631
781
|
# resource path
|
632
782
|
local_var_path = '/api/chunk/search'
|
@@ -658,7 +808,7 @@ module TrieveRubyClient
|
|
658
808
|
auth_names = opts[:debug_auth_names] || ['ApiKey']
|
659
809
|
|
660
810
|
new_options = opts.merge(
|
661
|
-
:operation => :"ChunkApi.
|
811
|
+
:operation => :"ChunkApi.search_chunks",
|
662
812
|
:header_params => header_params,
|
663
813
|
:query_params => query_params,
|
664
814
|
:form_params => form_params,
|
@@ -669,7 +819,7 @@ module TrieveRubyClient
|
|
669
819
|
|
670
820
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
671
821
|
if @api_client.config.debugging
|
672
|
-
@api_client.config.logger.debug "API called: ChunkApi#
|
822
|
+
@api_client.config.logger.debug "API called: ChunkApi#search_chunks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
673
823
|
end
|
674
824
|
return data, status_code, headers
|
675
825
|
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.7.
|
6
|
+
The version of the OpenAPI document: 0.7.6
|
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.7.
|
6
|
+
The version of the OpenAPI document: 0.7.6
|
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.7.
|
6
|
+
The version of the OpenAPI document: 0.7.6
|
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.7.
|
6
|
+
The version of the OpenAPI document: 0.7.6
|
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.7.
|
6
|
+
The version of the OpenAPI document: 0.7.6
|
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.7.
|
6
|
+
The version of the OpenAPI document: 0.7.6
|
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.7.
|
6
|
+
The version of the OpenAPI document: 0.7.6
|
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.7.
|
6
|
+
The version of the OpenAPI document: 0.7.6
|
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.7.
|
6
|
+
The version of the OpenAPI document: 0.7.6
|
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.7.
|
6
|
+
The version of the OpenAPI document: 0.7.6
|
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.7.
|
6
|
+
The version of the OpenAPI document: 0.7.6
|
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.7.
|
6
|
+
The version of the OpenAPI document: 0.7.6
|
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.7.
|
6
|
+
The version of the OpenAPI document: 0.7.6
|
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.7.
|
6
|
+
The version of the OpenAPI document: 0.7.6
|
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.7.
|
6
|
+
The version of the OpenAPI document: 0.7.6
|
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.7.
|
6
|
+
The version of the OpenAPI document: 0.7.6
|
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.7.
|
6
|
+
The version of the OpenAPI document: 0.7.6
|
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.7.
|
6
|
+
The version of the OpenAPI document: 0.7.6
|
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.7.
|
6
|
+
The version of the OpenAPI document: 0.7.6
|
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.7.
|
6
|
+
The version of the OpenAPI document: 0.7.6
|
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.7.
|
6
|
+
The version of the OpenAPI document: 0.7.6
|
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.7.
|
6
|
+
The version of the OpenAPI document: 0.7.6
|
7
7
|
Contact: developers@trieve.ai
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
Generator version: 7.4.0
|
@@ -33,6 +33,8 @@ module TrieveRubyClient
|
|
33
33
|
# Link to the chunk. 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.
|
34
34
|
attr_accessor :link
|
35
35
|
|
36
|
+
attr_accessor :location
|
37
|
+
|
36
38
|
# 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.
|
37
39
|
attr_accessor :metadata
|
38
40
|
|
@@ -63,6 +65,7 @@ module TrieveRubyClient
|
|
63
65
|
:'group_ids' => :'group_ids',
|
64
66
|
:'group_tracking_ids' => :'group_tracking_ids',
|
65
67
|
:'link' => :'link',
|
68
|
+
:'location' => :'location',
|
66
69
|
:'metadata' => :'metadata',
|
67
70
|
:'split_avg' => :'split_avg',
|
68
71
|
:'tag_set' => :'tag_set',
|
@@ -87,6 +90,7 @@ module TrieveRubyClient
|
|
87
90
|
:'group_ids' => :'Array<String>',
|
88
91
|
:'group_tracking_ids' => :'Array<String>',
|
89
92
|
:'link' => :'String',
|
93
|
+
:'location' => :'GeoInfo',
|
90
94
|
:'metadata' => :'Object',
|
91
95
|
:'split_avg' => :'Boolean',
|
92
96
|
:'tag_set' => :'Array<String>',
|
@@ -106,6 +110,7 @@ module TrieveRubyClient
|
|
106
110
|
:'group_ids',
|
107
111
|
:'group_tracking_ids',
|
108
112
|
:'link',
|
113
|
+
:'location',
|
109
114
|
:'metadata',
|
110
115
|
:'split_avg',
|
111
116
|
:'tag_set',
|
@@ -161,6 +166,10 @@ module TrieveRubyClient
|
|
161
166
|
self.link = attributes[:'link']
|
162
167
|
end
|
163
168
|
|
169
|
+
if attributes.key?(:'location')
|
170
|
+
self.location = attributes[:'location']
|
171
|
+
end
|
172
|
+
|
164
173
|
if attributes.key?(:'metadata')
|
165
174
|
self.metadata = attributes[:'metadata']
|
166
175
|
end
|
@@ -218,6 +227,7 @@ module TrieveRubyClient
|
|
218
227
|
group_ids == o.group_ids &&
|
219
228
|
group_tracking_ids == o.group_tracking_ids &&
|
220
229
|
link == o.link &&
|
230
|
+
location == o.location &&
|
221
231
|
metadata == o.metadata &&
|
222
232
|
split_avg == o.split_avg &&
|
223
233
|
tag_set == o.tag_set &&
|
@@ -236,7 +246,7 @@ module TrieveRubyClient
|
|
236
246
|
# Calculates hash code according to all attributes.
|
237
247
|
# @return [Integer] Hash code
|
238
248
|
def hash
|
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
|
249
|
+
[chunk_html, chunk_vector, convert_html_to_text, group_ids, group_tracking_ids, link, location, metadata, split_avg, tag_set, time_stamp, tracking_id, upsert_by_tracking_id, weight].hash
|
240
250
|
end
|
241
251
|
|
242
252
|
# 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.7.
|
6
|
+
The version of the OpenAPI document: 0.7.6
|
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.7.
|
6
|
+
The version of the OpenAPI document: 0.7.6
|
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.7.
|
6
|
+
The version of the OpenAPI document: 0.7.6
|
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.7.
|
6
|
+
The version of the OpenAPI document: 0.7.6
|
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 :link
|
29
29
|
|
30
|
+
attr_accessor :location
|
31
|
+
|
30
32
|
attr_accessor :metadata
|
31
33
|
|
32
34
|
attr_accessor :qdrant_point_id
|
@@ -50,6 +52,7 @@ module TrieveRubyClient
|
|
50
52
|
:'dataset_id' => :'dataset_id',
|
51
53
|
:'id' => :'id',
|
52
54
|
:'link' => :'link',
|
55
|
+
:'location' => :'location',
|
53
56
|
:'metadata' => :'metadata',
|
54
57
|
:'qdrant_point_id' => :'qdrant_point_id',
|
55
58
|
:'tag_set' => :'tag_set',
|
@@ -74,6 +77,7 @@ module TrieveRubyClient
|
|
74
77
|
:'dataset_id' => :'String',
|
75
78
|
:'id' => :'String',
|
76
79
|
:'link' => :'String',
|
80
|
+
:'location' => :'GeoInfo',
|
77
81
|
:'metadata' => :'Object',
|
78
82
|
:'qdrant_point_id' => :'String',
|
79
83
|
:'tag_set' => :'String',
|
@@ -89,6 +93,7 @@ module TrieveRubyClient
|
|
89
93
|
Set.new([
|
90
94
|
:'chunk_html',
|
91
95
|
:'link',
|
96
|
+
:'location',
|
92
97
|
:'metadata',
|
93
98
|
:'qdrant_point_id',
|
94
99
|
:'tag_set',
|
@@ -144,6 +149,10 @@ module TrieveRubyClient
|
|
144
149
|
self.link = attributes[:'link']
|
145
150
|
end
|
146
151
|
|
152
|
+
if attributes.key?(:'location')
|
153
|
+
self.location = attributes[:'location']
|
154
|
+
end
|
155
|
+
|
147
156
|
if attributes.key?(:'metadata')
|
148
157
|
self.metadata = attributes[:'metadata']
|
149
158
|
end
|
@@ -233,6 +242,7 @@ module TrieveRubyClient
|
|
233
242
|
dataset_id == o.dataset_id &&
|
234
243
|
id == o.id &&
|
235
244
|
link == o.link &&
|
245
|
+
location == o.location &&
|
236
246
|
metadata == o.metadata &&
|
237
247
|
qdrant_point_id == o.qdrant_point_id &&
|
238
248
|
tag_set == o.tag_set &&
|
@@ -251,7 +261,7 @@ module TrieveRubyClient
|
|
251
261
|
# Calculates hash code according to all attributes.
|
252
262
|
# @return [Integer] Hash code
|
253
263
|
def hash
|
254
|
-
[chunk_html, content, created_at, dataset_id, id, link, metadata, qdrant_point_id, tag_set, time_stamp, tracking_id, updated_at, weight].hash
|
264
|
+
[chunk_html, content, created_at, dataset_id, id, link, location, metadata, qdrant_point_id, tag_set, time_stamp, tracking_id, updated_at, weight].hash
|
255
265
|
end
|
256
266
|
|
257
267
|
# 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.7.
|
6
|
+
The version of the OpenAPI document: 0.7.6
|
7
7
|
Contact: developers@trieve.ai
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
Generator version: 7.4.0
|