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
@@ -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
@@ -15,21 +15,18 @@ require 'time'
15
15
 
16
16
  module TrieveRubyClient
17
17
  class SearchChunkData
18
- # Set date_bias to true to bias search results towards more recent chunks. This will work best in hybrid search mode.
19
- attr_accessor :date_bias
20
-
21
18
  attr_accessor :filters
22
19
 
23
20
  # 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.
24
21
  attr_accessor :get_collisions
25
22
 
26
- # 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.
23
+ # 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).
27
24
  attr_accessor :get_total_pages
28
25
 
29
26
  # Set highlight_delimiters to a list of strings to use as delimiters for highlighting. If not specified, this defaults to [\"?\", \",\", \".\", \"!\"].
30
27
  attr_accessor :highlight_delimiters
31
28
 
32
- # Set highlight_results to true to highlight the results. If not specified, this defaults to true.
29
+ # 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.
33
30
  attr_accessor :highlight_results
34
31
 
35
32
  # Page of chunks to fetch. Page is 1-indexed.
@@ -41,13 +38,16 @@ module TrieveRubyClient
41
38
  # 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.
42
39
  attr_accessor :query
43
40
 
41
+ # 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.
42
+ attr_accessor :recency_bias
43
+
44
44
  # Set score_threshold to a float to filter out chunks with a score below the threshold.
45
45
  attr_accessor :score_threshold
46
46
 
47
47
  # 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.
48
48
  attr_accessor :search_type
49
49
 
50
- # 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.
50
+ # 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.
51
51
  attr_accessor :slim_chunks
52
52
 
53
53
  # 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.
@@ -56,7 +56,6 @@ module TrieveRubyClient
56
56
  # Attribute mapping from ruby-style variable name to JSON key.
57
57
  def self.attribute_map
58
58
  {
59
- :'date_bias' => :'date_bias',
60
59
  :'filters' => :'filters',
61
60
  :'get_collisions' => :'get_collisions',
62
61
  :'get_total_pages' => :'get_total_pages',
@@ -65,6 +64,7 @@ module TrieveRubyClient
65
64
  :'page' => :'page',
66
65
  :'page_size' => :'page_size',
67
66
  :'query' => :'query',
67
+ :'recency_bias' => :'recency_bias',
68
68
  :'score_threshold' => :'score_threshold',
69
69
  :'search_type' => :'search_type',
70
70
  :'slim_chunks' => :'slim_chunks',
@@ -80,7 +80,6 @@ module TrieveRubyClient
80
80
  # Attribute type mapping.
81
81
  def self.openapi_types
82
82
  {
83
- :'date_bias' => :'Boolean',
84
83
  :'filters' => :'ChunkFilter',
85
84
  :'get_collisions' => :'Boolean',
86
85
  :'get_total_pages' => :'Boolean',
@@ -89,6 +88,7 @@ module TrieveRubyClient
89
88
  :'page' => :'Integer',
90
89
  :'page_size' => :'Integer',
91
90
  :'query' => :'String',
91
+ :'recency_bias' => :'Float',
92
92
  :'score_threshold' => :'Float',
93
93
  :'search_type' => :'String',
94
94
  :'slim_chunks' => :'Boolean',
@@ -99,7 +99,6 @@ module TrieveRubyClient
99
99
  # List of attributes with nullable: true
100
100
  def self.openapi_nullable
101
101
  Set.new([
102
- :'date_bias',
103
102
  :'filters',
104
103
  :'get_collisions',
105
104
  :'get_total_pages',
@@ -107,6 +106,7 @@ module TrieveRubyClient
107
106
  :'highlight_results',
108
107
  :'page',
109
108
  :'page_size',
109
+ :'recency_bias',
110
110
  :'score_threshold',
111
111
  :'slim_chunks',
112
112
  :'use_weights'
@@ -128,10 +128,6 @@ module TrieveRubyClient
128
128
  h[k.to_sym] = v
129
129
  }
130
130
 
131
- if attributes.key?(:'date_bias')
132
- self.date_bias = attributes[:'date_bias']
133
- end
134
-
135
131
  if attributes.key?(:'filters')
136
132
  self.filters = attributes[:'filters']
137
133
  end
@@ -168,6 +164,10 @@ module TrieveRubyClient
168
164
  self.query = nil
169
165
  end
170
166
 
167
+ if attributes.key?(:'recency_bias')
168
+ self.recency_bias = attributes[:'recency_bias']
169
+ end
170
+
171
171
  if attributes.key?(:'score_threshold')
172
172
  self.score_threshold = attributes[:'score_threshold']
173
173
  end
@@ -247,7 +247,6 @@ module TrieveRubyClient
247
247
  def ==(o)
248
248
  return true if self.equal?(o)
249
249
  self.class == o.class &&
250
- date_bias == o.date_bias &&
251
250
  filters == o.filters &&
252
251
  get_collisions == o.get_collisions &&
253
252
  get_total_pages == o.get_total_pages &&
@@ -256,6 +255,7 @@ module TrieveRubyClient
256
255
  page == o.page &&
257
256
  page_size == o.page_size &&
258
257
  query == o.query &&
258
+ recency_bias == o.recency_bias &&
259
259
  score_threshold == o.score_threshold &&
260
260
  search_type == o.search_type &&
261
261
  slim_chunks == o.slim_chunks &&
@@ -271,7 +271,7 @@ module TrieveRubyClient
271
271
  # Calculates hash code according to all attributes.
272
272
  # @return [Integer] Hash code
273
273
  def hash
274
- [date_bias, filters, get_collisions, get_total_pages, highlight_delimiters, highlight_results, page, page_size, query, score_threshold, search_type, slim_chunks, use_weights].hash
274
+ [filters, get_collisions, get_total_pages, highlight_delimiters, highlight_results, page, page_size, query, recency_bias, score_threshold, search_type, slim_chunks, use_weights].hash
275
275
  end
276
276
 
277
277
  # 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.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
@@ -20,7 +20,7 @@ module TrieveRubyClient
20
20
  # 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.
21
21
  attr_accessor :get_collisions
22
22
 
23
- # 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.
23
+ # 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).
24
24
  attr_accessor :get_total_pages
25
25
 
26
26
  # 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.
@@ -29,7 +29,7 @@ module TrieveRubyClient
29
29
  # Set highlight_delimiters to a list of strings to use as delimiters for highlighting. If not specified, this defaults to [\"?\", \",\", \".\", \"!\"].
30
30
  attr_accessor :highlight_delimiters
31
31
 
32
- # Set highlight_results to true to highlight the results. If not specified, this defaults to true.
32
+ # 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.
33
33
  attr_accessor :highlight_results
34
34
 
35
35
  # Page of group results to fetch. Page is 1-indexed.
@@ -47,7 +47,7 @@ module TrieveRubyClient
47
47
  # 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.
48
48
  attr_accessor :search_type
49
49
 
50
- # 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.
50
+ # 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.
51
51
  attr_accessor :slim_chunks
52
52
 
53
53
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -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
@@ -15,12 +15,9 @@ require 'time'
15
15
 
16
16
  module TrieveRubyClient
17
17
  class SearchWithinGroupData
18
- # Set date_bias to true to bias search results towards more recent chunks. This will work best in hybrid search mode.
19
- attr_accessor :date_bias
20
-
21
18
  attr_accessor :filters
22
19
 
23
- # 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.
20
+ # 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).
24
21
  attr_accessor :get_total_pages
25
22
 
26
23
  # Group specifies the group to search within. Results will only consist of chunks which are bookmarks within the specified group.
@@ -32,7 +29,7 @@ module TrieveRubyClient
32
29
  # Set highlight_delimiters to a list of strings to use as delimiters for highlighting. If not specified, this defaults to [\"?\", \",\", \".\", \"!\"].
33
30
  attr_accessor :highlight_delimiters
34
31
 
35
- # Set highlight_results to true to highlight the results. If not specified, this defaults to true.
32
+ # 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.
36
33
  attr_accessor :highlight_results
37
34
 
38
35
  # The page of chunks to fetch. Page is 1-indexed.
@@ -44,13 +41,16 @@ module TrieveRubyClient
44
41
  # 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.
45
42
  attr_accessor :query
46
43
 
44
+ # 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.
45
+ attr_accessor :recency_bias
46
+
47
47
  # Set score_threshold to a float to filter out chunks with a score below the threshold.
48
48
  attr_accessor :score_threshold
49
49
 
50
50
  # 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.
51
51
  attr_accessor :search_type
52
52
 
53
- # 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.
53
+ # 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.
54
54
  attr_accessor :slim_chunks
55
55
 
56
56
  # 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.
@@ -59,7 +59,6 @@ module TrieveRubyClient
59
59
  # Attribute mapping from ruby-style variable name to JSON key.
60
60
  def self.attribute_map
61
61
  {
62
- :'date_bias' => :'date_bias',
63
62
  :'filters' => :'filters',
64
63
  :'get_total_pages' => :'get_total_pages',
65
64
  :'group_id' => :'group_id',
@@ -69,6 +68,7 @@ module TrieveRubyClient
69
68
  :'page' => :'page',
70
69
  :'page_size' => :'page_size',
71
70
  :'query' => :'query',
71
+ :'recency_bias' => :'recency_bias',
72
72
  :'score_threshold' => :'score_threshold',
73
73
  :'search_type' => :'search_type',
74
74
  :'slim_chunks' => :'slim_chunks',
@@ -84,7 +84,6 @@ module TrieveRubyClient
84
84
  # Attribute type mapping.
85
85
  def self.openapi_types
86
86
  {
87
- :'date_bias' => :'Boolean',
88
87
  :'filters' => :'ChunkFilter',
89
88
  :'get_total_pages' => :'Boolean',
90
89
  :'group_id' => :'String',
@@ -94,6 +93,7 @@ module TrieveRubyClient
94
93
  :'page' => :'Integer',
95
94
  :'page_size' => :'Integer',
96
95
  :'query' => :'String',
96
+ :'recency_bias' => :'Float',
97
97
  :'score_threshold' => :'Float',
98
98
  :'search_type' => :'String',
99
99
  :'slim_chunks' => :'Boolean',
@@ -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
- :'date_bias',
108
107
  :'filters',
109
108
  :'get_total_pages',
110
109
  :'group_id',
@@ -113,6 +112,7 @@ module TrieveRubyClient
113
112
  :'highlight_results',
114
113
  :'page',
115
114
  :'page_size',
115
+ :'recency_bias',
116
116
  :'score_threshold',
117
117
  :'slim_chunks',
118
118
  :'use_weights'
@@ -134,10 +134,6 @@ module TrieveRubyClient
134
134
  h[k.to_sym] = v
135
135
  }
136
136
 
137
- if attributes.key?(:'date_bias')
138
- self.date_bias = attributes[:'date_bias']
139
- end
140
-
141
137
  if attributes.key?(:'filters')
142
138
  self.filters = attributes[:'filters']
143
139
  end
@@ -178,6 +174,10 @@ module TrieveRubyClient
178
174
  self.query = nil
179
175
  end
180
176
 
177
+ if attributes.key?(:'recency_bias')
178
+ self.recency_bias = attributes[:'recency_bias']
179
+ end
180
+
181
181
  if attributes.key?(:'score_threshold')
182
182
  self.score_threshold = attributes[:'score_threshold']
183
183
  end
@@ -257,7 +257,6 @@ module TrieveRubyClient
257
257
  def ==(o)
258
258
  return true if self.equal?(o)
259
259
  self.class == o.class &&
260
- date_bias == o.date_bias &&
261
260
  filters == o.filters &&
262
261
  get_total_pages == o.get_total_pages &&
263
262
  group_id == o.group_id &&
@@ -267,6 +266,7 @@ module TrieveRubyClient
267
266
  page == o.page &&
268
267
  page_size == o.page_size &&
269
268
  query == o.query &&
269
+ recency_bias == o.recency_bias &&
270
270
  score_threshold == o.score_threshold &&
271
271
  search_type == o.search_type &&
272
272
  slim_chunks == o.slim_chunks &&
@@ -282,7 +282,7 @@ module TrieveRubyClient
282
282
  # Calculates hash code according to all attributes.
283
283
  # @return [Integer] Hash code
284
284
  def hash
285
- [date_bias, filters, get_total_pages, group_id, group_tracking_id, highlight_delimiters, highlight_results, page, page_size, query, score_threshold, search_type, slim_chunks, use_weights].hash
285
+ [filters, get_total_pages, group_id, group_tracking_id, highlight_delimiters, highlight_results, page, page_size, query, recency_bias, score_threshold, search_type, slim_chunks, use_weights].hash
286
286
  end
287
287
 
288
288
  # 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.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
@@ -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
@@ -11,5 +11,5 @@ Generator version: 7.4.0
11
11
  =end
12
12
 
13
13
  module TrieveRubyClient
14
- VERSION = '0.8.0'
14
+ VERSION = '0.8.2'
15
15
  end
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
5
5
 
6
- The version of the OpenAPI document: 0.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
@@ -5,5 +5,5 @@ gemHomepage: "https://trieve.ai"
5
5
  gemLicense: "MIT"
6
6
  gemName: "trieve_ruby_client"
7
7
  gemSummary: "Trieve Ruby API client"
8
- gemVersion: "0.8.0"
8
+ gemVersion: "0.8.2"
9
9
  moduleName: "TrieveRubyClient"