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
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 4c60cbaadb194dd6d1ef05f7ff7a1c10cce9b917a01f697cc1962f7e7cff7307
|
4
|
+
data.tar.gz: e42e740cdee7bca501cef79b9e4949b86fec32d1b10fa3fadf68abae6946dcb6
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 8f5108a2f52b915de1a3550ff04fc75725034ffb208ec192cab9f6d4c5d86c7a4a96b1f3800c31e2f0994c39ae32aa6254a0202869dacca5b8eba72a1f385887
|
7
|
+
data.tar.gz: 3fc1c55240b0562475923a462bd96820b2f9e2c9503ef3fbd6eacff5c209776c20948ab4b92682b74fcfff4f8dc0c092f55099457ea2122a421fccbe6d609816
|
data/README.md
CHANGED
@@ -6,8 +6,8 @@ Trieve OpenAPI Specification. This document describes all of the operations avai
|
|
6
6
|
|
7
7
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
8
8
|
|
9
|
-
- API version: 0.7.
|
10
|
-
- Package version: 0.7.
|
9
|
+
- API version: 0.7.6
|
10
|
+
- Package version: 0.7.6
|
11
11
|
- Generator version: 7.4.0
|
12
12
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
13
13
|
For more information, please visit [https://trieve.ai](https://trieve.ai)
|
@@ -25,16 +25,16 @@ gem build trieve_ruby_client.gemspec
|
|
25
25
|
Then either install the gem locally:
|
26
26
|
|
27
27
|
```shell
|
28
|
-
gem install ./trieve_ruby_client-0.7.
|
28
|
+
gem install ./trieve_ruby_client-0.7.6.gem
|
29
29
|
```
|
30
30
|
|
31
|
-
(for development, run `gem install --dev ./trieve_ruby_client-0.7.
|
31
|
+
(for development, run `gem install --dev ./trieve_ruby_client-0.7.6.gem` to install the development dependencies)
|
32
32
|
|
33
33
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
34
34
|
|
35
35
|
Finally add this to the Gemfile:
|
36
36
|
|
37
|
-
gem 'trieve_ruby_client', '~> 0.7.
|
37
|
+
gem 'trieve_ruby_client', '~> 0.7.6'
|
38
38
|
|
39
39
|
### Install from Git
|
40
40
|
|
@@ -87,8 +87,10 @@ Class | Method | HTTP request | Description
|
|
87
87
|
*TrieveRubyClient::ChunkApi* | [**generate_off_chunks**](docs/ChunkApi.md#generate_off_chunks) | **POST** /api/chunk/generate | RAG on Specified Chunks
|
88
88
|
*TrieveRubyClient::ChunkApi* | [**get_chunk_by_id**](docs/ChunkApi.md#get_chunk_by_id) | **GET** /api/chunk/{chunk_id} | Get Chunk By Id
|
89
89
|
*TrieveRubyClient::ChunkApi* | [**get_chunk_by_tracking_id**](docs/ChunkApi.md#get_chunk_by_tracking_id) | **GET** /api/chunk/tracking_id/{tracking_id} | Get Chunk By Tracking Id
|
90
|
+
*TrieveRubyClient::ChunkApi* | [**get_chunks_by_ids**](docs/ChunkApi.md#get_chunks_by_ids) | **POST** /api/chunks | Get Chunks By Ids
|
91
|
+
*TrieveRubyClient::ChunkApi* | [**get_chunks_by_tracking_ids**](docs/ChunkApi.md#get_chunks_by_tracking_ids) | **POST** /api/chunks/tracking | Get Chunks By TrackingIds
|
90
92
|
*TrieveRubyClient::ChunkApi* | [**get_recommended_chunks**](docs/ChunkApi.md#get_recommended_chunks) | **POST** /api/chunk/recommend | Get Recommended Chunks
|
91
|
-
*TrieveRubyClient::ChunkApi* | [**
|
93
|
+
*TrieveRubyClient::ChunkApi* | [**search_chunks**](docs/ChunkApi.md#search_chunks) | **POST** /api/chunk/search | Search
|
92
94
|
*TrieveRubyClient::ChunkApi* | [**update_chunk**](docs/ChunkApi.md#update_chunk) | **PUT** /api/chunk | Update Chunk
|
93
95
|
*TrieveRubyClient::ChunkApi* | [**update_chunk_by_tracking_id**](docs/ChunkApi.md#update_chunk_by_tracking_id) | **PUT** /api/chunk/tracking_id/update | Update Chunk By Tracking Id
|
94
96
|
*TrieveRubyClient::ChunkGroupApi* | [**add_chunk_to_group**](docs/ChunkGroupApi.md#add_chunk_to_group) | **POST** /api/chunk_group/chunk/{group_id} | Add Chunk to Group
|
@@ -180,12 +182,19 @@ Class | Method | HTTP request | Description
|
|
180
182
|
- [TrieveRubyClient::File](docs/File.md)
|
181
183
|
- [TrieveRubyClient::FileDTO](docs/FileDTO.md)
|
182
184
|
- [TrieveRubyClient::GenerateChunksRequest](docs/GenerateChunksRequest.md)
|
185
|
+
- [TrieveRubyClient::GeoInfo](docs/GeoInfo.md)
|
186
|
+
- [TrieveRubyClient::GeoTypes](docs/GeoTypes.md)
|
187
|
+
- [TrieveRubyClient::GetChunksData](docs/GetChunksData.md)
|
183
188
|
- [TrieveRubyClient::GetEventsData](docs/GetEventsData.md)
|
184
189
|
- [TrieveRubyClient::GetGroupsForChunksData](docs/GetGroupsForChunksData.md)
|
190
|
+
- [TrieveRubyClient::GetTrackingChunksData](docs/GetTrackingChunksData.md)
|
185
191
|
- [TrieveRubyClient::GroupData](docs/GroupData.md)
|
186
192
|
- [TrieveRubyClient::GroupScoreChunk](docs/GroupScoreChunk.md)
|
187
193
|
- [TrieveRubyClient::GroupScoreSlimChunks](docs/GroupScoreSlimChunks.md)
|
188
194
|
- [TrieveRubyClient::InvitationData](docs/InvitationData.md)
|
195
|
+
- [TrieveRubyClient::LocationBoundingBox](docs/LocationBoundingBox.md)
|
196
|
+
- [TrieveRubyClient::LocationPolygon](docs/LocationPolygon.md)
|
197
|
+
- [TrieveRubyClient::LocationRadius](docs/LocationRadius.md)
|
189
198
|
- [TrieveRubyClient::MatchCondition](docs/MatchCondition.md)
|
190
199
|
- [TrieveRubyClient::Message](docs/Message.md)
|
191
200
|
- [TrieveRubyClient::Organization](docs/Organization.md)
|
data/docs/ChunkApi.md
CHANGED
@@ -11,8 +11,10 @@ All URIs are relative to *https://api.trieve.ai*
|
|
11
11
|
| [**generate_off_chunks**](ChunkApi.md#generate_off_chunks) | **POST** /api/chunk/generate | RAG on Specified Chunks |
|
12
12
|
| [**get_chunk_by_id**](ChunkApi.md#get_chunk_by_id) | **GET** /api/chunk/{chunk_id} | Get Chunk By Id |
|
13
13
|
| [**get_chunk_by_tracking_id**](ChunkApi.md#get_chunk_by_tracking_id) | **GET** /api/chunk/tracking_id/{tracking_id} | Get Chunk By Tracking Id |
|
14
|
+
| [**get_chunks_by_ids**](ChunkApi.md#get_chunks_by_ids) | **POST** /api/chunks | Get Chunks By Ids |
|
15
|
+
| [**get_chunks_by_tracking_ids**](ChunkApi.md#get_chunks_by_tracking_ids) | **POST** /api/chunks/tracking | Get Chunks By TrackingIds |
|
14
16
|
| [**get_recommended_chunks**](ChunkApi.md#get_recommended_chunks) | **POST** /api/chunk/recommend | Get Recommended Chunks |
|
15
|
-
| [**
|
17
|
+
| [**search_chunks**](ChunkApi.md#search_chunks) | **POST** /api/chunk/search | Search |
|
16
18
|
| [**update_chunk**](ChunkApi.md#update_chunk) | **PUT** /api/chunk | Update Chunk |
|
17
19
|
| [**update_chunk_by_tracking_id**](ChunkApi.md#update_chunk_by_tracking_id) | **PUT** /api/chunk/tracking_id/update | Update Chunk By Tracking Id |
|
18
20
|
|
@@ -23,7 +25,7 @@ All URIs are relative to *https://api.trieve.ai*
|
|
23
25
|
|
24
26
|
Create or Upsert Chunk or Chunks
|
25
27
|
|
26
|
-
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.
|
28
|
+
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.
|
27
29
|
|
28
30
|
### Examples
|
29
31
|
|
@@ -526,6 +528,152 @@ end
|
|
526
528
|
- **Accept**: application/json
|
527
529
|
|
528
530
|
|
531
|
+
## get_chunks_by_ids
|
532
|
+
|
533
|
+
> <Array<ChunkMetadata>> get_chunks_by_ids(tr_dataset, get_chunks_data)
|
534
|
+
|
535
|
+
Get Chunks By Ids
|
536
|
+
|
537
|
+
Get Chunks By Ids Get multiple chunks by multiple ids.
|
538
|
+
|
539
|
+
### Examples
|
540
|
+
|
541
|
+
```ruby
|
542
|
+
require 'time'
|
543
|
+
require 'trieve_ruby_client'
|
544
|
+
# setup authorization
|
545
|
+
TrieveRubyClient.configure do |config|
|
546
|
+
# Configure API key authorization: ApiKey
|
547
|
+
config.api_key['ApiKey'] = 'YOUR API KEY'
|
548
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
549
|
+
# config.api_key_prefix['ApiKey'] = 'Bearer'
|
550
|
+
end
|
551
|
+
|
552
|
+
api_instance = TrieveRubyClient::ChunkApi.new
|
553
|
+
tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
|
554
|
+
get_chunks_data = TrieveRubyClient::GetChunksData.new({ids: ['ids_example']}) # GetChunksData | JSON request payload to get the chunks in the request
|
555
|
+
|
556
|
+
begin
|
557
|
+
# Get Chunks By Ids
|
558
|
+
result = api_instance.get_chunks_by_ids(tr_dataset, get_chunks_data)
|
559
|
+
p result
|
560
|
+
rescue TrieveRubyClient::ApiError => e
|
561
|
+
puts "Error when calling ChunkApi->get_chunks_by_ids: #{e}"
|
562
|
+
end
|
563
|
+
```
|
564
|
+
|
565
|
+
#### Using the get_chunks_by_ids_with_http_info variant
|
566
|
+
|
567
|
+
This returns an Array which contains the response data, status code and headers.
|
568
|
+
|
569
|
+
> <Array(<Array<ChunkMetadata>>, Integer, Hash)> get_chunks_by_ids_with_http_info(tr_dataset, get_chunks_data)
|
570
|
+
|
571
|
+
```ruby
|
572
|
+
begin
|
573
|
+
# Get Chunks By Ids
|
574
|
+
data, status_code, headers = api_instance.get_chunks_by_ids_with_http_info(tr_dataset, get_chunks_data)
|
575
|
+
p status_code # => 2xx
|
576
|
+
p headers # => { ... }
|
577
|
+
p data # => <Array<ChunkMetadata>>
|
578
|
+
rescue TrieveRubyClient::ApiError => e
|
579
|
+
puts "Error when calling ChunkApi->get_chunks_by_ids_with_http_info: #{e}"
|
580
|
+
end
|
581
|
+
```
|
582
|
+
|
583
|
+
### Parameters
|
584
|
+
|
585
|
+
| Name | Type | Description | Notes |
|
586
|
+
| ---- | ---- | ----------- | ----- |
|
587
|
+
| **tr_dataset** | **String** | The dataset id to use for the request | |
|
588
|
+
| **get_chunks_data** | [**GetChunksData**](GetChunksData.md) | JSON request payload to get the chunks in the request | |
|
589
|
+
|
590
|
+
### Return type
|
591
|
+
|
592
|
+
[**Array<ChunkMetadata>**](ChunkMetadata.md)
|
593
|
+
|
594
|
+
### Authorization
|
595
|
+
|
596
|
+
[ApiKey](../README.md#ApiKey)
|
597
|
+
|
598
|
+
### HTTP request headers
|
599
|
+
|
600
|
+
- **Content-Type**: application/json
|
601
|
+
- **Accept**: application/json
|
602
|
+
|
603
|
+
|
604
|
+
## get_chunks_by_tracking_ids
|
605
|
+
|
606
|
+
> <ChunkMetadata> get_chunks_by_tracking_ids(tr_dataset, get_tracking_chunks_data)
|
607
|
+
|
608
|
+
Get Chunks By TrackingIds
|
609
|
+
|
610
|
+
Get Chunks By TrackingIds Get multiple chunks by ids.
|
611
|
+
|
612
|
+
### Examples
|
613
|
+
|
614
|
+
```ruby
|
615
|
+
require 'time'
|
616
|
+
require 'trieve_ruby_client'
|
617
|
+
# setup authorization
|
618
|
+
TrieveRubyClient.configure do |config|
|
619
|
+
# Configure API key authorization: ApiKey
|
620
|
+
config.api_key['ApiKey'] = 'YOUR API KEY'
|
621
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
622
|
+
# config.api_key_prefix['ApiKey'] = 'Bearer'
|
623
|
+
end
|
624
|
+
|
625
|
+
api_instance = TrieveRubyClient::ChunkApi.new
|
626
|
+
tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
|
627
|
+
get_tracking_chunks_data = TrieveRubyClient::GetTrackingChunksData.new({tracking_ids: ['tracking_ids_example']}) # GetTrackingChunksData | JSON request payload to get the chunks in the request
|
628
|
+
|
629
|
+
begin
|
630
|
+
# Get Chunks By TrackingIds
|
631
|
+
result = api_instance.get_chunks_by_tracking_ids(tr_dataset, get_tracking_chunks_data)
|
632
|
+
p result
|
633
|
+
rescue TrieveRubyClient::ApiError => e
|
634
|
+
puts "Error when calling ChunkApi->get_chunks_by_tracking_ids: #{e}"
|
635
|
+
end
|
636
|
+
```
|
637
|
+
|
638
|
+
#### Using the get_chunks_by_tracking_ids_with_http_info variant
|
639
|
+
|
640
|
+
This returns an Array which contains the response data, status code and headers.
|
641
|
+
|
642
|
+
> <Array(<ChunkMetadata>, Integer, Hash)> get_chunks_by_tracking_ids_with_http_info(tr_dataset, get_tracking_chunks_data)
|
643
|
+
|
644
|
+
```ruby
|
645
|
+
begin
|
646
|
+
# Get Chunks By TrackingIds
|
647
|
+
data, status_code, headers = api_instance.get_chunks_by_tracking_ids_with_http_info(tr_dataset, get_tracking_chunks_data)
|
648
|
+
p status_code # => 2xx
|
649
|
+
p headers # => { ... }
|
650
|
+
p data # => <ChunkMetadata>
|
651
|
+
rescue TrieveRubyClient::ApiError => e
|
652
|
+
puts "Error when calling ChunkApi->get_chunks_by_tracking_ids_with_http_info: #{e}"
|
653
|
+
end
|
654
|
+
```
|
655
|
+
|
656
|
+
### Parameters
|
657
|
+
|
658
|
+
| Name | Type | Description | Notes |
|
659
|
+
| ---- | ---- | ----------- | ----- |
|
660
|
+
| **tr_dataset** | **String** | The dataset id to use for the request | |
|
661
|
+
| **get_tracking_chunks_data** | [**GetTrackingChunksData**](GetTrackingChunksData.md) | JSON request payload to get the chunks in the request | |
|
662
|
+
|
663
|
+
### Return type
|
664
|
+
|
665
|
+
[**ChunkMetadata**](ChunkMetadata.md)
|
666
|
+
|
667
|
+
### Authorization
|
668
|
+
|
669
|
+
[ApiKey](../README.md#ApiKey)
|
670
|
+
|
671
|
+
### HTTP request headers
|
672
|
+
|
673
|
+
- **Content-Type**: application/json
|
674
|
+
- **Accept**: application/json
|
675
|
+
|
676
|
+
|
529
677
|
## get_recommended_chunks
|
530
678
|
|
531
679
|
> <Array<ChunkMetadataWithScore>> get_recommended_chunks(tr_dataset, recommend_chunks_request)
|
@@ -599,9 +747,9 @@ end
|
|
599
747
|
- **Accept**: application/json
|
600
748
|
|
601
749
|
|
602
|
-
##
|
750
|
+
## search_chunks
|
603
751
|
|
604
|
-
> <SearchChunkQueryResponseBody>
|
752
|
+
> <SearchChunkQueryResponseBody> search_chunks(tr_dataset, search_chunk_data)
|
605
753
|
|
606
754
|
Search
|
607
755
|
|
@@ -626,28 +774,28 @@ search_chunk_data = TrieveRubyClient::SearchChunkData.new({query: 'query_example
|
|
626
774
|
|
627
775
|
begin
|
628
776
|
# Search
|
629
|
-
result = api_instance.
|
777
|
+
result = api_instance.search_chunks(tr_dataset, search_chunk_data)
|
630
778
|
p result
|
631
779
|
rescue TrieveRubyClient::ApiError => e
|
632
|
-
puts "Error when calling ChunkApi->
|
780
|
+
puts "Error when calling ChunkApi->search_chunks: #{e}"
|
633
781
|
end
|
634
782
|
```
|
635
783
|
|
636
|
-
#### Using the
|
784
|
+
#### Using the search_chunks_with_http_info variant
|
637
785
|
|
638
786
|
This returns an Array which contains the response data, status code and headers.
|
639
787
|
|
640
|
-
> <Array(<SearchChunkQueryResponseBody>, Integer, Hash)>
|
788
|
+
> <Array(<SearchChunkQueryResponseBody>, Integer, Hash)> search_chunks_with_http_info(tr_dataset, search_chunk_data)
|
641
789
|
|
642
790
|
```ruby
|
643
791
|
begin
|
644
792
|
# Search
|
645
|
-
data, status_code, headers = api_instance.
|
793
|
+
data, status_code, headers = api_instance.search_chunks_with_http_info(tr_dataset, search_chunk_data)
|
646
794
|
p status_code # => 2xx
|
647
795
|
p headers # => { ... }
|
648
796
|
p data # => <SearchChunkQueryResponseBody>
|
649
797
|
rescue TrieveRubyClient::ApiError => e
|
650
|
-
puts "Error when calling ChunkApi->
|
798
|
+
puts "Error when calling ChunkApi->search_chunks_with_http_info: #{e}"
|
651
799
|
end
|
652
800
|
```
|
653
801
|
|
data/docs/ChunkData.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 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. | [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 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. | [optional] |
|
12
12
|
| **link** | **String** | 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. | [optional] |
|
13
|
+
| **location** | [**GeoInfo**](GeoInfo.md) | | [optional] |
|
13
14
|
| **metadata** | **Object** | 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. | [optional] |
|
14
15
|
| **split_avg** | **Boolean** | Split avg is a boolean which tells the server to split the text in the chunk_html into smaller chunks and average their resulting vectors. This is useful for when you want to create a chunk from a large piece of text and want to split it into smaller chunks to create a more fuzzy average dense vector. The sparse vector will be generated normally with no averaging. By default this is false. | [optional] |
|
15
16
|
| **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. | [optional] |
|
@@ -30,6 +31,7 @@ instance = TrieveRubyClient::ChunkData.new(
|
|
30
31
|
group_ids: null,
|
31
32
|
group_tracking_ids: null,
|
32
33
|
link: null,
|
34
|
+
location: null,
|
33
35
|
metadata: null,
|
34
36
|
split_avg: null,
|
35
37
|
tag_set: null,
|
data/docs/ChunkMetadata.md
CHANGED
@@ -10,6 +10,7 @@
|
|
10
10
|
| **dataset_id** | **String** | | |
|
11
11
|
| **id** | **String** | | |
|
12
12
|
| **link** | **String** | | [optional] |
|
13
|
+
| **location** | [**GeoInfo**](GeoInfo.md) | | [optional] |
|
13
14
|
| **metadata** | **Object** | | [optional] |
|
14
15
|
| **qdrant_point_id** | **String** | | [optional] |
|
15
16
|
| **tag_set** | **String** | | [optional] |
|
@@ -30,6 +31,7 @@ instance = TrieveRubyClient::ChunkMetadata.new(
|
|
30
31
|
dataset_id: null,
|
31
32
|
id: null,
|
32
33
|
link: null,
|
34
|
+
location: null,
|
33
35
|
metadata: null,
|
34
36
|
qdrant_point_id: null,
|
35
37
|
tag_set: null,
|
data/docs/CreateMessageData.md
CHANGED
@@ -6,7 +6,6 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **highlight_citations** | **Boolean** | Whether or not to highlight the citations in the response. If this is set to true or not included, the citations will be highlighted. If this is set to false, the citations will not be highlighted. Default is true. | [optional] |
|
8
8
|
| **highlight_delimiters** | **Array<String>** | The delimiters to use for highlighting the citations. If this is not included, the default delimiters will be used. Default is `[\".\", \"!\", \"?\", \"\\n\", \"\\t\", \",\"]`. | [optional] |
|
9
|
-
| **model** | **String** | The model to use for the assistant's messages. This can be any model from the openrouter model list. If no model is provided, gpt-3.5-turbo will be used. | [optional] |
|
10
9
|
| **new_message_content** | **String** | The content of the user message to attach to the topic and then generate an assistant message in response to. | |
|
11
10
|
| **stream_response** | **Boolean** | Whether or not to stream the response. If this is set to true or not included, the response will be a stream. If this is set to false, the response will be a normal JSON response. Default is true. | [optional] |
|
12
11
|
| **topic_id** | **String** | The ID of the topic to attach the message to. | |
|
@@ -19,7 +18,6 @@ require 'trieve_ruby_client'
|
|
19
18
|
instance = TrieveRubyClient::CreateMessageData.new(
|
20
19
|
highlight_citations: null,
|
21
20
|
highlight_delimiters: null,
|
22
|
-
model: null,
|
23
21
|
new_message_content: null,
|
24
22
|
stream_response: null,
|
25
23
|
topic_id: null
|
data/docs/CreateTopicData.md
CHANGED
@@ -5,7 +5,6 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **first_user_message** | **String** | The first message which will belong to the topic. The topic name is generated based on this message similar to how it works in the OpenAI chat UX if a name is not explicitly provided on the name request body key. | [optional] |
|
8
|
-
| **model** | **String** | The model to use for the assistant's messages. This can be any model from the openrouter model list. If no model is provided, the gpt-3.5-turbo will be used. | [optional] |
|
9
8
|
| **name** | **String** | The name of the topic. If this is not provided, the topic name is generated from the first_user_message. | [optional] |
|
10
9
|
| **owner_id** | **String** | The owner_id of the topic. This is typically a browser fingerprint or your user's id. It is used to group topics together for a user. | |
|
11
10
|
|
@@ -16,7 +15,6 @@ require 'trieve_ruby_client'
|
|
16
15
|
|
17
16
|
instance = TrieveRubyClient::CreateTopicData.new(
|
18
17
|
first_user_message: null,
|
19
|
-
model: null,
|
20
18
|
name: null,
|
21
19
|
owner_id: null
|
22
20
|
)
|
data/docs/EditMessageData.md
CHANGED
@@ -7,7 +7,6 @@
|
|
7
7
|
| **highlight_citations** | **Boolean** | Whether or not to highlight the citations in the response. If this is set to true or not included, the citations will be highlighted. If this is set to false, the citations will not be highlighted. Default is true. | [optional] |
|
8
8
|
| **highlight_delimiters** | **Array<String>** | The delimiters to use for highlighting the citations. If this is not included, the default delimiters will be used. Default is `[\".\", \"!\", \"?\", \"\\n\", \"\\t\", \",\"]`. | [optional] |
|
9
9
|
| **message_sort_order** | **Integer** | The sort order of the message to edit. | |
|
10
|
-
| **model** | **String** | The model to use for the assistant generative inferences. This can be any model from the openrouter model list. If no model is provided, the gpt-3.5-turbo will be used.~ | [optional] |
|
11
10
|
| **new_message_content** | **String** | The new content of the message to replace the old content with. | |
|
12
11
|
| **stream_response** | **Boolean** | Whether or not to stream the response. If this is set to true or not included, the response will be a stream. If this is set to false, the response will be a normal JSON response. Default is true. | [optional] |
|
13
12
|
| **topic_id** | **String** | The id of the topic to edit the message at the given sort order for. | |
|
@@ -21,7 +20,6 @@ instance = TrieveRubyClient::EditMessageData.new(
|
|
21
20
|
highlight_citations: null,
|
22
21
|
highlight_delimiters: null,
|
23
22
|
message_sort_order: null,
|
24
|
-
model: null,
|
25
23
|
new_message_content: null,
|
26
24
|
stream_response: null,
|
27
25
|
topic_id: null
|
data/docs/FieldCondition.md
CHANGED
@@ -5,6 +5,9 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **field** | **String** | Field is the name of the field to filter on. The field value will be used to check for an exact substring match on the metadata values for each existing chunk. This is useful for when you want to filter chunks by arbitrary metadata. To access fields inside of the metadata that you provide with the card, prefix the field name with `metadata.`. | |
|
8
|
+
| **geo_bounding_box** | [**LocationBoundingBox**](LocationBoundingBox.md) | | [optional] |
|
9
|
+
| **geo_polygon** | [**LocationPolygon**](LocationPolygon.md) | | [optional] |
|
10
|
+
| **geo_radius** | [**LocationRadius**](LocationRadius.md) | | [optional] |
|
8
11
|
| **match** | [**Array<MatchCondition>**](MatchCondition.md) | Match is the value to match on the field. The match value will be used to check for an exact substring match on the metadata values for each existing chunk. This is useful for when you want to filter chunks by arbitrary metadata. | [optional] |
|
9
12
|
| **range** | [**Range**](Range.md) | | [optional] |
|
10
13
|
|
@@ -15,6 +18,9 @@ require 'trieve_ruby_client'
|
|
15
18
|
|
16
19
|
instance = TrieveRubyClient::FieldCondition.new(
|
17
20
|
field: null,
|
21
|
+
geo_bounding_box: null,
|
22
|
+
geo_polygon: null,
|
23
|
+
geo_radius: null,
|
18
24
|
match: null,
|
19
25
|
range: null
|
20
26
|
)
|
@@ -5,7 +5,6 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **chunk_ids** | **Array<String>** | The ids of the chunks to be retrieved and injected into the context window for RAG. | |
|
8
|
-
| **model** | **String** | The model to use for the chat. This can be any model from the openrouter model list. If no model is provided, gpt-3.5-turbo will be used. | [optional] |
|
9
8
|
| **prev_messages** | [**Array<ChatMessageProxy>**](ChatMessageProxy.md) | The previous messages to be placed into the chat history. The last message in this array will be the prompt for the model to inference on. The length of this array must be at least 1. | |
|
10
9
|
| **prompt** | **String** | Prompt for the last message in the prev_messages array. This will be used to generate the next message in the chat. The default is 'Respond to the instruction and include the doc numbers that you used in square brackets at the end of the sentences that you used the docs for:'. You can also specify an empty string to leave the final message alone such that your user's final message can be used as the prompt. See docs.trieve.ai or contact us for more information. | [optional] |
|
11
10
|
| **stream_response** | **Boolean** | Whether or not to stream the response. If this is set to true or not included, the response will be a stream. If this is set to false, the response will be a normal JSON response. Default is true. | [optional] |
|
@@ -17,7 +16,6 @@ require 'trieve_ruby_client'
|
|
17
16
|
|
18
17
|
instance = TrieveRubyClient::GenerateChunksRequest.new(
|
19
18
|
chunk_ids: null,
|
20
|
-
model: null,
|
21
19
|
prev_messages: null,
|
22
20
|
prompt: null,
|
23
21
|
stream_response: null
|
data/docs/GeoInfo.md
ADDED
@@ -0,0 +1,20 @@
|
|
1
|
+
# TrieveRubyClient::GeoInfo
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **lat** | [**GeoTypes**](GeoTypes.md) | | |
|
8
|
+
| **lon** | [**GeoTypes**](GeoTypes.md) | | |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'trieve_ruby_client'
|
14
|
+
|
15
|
+
instance = TrieveRubyClient::GeoInfo.new(
|
16
|
+
lat: null,
|
17
|
+
lon: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
data/docs/GeoTypes.md
ADDED
@@ -0,0 +1,49 @@
|
|
1
|
+
# TrieveRubyClient::GeoTypes
|
2
|
+
|
3
|
+
## Class instance methods
|
4
|
+
|
5
|
+
### `openapi_one_of`
|
6
|
+
|
7
|
+
Returns the list of classes defined in oneOf.
|
8
|
+
|
9
|
+
#### Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'trieve_ruby_client'
|
13
|
+
|
14
|
+
TrieveRubyClient::GeoTypes.openapi_one_of
|
15
|
+
# =>
|
16
|
+
# [
|
17
|
+
# :'Float',
|
18
|
+
# :'Integer'
|
19
|
+
# ]
|
20
|
+
```
|
21
|
+
|
22
|
+
### build
|
23
|
+
|
24
|
+
Find the appropriate object from the `openapi_one_of` list and casts the data into it.
|
25
|
+
|
26
|
+
#### Example
|
27
|
+
|
28
|
+
```ruby
|
29
|
+
require 'trieve_ruby_client'
|
30
|
+
|
31
|
+
TrieveRubyClient::GeoTypes.build(data)
|
32
|
+
# => #<Float:0x00007fdd4aab02a0>
|
33
|
+
|
34
|
+
TrieveRubyClient::GeoTypes.build(data_that_doesnt_match)
|
35
|
+
# => nil
|
36
|
+
```
|
37
|
+
|
38
|
+
#### Parameters
|
39
|
+
|
40
|
+
| Name | Type | Description |
|
41
|
+
| ---- | ---- | ----------- |
|
42
|
+
| **data** | **Mixed** | data to be matched against the list of oneOf items |
|
43
|
+
|
44
|
+
#### Return type
|
45
|
+
|
46
|
+
- `Float`
|
47
|
+
- `Integer`
|
48
|
+
- `nil` (if no type matches)
|
49
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# TrieveRubyClient::GetChunksData
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **ids** | **Array<String>** | | |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'trieve_ruby_client'
|
13
|
+
|
14
|
+
instance = TrieveRubyClient::GetChunksData.new(
|
15
|
+
ids: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# TrieveRubyClient::GetTrackingChunksData
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **tracking_ids** | **Array<String>** | | |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'trieve_ruby_client'
|
13
|
+
|
14
|
+
instance = TrieveRubyClient::GetTrackingChunksData.new(
|
15
|
+
tracking_ids: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# TrieveRubyClient::LocationBoundingBox
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **bottom_right** | [**GeoInfo**](GeoInfo.md) | | |
|
8
|
+
| **top_left** | [**GeoInfo**](GeoInfo.md) | | |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'trieve_ruby_client'
|
14
|
+
|
15
|
+
instance = TrieveRubyClient::LocationBoundingBox.new(
|
16
|
+
bottom_right: null,
|
17
|
+
top_left: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# TrieveRubyClient::LocationPolygon
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **exterior** | [**Array<GeoInfo>**](GeoInfo.md) | | |
|
8
|
+
| **interior** | **Array<Array<GeoInfo>>** | | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'trieve_ruby_client'
|
14
|
+
|
15
|
+
instance = TrieveRubyClient::LocationPolygon.new(
|
16
|
+
exterior: null,
|
17
|
+
interior: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# TrieveRubyClient::LocationRadius
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **center** | [**GeoInfo**](GeoInfo.md) | | |
|
8
|
+
| **radius** | **Float** | | |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'trieve_ruby_client'
|
14
|
+
|
15
|
+
instance = TrieveRubyClient::LocationRadius.new(
|
16
|
+
center: null,
|
17
|
+
radius: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
data/docs/RangeCondition.md
CHANGED
@@ -15,6 +15,7 @@ TrieveRubyClient::RangeCondition.openapi_one_of
|
|
15
15
|
# =>
|
16
16
|
# [
|
17
17
|
# :'Float',
|
18
|
+
# :'Integer',
|
18
19
|
# :'String'
|
19
20
|
# ]
|
20
21
|
```
|
@@ -44,6 +45,7 @@ TrieveRubyClient::RangeCondition.build(data_that_doesnt_match)
|
|
44
45
|
#### Return type
|
45
46
|
|
46
47
|
- `Float`
|
48
|
+
- `Integer`
|
47
49
|
- `String`
|
48
50
|
- `nil` (if no type matches)
|
49
51
|
|
@@ -6,7 +6,6 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **highlight_citations** | **Boolean** | Whether or not to highlight the citations in the response. If this is set to true or not included, the citations will be highlighted. If this is set to false, the citations will not be highlighted. Default is true. | [optional] |
|
8
8
|
| **highlight_delimiters** | **Array<String>** | The delimiters to use for highlighting the citations. If this is not included, the default delimiters will be used. Default is `[\".\", \"!\", \"?\", \"\\n\", \"\\t\", \",\"]`. | [optional] |
|
9
|
-
| **model** | **String** | The model to use for the assistant generative inferences. This can be any model from the openrouter model list. If no model is provided, the gpt-3.5-turbo will be used.~ | [optional] |
|
10
9
|
| **stream_response** | **Boolean** | Whether or not to stream the response. If this is set to true or not included, the response will be a stream. If this is set to false, the response will be a normal JSON response. Default is true. | [optional] |
|
11
10
|
| **topic_id** | **String** | The id of the topic to regenerate the last message for. | |
|
12
11
|
|
@@ -18,7 +17,6 @@ require 'trieve_ruby_client'
|
|
18
17
|
instance = TrieveRubyClient::RegenerateMessageData.new(
|
19
18
|
highlight_citations: null,
|
20
19
|
highlight_delimiters: null,
|
21
|
-
model: null,
|
22
20
|
stream_response: null,
|
23
21
|
topic_id: null
|
24
22
|
)
|
data/docs/SlimChunkMetadata.md
CHANGED
@@ -5,8 +5,10 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **created_at** | **Time** | | |
|
8
|
+
| **dataset_id** | **String** | | |
|
8
9
|
| **id** | **String** | | |
|
9
10
|
| **link** | **String** | | [optional] |
|
11
|
+
| **location** | [**GeoInfo**](GeoInfo.md) | | [optional] |
|
10
12
|
| **metadata** | **Object** | | [optional] |
|
11
13
|
| **qdrant_point_id** | **String** | | [optional] |
|
12
14
|
| **tag_set** | **String** | | [optional] |
|
@@ -22,8 +24,10 @@ require 'trieve_ruby_client'
|
|
22
24
|
|
23
25
|
instance = TrieveRubyClient::SlimChunkMetadata.new(
|
24
26
|
created_at: null,
|
27
|
+
dataset_id: null,
|
25
28
|
id: null,
|
26
29
|
link: null,
|
30
|
+
location: null,
|
27
31
|
metadata: null,
|
28
32
|
qdrant_point_id: null,
|
29
33
|
tag_set: null,
|