trieve_ruby_client 0.6.2 → 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.
Files changed (116) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +5 -5
  3. data/docs/ChunkApi.md +1 -1
  4. data/docs/ChunkData.md +2 -0
  5. data/docs/FileApi.md +1 -1
  6. data/docs/GroupScoreChunk.md +2 -0
  7. data/docs/UpdateChunkByTrackingIdData.md +2 -0
  8. data/docs/UpdateChunkData.md +2 -0
  9. data/docs/UploadFileData.md +2 -2
  10. data/lib/trieve_ruby_client/api/auth_api.rb +1 -1
  11. data/lib/trieve_ruby_client/api/chunk_api.rb +3 -3
  12. data/lib/trieve_ruby_client/api/chunk_group_api.rb +1 -1
  13. data/lib/trieve_ruby_client/api/dataset_api.rb +1 -1
  14. data/lib/trieve_ruby_client/api/events_api.rb +1 -1
  15. data/lib/trieve_ruby_client/api/file_api.rb +1 -1
  16. data/lib/trieve_ruby_client/api/health_api.rb +1 -1
  17. data/lib/trieve_ruby_client/api/invitation_api.rb +1 -1
  18. data/lib/trieve_ruby_client/api/message_api.rb +1 -1
  19. data/lib/trieve_ruby_client/api/organization_api.rb +1 -1
  20. data/lib/trieve_ruby_client/api/stripe_api.rb +1 -1
  21. data/lib/trieve_ruby_client/api/topic_api.rb +1 -1
  22. data/lib/trieve_ruby_client/api/user_api.rb +1 -1
  23. data/lib/trieve_ruby_client/api_client.rb +1 -1
  24. data/lib/trieve_ruby_client/api_error.rb +1 -1
  25. data/lib/trieve_ruby_client/configuration.rb +1 -1
  26. data/lib/trieve_ruby_client/models/add_chunk_to_group_data.rb +1 -1
  27. data/lib/trieve_ruby_client/models/api_key_dto.rb +1 -1
  28. data/lib/trieve_ruby_client/models/auth_query.rb +1 -1
  29. data/lib/trieve_ruby_client/models/batch_queued_chunk_response.rb +1 -1
  30. data/lib/trieve_ruby_client/models/bookmark_data.rb +1 -1
  31. data/lib/trieve_ruby_client/models/bookmark_group_result.rb +1 -1
  32. data/lib/trieve_ruby_client/models/chat_message_proxy.rb +1 -1
  33. data/lib/trieve_ruby_client/models/chunk_data.rb +13 -2
  34. data/lib/trieve_ruby_client/models/chunk_filter.rb +1 -1
  35. data/lib/trieve_ruby_client/models/chunk_group.rb +1 -1
  36. data/lib/trieve_ruby_client/models/chunk_group_and_file.rb +1 -1
  37. data/lib/trieve_ruby_client/models/chunk_metadata.rb +1 -1
  38. data/lib/trieve_ruby_client/models/chunk_metadata_with_score.rb +1 -1
  39. data/lib/trieve_ruby_client/models/client_dataset_configuration.rb +1 -1
  40. data/lib/trieve_ruby_client/models/create_chunk_data.rb +1 -1
  41. data/lib/trieve_ruby_client/models/create_chunk_group_data.rb +1 -1
  42. data/lib/trieve_ruby_client/models/create_dataset_request.rb +1 -1
  43. data/lib/trieve_ruby_client/models/create_message_data.rb +1 -1
  44. data/lib/trieve_ruby_client/models/create_organization_data.rb +1 -1
  45. data/lib/trieve_ruby_client/models/create_topic_data.rb +1 -1
  46. data/lib/trieve_ruby_client/models/dataset.rb +1 -1
  47. data/lib/trieve_ruby_client/models/dataset_and_usage.rb +1 -1
  48. data/lib/trieve_ruby_client/models/dataset_dto.rb +1 -1
  49. data/lib/trieve_ruby_client/models/dataset_usage_count.rb +1 -1
  50. data/lib/trieve_ruby_client/models/delete_topic_data.rb +1 -1
  51. data/lib/trieve_ruby_client/models/delete_user_api_key_request.rb +1 -1
  52. data/lib/trieve_ruby_client/models/edit_message_data.rb +1 -1
  53. data/lib/trieve_ruby_client/models/error_response_body.rb +1 -1
  54. data/lib/trieve_ruby_client/models/event.rb +1 -1
  55. data/lib/trieve_ruby_client/models/event_return.rb +1 -1
  56. data/lib/trieve_ruby_client/models/field_condition.rb +1 -1
  57. data/lib/trieve_ruby_client/models/file.rb +1 -1
  58. data/lib/trieve_ruby_client/models/file_dto.rb +1 -1
  59. data/lib/trieve_ruby_client/models/generate_chunks_request.rb +1 -1
  60. data/lib/trieve_ruby_client/models/get_events_data.rb +1 -1
  61. data/lib/trieve_ruby_client/models/get_groups_for_chunks_data.rb +1 -1
  62. data/lib/trieve_ruby_client/models/group_data.rb +1 -1
  63. data/lib/trieve_ruby_client/models/group_score_chunk.rb +12 -2
  64. data/lib/trieve_ruby_client/models/group_score_slim_chunks.rb +1 -1
  65. data/lib/trieve_ruby_client/models/invitation_data.rb +1 -1
  66. data/lib/trieve_ruby_client/models/match_condition.rb +1 -1
  67. data/lib/trieve_ruby_client/models/message.rb +1 -1
  68. data/lib/trieve_ruby_client/models/organization.rb +1 -1
  69. data/lib/trieve_ruby_client/models/organization_usage_count.rb +1 -1
  70. data/lib/trieve_ruby_client/models/range.rb +1 -1
  71. data/lib/trieve_ruby_client/models/range_condition.rb +1 -1
  72. data/lib/trieve_ruby_client/models/recommend_chunks_request.rb +1 -1
  73. data/lib/trieve_ruby_client/models/recommend_group_chunks_request.rb +1 -1
  74. data/lib/trieve_ruby_client/models/regenerate_message_data.rb +1 -1
  75. data/lib/trieve_ruby_client/models/return_queued_chunk.rb +1 -1
  76. data/lib/trieve_ruby_client/models/score_chunk_dto.rb +1 -1
  77. data/lib/trieve_ruby_client/models/score_slim_chunks.rb +1 -1
  78. data/lib/trieve_ruby_client/models/search_chunk_data.rb +1 -1
  79. data/lib/trieve_ruby_client/models/search_chunk_query_response_body.rb +1 -1
  80. data/lib/trieve_ruby_client/models/search_over_groups_data.rb +1 -1
  81. data/lib/trieve_ruby_client/models/search_over_groups_results.rb +1 -1
  82. data/lib/trieve_ruby_client/models/search_over_groups_slim_results.rb +1 -1
  83. data/lib/trieve_ruby_client/models/search_slim_chunk_query_response_body.rb +1 -1
  84. data/lib/trieve_ruby_client/models/search_within_group_data.rb +1 -1
  85. data/lib/trieve_ruby_client/models/search_within_group_results.rb +1 -1
  86. data/lib/trieve_ruby_client/models/search_within_group_slim_results.rb +1 -1
  87. data/lib/trieve_ruby_client/models/set_user_api_key_request.rb +1 -1
  88. data/lib/trieve_ruby_client/models/set_user_api_key_response.rb +1 -1
  89. data/lib/trieve_ruby_client/models/single_queued_chunk_response.rb +1 -1
  90. data/lib/trieve_ruby_client/models/slim_chunk_metadata.rb +1 -1
  91. data/lib/trieve_ruby_client/models/slim_chunk_metadata_with_score.rb +1 -1
  92. data/lib/trieve_ruby_client/models/slim_group.rb +1 -1
  93. data/lib/trieve_ruby_client/models/slim_user.rb +1 -1
  94. data/lib/trieve_ruby_client/models/stripe_plan.rb +1 -1
  95. data/lib/trieve_ruby_client/models/suggested_queries_request.rb +1 -1
  96. data/lib/trieve_ruby_client/models/suggested_queries_response.rb +1 -1
  97. data/lib/trieve_ruby_client/models/topic.rb +1 -1
  98. data/lib/trieve_ruby_client/models/update_chunk_by_tracking_id_data.rb +13 -2
  99. data/lib/trieve_ruby_client/models/update_chunk_data.rb +13 -2
  100. data/lib/trieve_ruby_client/models/update_chunk_group_data.rb +1 -1
  101. data/lib/trieve_ruby_client/models/update_dataset_request.rb +1 -1
  102. data/lib/trieve_ruby_client/models/update_group_by_tracking_id_data.rb +1 -1
  103. data/lib/trieve_ruby_client/models/update_organization_data.rb +1 -1
  104. data/lib/trieve_ruby_client/models/update_topic_data.rb +1 -1
  105. data/lib/trieve_ruby_client/models/update_user_data.rb +1 -1
  106. data/lib/trieve_ruby_client/models/upload_file_data.rb +13 -19
  107. data/lib/trieve_ruby_client/models/upload_file_result.rb +1 -1
  108. data/lib/trieve_ruby_client/models/user_organization.rb +1 -1
  109. data/lib/trieve_ruby_client/version.rb +2 -2
  110. data/lib/trieve_ruby_client.rb +1 -1
  111. data/openapi-generator.yaml +1 -1
  112. data/openapi.json +27 -8
  113. data/spec/spec_helper.rb +1 -1
  114. data/trieve_ruby_client-0.6.2.gem +0 -0
  115. data/trieve_ruby_client.gemspec +1 -1
  116. metadata +3 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: a535668b86dc6d7a9c34dbf5f73599b5cb779ca38d16c4e59dc4fec8bf40dfd3
4
- data.tar.gz: dce36c7454918e72708d1cbf0c349175d86438450910502269e1bbc4f918f60e
3
+ metadata.gz: 98f7a830f8d3738bbd09ecd1a65b9162f9fabfd8cd15b178e7f97c9ba3d3b3b7
4
+ data.tar.gz: aa8a52a5502c7e3ba00bc5a7753e2d614780f9d8fb8374ac2dda36a4d2c8f140
5
5
  SHA512:
6
- metadata.gz: ca8dcc93ee03db947a313c5acaa6d1a40897efba991a0bda43f31e76000e69154250878523e9dbe669d854e7a8a6f925282371eb1c0620c8165f1fa73022c72f
7
- data.tar.gz: 0e8b184949e29720dd63748ac05a6089b8bbefb5e145e2c96265edd2e3329ad77df062b99ef3e4be1a429412b8b0cba01d869409ec62878129d7fe25a79a87e0
6
+ metadata.gz: 972a16967ebd009b821f9ad19546d93272b612288828aa1fd145c5dc6f3390c29140c322a9bd9dae982b3aac6cf7dbab3db0ced6f2e0c4467b498f6689de955f
7
+ data.tar.gz: 0ab677d0ee623cef39b3bf4d413f1e0f62c5f3d47747e6a81e61da71c9372fe8bc73ff5f29dd96971057f9bd59c62d9a15251dcaf8280c24196c97cd1cb331a7
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.6.2
10
- - Package version: 0.6.2
9
+ - API version: 0.6.7
10
+ - Package version: 0.6.7
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.6.2.gem
28
+ gem install ./trieve_ruby_client-0.6.7.gem
29
29
  ```
30
30
 
31
- (for development, run `gem install --dev ./trieve_ruby_client-0.6.2.gem` to install the development dependencies)
31
+ (for development, run `gem install --dev ./trieve_ruby_client-0.6.7.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.6.2'
37
+ gem 'trieve_ruby_client', '~> 0.6.7'
38
38
 
39
39
  ### Install from Git
40
40
 
data/docs/ChunkApi.md CHANGED
@@ -605,7 +605,7 @@ end
605
605
 
606
606
  Search
607
607
 
608
- 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.
608
+ 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.
609
609
 
610
610
  ### Examples
611
611
 
data/docs/ChunkData.md CHANGED
@@ -6,6 +6,7 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **chunk_html** | **String** | HTML content of the chunk. This can also be plaintext. The innerText of the HTML will be used to create the embedding vector. The point of using HTML is for convienience, as some users have applications where users submit HTML content. | [optional] |
8
8
  | **chunk_vector** | **Array&lt;Float&gt;** | 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. | [optional] |
9
+ | **convert_html_to_text** | **Boolean** | 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. | [optional] |
9
10
  | **file_id** | **String** | 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. | [optional] |
10
11
  | **group_ids** | **Array&lt;String&gt;** | 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
12
  | **group_tracking_ids** | **Array&lt;String&gt;** | 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] |
@@ -26,6 +27,7 @@ require 'trieve_ruby_client'
26
27
  instance = TrieveRubyClient::ChunkData.new(
27
28
  chunk_html: null,
28
29
  chunk_vector: null,
30
+ convert_html_to_text: null,
29
31
  file_id: null,
30
32
  group_ids: null,
31
33
  group_tracking_ids: null,
data/docs/FileApi.md CHANGED
@@ -255,7 +255,7 @@ end
255
255
 
256
256
  api_instance = TrieveRubyClient::FileApi.new
257
257
  tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
258
- upload_file_data = TrieveRubyClient::UploadFileData.new({base64_file: 'base64_file_example', file_mime_type: 'file_mime_type_example', file_name: 'file_name_example'}) # UploadFileData | JSON request payload to upload a file
258
+ upload_file_data = TrieveRubyClient::UploadFileData.new({base64_file: 'base64_file_example', file_name: 'file_name_example'}) # UploadFileData | JSON request payload to upload a file
259
259
 
260
260
  begin
261
261
  # Upload File
@@ -5,6 +5,7 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **group_id** | **String** | | |
8
+ | **group_name** | **String** | | [optional] |
8
9
  | **group_tracking_id** | **String** | | [optional] |
9
10
  | **metadata** | [**Array&lt;ScoreChunkDTO&gt;**](ScoreChunkDTO.md) | | |
10
11
 
@@ -15,6 +16,7 @@ require 'trieve_ruby_client'
15
16
 
16
17
  instance = TrieveRubyClient::GroupScoreChunk.new(
17
18
  group_id: null,
19
+ group_name: null,
18
20
  group_tracking_id: null,
19
21
  metadata: null
20
22
  )
@@ -5,6 +5,7 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **chunk_html** | **String** | HTML content of the chunk you want to update. This can also be plaintext. The innerText of the HTML will be used to create the embedding vector. The point of using HTML is for convienience, as some users have applications where users submit HTML content. If no chunk_html is provided, the existing chunk_html will be used. | [optional] |
8
+ | **convert_html_to_text** | **Boolean** | 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. | [optional] |
8
9
  | **group_ids** | **Array&lt;String&gt;** | 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] |
9
10
  | **group_tracking_ids** | **Array&lt;String&gt;** | 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] |
10
11
  | **link** | **String** | Link of the chunk you want to update. This can also be any string. Frequently, this is a link to the source of the chunk. The link value will not affect the embedding creation. If no link is provided, the existing link will be used. | [optional] |
@@ -20,6 +21,7 @@ require 'trieve_ruby_client'
20
21
 
21
22
  instance = TrieveRubyClient::UpdateChunkByTrackingIdData.new(
22
23
  chunk_html: null,
24
+ convert_html_to_text: null,
23
25
  group_ids: null,
24
26
  group_tracking_ids: null,
25
27
  link: null,
@@ -6,6 +6,7 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **chunk_html** | **String** | HTML content of the chunk you want to update. This can also be plaintext. The innerText of the HTML will be used to create the embedding vector. The point of using HTML is for convienience, as some users have applications where users submit HTML content. If no chunk_html is provided, the existing chunk_html will be used. | [optional] |
8
8
  | **chunk_id** | **String** | Id of the chunk you want to update. You can provide either the chunk_id or the tracking_id. If both are provided, the chunk_id will be used. | [optional] |
9
+ | **convert_html_to_text** | **Boolean** | 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. | [optional] |
9
10
  | **group_ids** | **Array&lt;String&gt;** | 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] |
10
11
  | **group_tracking_ids** | **Array&lt;String&gt;** | Group tracking_ids are the tracking_ids of the groups that the chunk should be placed into. This is useful for when you want to update a chunk and add it to a group or multiple groups in one request. | [optional] |
11
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] |
@@ -23,6 +24,7 @@ require 'trieve_ruby_client'
23
24
  instance = TrieveRubyClient::UpdateChunkData.new(
24
25
  chunk_html: null,
25
26
  chunk_id: null,
27
+ convert_html_to_text: null,
26
28
  group_ids: null,
27
29
  group_tracking_ids: null,
28
30
  link: null,
@@ -7,8 +7,8 @@
7
7
  | **base64_file** | **String** | Base64 encoded file. Convert + to -, / to _, and remove the ending &#x3D; if present. This is the standard base64url encoding. | |
8
8
  | **create_chunks** | **Boolean** | Create chunks is a boolean which determines whether or not to create chunks from the file. If false, you can manually chunk the file and send the chunks to the create_chunk endpoint with the file_id to associate chunks with the file. Meant mostly for advanced users. | [optional] |
9
9
  | **description** | **String** | Description is an optional convience field so you do not have to remember what the file contains or is about. It will be included on the group resulting from the file which will hold its chunk. | [optional] |
10
- | **file_mime_type** | **String** | MIME type of the file being uploaded. | |
11
10
  | **file_name** | **String** | Name of the file being uploaded, including the extension. | |
11
+ | **group_tracking_id** | **String** | Group tracking id is an optional field which allows you to specify the tracking id of the group that is created from the file. Chunks created will be created with the tracking id of &#x60;group_tracking_id|&lt;index of chunk&gt;&#x60; | [optional] |
12
12
  | **link** | **String** | Link to the file. This can also be any string. This can be used to filter when searching for the file&#39;s resulting chunks. The link value will not affect embedding creation. | [optional] |
13
13
  | **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. Will be passed down to the file&#39;s chunks. | [optional] |
14
14
  | **tag_set** | **Array&lt;String&gt;** | Tag set is a comma separated list of tags which will be passed down to the chunks made from the file. Tags are used to filter chunks when searching. HNSW indices are created for each tag such that there is no performance loss when filtering on them. | [optional] |
@@ -23,8 +23,8 @@ instance = TrieveRubyClient::UploadFileData.new(
23
23
  base64_file: null,
24
24
  create_chunks: null,
25
25
  description: null,
26
- file_mime_type: null,
27
26
  file_name: null,
27
+ group_tracking_id: null,
28
28
  link: null,
29
29
  metadata: null,
30
30
  tag_set: 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.6.2
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.2
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
@@ -600,7 +600,7 @@ 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
@@ -611,7 +611,7 @@ module TrieveRubyClient
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&#39; &#x60;chunk_html&#x60; values will be modified with &#x60;&lt;b&gt;&#x60; 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&#39; &#x60;chunk_html&#x60; values will be modified with &#x60;&lt;b&gt;&lt;mark&gt;&#x60; 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
@@ -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.2
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.2
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.2
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.2
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.2
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.2
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.2
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.2
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.2
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.2
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.2
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.2
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.2
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.2
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.2
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.2
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.2
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.2
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.2
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.2
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.2
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.2
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.2
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.2
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.2
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.2
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.2
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.2
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.2
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.2
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.2
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.2
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.2
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.2
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.2
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.2
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.2
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