trieve_ruby_client 0.8.0 → 0.8.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (125) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +5 -5
  3. data/docs/ChunkData.md +1 -1
  4. data/docs/ChunkMetadata.md +0 -2
  5. data/docs/ChunkMetadataWithScore.md +0 -2
  6. data/docs/GroupScoreSlimChunks.md +4 -0
  7. data/docs/RecommendChunksRequest.md +1 -1
  8. data/docs/RecommendGroupChunksRequest.md +1 -1
  9. data/docs/SearchChunkData.md +5 -5
  10. data/docs/SearchOverGroupsData.md +3 -3
  11. data/docs/SearchWithinGroupData.md +5 -5
  12. data/lib/trieve_ruby_client/api/auth_api.rb +1 -1
  13. data/lib/trieve_ruby_client/api/chunk_api.rb +1 -1
  14. data/lib/trieve_ruby_client/api/chunk_group_api.rb +1 -1
  15. data/lib/trieve_ruby_client/api/dataset_api.rb +1 -1
  16. data/lib/trieve_ruby_client/api/events_api.rb +1 -1
  17. data/lib/trieve_ruby_client/api/file_api.rb +1 -1
  18. data/lib/trieve_ruby_client/api/health_api.rb +1 -1
  19. data/lib/trieve_ruby_client/api/invitation_api.rb +1 -1
  20. data/lib/trieve_ruby_client/api/message_api.rb +1 -1
  21. data/lib/trieve_ruby_client/api/organization_api.rb +1 -1
  22. data/lib/trieve_ruby_client/api/stripe_api.rb +1 -1
  23. data/lib/trieve_ruby_client/api/topic_api.rb +1 -1
  24. data/lib/trieve_ruby_client/api/user_api.rb +1 -1
  25. data/lib/trieve_ruby_client/api_client.rb +1 -1
  26. data/lib/trieve_ruby_client/api_error.rb +1 -1
  27. data/lib/trieve_ruby_client/configuration.rb +1 -1
  28. data/lib/trieve_ruby_client/models/add_chunk_to_group_data.rb +1 -1
  29. data/lib/trieve_ruby_client/models/api_key_dto.rb +1 -1
  30. data/lib/trieve_ruby_client/models/auth_query.rb +1 -1
  31. data/lib/trieve_ruby_client/models/batch_queued_chunk_response.rb +1 -1
  32. data/lib/trieve_ruby_client/models/bookmark_data.rb +1 -1
  33. data/lib/trieve_ruby_client/models/bookmark_group_result.rb +1 -1
  34. data/lib/trieve_ruby_client/models/chat_message_proxy.rb +1 -1
  35. data/lib/trieve_ruby_client/models/chunk_data.rb +8 -2
  36. data/lib/trieve_ruby_client/models/chunk_filter.rb +1 -1
  37. data/lib/trieve_ruby_client/models/chunk_group.rb +1 -1
  38. data/lib/trieve_ruby_client/models/chunk_group_and_file.rb +1 -1
  39. data/lib/trieve_ruby_client/models/chunk_metadata.rb +2 -18
  40. data/lib/trieve_ruby_client/models/chunk_metadata_with_score.rb +2 -18
  41. data/lib/trieve_ruby_client/models/client_dataset_configuration.rb +1 -1
  42. data/lib/trieve_ruby_client/models/create_chunk_data.rb +1 -1
  43. data/lib/trieve_ruby_client/models/create_chunk_group_data.rb +1 -1
  44. data/lib/trieve_ruby_client/models/create_dataset_request.rb +1 -1
  45. data/lib/trieve_ruby_client/models/create_message_data.rb +1 -1
  46. data/lib/trieve_ruby_client/models/create_organization_data.rb +1 -1
  47. data/lib/trieve_ruby_client/models/create_topic_data.rb +1 -1
  48. data/lib/trieve_ruby_client/models/dataset.rb +1 -1
  49. data/lib/trieve_ruby_client/models/dataset_and_usage.rb +1 -1
  50. data/lib/trieve_ruby_client/models/dataset_dto.rb +1 -1
  51. data/lib/trieve_ruby_client/models/dataset_usage_count.rb +1 -1
  52. data/lib/trieve_ruby_client/models/delete_topic_data.rb +1 -1
  53. data/lib/trieve_ruby_client/models/delete_user_api_key_request.rb +1 -1
  54. data/lib/trieve_ruby_client/models/edit_message_data.rb +1 -1
  55. data/lib/trieve_ruby_client/models/error_response_body.rb +1 -1
  56. data/lib/trieve_ruby_client/models/event.rb +1 -1
  57. data/lib/trieve_ruby_client/models/event_return.rb +1 -1
  58. data/lib/trieve_ruby_client/models/field_condition.rb +1 -1
  59. data/lib/trieve_ruby_client/models/file.rb +1 -1
  60. data/lib/trieve_ruby_client/models/file_dto.rb +1 -1
  61. data/lib/trieve_ruby_client/models/generate_chunks_request.rb +1 -1
  62. data/lib/trieve_ruby_client/models/geo_info.rb +1 -1
  63. data/lib/trieve_ruby_client/models/geo_types.rb +1 -1
  64. data/lib/trieve_ruby_client/models/get_chunks_data.rb +1 -1
  65. data/lib/trieve_ruby_client/models/get_events_data.rb +1 -1
  66. data/lib/trieve_ruby_client/models/get_groups_for_chunks_data.rb +1 -1
  67. data/lib/trieve_ruby_client/models/get_tracking_chunks_data.rb +1 -1
  68. data/lib/trieve_ruby_client/models/group_data.rb +1 -1
  69. data/lib/trieve_ruby_client/models/group_score_chunk.rb +1 -1
  70. data/lib/trieve_ruby_client/models/group_score_slim_chunks.rb +22 -2
  71. data/lib/trieve_ruby_client/models/invitation_data.rb +1 -1
  72. data/lib/trieve_ruby_client/models/location_bounding_box.rb +1 -1
  73. data/lib/trieve_ruby_client/models/location_polygon.rb +1 -1
  74. data/lib/trieve_ruby_client/models/location_radius.rb +1 -1
  75. data/lib/trieve_ruby_client/models/match_condition.rb +1 -1
  76. data/lib/trieve_ruby_client/models/message.rb +1 -1
  77. data/lib/trieve_ruby_client/models/organization.rb +1 -1
  78. data/lib/trieve_ruby_client/models/organization_usage_count.rb +1 -1
  79. data/lib/trieve_ruby_client/models/range.rb +1 -1
  80. data/lib/trieve_ruby_client/models/range_condition.rb +1 -1
  81. data/lib/trieve_ruby_client/models/recommend_chunks_request.rb +2 -2
  82. data/lib/trieve_ruby_client/models/recommend_group_chunks_request.rb +2 -2
  83. data/lib/trieve_ruby_client/models/regenerate_message_data.rb +1 -1
  84. data/lib/trieve_ruby_client/models/return_queued_chunk.rb +1 -1
  85. data/lib/trieve_ruby_client/models/score_chunk_dto.rb +1 -1
  86. data/lib/trieve_ruby_client/models/score_slim_chunks.rb +1 -1
  87. data/lib/trieve_ruby_client/models/search_chunk_data.rb +16 -16
  88. data/lib/trieve_ruby_client/models/search_chunk_query_response_body.rb +1 -1
  89. data/lib/trieve_ruby_client/models/search_over_groups_data.rb +4 -4
  90. data/lib/trieve_ruby_client/models/search_over_groups_results.rb +1 -1
  91. data/lib/trieve_ruby_client/models/search_over_groups_slim_results.rb +1 -1
  92. data/lib/trieve_ruby_client/models/search_slim_chunk_query_response_body.rb +1 -1
  93. data/lib/trieve_ruby_client/models/search_within_group_data.rb +16 -16
  94. data/lib/trieve_ruby_client/models/search_within_group_results.rb +1 -1
  95. data/lib/trieve_ruby_client/models/search_within_group_slim_results.rb +1 -1
  96. data/lib/trieve_ruby_client/models/set_user_api_key_request.rb +1 -1
  97. data/lib/trieve_ruby_client/models/set_user_api_key_response.rb +1 -1
  98. data/lib/trieve_ruby_client/models/single_queued_chunk_response.rb +1 -1
  99. data/lib/trieve_ruby_client/models/slim_chunk_metadata.rb +1 -1
  100. data/lib/trieve_ruby_client/models/slim_chunk_metadata_with_score.rb +1 -1
  101. data/lib/trieve_ruby_client/models/slim_group.rb +1 -1
  102. data/lib/trieve_ruby_client/models/slim_user.rb +1 -1
  103. data/lib/trieve_ruby_client/models/stripe_plan.rb +1 -1
  104. data/lib/trieve_ruby_client/models/suggested_queries_request.rb +1 -1
  105. data/lib/trieve_ruby_client/models/suggested_queries_response.rb +1 -1
  106. data/lib/trieve_ruby_client/models/topic.rb +1 -1
  107. data/lib/trieve_ruby_client/models/update_chunk_by_tracking_id_data.rb +1 -1
  108. data/lib/trieve_ruby_client/models/update_chunk_data.rb +1 -1
  109. data/lib/trieve_ruby_client/models/update_chunk_group_data.rb +1 -1
  110. data/lib/trieve_ruby_client/models/update_dataset_request.rb +1 -1
  111. data/lib/trieve_ruby_client/models/update_group_by_tracking_id_data.rb +1 -1
  112. data/lib/trieve_ruby_client/models/update_organization_data.rb +1 -1
  113. data/lib/trieve_ruby_client/models/update_topic_data.rb +1 -1
  114. data/lib/trieve_ruby_client/models/update_user_org_role_data.rb +1 -1
  115. data/lib/trieve_ruby_client/models/upload_file_data.rb +1 -1
  116. data/lib/trieve_ruby_client/models/upload_file_result.rb +1 -1
  117. data/lib/trieve_ruby_client/models/user_organization.rb +1 -1
  118. data/lib/trieve_ruby_client/version.rb +2 -2
  119. data/lib/trieve_ruby_client.rb +1 -1
  120. data/openapi-generator.yaml +1 -1
  121. data/openapi.json +38 -33
  122. data/spec/spec_helper.rb +1 -1
  123. data/trieve_ruby_client-0.8.0.gem +0 -0
  124. data/trieve_ruby_client.gemspec +1 -1
  125. metadata +3 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: b011a732a1c100768658282b5cc12fde441a13858d278e0f04cd58124a1091c5
4
- data.tar.gz: 72b1840e88e682f1b866deab79654b1478c43fd3107f46d89c822f47bf1483de
3
+ metadata.gz: 262e43a892cb1d13a50451d6fa02c78fae20a0c9e38be9639fd11a0bc2b68603
4
+ data.tar.gz: 17ff37410cb8c0862ecc78ec9abd155a7f0e4607cff27f90cf0ca8c98961b19d
5
5
  SHA512:
6
- metadata.gz: 2204107a561fa98633b5f69b7aa0de92a1e4e6ae1fd422cc22527af6a9e847858c1bf05119be00d98c0846a0567d9ad1cbc471ef7e27418edab3a000a984f4ea
7
- data.tar.gz: 27bf39cd2e4b253af367b39f9be0050a8630c571d70c323ff0f27a2effc117fff159577a36a82a72e6ef6e3b56dd708fac89290c9d75d22425f11e5a8409938e
6
+ metadata.gz: 80377af17609f7adb5a3c58e0919003e5278414838267479bfb3eba35aa862182c4f773841baf583a8b0334a9e3c059ee7034dfa55cab00b041beee36342cb32
7
+ data.tar.gz: 71a31dc55f5204701dff7b2fac3fa8fa941472d5c27cc74f2d96b2fa0b6e7fc07bceca77989dce86f07bb94a9d49727b32994c74824c7560f3ed58feee1f1cd9
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.8.0
10
- - Package version: 0.8.0
9
+ - API version: 0.8.2
10
+ - Package version: 0.8.2
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.8.0.gem
28
+ gem install ./trieve_ruby_client-0.8.2.gem
29
29
  ```
30
30
 
31
- (for development, run `gem install --dev ./trieve_ruby_client-0.8.0.gem` to install the development dependencies)
31
+ (for development, run `gem install --dev ./trieve_ruby_client-0.8.2.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.8.0'
37
+ gem 'trieve_ruby_client', '~> 0.8.2'
38
38
 
39
39
  ### Install from Git
40
40
 
data/docs/ChunkData.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
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] |
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. | |
8
8
  | **chunk_vector** | **Array<Float>** | 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
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] |
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] |
@@ -5,7 +5,6 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **chunk_html** | **String** | | [optional] |
8
- | **content** | **String** | | |
9
8
  | **created_at** | **Time** | | |
10
9
  | **dataset_id** | **String** | | |
11
10
  | **id** | **String** | | |
@@ -26,7 +25,6 @@ require 'trieve_ruby_client'
26
25
 
27
26
  instance = TrieveRubyClient::ChunkMetadata.new(
28
27
  chunk_html: null,
29
- content: null,
30
28
  created_at: null,
31
29
  dataset_id: null,
32
30
  id: null,
@@ -5,7 +5,6 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **chunk_html** | **String** | | [optional] |
8
- | **content** | **String** | | |
9
8
  | **created_at** | **Time** | | |
10
9
  | **dataset_id** | **String** | | |
11
10
  | **id** | **String** | | |
@@ -26,7 +25,6 @@ require 'trieve_ruby_client'
26
25
 
27
26
  instance = TrieveRubyClient::ChunkMetadataWithScore.new(
28
27
  chunk_html: null,
29
- content: null,
30
28
  created_at: null,
31
29
  dataset_id: null,
32
30
  id: null,
@@ -5,6 +5,8 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **group_id** | **String** | | |
8
+ | **group_name** | **String** | | [optional] |
9
+ | **group_tracking_id** | **String** | | [optional] |
8
10
  | **metadata** | [**Array<ScoreSlimChunks>**](ScoreSlimChunks.md) | | |
9
11
 
10
12
  ## Example
@@ -14,6 +16,8 @@ require 'trieve_ruby_client'
14
16
 
15
17
  instance = TrieveRubyClient::GroupScoreSlimChunks.new(
16
18
  group_id: null,
19
+ group_name: null,
20
+ group_tracking_id: null,
17
21
  metadata: null
18
22
  )
19
23
  ```
@@ -11,7 +11,7 @@
11
11
  | **positive_chunk_ids** | **Array<String>** | The ids of the chunks to be used as positive examples for the recommendation. The chunks in this array will be used to find similar chunks. | [optional] |
12
12
  | **positive_tracking_ids** | **Array<String>** | The tracking_ids of the chunks to be used as positive examples for the recommendation. The chunks in this array will be used to find similar chunks. | [optional] |
13
13
  | **recommend_type** | **String** | The type of recommendation to make. This lets you choose whether to recommend based off of `semantic` or `fulltext` similarity. The default is `semantic`. | [optional] |
14
- | **slim_chunks** | **Boolean** | Set slim_chunks to true to avoid returning the content and chunk_html of the chunks. This is useful for when you want to reduce amount of data over the wire for latency improvement. Default is false. | [optional] |
14
+ | **slim_chunks** | **Boolean** | Set slim_chunks to true to avoid returning the content and chunk_html of the chunks. This is useful for when you want to reduce amount of data over the wire for latency improvement (typicall 10-50ms). Default is false. | [optional] |
15
15
  | **strategy** | **String** | Strategy to use for recommendations, either \"average_vector\" or \"best_score\". The default is \"average_vector\". The \"average_vector\" strategy will construct a single average vector from the positive and negative samples then use it to perform a pseudo-search. The \"best_score\" strategy is more advanced and navigates the HNSW with a heuristic of picking edges where the point is closer to the positive samples than it is the negatives. | [optional] |
16
16
 
17
17
  ## Example
@@ -12,7 +12,7 @@
12
12
  | **positive_group_ids** | **Array<String>** | The ids of the groups to be used as positive examples for the recommendation. The groups in this array will be used to find similar groups. | [optional] |
13
13
  | **positive_group_tracking_ids** | **Array<String>** | The ids of the groups to be used as positive examples for the recommendation. The groups in this array will be used to find similar groups. | [optional] |
14
14
  | **recommend_type** | **String** | The type of recommendation to make. This lets you choose whether to recommend based off of `semantic` or `fulltext` similarity. The default is `semantic`. | [optional] |
15
- | **slim_chunks** | **Boolean** | Set slim_chunks to true to avoid returning the content and chunk_html of the chunks. This is useful for when you want to reduce amount of data over the wire for latency improvement. Default is false. | [optional] |
15
+ | **slim_chunks** | **Boolean** | Set slim_chunks to true to avoid returning the content and chunk_html of the chunks. This is useful for when you want to reduce amount of data over the wire for latency improvement (typicall 10-50ms). Default is false. | [optional] |
16
16
  | **strategy** | **String** | Strategy to use for recommendations, either \"average_vector\" or \"best_score\". The default is \"average_vector\". The \"average_vector\" strategy will construct a single average vector from the positive and negative samples then use it to perform a pseudo-search. The \"best_score\" strategy is more advanced and navigates the HNSW with a heuristic of picking edges where the point is closer to the positive samples than it is the negatives. | [optional] |
17
17
 
18
18
  ## Example
@@ -4,18 +4,18 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **date_bias** | **Boolean** | Set date_bias to true to bias search results towards more recent chunks. This will work best in hybrid search mode. | [optional] |
8
7
  | **filters** | [**ChunkFilter**](ChunkFilter.md) | | [optional] |
9
8
  | **get_collisions** | **Boolean** | Set get_collisions to true to get the collisions for each chunk. This will only apply if environment variable COLLISIONS_ENABLED is set to true. | [optional] |
10
- | **get_total_pages** | **Boolean** | Get total page count for the query accounting for the applied filters. Defaults to true, but can be set to false to reduce latency in edge cases performance. | [optional] |
9
+ | **get_total_pages** | **Boolean** | Get total page count for the query accounting for the applied filters. Defaults to false, but can be set to true when the latency penalty is acceptable (typically 50-200ms). | [optional] |
11
10
  | **highlight_delimiters** | **Array<String>** | Set highlight_delimiters to a list of strings to use as delimiters for highlighting. If not specified, this defaults to [\"?\", \",\", \".\", \"!\"]. | [optional] |
12
- | **highlight_results** | **Boolean** | Set highlight_results to true to highlight the results. If not specified, this defaults to true. | [optional] |
11
+ | **highlight_results** | **Boolean** | Set highlight_results to false for a slight latency improvement (1-10ms). If not specified, this defaults to true. This will add <b><mark> tags to the chunk_html of the chunks to highlight matching sub-sentences. | [optional] |
13
12
  | **page** | **Integer** | Page of chunks to fetch. Page is 1-indexed. | [optional] |
14
13
  | **page_size** | **Integer** | Page size is the number of chunks to fetch. This can be used to fetch more than 10 chunks at a time. | [optional] |
15
14
  | **query** | **String** | Query is the search query. This can be any string. The query will be used to create an embedding vector and/or SPLADE vector which will be used to find the result set. | |
15
+ | **recency_bias** | **Float** | Recency Bias lets you determine how much of an effect the recency of chunks will have on the search results. If not specified, this defaults to 0.0. We recommend setting this to 1.0 for a gentle reranking of the results, >3.0 for a strong reranking of the results. | [optional] |
16
16
  | **score_threshold** | **Float** | Set score_threshold to a float to filter out chunks with a score below the threshold. | [optional] |
17
17
  | **search_type** | **String** | Can be either \"semantic\", \"fulltext\", or \"hybrid\". \"hybrid\" will pull in one page (10 chunks) of both semantic and full-text results then re-rank them using BAAI/bge-reranker-large. \"semantic\" will pull in one page (10 chunks) of the nearest cosine distant vectors. \"fulltext\" will pull in one page (10 chunks) of full-text results based on SPLADE. | |
18
- | **slim_chunks** | **Boolean** | Set slim_chunks to true to avoid returning the content and chunk_html of the chunks. This is useful for when you want to reduce amount of data over the wire for latency improvement. Default is false. | [optional] |
18
+ | **slim_chunks** | **Boolean** | Set slim_chunks to true to avoid returning the content and chunk_html of the chunks. This is useful for when you want to reduce amount of data over the wire for latency improvement (typicall 10-50ms). Default is false. | [optional] |
19
19
  | **use_weights** | **Boolean** | Set use_weights to true to use the weights of the chunks in the result set in order to sort them. If not specified, this defaults to true. | [optional] |
20
20
 
21
21
  ## Example
@@ -24,7 +24,6 @@
24
24
  require 'trieve_ruby_client'
25
25
 
26
26
  instance = TrieveRubyClient::SearchChunkData.new(
27
- date_bias: null,
28
27
  filters: null,
29
28
  get_collisions: null,
30
29
  get_total_pages: null,
@@ -33,6 +32,7 @@ instance = TrieveRubyClient::SearchChunkData.new(
33
32
  page: null,
34
33
  page_size: null,
35
34
  query: null,
35
+ recency_bias: null,
36
36
  score_threshold: null,
37
37
  search_type: null,
38
38
  slim_chunks: null,
@@ -6,16 +6,16 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **filters** | [**ChunkFilter**](ChunkFilter.md) | | [optional] |
8
8
  | **get_collisions** | **Boolean** | Set get_collisions to true to get the collisions for each chunk. This will only apply if environment variable COLLISIONS_ENABLED is set to true. | [optional] |
9
- | **get_total_pages** | **Boolean** | Get total page count for the query accounting for the applied filters. Defaults to true, but can be set to false to reduce latency in edge cases performance. | [optional] |
9
+ | **get_total_pages** | **Boolean** | Get total page count for the query accounting for the applied filters. Defaults to false, but can be set to true when the latency penalty is acceptable (typically 50-200ms). | [optional] |
10
10
  | **group_size** | **Integer** | Group_size is the number of chunks to fetch for each group. The default is 3. If a group has less than group_size chunks, all chunks will be returned. If this is set to a large number, we recommend setting slim_chunks to true to avoid returning the content and chunk_html of the chunks so as to lower the amount of time required for content download and serialization. | [optional] |
11
11
  | **highlight_delimiters** | **Array<String>** | Set highlight_delimiters to a list of strings to use as delimiters for highlighting. If not specified, this defaults to [\"?\", \",\", \".\", \"!\"]. | [optional] |
12
- | **highlight_results** | **Boolean** | Set highlight_results to true to highlight the results. If not specified, this defaults to true. | [optional] |
12
+ | **highlight_results** | **Boolean** | Set highlight_results to false for a slight latency improvement (1-10ms). If not specified, this defaults to true. This will add <b><mark> tags to the chunk_html of the chunks to highlight matching sub-sentences. | [optional] |
13
13
  | **page** | **Integer** | Page of group results to fetch. Page is 1-indexed. | [optional] |
14
14
  | **page_size** | **Integer** | Page size is the number of group results to fetch. The default is 10. | [optional] |
15
15
  | **query** | **String** | Query is the search query. This can be any string. The query will be used to create an embedding vector and/or SPLADE vector which will be used to find the result set. | |
16
16
  | **score_threshold** | **Float** | Set score_threshold to a float to filter out chunks with a score below the threshold. | [optional] |
17
17
  | **search_type** | **String** | Can be either \"semantic\", \"fulltext\", or \"hybrid\". \"hybrid\" will pull in one page (10 chunks) of both semantic and full-text results then re-rank them using BAAI/bge-reranker-large. \"semantic\" will pull in one page (10 chunks) of the nearest cosine distant vectors. \"fulltext\" will pull in one page (10 chunks) of full-text results based on SPLADE. | |
18
- | **slim_chunks** | **Boolean** | Set slim_chunks to true to avoid returning the content and chunk_html of the chunks. This is useful for when you want to reduce amount of data over the wire for latency improvement. Default is false. | [optional] |
18
+ | **slim_chunks** | **Boolean** | Set slim_chunks to true to avoid returning the content and chunk_html of the chunks. This is useful for when you want to reduce amount of data over the wire for latency improvement (typicall 10-50ms). Default is false. | [optional] |
19
19
 
20
20
  ## Example
21
21
 
@@ -4,19 +4,19 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **date_bias** | **Boolean** | Set date_bias to true to bias search results towards more recent chunks. This will work best in hybrid search mode. | [optional] |
8
7
  | **filters** | [**ChunkFilter**](ChunkFilter.md) | | [optional] |
9
- | **get_total_pages** | **Boolean** | Get total page count for the query accounting for the applied filters. Defaults to true, but can be set to false to reduce latency in edge cases performance. | [optional] |
8
+ | **get_total_pages** | **Boolean** | Get total page count for the query accounting for the applied filters. Defaults to false, but can be set to true when the latency penalty is acceptable (typically 50-200ms). | [optional] |
10
9
  | **group_id** | **String** | Group specifies the group to search within. Results will only consist of chunks which are bookmarks within the specified group. | [optional] |
11
10
  | **group_tracking_id** | **String** | Group_tracking_id specifies the group to search within by tracking id. Results will only consist of chunks which are bookmarks within the specified group. If both group_id and group_tracking_id are provided, group_id will be used. | [optional] |
12
11
  | **highlight_delimiters** | **Array<String>** | Set highlight_delimiters to a list of strings to use as delimiters for highlighting. If not specified, this defaults to [\"?\", \",\", \".\", \"!\"]. | [optional] |
13
- | **highlight_results** | **Boolean** | Set highlight_results to true to highlight the results. If not specified, this defaults to true. | [optional] |
12
+ | **highlight_results** | **Boolean** | Set highlight_results to false for a slight latency improvement (1-10ms). If not specified, this defaults to true. This will add <b><mark> tags to the chunk_html of the chunks to highlight matching sub-sentences. | [optional] |
14
13
  | **page** | **Integer** | The page of chunks to fetch. Page is 1-indexed. | [optional] |
15
14
  | **page_size** | **Integer** | The page size is the number of chunks to fetch. This can be used to fetch more than 10 chunks at a time. | [optional] |
16
15
  | **query** | **String** | The query is the search query. This can be any string. The query will be used to create an embedding vector and/or SPLADE vector which will be used to find the result set. | |
16
+ | **recency_bias** | **Float** | Recency Bias lets you determine how much of an effect the recency of chunks will have on the search results. If not specified, this defaults to 0.0. | [optional] |
17
17
  | **score_threshold** | **Float** | Set score_threshold to a float to filter out chunks with a score below the threshold. | [optional] |
18
18
  | **search_type** | **String** | Search_type can be either \"semantic\", \"fulltext\", or \"hybrid\". \"hybrid\" will pull in one page (10 chunks) of both semantic and full-text results then re-rank them using BAAI/bge-reranker-large. \"semantic\" will pull in one page (10 chunks) of the nearest cosine distant vectors. \"fulltext\" will pull in one page (10 chunks) of full-text results based on SPLADE. | |
19
- | **slim_chunks** | **Boolean** | Set slim_chunks to true to avoid returning the content and chunk_html of the chunks. This is useful for when you want to reduce amount of data over the wire for latency improvement. Default is false. | [optional] |
19
+ | **slim_chunks** | **Boolean** | Set slim_chunks to true to avoid returning the content and chunk_html of the chunks. This is useful for when you want to reduce amount of data over the wire for latency improvement (typicall 10-50ms). Default is false. | [optional] |
20
20
  | **use_weights** | **Boolean** | Set use_weights to true to use the weights of the chunks in the result set in order to sort them. If not specified, this defaults to true. | [optional] |
21
21
 
22
22
  ## Example
@@ -25,7 +25,6 @@
25
25
  require 'trieve_ruby_client'
26
26
 
27
27
  instance = TrieveRubyClient::SearchWithinGroupData.new(
28
- date_bias: null,
29
28
  filters: null,
30
29
  get_total_pages: null,
31
30
  group_id: null,
@@ -35,6 +34,7 @@ instance = TrieveRubyClient::SearchWithinGroupData.new(
35
34
  page: null,
36
35
  page_size: null,
37
36
  query: null,
37
+ recency_bias: null,
38
38
  score_threshold: null,
39
39
  search_type: null,
40
40
  slim_chunks: 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.8.0
6
+ The version of the OpenAPI document: 0.8.2
7
7
  Contact: developers@trieve.ai
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.4.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
5
5
 
6
- The version of the OpenAPI document: 0.8.0
6
+ The version of the OpenAPI document: 0.8.2
7
7
  Contact: developers@trieve.ai
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.4.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
5
5
 
6
- The version of the OpenAPI document: 0.8.0
6
+ The version of the OpenAPI document: 0.8.2
7
7
  Contact: developers@trieve.ai
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.4.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
5
5
 
6
- The version of the OpenAPI document: 0.8.0
6
+ The version of the OpenAPI document: 0.8.2
7
7
  Contact: developers@trieve.ai
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.4.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
5
5
 
6
- The version of the OpenAPI document: 0.8.0
6
+ The version of the OpenAPI document: 0.8.2
7
7
  Contact: developers@trieve.ai
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.4.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
5
5
 
6
- The version of the OpenAPI document: 0.8.0
6
+ The version of the OpenAPI document: 0.8.2
7
7
  Contact: developers@trieve.ai
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.4.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
5
5
 
6
- The version of the OpenAPI document: 0.8.0
6
+ The version of the OpenAPI document: 0.8.2
7
7
  Contact: developers@trieve.ai
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.4.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
5
5
 
6
- The version of the OpenAPI document: 0.8.0
6
+ The version of the OpenAPI document: 0.8.2
7
7
  Contact: developers@trieve.ai
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.4.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
5
5
 
6
- The version of the OpenAPI document: 0.8.0
6
+ The version of the OpenAPI document: 0.8.2
7
7
  Contact: developers@trieve.ai
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.4.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
5
5
 
6
- The version of the OpenAPI document: 0.8.0
6
+ The version of the OpenAPI document: 0.8.2
7
7
  Contact: developers@trieve.ai
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.4.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
5
5
 
6
- The version of the OpenAPI document: 0.8.0
6
+ The version of the OpenAPI document: 0.8.2
7
7
  Contact: developers@trieve.ai
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.4.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
5
5
 
6
- The version of the OpenAPI document: 0.8.0
6
+ The version of the OpenAPI document: 0.8.2
7
7
  Contact: developers@trieve.ai
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.4.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
5
5
 
6
- The version of the OpenAPI document: 0.8.0
6
+ The version of the OpenAPI document: 0.8.2
7
7
  Contact: developers@trieve.ai
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.4.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
5
5
 
6
- The version of the OpenAPI document: 0.8.0
6
+ The version of the OpenAPI document: 0.8.2
7
7
  Contact: developers@trieve.ai
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.4.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
5
5
 
6
- The version of the OpenAPI document: 0.8.0
6
+ The version of the OpenAPI document: 0.8.2
7
7
  Contact: developers@trieve.ai
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.4.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
5
5
 
6
- The version of the OpenAPI document: 0.8.0
6
+ The version of the OpenAPI document: 0.8.2
7
7
  Contact: developers@trieve.ai
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.4.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
5
5
 
6
- The version of the OpenAPI document: 0.8.0
6
+ The version of the OpenAPI document: 0.8.2
7
7
  Contact: developers@trieve.ai
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.4.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
5
5
 
6
- The version of the OpenAPI document: 0.8.0
6
+ The version of the OpenAPI document: 0.8.2
7
7
  Contact: developers@trieve.ai
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.4.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
5
5
 
6
- The version of the OpenAPI document: 0.8.0
6
+ The version of the OpenAPI document: 0.8.2
7
7
  Contact: developers@trieve.ai
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.4.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
5
5
 
6
- The version of the OpenAPI document: 0.8.0
6
+ The version of the OpenAPI document: 0.8.2
7
7
  Contact: developers@trieve.ai
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.4.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
5
5
 
6
- The version of the OpenAPI document: 0.8.0
6
+ The version of the OpenAPI document: 0.8.2
7
7
  Contact: developers@trieve.ai
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.4.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
5
5
 
6
- The version of the OpenAPI document: 0.8.0
6
+ The version of the OpenAPI document: 0.8.2
7
7
  Contact: developers@trieve.ai
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.4.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
5
5
 
6
- The version of the OpenAPI document: 0.8.0
6
+ The version of the OpenAPI document: 0.8.2
7
7
  Contact: developers@trieve.ai
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.4.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
5
5
 
6
- The version of the OpenAPI document: 0.8.0
6
+ The version of the OpenAPI document: 0.8.2
7
7
  Contact: developers@trieve.ai
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.4.0
@@ -104,7 +104,6 @@ module TrieveRubyClient
104
104
  # List of attributes with nullable: true
105
105
  def self.openapi_nullable
106
106
  Set.new([
107
- :'chunk_html',
108
107
  :'chunk_vector',
109
108
  :'convert_html_to_text',
110
109
  :'group_ids',
@@ -138,6 +137,8 @@ module TrieveRubyClient
138
137
 
139
138
  if attributes.key?(:'chunk_html')
140
139
  self.chunk_html = attributes[:'chunk_html']
140
+ else
141
+ self.chunk_html = nil
141
142
  end
142
143
 
143
144
  if attributes.key?(:'chunk_vector')
@@ -206,6 +207,10 @@ module TrieveRubyClient
206
207
  def list_invalid_properties
207
208
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
208
209
  invalid_properties = Array.new
210
+ if @chunk_html.nil?
211
+ invalid_properties.push('invalid value for "chunk_html", chunk_html cannot be nil.')
212
+ end
213
+
209
214
  invalid_properties
210
215
  end
211
216
 
@@ -213,6 +218,7 @@ module TrieveRubyClient
213
218
  # @return true if the model is valid
214
219
  def valid?
215
220
  warn '[DEPRECATED] the `valid?` method is obsolete'
221
+ return false if @chunk_html.nil?
216
222
  true
217
223
  end
218
224
 
@@ -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.8.0
6
+ The version of the OpenAPI document: 0.8.2
7
7
  Contact: developers@trieve.ai
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.4.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
5
5
 
6
- The version of the OpenAPI document: 0.8.0
6
+ The version of the OpenAPI document: 0.8.2
7
7
  Contact: developers@trieve.ai
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.4.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
5
5
 
6
- The version of the OpenAPI document: 0.8.0
6
+ The version of the OpenAPI document: 0.8.2
7
7
  Contact: developers@trieve.ai
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.4.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
5
5
 
6
- The version of the OpenAPI document: 0.8.0
6
+ The version of the OpenAPI document: 0.8.2
7
7
  Contact: developers@trieve.ai
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.4.0
@@ -17,8 +17,6 @@ module TrieveRubyClient
17
17
  class ChunkMetadata
18
18
  attr_accessor :chunk_html
19
19
 
20
- attr_accessor :content
21
-
22
20
  attr_accessor :created_at
23
21
 
24
22
  attr_accessor :dataset_id
@@ -47,7 +45,6 @@ module TrieveRubyClient
47
45
  def self.attribute_map
48
46
  {
49
47
  :'chunk_html' => :'chunk_html',
50
- :'content' => :'content',
51
48
  :'created_at' => :'created_at',
52
49
  :'dataset_id' => :'dataset_id',
53
50
  :'id' => :'id',
@@ -72,7 +69,6 @@ module TrieveRubyClient
72
69
  def self.openapi_types
73
70
  {
74
71
  :'chunk_html' => :'String',
75
- :'content' => :'String',
76
72
  :'created_at' => :'Time',
77
73
  :'dataset_id' => :'String',
78
74
  :'id' => :'String',
@@ -121,12 +117,6 @@ module TrieveRubyClient
121
117
  self.chunk_html = attributes[:'chunk_html']
122
118
  end
123
119
 
124
- if attributes.key?(:'content')
125
- self.content = attributes[:'content']
126
- else
127
- self.content = nil
128
- end
129
-
130
120
  if attributes.key?(:'created_at')
131
121
  self.created_at = attributes[:'created_at']
132
122
  else
@@ -191,10 +181,6 @@ module TrieveRubyClient
191
181
  def list_invalid_properties
192
182
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
193
183
  invalid_properties = Array.new
194
- if @content.nil?
195
- invalid_properties.push('invalid value for "content", content cannot be nil.')
196
- end
197
-
198
184
  if @created_at.nil?
199
185
  invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
200
186
  end
@@ -222,7 +208,6 @@ module TrieveRubyClient
222
208
  # @return true if the model is valid
223
209
  def valid?
224
210
  warn '[DEPRECATED] the `valid?` method is obsolete'
225
- return false if @content.nil?
226
211
  return false if @created_at.nil?
227
212
  return false if @dataset_id.nil?
228
213
  return false if @id.nil?
@@ -237,7 +222,6 @@ module TrieveRubyClient
237
222
  return true if self.equal?(o)
238
223
  self.class == o.class &&
239
224
  chunk_html == o.chunk_html &&
240
- content == o.content &&
241
225
  created_at == o.created_at &&
242
226
  dataset_id == o.dataset_id &&
243
227
  id == o.id &&
@@ -261,7 +245,7 @@ module TrieveRubyClient
261
245
  # Calculates hash code according to all attributes.
262
246
  # @return [Integer] Hash code
263
247
  def 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
248
+ [chunk_html, created_at, dataset_id, id, link, location, metadata, qdrant_point_id, tag_set, time_stamp, tracking_id, updated_at, weight].hash
265
249
  end
266
250
 
267
251
  # Builds the object from hash