trieve_ruby_client 0.8.2 → 0.10.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 (219) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +39 -30
  3. data/docs/ApiKeyRespBody.md +32 -0
  4. data/docs/AutocompleteData.md +42 -0
  5. data/docs/AutocompleteReqPayload.md +50 -0
  6. data/docs/BoostPhrase.md +20 -0
  7. data/docs/ChunkApi.md +140 -66
  8. data/docs/ChunkData.md +3 -1
  9. data/docs/ChunkFilter.md +3 -3
  10. data/docs/ChunkGroup.md +1 -1
  11. data/docs/ChunkGroupApi.md +35 -33
  12. data/docs/ChunkMetadata.md +5 -1
  13. data/docs/ChunkMetadataStringTagSet.md +46 -0
  14. data/docs/ChunkMetadataTypes.md +51 -0
  15. data/docs/ChunkReqPayload.md +50 -0
  16. data/docs/ClientDatasetConfiguration.md +0 -2
  17. data/docs/ConditionType.md +49 -0
  18. data/docs/ContentChunkMetadata.md +32 -0
  19. data/docs/CreateChunkGroupReqPayload.md +28 -0
  20. data/docs/CreateChunkReqPayloadEnum.md +49 -0
  21. data/docs/CreateDatasetRequest.md +2 -2
  22. data/docs/CreateMessageData.md +2 -2
  23. data/docs/CreateMessageReqPayload.md +42 -0
  24. data/docs/CreateTopicReqPayload.md +22 -0
  25. data/docs/Dataset.md +2 -0
  26. data/docs/DatasetApi.md +236 -12
  27. data/docs/DateRange.md +24 -0
  28. data/docs/EditMessageReqPayload.md +44 -0
  29. data/docs/FieldCondition.md +2 -0
  30. data/docs/File.md +1 -1
  31. data/docs/FileApi.md +7 -7
  32. data/docs/GenerateChunksRequest.md +2 -0
  33. data/docs/GetDatasetsPagination.md +20 -0
  34. data/docs/HasIDCondition.md +20 -0
  35. data/docs/InvitationApi.md +1 -1
  36. data/docs/MatchCondition.md +3 -1
  37. data/docs/MessageApi.md +42 -42
  38. data/docs/Organization.md +2 -0
  39. data/docs/OrganizationApi.md +24 -25
  40. data/docs/RangeCondition.md +1 -3
  41. data/docs/RegenerateMessageReqPayload.md +40 -0
  42. data/docs/RemoveChunkFromGroupReqPayload.md +18 -0
  43. data/docs/ScoreChunkDTO.md +3 -1
  44. data/docs/SearchChunkData.md +9 -3
  45. data/docs/SearchChunksReqPayload.md +54 -0
  46. data/docs/SearchOverGroupsData.md +10 -2
  47. data/docs/SearchWithinGroupData.md +12 -2
  48. data/docs/SetUserApiKeyRequest.md +4 -0
  49. data/docs/SlimChunkMetadata.md +4 -0
  50. data/docs/SuggestedQueriesReqPayload.md +18 -0
  51. data/docs/TopicApi.md +16 -16
  52. data/docs/UpdateChunkData.md +2 -0
  53. data/docs/UpdateChunkReqPayload.md +46 -0
  54. data/docs/UpdateDatasetRequest.md +2 -0
  55. data/docs/UpdateGroupByTrackingIDReqPayload.md +26 -0
  56. data/docs/UpdateTopicReqPayload.md +20 -0
  57. data/docs/UpdateUserOrgRoleData.md +1 -1
  58. data/docs/UploadFileReqPayload.md +40 -0
  59. data/docs/UserApi.md +7 -8
  60. data/lib/trieve_ruby_client/api/auth_api.rb +1 -1
  61. data/lib/trieve_ruby_client/api/chunk_api.rb +158 -83
  62. data/lib/trieve_ruby_client/api/chunk_group_api.rb +58 -51
  63. data/lib/trieve_ruby_client/api/dataset_api.rb +224 -15
  64. data/lib/trieve_ruby_client/api/events_api.rb +1 -1
  65. data/lib/trieve_ruby_client/api/file_api.rb +12 -12
  66. data/lib/trieve_ruby_client/api/health_api.rb +1 -1
  67. data/lib/trieve_ruby_client/api/invitation_api.rb +3 -3
  68. data/lib/trieve_ruby_client/api/message_api.rb +50 -50
  69. data/lib/trieve_ruby_client/api/organization_api.rb +27 -27
  70. data/lib/trieve_ruby_client/api/stripe_api.rb +1 -1
  71. data/lib/trieve_ruby_client/api/topic_api.rb +27 -27
  72. data/lib/trieve_ruby_client/api/user_api.rb +8 -8
  73. data/lib/trieve_ruby_client/api_client.rb +1 -1
  74. data/lib/trieve_ruby_client/api_error.rb +1 -1
  75. data/lib/trieve_ruby_client/configuration.rb +1 -1
  76. data/lib/trieve_ruby_client/models/add_chunk_to_group_data.rb +1 -1
  77. data/lib/trieve_ruby_client/models/api_key_dto.rb +1 -1
  78. data/lib/trieve_ruby_client/models/api_key_resp_body.rb +325 -0
  79. data/lib/trieve_ruby_client/models/auth_query.rb +1 -1
  80. data/lib/trieve_ruby_client/models/autocomplete_data.rb +378 -0
  81. data/lib/trieve_ruby_client/models/autocomplete_req_payload.rb +467 -0
  82. data/lib/trieve_ruby_client/models/batch_queued_chunk_response.rb +1 -1
  83. data/lib/trieve_ruby_client/models/bookmark_data.rb +1 -1
  84. data/lib/trieve_ruby_client/models/bookmark_group_result.rb +1 -1
  85. data/lib/trieve_ruby_client/models/boost_phrase.rb +240 -0
  86. data/lib/trieve_ruby_client/models/chat_message_proxy.rb +1 -1
  87. data/lib/trieve_ruby_client/models/chunk_data.rb +16 -9
  88. data/lib/trieve_ruby_client/models/chunk_filter.rb +4 -4
  89. data/lib/trieve_ruby_client/models/chunk_group.rb +5 -3
  90. data/lib/trieve_ruby_client/models/chunk_group_and_file.rb +1 -1
  91. data/lib/trieve_ruby_client/models/chunk_metadata.rb +28 -4
  92. data/lib/trieve_ruby_client/models/chunk_metadata_string_tag_set.rb +387 -0
  93. data/lib/trieve_ruby_client/models/chunk_metadata_types.rb +106 -0
  94. data/lib/trieve_ruby_client/models/chunk_metadata_with_score.rb +1 -1
  95. data/lib/trieve_ruby_client/models/chunk_req_payload.rb +400 -0
  96. data/lib/trieve_ruby_client/models/client_dataset_configuration.rb +2 -18
  97. data/lib/trieve_ruby_client/models/condition_type.rb +105 -0
  98. data/lib/trieve_ruby_client/models/content_chunk_metadata.rb +299 -0
  99. data/lib/trieve_ruby_client/models/create_chunk_data.rb +1 -1
  100. data/lib/trieve_ruby_client/models/create_chunk_group_data.rb +1 -1
  101. data/lib/trieve_ruby_client/models/create_chunk_group_req_payload.rb +273 -0
  102. data/lib/trieve_ruby_client/models/create_chunk_req_payload_enum.rb +105 -0
  103. data/lib/trieve_ruby_client/models/create_dataset_request.rb +3 -3
  104. data/lib/trieve_ruby_client/models/create_message_data.rb +13 -13
  105. data/lib/trieve_ruby_client/models/create_message_req_payload.rb +378 -0
  106. data/lib/trieve_ruby_client/models/create_organization_data.rb +1 -1
  107. data/lib/trieve_ruby_client/models/create_topic_data.rb +1 -1
  108. data/lib/trieve_ruby_client/models/create_topic_req_payload.rb +244 -0
  109. data/lib/trieve_ruby_client/models/dataset.rb +18 -2
  110. data/lib/trieve_ruby_client/models/dataset_and_usage.rb +1 -1
  111. data/lib/trieve_ruby_client/models/dataset_dto.rb +1 -1
  112. data/lib/trieve_ruby_client/models/dataset_usage_count.rb +1 -1
  113. data/lib/trieve_ruby_client/models/date_range.rb +245 -0
  114. data/lib/trieve_ruby_client/models/delete_topic_data.rb +1 -1
  115. data/lib/trieve_ruby_client/models/delete_user_api_key_request.rb +1 -1
  116. data/lib/trieve_ruby_client/models/edit_message_data.rb +1 -1
  117. data/lib/trieve_ruby_client/models/edit_message_req_payload.rb +395 -0
  118. data/lib/trieve_ruby_client/models/error_response_body.rb +1 -1
  119. data/lib/trieve_ruby_client/models/event.rb +1 -1
  120. data/lib/trieve_ruby_client/models/event_return.rb +1 -1
  121. data/lib/trieve_ruby_client/models/field_condition.rb +12 -2
  122. data/lib/trieve_ruby_client/models/file.rb +5 -3
  123. data/lib/trieve_ruby_client/models/file_dto.rb +1 -1
  124. data/lib/trieve_ruby_client/models/generate_chunks_request.rb +13 -2
  125. data/lib/trieve_ruby_client/models/geo_info.rb +1 -1
  126. data/lib/trieve_ruby_client/models/geo_types.rb +1 -1
  127. data/lib/trieve_ruby_client/models/get_chunks_data.rb +1 -1
  128. data/lib/trieve_ruby_client/models/get_datasets_pagination.rb +225 -0
  129. data/lib/trieve_ruby_client/models/get_events_data.rb +1 -1
  130. data/lib/trieve_ruby_client/models/get_groups_for_chunks_data.rb +1 -1
  131. data/lib/trieve_ruby_client/models/get_tracking_chunks_data.rb +1 -1
  132. data/lib/trieve_ruby_client/models/group_data.rb +1 -1
  133. data/lib/trieve_ruby_client/models/group_score_chunk.rb +1 -1
  134. data/lib/trieve_ruby_client/models/has_id_condition.rb +229 -0
  135. data/lib/trieve_ruby_client/models/invitation_data.rb +1 -1
  136. data/lib/trieve_ruby_client/models/location_bounding_box.rb +1 -1
  137. data/lib/trieve_ruby_client/models/location_polygon.rb +1 -1
  138. data/lib/trieve_ruby_client/models/location_radius.rb +1 -1
  139. data/lib/trieve_ruby_client/models/match_condition.rb +2 -1
  140. data/lib/trieve_ruby_client/models/message.rb +1 -1
  141. data/lib/trieve_ruby_client/models/organization.rb +18 -2
  142. data/lib/trieve_ruby_client/models/organization_usage_count.rb +1 -1
  143. data/lib/trieve_ruby_client/models/range.rb +1 -1
  144. data/lib/trieve_ruby_client/models/range_condition.rb +2 -3
  145. data/lib/trieve_ruby_client/models/recommend_chunks_request.rb +1 -1
  146. data/lib/trieve_ruby_client/models/recommend_group_chunks_request.rb +1 -1
  147. data/lib/trieve_ruby_client/models/regenerate_message_data.rb +1 -1
  148. data/lib/trieve_ruby_client/models/regenerate_message_req_payload.rb +361 -0
  149. data/lib/trieve_ruby_client/models/remove_chunk_from_group_req_payload.rb +222 -0
  150. data/lib/trieve_ruby_client/models/return_queued_chunk.rb +1 -1
  151. data/lib/trieve_ruby_client/models/score_chunk_dto.rb +15 -3
  152. data/lib/trieve_ruby_client/models/search_chunk_data.rb +40 -5
  153. data/lib/trieve_ruby_client/models/search_chunk_query_response_body.rb +1 -1
  154. data/lib/trieve_ruby_client/models/search_chunks_req_payload.rb +504 -0
  155. data/lib/trieve_ruby_client/models/search_over_groups_data.rb +93 -4
  156. data/lib/trieve_ruby_client/models/search_over_groups_results.rb +1 -1
  157. data/lib/trieve_ruby_client/models/search_within_group_data.rb +106 -4
  158. data/lib/trieve_ruby_client/models/search_within_group_results.rb +1 -1
  159. data/lib/trieve_ruby_client/models/set_user_api_key_request.rb +28 -2
  160. data/lib/trieve_ruby_client/models/set_user_api_key_response.rb +1 -1
  161. data/lib/trieve_ruby_client/models/single_queued_chunk_response.rb +1 -1
  162. data/lib/trieve_ruby_client/models/slim_chunk_metadata.rb +24 -2
  163. data/lib/trieve_ruby_client/models/slim_chunk_metadata_with_score.rb +1 -1
  164. data/lib/trieve_ruby_client/models/slim_group.rb +1 -1
  165. data/lib/trieve_ruby_client/models/slim_user.rb +1 -1
  166. data/lib/trieve_ruby_client/models/stripe_plan.rb +1 -1
  167. data/lib/trieve_ruby_client/models/suggested_queries_req_payload.rb +222 -0
  168. data/lib/trieve_ruby_client/models/suggested_queries_request.rb +1 -1
  169. data/lib/trieve_ruby_client/models/suggested_queries_response.rb +1 -1
  170. data/lib/trieve_ruby_client/models/topic.rb +1 -1
  171. data/lib/trieve_ruby_client/models/update_chunk_by_tracking_id_data.rb +1 -1
  172. data/lib/trieve_ruby_client/models/update_chunk_data.rb +15 -2
  173. data/lib/trieve_ruby_client/models/update_chunk_group_data.rb +1 -1
  174. data/lib/trieve_ruby_client/models/update_chunk_req_payload.rb +376 -0
  175. data/lib/trieve_ruby_client/models/update_dataset_request.rb +13 -2
  176. data/lib/trieve_ruby_client/models/update_group_by_tracking_id_data.rb +1 -1
  177. data/lib/trieve_ruby_client/models/update_group_by_tracking_id_req_payload.rb +268 -0
  178. data/lib/trieve_ruby_client/models/update_organization_data.rb +1 -1
  179. data/lib/trieve_ruby_client/models/update_topic_data.rb +1 -1
  180. data/lib/trieve_ruby_client/models/update_topic_req_payload.rb +239 -0
  181. data/lib/trieve_ruby_client/models/update_user_org_role_data.rb +2 -2
  182. data/lib/trieve_ruby_client/models/upload_file_data.rb +1 -1
  183. data/lib/trieve_ruby_client/models/upload_file_req_payload.rb +368 -0
  184. data/lib/trieve_ruby_client/models/upload_file_result.rb +1 -1
  185. data/lib/trieve_ruby_client/models/user_organization.rb +1 -1
  186. data/lib/trieve_ruby_client/version.rb +2 -2
  187. data/lib/trieve_ruby_client.rb +25 -20
  188. data/openapi-generator.yaml +1 -1
  189. data/openapi.json +1 -7789
  190. data/spec/models/api_key_resp_body_spec.rb +78 -0
  191. data/spec/models/autocomplete_data_spec.rb +108 -0
  192. data/spec/models/autocomplete_req_payload_spec.rb +132 -0
  193. data/spec/models/boost_phrase_spec.rb +42 -0
  194. data/spec/models/chunk_metadata_string_tag_set_spec.rb +120 -0
  195. data/spec/models/chunk_metadata_types_spec.rb +32 -0
  196. data/spec/models/chunk_req_payload_spec.rb +132 -0
  197. data/spec/models/condition_type_spec.rb +32 -0
  198. data/spec/models/content_chunk_metadata_spec.rb +72 -0
  199. data/spec/models/create_chunk_group_req_payload_spec.rb +66 -0
  200. data/spec/models/create_chunk_req_payload_enum_spec.rb +32 -0
  201. data/spec/models/create_message_req_payload_spec.rb +108 -0
  202. data/spec/models/create_topic_req_payload_spec.rb +48 -0
  203. data/spec/models/date_range_spec.rb +54 -0
  204. data/spec/models/edit_message_req_payload_spec.rb +114 -0
  205. data/spec/models/get_datasets_pagination_spec.rb +42 -0
  206. data/spec/models/has_id_condition_spec.rb +42 -0
  207. data/spec/models/regenerate_message_req_payload_spec.rb +102 -0
  208. data/spec/models/remove_chunk_from_group_req_payload_spec.rb +36 -0
  209. data/spec/models/search_chunks_req_payload_spec.rb +144 -0
  210. data/spec/models/suggested_queries_req_payload_spec.rb +36 -0
  211. data/spec/models/update_chunk_req_payload_spec.rb +120 -0
  212. data/spec/models/update_group_by_tracking_id_req_payload_spec.rb +60 -0
  213. data/spec/models/update_topic_req_payload_spec.rb +42 -0
  214. data/spec/models/upload_file_req_payload_spec.rb +102 -0
  215. data/spec/spec_helper.rb +1 -1
  216. data/trieve_ruby_client-0.8.2.gem +0 -0
  217. data/trieve_ruby_client-0.8.5.gem +0 -0
  218. data/trieve_ruby_client.gemspec +1 -1
  219. metadata +104 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 262e43a892cb1d13a50451d6fa02c78fae20a0c9e38be9639fd11a0bc2b68603
4
- data.tar.gz: 17ff37410cb8c0862ecc78ec9abd155a7f0e4607cff27f90cf0ca8c98961b19d
3
+ metadata.gz: 1a168187dd7ee17f3200711aa37293b261c6c2b1efcdabbcaf20824b447d13af
4
+ data.tar.gz: c034af1fdb2902e0190b7493984f5a5b2517e76a12d83581fedb50f129926b14
5
5
  SHA512:
6
- metadata.gz: 80377af17609f7adb5a3c58e0919003e5278414838267479bfb3eba35aa862182c4f773841baf583a8b0334a9e3c059ee7034dfa55cab00b041beee36342cb32
7
- data.tar.gz: 71a31dc55f5204701dff7b2fac3fa8fa941472d5c27cc74f2d96b2fa0b6e7fc07bceca77989dce86f07bb94a9d49727b32994c74824c7560f3ed58feee1f1cd9
6
+ metadata.gz: a90adfe8bf23396bb6a5bee60fae21870edf82a072303090601787ab084e33459c4da8e32487593249077734797bce8b8e933ecb5ff83f07401c7c4a5d64cfeb
7
+ data.tar.gz: 2f8dd54c97384240971243258e27c0ae950b5cd8d178e850dd12b380c0b60a9c953c94a583447770f23abadcfd154c5daee2659b304fe7a36a78142f8472ff88
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.2
10
- - Package version: 0.8.2
9
+ - API version: 0.10.7
10
+ - Package version: 0.10.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.8.2.gem
28
+ gem install ./trieve_ruby_client-0.10.7.gem
29
29
  ```
30
30
 
31
- (for development, run `gem install --dev ./trieve_ruby_client-0.8.2.gem` to install the development dependencies)
31
+ (for development, run `gem install --dev ./trieve_ruby_client-0.10.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.8.2'
37
+ gem 'trieve_ruby_client', '~> 0.10.7'
38
38
 
39
39
  ### Install from Git
40
40
 
@@ -80,8 +80,8 @@ Class | Method | HTTP request | Description
80
80
  *TrieveRubyClient::AuthApi* | [**get_me**](docs/AuthApi.md#get_me) | **GET** /api/auth/me | Get Me
81
81
  *TrieveRubyClient::AuthApi* | [**login**](docs/AuthApi.md#login) | **GET** /api/auth | Login
82
82
  *TrieveRubyClient::AuthApi* | [**logout**](docs/AuthApi.md#logout) | **DELETE** /api/auth | Logout
83
+ *TrieveRubyClient::ChunkApi* | [**autocomplete**](docs/ChunkApi.md#autocomplete) | **POST** /api/chunk/autocomplete | Autocomplete
83
84
  *TrieveRubyClient::ChunkApi* | [**create_chunk**](docs/ChunkApi.md#create_chunk) | **POST** /api/chunk | Create or Upsert Chunk or Chunks
84
- *TrieveRubyClient::ChunkApi* | [**create_suggested_queries_handler**](docs/ChunkApi.md#create_suggested_queries_handler) | **POST** /api/chunk/gen_suggestions | Generate suggested queries
85
85
  *TrieveRubyClient::ChunkApi* | [**delete_chunk**](docs/ChunkApi.md#delete_chunk) | **DELETE** /api/chunk/{chunk_id} | Delete Chunk
86
86
  *TrieveRubyClient::ChunkApi* | [**delete_chunk_by_tracking_id**](docs/ChunkApi.md#delete_chunk_by_tracking_id) | **DELETE** /api/chunk/tracking_id/{tracking_id} | Delete Chunk By Tracking Id
87
87
  *TrieveRubyClient::ChunkApi* | [**generate_off_chunks**](docs/ChunkApi.md#generate_off_chunks) | **POST** /api/chunk/generate | RAG on Specified Chunks
@@ -90,6 +90,7 @@ Class | Method | HTTP request | Description
90
90
  *TrieveRubyClient::ChunkApi* | [**get_chunks_by_ids**](docs/ChunkApi.md#get_chunks_by_ids) | **POST** /api/chunks | Get Chunks By Ids
91
91
  *TrieveRubyClient::ChunkApi* | [**get_chunks_by_tracking_ids**](docs/ChunkApi.md#get_chunks_by_tracking_ids) | **POST** /api/chunks/tracking | Get Chunks By TrackingIds
92
92
  *TrieveRubyClient::ChunkApi* | [**get_recommended_chunks**](docs/ChunkApi.md#get_recommended_chunks) | **POST** /api/chunk/recommend | Get Recommended Chunks
93
+ *TrieveRubyClient::ChunkApi* | [**get_suggested_queries**](docs/ChunkApi.md#get_suggested_queries) | **POST** /api/chunk/gen_suggestions | Generate suggested queries
93
94
  *TrieveRubyClient::ChunkApi* | [**search_chunks**](docs/ChunkApi.md#search_chunks) | **POST** /api/chunk/search | Search
94
95
  *TrieveRubyClient::ChunkApi* | [**update_chunk**](docs/ChunkApi.md#update_chunk) | **PUT** /api/chunk | Update Chunk
95
96
  *TrieveRubyClient::ChunkApi* | [**update_chunk_by_tracking_id**](docs/ChunkApi.md#update_chunk_by_tracking_id) | **PUT** /api/chunk/tracking_id/update | Update Chunk By Tracking Id
@@ -110,11 +111,14 @@ Class | Method | HTTP request | Description
110
111
  *TrieveRubyClient::ChunkGroupApi* | [**search_within_group**](docs/ChunkGroupApi.md#search_within_group) | **POST** /api/chunk_group/search | Search Within Group
111
112
  *TrieveRubyClient::ChunkGroupApi* | [**update_chunk_group**](docs/ChunkGroupApi.md#update_chunk_group) | **PUT** /api/chunk_group | Update Group
112
113
  *TrieveRubyClient::ChunkGroupApi* | [**update_group_by_tracking_id**](docs/ChunkGroupApi.md#update_group_by_tracking_id) | **PUT** /api/chunk_group/tracking_id/{tracking_id} | Update Group by Tracking ID
114
+ *TrieveRubyClient::DatasetApi* | [**clear_dataset**](docs/DatasetApi.md#clear_dataset) | **PUT** /api/dataset/clear/{dataset_id} | Clear Dataset
113
115
  *TrieveRubyClient::DatasetApi* | [**create_dataset**](docs/DatasetApi.md#create_dataset) | **POST** /api/dataset | Create dataset
114
116
  *TrieveRubyClient::DatasetApi* | [**delete_dataset**](docs/DatasetApi.md#delete_dataset) | **DELETE** /api/dataset/{dataset_id} | Delete Dataset
117
+ *TrieveRubyClient::DatasetApi* | [**delete_dataset_by_tracking_id**](docs/DatasetApi.md#delete_dataset_by_tracking_id) | **DELETE** /api/dataset/tracking_id/{tracking_id} | Delete Dataset by Tracking ID
115
118
  *TrieveRubyClient::DatasetApi* | [**get_client_dataset_config**](docs/DatasetApi.md#get_client_dataset_config) | **GET** /api/dataset/envs | Get Client Configuration
116
119
  *TrieveRubyClient::DatasetApi* | [**get_dataset**](docs/DatasetApi.md#get_dataset) | **GET** /api/dataset/{dataset_id} | Get Dataset
117
120
  *TrieveRubyClient::DatasetApi* | [**get_datasets_from_organization**](docs/DatasetApi.md#get_datasets_from_organization) | **GET** /api/dataset/organization/{organization_id} | Get Datasets from Organization
121
+ *TrieveRubyClient::DatasetApi* | [**get_usage_by_dataset_id**](docs/DatasetApi.md#get_usage_by_dataset_id) | **GET** /api/dataset/usage/{dataset_id} | Get Usage By Dataset ID
118
122
  *TrieveRubyClient::DatasetApi* | [**update_dataset**](docs/DatasetApi.md#update_dataset) | **PUT** /api/dataset | Update Dataset
119
123
  *TrieveRubyClient::EventsApi* | [**get_events**](docs/EventsApi.md#get_events) | **POST** /api/events | Get events for the dataset
120
124
  *TrieveRubyClient::FileApi* | [**delete_file_handler**](docs/FileApi.md#delete_file_handler) | **DELETE** /api/file/{file_id} | Delete File
@@ -123,13 +127,13 @@ Class | Method | HTTP request | Description
123
127
  *TrieveRubyClient::FileApi* | [**upload_file_handler**](docs/FileApi.md#upload_file_handler) | **POST** /api/file | Upload File
124
128
  *TrieveRubyClient::HealthApi* | [**health_check**](docs/HealthApi.md#health_check) | **GET** /api/health | Health Check
125
129
  *TrieveRubyClient::InvitationApi* | [**post_invitation**](docs/InvitationApi.md#post_invitation) | **POST** /api/invitation | Send Invitation
126
- *TrieveRubyClient::MessageApi* | [**create_message_completion_handler**](docs/MessageApi.md#create_message_completion_handler) | **POST** /api/message | Create a message
127
- *TrieveRubyClient::MessageApi* | [**edit_message_handler**](docs/MessageApi.md#edit_message_handler) | **PUT** /api/message | Edit a message
130
+ *TrieveRubyClient::MessageApi* | [**create_message**](docs/MessageApi.md#create_message) | **POST** /api/message | Create message
131
+ *TrieveRubyClient::MessageApi* | [**edit_message**](docs/MessageApi.md#edit_message) | **PUT** /api/message | Edit message
128
132
  *TrieveRubyClient::MessageApi* | [**get_all_topic_messages**](docs/MessageApi.md#get_all_topic_messages) | **GET** /api/messages/{messages_topic_id} | Get all messages for a given topic
129
- *TrieveRubyClient::MessageApi* | [**regenerate_message_handler**](docs/MessageApi.md#regenerate_message_handler) | **DELETE** /api/message | Regenerate message
133
+ *TrieveRubyClient::MessageApi* | [**regenerate_message**](docs/MessageApi.md#regenerate_message) | **DELETE** /api/message | Regenerate message
130
134
  *TrieveRubyClient::OrganizationApi* | [**create_organization**](docs/OrganizationApi.md#create_organization) | **POST** /api/organization | Create Organization
131
- *TrieveRubyClient::OrganizationApi* | [**delete_organization_by_id**](docs/OrganizationApi.md#delete_organization_by_id) | **DELETE** /api/organization/{organization_id} | Delete Organization
132
- *TrieveRubyClient::OrganizationApi* | [**get_organization_by_id**](docs/OrganizationApi.md#get_organization_by_id) | **GET** /api/organization/{organization_id} | Get Organization
135
+ *TrieveRubyClient::OrganizationApi* | [**delete_organization**](docs/OrganizationApi.md#delete_organization) | **DELETE** /api/organization/{organization_id} | Delete Organization
136
+ *TrieveRubyClient::OrganizationApi* | [**get_organization**](docs/OrganizationApi.md#get_organization) | **GET** /api/organization/{organization_id} | Get Organization
133
137
  *TrieveRubyClient::OrganizationApi* | [**get_organization_usage**](docs/OrganizationApi.md#get_organization_usage) | **GET** /api/organization/usage/{organization_id} | Get Organization Usage
134
138
  *TrieveRubyClient::OrganizationApi* | [**get_organization_users**](docs/OrganizationApi.md#get_organization_users) | **GET** /api/organization/users/{organization_id} | Get Organization Users
135
139
  *TrieveRubyClient::OrganizationApi* | [**update_organization**](docs/OrganizationApi.md#update_organization) | **PUT** /api/organization | Update Organization
@@ -149,32 +153,39 @@ Class | Method | HTTP request | Description
149
153
  ## Documentation for Models
150
154
 
151
155
  - [TrieveRubyClient::AddChunkToGroupData](docs/AddChunkToGroupData.md)
152
- - [TrieveRubyClient::ApiKeyDTO](docs/ApiKeyDTO.md)
156
+ - [TrieveRubyClient::ApiKeyRespBody](docs/ApiKeyRespBody.md)
153
157
  - [TrieveRubyClient::AuthQuery](docs/AuthQuery.md)
158
+ - [TrieveRubyClient::AutocompleteReqPayload](docs/AutocompleteReqPayload.md)
154
159
  - [TrieveRubyClient::BatchQueuedChunkResponse](docs/BatchQueuedChunkResponse.md)
155
160
  - [TrieveRubyClient::BookmarkData](docs/BookmarkData.md)
156
161
  - [TrieveRubyClient::BookmarkGroupResult](docs/BookmarkGroupResult.md)
162
+ - [TrieveRubyClient::BoostPhrase](docs/BoostPhrase.md)
157
163
  - [TrieveRubyClient::ChatMessageProxy](docs/ChatMessageProxy.md)
158
- - [TrieveRubyClient::ChunkData](docs/ChunkData.md)
159
164
  - [TrieveRubyClient::ChunkFilter](docs/ChunkFilter.md)
160
165
  - [TrieveRubyClient::ChunkGroup](docs/ChunkGroup.md)
161
166
  - [TrieveRubyClient::ChunkGroupAndFile](docs/ChunkGroupAndFile.md)
162
167
  - [TrieveRubyClient::ChunkMetadata](docs/ChunkMetadata.md)
168
+ - [TrieveRubyClient::ChunkMetadataStringTagSet](docs/ChunkMetadataStringTagSet.md)
169
+ - [TrieveRubyClient::ChunkMetadataTypes](docs/ChunkMetadataTypes.md)
163
170
  - [TrieveRubyClient::ChunkMetadataWithScore](docs/ChunkMetadataWithScore.md)
171
+ - [TrieveRubyClient::ChunkReqPayload](docs/ChunkReqPayload.md)
164
172
  - [TrieveRubyClient::ClientDatasetConfiguration](docs/ClientDatasetConfiguration.md)
165
- - [TrieveRubyClient::CreateChunkData](docs/CreateChunkData.md)
166
- - [TrieveRubyClient::CreateChunkGroupData](docs/CreateChunkGroupData.md)
173
+ - [TrieveRubyClient::ConditionType](docs/ConditionType.md)
174
+ - [TrieveRubyClient::ContentChunkMetadata](docs/ContentChunkMetadata.md)
175
+ - [TrieveRubyClient::CreateChunkGroupReqPayload](docs/CreateChunkGroupReqPayload.md)
176
+ - [TrieveRubyClient::CreateChunkReqPayloadEnum](docs/CreateChunkReqPayloadEnum.md)
167
177
  - [TrieveRubyClient::CreateDatasetRequest](docs/CreateDatasetRequest.md)
168
- - [TrieveRubyClient::CreateMessageData](docs/CreateMessageData.md)
178
+ - [TrieveRubyClient::CreateMessageReqPayload](docs/CreateMessageReqPayload.md)
169
179
  - [TrieveRubyClient::CreateOrganizationData](docs/CreateOrganizationData.md)
170
- - [TrieveRubyClient::CreateTopicData](docs/CreateTopicData.md)
180
+ - [TrieveRubyClient::CreateTopicReqPayload](docs/CreateTopicReqPayload.md)
171
181
  - [TrieveRubyClient::Dataset](docs/Dataset.md)
172
182
  - [TrieveRubyClient::DatasetAndUsage](docs/DatasetAndUsage.md)
173
183
  - [TrieveRubyClient::DatasetDTO](docs/DatasetDTO.md)
174
184
  - [TrieveRubyClient::DatasetUsageCount](docs/DatasetUsageCount.md)
185
+ - [TrieveRubyClient::DateRange](docs/DateRange.md)
175
186
  - [TrieveRubyClient::DeleteTopicData](docs/DeleteTopicData.md)
176
187
  - [TrieveRubyClient::DeleteUserApiKeyRequest](docs/DeleteUserApiKeyRequest.md)
177
- - [TrieveRubyClient::EditMessageData](docs/EditMessageData.md)
188
+ - [TrieveRubyClient::EditMessageReqPayload](docs/EditMessageReqPayload.md)
178
189
  - [TrieveRubyClient::ErrorResponseBody](docs/ErrorResponseBody.md)
179
190
  - [TrieveRubyClient::Event](docs/Event.md)
180
191
  - [TrieveRubyClient::EventReturn](docs/EventReturn.md)
@@ -185,12 +196,13 @@ Class | Method | HTTP request | Description
185
196
  - [TrieveRubyClient::GeoInfo](docs/GeoInfo.md)
186
197
  - [TrieveRubyClient::GeoTypes](docs/GeoTypes.md)
187
198
  - [TrieveRubyClient::GetChunksData](docs/GetChunksData.md)
199
+ - [TrieveRubyClient::GetDatasetsPagination](docs/GetDatasetsPagination.md)
188
200
  - [TrieveRubyClient::GetEventsData](docs/GetEventsData.md)
189
201
  - [TrieveRubyClient::GetGroupsForChunksData](docs/GetGroupsForChunksData.md)
190
202
  - [TrieveRubyClient::GetTrackingChunksData](docs/GetTrackingChunksData.md)
191
203
  - [TrieveRubyClient::GroupData](docs/GroupData.md)
192
204
  - [TrieveRubyClient::GroupScoreChunk](docs/GroupScoreChunk.md)
193
- - [TrieveRubyClient::GroupScoreSlimChunks](docs/GroupScoreSlimChunks.md)
205
+ - [TrieveRubyClient::HasIDCondition](docs/HasIDCondition.md)
194
206
  - [TrieveRubyClient::InvitationData](docs/InvitationData.md)
195
207
  - [TrieveRubyClient::LocationBoundingBox](docs/LocationBoundingBox.md)
196
208
  - [TrieveRubyClient::LocationPolygon](docs/LocationPolygon.md)
@@ -203,19 +215,16 @@ Class | Method | HTTP request | Description
203
215
  - [TrieveRubyClient::RangeCondition](docs/RangeCondition.md)
204
216
  - [TrieveRubyClient::RecommendChunksRequest](docs/RecommendChunksRequest.md)
205
217
  - [TrieveRubyClient::RecommendGroupChunksRequest](docs/RecommendGroupChunksRequest.md)
206
- - [TrieveRubyClient::RegenerateMessageData](docs/RegenerateMessageData.md)
218
+ - [TrieveRubyClient::RegenerateMessageReqPayload](docs/RegenerateMessageReqPayload.md)
219
+ - [TrieveRubyClient::RemoveChunkFromGroupReqPayload](docs/RemoveChunkFromGroupReqPayload.md)
207
220
  - [TrieveRubyClient::ReturnQueuedChunk](docs/ReturnQueuedChunk.md)
208
221
  - [TrieveRubyClient::ScoreChunkDTO](docs/ScoreChunkDTO.md)
209
- - [TrieveRubyClient::ScoreSlimChunks](docs/ScoreSlimChunks.md)
210
- - [TrieveRubyClient::SearchChunkData](docs/SearchChunkData.md)
211
222
  - [TrieveRubyClient::SearchChunkQueryResponseBody](docs/SearchChunkQueryResponseBody.md)
223
+ - [TrieveRubyClient::SearchChunksReqPayload](docs/SearchChunksReqPayload.md)
212
224
  - [TrieveRubyClient::SearchOverGroupsData](docs/SearchOverGroupsData.md)
213
225
  - [TrieveRubyClient::SearchOverGroupsResults](docs/SearchOverGroupsResults.md)
214
- - [TrieveRubyClient::SearchOverGroupsSlimResults](docs/SearchOverGroupsSlimResults.md)
215
- - [TrieveRubyClient::SearchSlimChunkQueryResponseBody](docs/SearchSlimChunkQueryResponseBody.md)
216
226
  - [TrieveRubyClient::SearchWithinGroupData](docs/SearchWithinGroupData.md)
217
227
  - [TrieveRubyClient::SearchWithinGroupResults](docs/SearchWithinGroupResults.md)
218
- - [TrieveRubyClient::SearchWithinGroupSlimResults](docs/SearchWithinGroupSlimResults.md)
219
228
  - [TrieveRubyClient::SetUserApiKeyRequest](docs/SetUserApiKeyRequest.md)
220
229
  - [TrieveRubyClient::SetUserApiKeyResponse](docs/SetUserApiKeyResponse.md)
221
230
  - [TrieveRubyClient::SingleQueuedChunkResponse](docs/SingleQueuedChunkResponse.md)
@@ -224,18 +233,18 @@ Class | Method | HTTP request | Description
224
233
  - [TrieveRubyClient::SlimGroup](docs/SlimGroup.md)
225
234
  - [TrieveRubyClient::SlimUser](docs/SlimUser.md)
226
235
  - [TrieveRubyClient::StripePlan](docs/StripePlan.md)
227
- - [TrieveRubyClient::SuggestedQueriesRequest](docs/SuggestedQueriesRequest.md)
236
+ - [TrieveRubyClient::SuggestedQueriesReqPayload](docs/SuggestedQueriesReqPayload.md)
228
237
  - [TrieveRubyClient::SuggestedQueriesResponse](docs/SuggestedQueriesResponse.md)
229
238
  - [TrieveRubyClient::Topic](docs/Topic.md)
230
239
  - [TrieveRubyClient::UpdateChunkByTrackingIdData](docs/UpdateChunkByTrackingIdData.md)
231
- - [TrieveRubyClient::UpdateChunkData](docs/UpdateChunkData.md)
232
240
  - [TrieveRubyClient::UpdateChunkGroupData](docs/UpdateChunkGroupData.md)
241
+ - [TrieveRubyClient::UpdateChunkReqPayload](docs/UpdateChunkReqPayload.md)
233
242
  - [TrieveRubyClient::UpdateDatasetRequest](docs/UpdateDatasetRequest.md)
234
- - [TrieveRubyClient::UpdateGroupByTrackingIDData](docs/UpdateGroupByTrackingIDData.md)
243
+ - [TrieveRubyClient::UpdateGroupByTrackingIDReqPayload](docs/UpdateGroupByTrackingIDReqPayload.md)
235
244
  - [TrieveRubyClient::UpdateOrganizationData](docs/UpdateOrganizationData.md)
236
- - [TrieveRubyClient::UpdateTopicData](docs/UpdateTopicData.md)
245
+ - [TrieveRubyClient::UpdateTopicReqPayload](docs/UpdateTopicReqPayload.md)
237
246
  - [TrieveRubyClient::UpdateUserOrgRoleData](docs/UpdateUserOrgRoleData.md)
238
- - [TrieveRubyClient::UploadFileData](docs/UploadFileData.md)
247
+ - [TrieveRubyClient::UploadFileReqPayload](docs/UploadFileReqPayload.md)
239
248
  - [TrieveRubyClient::UploadFileResult](docs/UploadFileResult.md)
240
249
  - [TrieveRubyClient::UserOrganization](docs/UserOrganization.md)
241
250
 
data/docs/ApiKeyRespBody.md ADDED
@@ -0,0 +1,32 @@
1
+ # TrieveRubyClient::ApiKeyRespBody
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **created_at** | **Time** | | |
8
+ | **dataset_ids** | **Array<String>** | | [optional] |
9
+ | **id** | **String** | | |
10
+ | **name** | **String** | | |
11
+ | **organization_ids** | **Array<String>** | | [optional] |
12
+ | **role** | **Integer** | | |
13
+ | **updated_at** | **Time** | | |
14
+ | **user_id** | **String** | | |
15
+
16
+ ## Example
17
+
18
+ ```ruby
19
+ require 'trieve_ruby_client'
20
+
21
+ instance = TrieveRubyClient::ApiKeyRespBody.new(
22
+ created_at: null,
23
+ dataset_ids: null,
24
+ id: null,
25
+ name: null,
26
+ organization_ids: null,
27
+ role: null,
28
+ updated_at: null,
29
+ user_id: null
30
+ )
31
+ ```
32
+
data/docs/AutocompleteData.md ADDED
@@ -0,0 +1,42 @@
1
+ # TrieveRubyClient::AutocompleteData
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **content_only** | **Boolean** | Set content_only to true to only returning the chunk_html of the chunks. This is useful for when you want to reduce amount of data over the wire for latency improvement (typically 10-50ms). Default is false. | [optional] |
8
+ | **filters** | [**ChunkFilter**](ChunkFilter.md) | | [optional] |
9
+ | **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] |
10
+ | **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] |
11
+ | **highlight_threshold** | **Float** | Set highlight_threshold to a lower or higher value to adjust the sensitivity of the highlights applied to the chunk html. If not specified, this defaults to 0.8. The range is 0.0 to 1.0. | [optional] |
12
+ | **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] |
13
+ | **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. | |
14
+ | **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] |
15
+ | **score_threshold** | **Float** | Set score_threshold to a float to filter out chunks with a score below the threshold. | [optional] |
16
+ | **search_type** | **String** | Can be either \"semantic\", or \"fulltext\". \"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. | |
17
+ | **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 (typically 10-50ms). Default is false. | [optional] |
18
+ | **tag_weights** | **Hash<String, Float>** | Tag weights is a JSON object which can be used to boost the ranking of chunks with certain tags. This is useful for when you want to be able to bias towards chunks with a certain tag on the fly. The keys are the tag names and the values are the weights. | [optional] |
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
+
21
+ ## Example
22
+
23
+ ```ruby
24
+ require 'trieve_ruby_client'
25
+
26
+ instance = TrieveRubyClient::AutocompleteData.new(
27
+ content_only: null,
28
+ filters: null,
29
+ highlight_delimiters: null,
30
+ highlight_results: null,
31
+ highlight_threshold: null,
32
+ page_size: null,
33
+ query: null,
34
+ recency_bias: null,
35
+ score_threshold: null,
36
+ search_type: null,
37
+ slim_chunks: null,
38
+ tag_weights: null,
39
+ use_weights: null
40
+ )
41
+ ```
42
+
data/docs/AutocompleteReqPayload.md ADDED
@@ -0,0 +1,50 @@
1
+ # TrieveRubyClient::AutocompleteReqPayload
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **content_only** | **Boolean** | Set content_only to true to only returning the chunk_html of the chunks. This is useful for when you want to reduce amount of data over the wire for latency improvement (typically 10-50ms). Default is false. | [optional] |
8
+ | **extend_results** | **Boolean** | If specified to true, this will extend the search results to include non-exact prefix matches of the same search_type such that a full page_size of results are returned. Default is false. | [optional] |
9
+ | **filters** | [**ChunkFilter**](ChunkFilter.md) | | [optional] |
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 [\"?\", \",\", \".\", \"!\"]. These are the characters that will be used to split the chunk_html into splits for highlighting. | [optional] |
11
+ | **highlight_max_length** | **Integer** | Set highlight_max_length to control the maximum number of tokens (typically whitespace separated strings, but sometimes also word stems) which can be present within a single highlight. If not specified, this defaults to 8. This is useful to shorten large splits which may have low scores due to length compared to the query. Set to something very large like 100 to highlight entire splits. | [optional] |
12
+ | **highlight_max_num** | **Integer** | Set highlight_max_num to control the maximum number of highlights per chunk. If not specified, this defaults to 3. It may be less than 3 if no snippets score above the highlight_threshold. | [optional] |
13
+ | **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 splits and return the highlights on each scored chunk in the response. | [optional] |
14
+ | **highlight_threshold** | **Float** | Set highlight_threshold to a lower or higher value to adjust the sensitivity of the highlights applied to the chunk html. If not specified, this defaults to 0.8. The range is 0.0 to 1.0. | [optional] |
15
+ | **highlight_window** | **Integer** | Set highlight_window to a number to control the amount of words that are returned around the matched phrases. If not specified, this defaults to 0. This is useful for when you want to show more context around the matched words. When specified, window/2 whitespace separated words are added before and after each highlight in the response's highlights array. If an extended highlight overlaps with another highlight, the overlapping words are only included once. | [optional] |
16
+ | **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] |
17
+ | **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. | |
18
+ | **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] |
19
+ | **score_threshold** | **Float** | Set score_threshold to a float to filter out chunks with a score below the threshold. | [optional] |
20
+ | **search_type** | **String** | Can be either \"semantic\", or \"fulltext\". \"semantic\" will pull in one page_size of the nearest cosine distant vectors. \"fulltext\" will pull in one page_size of full-text results based on SPLADE. | |
21
+ | **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 (typically 10-50ms). Default is false. | [optional] |
22
+ | **tag_weights** | **Hash<String, Float>** | Tag weights is a JSON object which can be used to boost the ranking of chunks with certain tags. This is useful for when you want to be able to bias towards chunks with a certain tag on the fly. The keys are the tag names and the values are the weights. | [optional] |
23
+ | **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] |
24
+
25
+ ## Example
26
+
27
+ ```ruby
28
+ require 'trieve_ruby_client'
29
+
30
+ instance = TrieveRubyClient::AutocompleteReqPayload.new(
31
+ content_only: null,
32
+ extend_results: null,
33
+ filters: null,
34
+ highlight_delimiters: null,
35
+ highlight_max_length: null,
36
+ highlight_max_num: null,
37
+ highlight_results: null,
38
+ highlight_threshold: null,
39
+ highlight_window: null,
40
+ page_size: null,
41
+ query: null,
42
+ recency_bias: null,
43
+ score_threshold: null,
44
+ search_type: null,
45
+ slim_chunks: null,
46
+ tag_weights: null,
47
+ use_weights: null
48
+ )
49
+ ```
50
+
data/docs/BoostPhrase.md ADDED
@@ -0,0 +1,20 @@
1
+ # TrieveRubyClient::BoostPhrase
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **boost_factor** | **Float** | Amount to multiplicatevly increase the frequency of the tokens in the phrase by | |
8
+ | **phrase** | **String** | The phrase to boost in the fulltext document frequency index | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'trieve_ruby_client'
14
+
15
+ instance = TrieveRubyClient::BoostPhrase.new(
16
+ boost_factor: null,
17
+ phrase: null
18
+ )
19
+ ```
20
+