trieve_ruby_client 0.5.0 → 0.5.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 (163) hide show
  1. checksums.yaml +4 -4
  2. data/GENERATE_COMMAND.txt +1 -0
  3. data/README.md +21 -10
  4. data/docs/AuthApi.md +1 -1
  5. data/docs/ChunkApi.md +9 -9
  6. data/docs/ChunkGroupApi.md +25 -16
  7. data/docs/DatasetApi.md +9 -9
  8. data/docs/EventsApi.md +1 -1
  9. data/docs/FileApi.md +1 -1
  10. data/docs/GroupScoreChunkDTO.md +2 -0
  11. data/docs/GroupSlimChunksDTO.md +20 -0
  12. data/docs/HealthApi.md +1 -1
  13. data/docs/InvitationApi.md +1 -1
  14. data/docs/MessageApi.md +1 -1
  15. data/docs/OrganizationApi.md +1 -1
  16. data/docs/Range.md +4 -4
  17. data/docs/RangeCondition.md +49 -0
  18. data/docs/ReccomendGroupChunksRequest.md +3 -1
  19. data/docs/RecommendChunksRequest.md +3 -1
  20. data/docs/RecommendChunksResponseTypes.md +49 -0
  21. data/docs/RecommendGroupChunkResponseTypes.md +49 -0
  22. data/docs/ScoreSlimChunks.md +20 -0
  23. data/docs/SearchChunkData.md +4 -0
  24. data/docs/SearchChunkResponseTypes.md +49 -0
  25. data/docs/SearchGroupSlimChunksResult.md +22 -0
  26. data/docs/SearchOverGroupsData.md +5 -1
  27. data/docs/SearchOverGroupsResponseTypes.md +49 -0
  28. data/docs/SearchOverGroupsSlimChunksResponseBody.md +20 -0
  29. data/docs/SearchSlimChunkQueryResponseBody.md +20 -0
  30. data/docs/SearchWithinGroupData.md +4 -0
  31. data/docs/SearchWithinGroupResponseTypes.md +49 -0
  32. data/docs/SlimChunkMetadata.md +36 -0
  33. data/docs/SlimUser.md +1 -7
  34. data/docs/StripeApi.md +1 -1
  35. data/docs/TopicApi.md +9 -9
  36. data/docs/UpdateChunkData.md +2 -0
  37. data/docs/UpdateUserData.md +1 -7
  38. data/docs/UserApi.md +9 -9
  39. data/lib/trieve_ruby_client/api/auth_api.rb +1 -1
  40. data/lib/trieve_ruby_client/api/chunk_api.rb +7 -7
  41. data/lib/trieve_ruby_client/api/chunk_group_api.rb +21 -14
  42. data/lib/trieve_ruby_client/api/dataset_api.rb +11 -16
  43. data/lib/trieve_ruby_client/api/events_api.rb +1 -1
  44. data/lib/trieve_ruby_client/api/file_api.rb +1 -1
  45. data/lib/trieve_ruby_client/api/health_api.rb +1 -1
  46. data/lib/trieve_ruby_client/api/invitation_api.rb +1 -1
  47. data/lib/trieve_ruby_client/api/message_api.rb +1 -1
  48. data/lib/trieve_ruby_client/api/organization_api.rb +1 -1
  49. data/lib/trieve_ruby_client/api/stripe_api.rb +1 -1
  50. data/lib/trieve_ruby_client/api/topic_api.rb +11 -16
  51. data/lib/trieve_ruby_client/api/user_api.rb +11 -16
  52. data/lib/trieve_ruby_client/api_client.rb +1 -1
  53. data/lib/trieve_ruby_client/api_error.rb +1 -1
  54. data/lib/trieve_ruby_client/configuration.rb +7 -7
  55. data/lib/trieve_ruby_client/models/add_chunk_to_group_data.rb +1 -1
  56. data/lib/trieve_ruby_client/models/api_key_dto.rb +1 -1
  57. data/lib/trieve_ruby_client/models/auth_query.rb +1 -1
  58. data/lib/trieve_ruby_client/models/batch_queued_chunk_response.rb +1 -1
  59. data/lib/trieve_ruby_client/models/bookmark_data.rb +1 -1
  60. data/lib/trieve_ruby_client/models/bookmark_group_result.rb +1 -1
  61. data/lib/trieve_ruby_client/models/chat_message_proxy.rb +1 -1
  62. data/lib/trieve_ruby_client/models/chunk_data.rb +1 -1
  63. data/lib/trieve_ruby_client/models/chunk_filter.rb +1 -1
  64. data/lib/trieve_ruby_client/models/chunk_group.rb +1 -1
  65. data/lib/trieve_ruby_client/models/chunk_group_and_file.rb +1 -1
  66. data/lib/trieve_ruby_client/models/chunk_metadata.rb +1 -1
  67. data/lib/trieve_ruby_client/models/chunk_metadata_with_file_data.rb +1 -1
  68. data/lib/trieve_ruby_client/models/client_dataset_configuration.rb +1 -1
  69. data/lib/trieve_ruby_client/models/create_chunk_data.rb +1 -1
  70. data/lib/trieve_ruby_client/models/create_chunk_group_data.rb +1 -1
  71. data/lib/trieve_ruby_client/models/create_dataset_request.rb +1 -1
  72. data/lib/trieve_ruby_client/models/create_message_data.rb +1 -1
  73. data/lib/trieve_ruby_client/models/create_organization_data.rb +1 -1
  74. data/lib/trieve_ruby_client/models/create_topic_data.rb +1 -1
  75. data/lib/trieve_ruby_client/models/dataset.rb +1 -1
  76. data/lib/trieve_ruby_client/models/dataset_and_usage.rb +1 -1
  77. data/lib/trieve_ruby_client/models/dataset_dto.rb +1 -1
  78. data/lib/trieve_ruby_client/models/dataset_usage_count.rb +1 -1
  79. data/lib/trieve_ruby_client/models/delete_topic_data.rb +1 -1
  80. data/lib/trieve_ruby_client/models/delete_user_api_key_request.rb +1 -1
  81. data/lib/trieve_ruby_client/models/edit_message_data.rb +1 -1
  82. data/lib/trieve_ruby_client/models/error_response_body.rb +1 -1
  83. data/lib/trieve_ruby_client/models/event.rb +1 -1
  84. data/lib/trieve_ruby_client/models/event_return.rb +1 -1
  85. data/lib/trieve_ruby_client/models/field_condition.rb +1 -1
  86. data/lib/trieve_ruby_client/models/file.rb +1 -1
  87. data/lib/trieve_ruby_client/models/file_dto.rb +1 -1
  88. data/lib/trieve_ruby_client/models/generate_chunks_request.rb +1 -1
  89. data/lib/trieve_ruby_client/models/get_events_data.rb +1 -1
  90. data/lib/trieve_ruby_client/models/get_groups_for_chunks_data.rb +1 -1
  91. data/lib/trieve_ruby_client/models/group_data.rb +1 -1
  92. data/lib/trieve_ruby_client/models/group_score_chunk_dto.rb +12 -2
  93. data/lib/trieve_ruby_client/models/group_slim_chunks_dto.rb +239 -0
  94. data/lib/trieve_ruby_client/models/invitation_data.rb +1 -1
  95. data/lib/trieve_ruby_client/models/match_condition.rb +1 -1
  96. data/lib/trieve_ruby_client/models/message.rb +1 -1
  97. data/lib/trieve_ruby_client/models/organization.rb +1 -1
  98. data/lib/trieve_ruby_client/models/organization_usage_count.rb +1 -1
  99. data/lib/trieve_ruby_client/models/range.rb +5 -5
  100. data/lib/trieve_ruby_client/models/range_condition.rb +105 -0
  101. data/lib/trieve_ruby_client/models/reccomend_group_chunks_request.rb +17 -6
  102. data/lib/trieve_ruby_client/models/recommend_chunks_request.rb +17 -6
  103. data/lib/trieve_ruby_client/models/recommend_chunks_response_types.rb +105 -0
  104. data/lib/trieve_ruby_client/models/recommend_group_chunk_response_types.rb +105 -0
  105. data/lib/trieve_ruby_client/models/regenerate_message_data.rb +1 -1
  106. data/lib/trieve_ruby_client/models/return_queued_chunk.rb +1 -1
  107. data/lib/trieve_ruby_client/models/score_chunk_dto.rb +1 -1
  108. data/lib/trieve_ruby_client/models/score_slim_chunks.rb +239 -0
  109. data/lib/trieve_ruby_client/models/search_chunk_data.rb +24 -2
  110. data/lib/trieve_ruby_client/models/search_chunk_query_response_body.rb +1 -1
  111. data/lib/trieve_ruby_client/models/search_chunk_response_types.rb +105 -0
  112. data/lib/trieve_ruby_client/models/search_group_slim_chunks_result.rb +255 -0
  113. data/lib/trieve_ruby_client/models/search_groups_result.rb +1 -1
  114. data/lib/trieve_ruby_client/models/search_over_groups_data.rb +27 -5
  115. data/lib/trieve_ruby_client/models/search_over_groups_response_body.rb +1 -1
  116. data/lib/trieve_ruby_client/models/search_over_groups_response_types.rb +105 -0
  117. data/lib/trieve_ruby_client/models/search_over_groups_slim_chunks_response_body.rb +239 -0
  118. data/lib/trieve_ruby_client/models/search_slim_chunk_query_response_body.rb +239 -0
  119. data/lib/trieve_ruby_client/models/search_within_group_data.rb +24 -2
  120. data/lib/trieve_ruby_client/models/search_within_group_response_types.rb +105 -0
  121. data/lib/trieve_ruby_client/models/set_user_api_key_request.rb +1 -1
  122. data/lib/trieve_ruby_client/models/set_user_api_key_response.rb +1 -1
  123. data/lib/trieve_ruby_client/models/single_queued_chunk_response.rb +1 -1
  124. data/lib/trieve_ruby_client/models/slim_chunk_metadata.rb +329 -0
  125. data/lib/trieve_ruby_client/models/slim_group.rb +1 -1
  126. data/lib/trieve_ruby_client/models/slim_user.rb +5 -41
  127. data/lib/trieve_ruby_client/models/stripe_plan.rb +1 -1
  128. data/lib/trieve_ruby_client/models/suggested_queries_request.rb +1 -1
  129. data/lib/trieve_ruby_client/models/suggested_queries_response.rb +1 -1
  130. data/lib/trieve_ruby_client/models/topic.rb +1 -1
  131. data/lib/trieve_ruby_client/models/update_chunk_by_tracking_id_data.rb +1 -1
  132. data/lib/trieve_ruby_client/models/update_chunk_data.rb +15 -2
  133. data/lib/trieve_ruby_client/models/update_chunk_group_data.rb +1 -1
  134. data/lib/trieve_ruby_client/models/update_dataset_request.rb +1 -1
  135. data/lib/trieve_ruby_client/models/update_group_by_tracking_id_data.rb +1 -1
  136. data/lib/trieve_ruby_client/models/update_organization_data.rb +1 -1
  137. data/lib/trieve_ruby_client/models/update_topic_data.rb +1 -1
  138. data/lib/trieve_ruby_client/models/update_user_data.rb +6 -39
  139. data/lib/trieve_ruby_client/models/upload_file_data.rb +1 -1
  140. data/lib/trieve_ruby_client/models/upload_file_result.rb +1 -1
  141. data/lib/trieve_ruby_client/models/user_organization.rb +1 -1
  142. data/lib/trieve_ruby_client/version.rb +2 -2
  143. data/lib/trieve_ruby_client.rb +13 -2
  144. data/openapi-generator.yaml +1 -1
  145. data/openapi.json +636 -217
  146. data/spec/models/group_slim_chunks_dto_spec.rb +42 -0
  147. data/spec/models/range_condition_spec.rb +32 -0
  148. data/spec/models/recommend_chunks_response_types_spec.rb +32 -0
  149. data/spec/models/recommend_group_chunk_response_types_spec.rb +32 -0
  150. data/spec/models/score_slim_chunks_spec.rb +42 -0
  151. data/spec/models/search_chunk_response_types_spec.rb +32 -0
  152. data/spec/models/search_group_slim_chunks_result_spec.rb +48 -0
  153. data/spec/models/search_over_groups_response_types_spec.rb +32 -0
  154. data/spec/models/search_over_groups_slim_chunks_response_body_spec.rb +42 -0
  155. data/spec/models/search_slim_chunk_query_response_body_spec.rb +42 -0
  156. data/spec/models/search_within_group_response_types_spec.rb +32 -0
  157. data/spec/models/slim_chunk_metadata_spec.rb +90 -0
  158. data/spec/spec_helper.rb +1 -1
  159. data/trieve_ruby_client-0.5.0.gem +0 -0
  160. data/trieve_ruby_client.gemspec +1 -1
  161. metadata +52 -4
  162. data/trieve_ruby_client-0.3.5.gem +0 -0
  163. data/trieve_ruby_client-0.4.0.gem +0 -0
data/openapi.json CHANGED
@@ -12,16 +12,16 @@
12
12
  "name": "BSL",
13
13
  "url": "https://github.com/devflowinc/trieve/blob/main/LICENSE.txt"
14
14
  },
15
- "version": "0.5.0"
15
+ "version": "0.5.7"
16
16
  },
17
17
  "servers": [
18
- {
19
- "url": "http://localhost:8090",
20
- "description": "Local development server"
21
- },
22
18
  {
23
19
  "url": "https://api.trieve.ai",
24
20
  "description": "Production server"
21
+ },
22
+ {
23
+ "url": "http://localhost:8090",
24
+ "description": "Local development server"
25
25
  }
26
26
  ],
27
27
  "paths": {
@@ -422,14 +422,11 @@
422
422
  },
423
423
  "responses": {
424
424
  "200": {
425
- "description": "JSON response payload containing chunks with scores which are similar to those in the request body",
425
+ "description": "Chunks with embedding vectors which are similar to those in the request body",
426
426
  "content": {
427
427
  "application/json": {
428
428
  "schema": {
429
- "type": "array",
430
- "items": {
431
- "$ref": "#/components/schemas/ChunkMetadataWithFileData"
432
- }
429
+ "$ref": "#/components/schemas/RecommendChunksResponseTypes"
433
430
  }
434
431
  }
435
432
  }
@@ -486,11 +483,11 @@
486
483
  },
487
484
  "responses": {
488
485
  "200": {
489
- "description": "chunks which are similar to the embedding vector of the search query",
486
+ "description": "Chunks with embedding vectors which are similar to those in the request body",
490
487
  "content": {
491
488
  "application/json": {
492
489
  "schema": {
493
- "$ref": "#/components/schemas/SearchChunkQueryResponseBody"
490
+ "$ref": "#/components/schemas/SearchChunkResponseTypes"
494
491
  }
495
492
  }
496
493
  }
@@ -1100,6 +1097,17 @@
1100
1097
  "summary": "Search Over Groups",
1101
1098
  "description": "Search Over Groups\n\nThis route allows you to get groups as results instead of chunks. Each group returned will have the matching chunks sorted by similarity within the group. This is useful for when you want to get groups of chunks which are similar to the search query. If choosing hybrid search, the results will be re-ranked using BAAI/bge-reranker-large. Compatible with semantic, fulltext, or hybrid search modes.",
1102
1099
  "operationId": "search_over_groups",
1100
+ "parameters": [
1101
+ {
1102
+ "name": "TR-Dataset",
1103
+ "in": "header",
1104
+ "description": "The dataset id to use for the request",
1105
+ "required": true,
1106
+ "schema": {
1107
+ "type": "string"
1108
+ }
1109
+ }
1110
+ ],
1103
1111
  "requestBody": {
1104
1112
  "description": "JSON request payload to semantically search over groups",
1105
1113
  "content": {
@@ -1117,7 +1125,7 @@
1117
1125
  "content": {
1118
1126
  "application/json": {
1119
1127
  "schema": {
1120
- "$ref": "#/components/schemas/SearchOverGroupsResponseBody"
1128
+ "$ref": "#/components/schemas/SearchOverGroupsResponseTypes"
1121
1129
  }
1122
1130
  }
1123
1131
  }
@@ -1132,7 +1140,14 @@
1132
1140
  }
1133
1141
  }
1134
1142
  }
1135
- }
1143
+ },
1144
+ "security": [
1145
+ {
1146
+ "ApiKey": [
1147
+ "readonly"
1148
+ ]
1149
+ }
1150
+ ]
1136
1151
  }
1137
1152
  },
1138
1153
  "/api/chunk_group/recommend": {
@@ -1167,14 +1182,11 @@
1167
1182
  },
1168
1183
  "responses": {
1169
1184
  "200": {
1170
- "description": "JSON response payload containing chunks with scores which are similar to those in the request body",
1185
+ "description": "JSON body representing the groups which are similar to the groups in the request",
1171
1186
  "content": {
1172
1187
  "application/json": {
1173
1188
  "schema": {
1174
- "type": "array",
1175
- "items": {
1176
- "$ref": "#/components/schemas/GroupScoreChunkDTO"
1177
- }
1189
+ "$ref": "#/components/schemas/RecommendGroupChunkResponseTypes"
1178
1190
  }
1179
1191
  }
1180
1192
  }
@@ -1235,7 +1247,7 @@
1235
1247
  "content": {
1236
1248
  "application/json": {
1237
1249
  "schema": {
1238
- "$ref": "#/components/schemas/SearchGroupsResult"
1250
+ "$ref": "#/components/schemas/SearchWithinGroupResponseTypes"
1239
1251
  }
1240
1252
  }
1241
1253
  }
@@ -1872,58 +1884,6 @@
1872
1884
  ]
1873
1885
  }
1874
1886
  ]
1875
- },
1876
- "delete": {
1877
- "tags": [
1878
- "dataset"
1879
- ],
1880
- "summary": "Delete Dataset",
1881
- "description": "Delete Dataset\n\nDelete a dataset. The auth'ed user must be an owner of the organization to delete a dataset.",
1882
- "operationId": "delete_dataset",
1883
- "parameters": [
1884
- {
1885
- "name": "TR-Organization",
1886
- "in": "header",
1887
- "description": "The organization id to use for the request",
1888
- "required": true,
1889
- "schema": {
1890
- "type": "string"
1891
- }
1892
- }
1893
- ],
1894
- "requestBody": {
1895
- "description": "JSON request payload to delete a dataset",
1896
- "content": {
1897
- "application/json": {
1898
- "schema": {
1899
- "$ref": "#/components/schemas/DeleteDatasetRequest"
1900
- }
1901
- }
1902
- },
1903
- "required": true
1904
- },
1905
- "responses": {
1906
- "204": {
1907
- "description": "Dataset deleted successfully"
1908
- },
1909
- "400": {
1910
- "description": "Service error relating to deleting the dataset",
1911
- "content": {
1912
- "application/json": {
1913
- "schema": {
1914
- "$ref": "#/components/schemas/ErrorResponseBody"
1915
- }
1916
- }
1917
- }
1918
- }
1919
- },
1920
- "security": [
1921
- {
1922
- "ApiKey": [
1923
- "owner"
1924
- ]
1925
- }
1926
- ]
1927
1887
  }
1928
1888
  },
1929
1889
  "/api/dataset/envs": {
@@ -2250,6 +2210,57 @@
2250
2210
  ]
2251
2211
  }
2252
2212
  ]
2213
+ },
2214
+ "delete": {
2215
+ "tags": [
2216
+ "dataset"
2217
+ ],
2218
+ "summary": "Delete Dataset",
2219
+ "description": "Delete Dataset\n\nDelete a dataset. The auth'ed user must be an owner of the organization to delete a dataset.",
2220
+ "operationId": "delete_dataset",
2221
+ "parameters": [
2222
+ {
2223
+ "name": "TR-Organization",
2224
+ "in": "header",
2225
+ "description": "The organization id to use for the request",
2226
+ "required": true,
2227
+ "schema": {
2228
+ "type": "string"
2229
+ }
2230
+ },
2231
+ {
2232
+ "name": "dataset_id",
2233
+ "in": "path",
2234
+ "description": "The id of the dataset you want to delete.",
2235
+ "required": true,
2236
+ "schema": {
2237
+ "type": "string",
2238
+ "format": "uuid"
2239
+ }
2240
+ }
2241
+ ],
2242
+ "responses": {
2243
+ "204": {
2244
+ "description": "Dataset deleted successfully"
2245
+ },
2246
+ "400": {
2247
+ "description": "Service error relating to deleting the dataset",
2248
+ "content": {
2249
+ "application/json": {
2250
+ "schema": {
2251
+ "$ref": "#/components/schemas/ErrorResponseBody"
2252
+ }
2253
+ }
2254
+ }
2255
+ }
2256
+ },
2257
+ "security": [
2258
+ {
2259
+ "ApiKey": [
2260
+ "owner"
2261
+ ]
2262
+ }
2263
+ ]
2253
2264
  }
2254
2265
  },
2255
2266
  "/api/events": {
@@ -3467,15 +3478,27 @@
3467
3478
  ]
3468
3479
  }
3469
3480
  ]
3470
- },
3471
- "delete": {
3481
+ }
3482
+ },
3483
+ "/api/topic/user/{user_id}": {
3484
+ "get": {
3472
3485
  "tags": [
3473
3486
  "topic"
3474
3487
  ],
3475
- "summary": "Delete Topic",
3476
- "description": "Delete Topic\n\nDelete an existing chat topic. When a topic is deleted, all associated chat messages are also deleted.",
3477
- "operationId": "delete_topic",
3488
+ "summary": "Get All Topics for User",
3489
+ "description": "Get All Topics for User\n\nGet all topics belonging to a the auth'ed user. Soon, we plan to allow specification of the user for this route and include pagination.",
3490
+ "operationId": "get_all_topics_for_user",
3478
3491
  "parameters": [
3492
+ {
3493
+ "name": "user_id",
3494
+ "in": "path",
3495
+ "description": "The id of the user to get topics for",
3496
+ "required": true,
3497
+ "schema": {
3498
+ "type": "string",
3499
+ "format": "uuid"
3500
+ }
3501
+ },
3479
3502
  {
3480
3503
  "name": "TR-Dataset",
3481
3504
  "in": "header",
@@ -3486,23 +3509,22 @@
3486
3509
  }
3487
3510
  }
3488
3511
  ],
3489
- "requestBody": {
3490
- "description": "JSON request payload to delete a chat topic",
3491
- "content": {
3492
- "application/json": {
3493
- "schema": {
3494
- "$ref": "#/components/schemas/DeleteTopicData"
3512
+ "responses": {
3513
+ "200": {
3514
+ "description": "All topics belonging to a given user",
3515
+ "content": {
3516
+ "application/json": {
3517
+ "schema": {
3518
+ "type": "array",
3519
+ "items": {
3520
+ "$ref": "#/components/schemas/Topic"
3521
+ }
3522
+ }
3495
3523
  }
3496
3524
  }
3497
3525
  },
3498
- "required": true
3499
- },
3500
- "responses": {
3501
- "204": {
3502
- "description": "Confirmation that the topic was deleted"
3503
- },
3504
3526
  "400": {
3505
- "description": "Service error relating to topic deletion",
3527
+ "description": "Service error relating to topic get",
3506
3528
  "content": {
3507
3529
  "application/json": {
3508
3530
  "schema": {
@@ -3521,51 +3543,41 @@
3521
3543
  ]
3522
3544
  }
3523
3545
  },
3524
- "/api/topic/user/{user_id}": {
3525
- "get": {
3546
+ "/api/topic/{topic_id}": {
3547
+ "delete": {
3526
3548
  "tags": [
3527
3549
  "topic"
3528
3550
  ],
3529
- "summary": "Get All Topics for User",
3530
- "description": "Get All Topics for User\n\nGet all topics belonging to a the auth'ed user. Soon, we plan to allow specification of the user for this route and include pagination.",
3531
- "operationId": "get_all_topics_for_user",
3551
+ "summary": "Delete Topic",
3552
+ "description": "Delete Topic\n\nDelete an existing chat topic. When a topic is deleted, all associated chat messages are also deleted.",
3553
+ "operationId": "delete_topic",
3532
3554
  "parameters": [
3533
3555
  {
3534
- "name": "user_id",
3535
- "in": "path",
3536
- "description": "The id of the user to get topics for",
3556
+ "name": "TR-Dataset",
3557
+ "in": "header",
3558
+ "description": "The dataset id to use for the request",
3537
3559
  "required": true,
3538
3560
  "schema": {
3539
- "type": "string",
3540
- "format": "uuid"
3561
+ "type": "string"
3541
3562
  }
3542
3563
  },
3543
3564
  {
3544
- "name": "TR-Dataset",
3545
- "in": "header",
3546
- "description": "The dataset id to use for the request",
3565
+ "name": "topic_id",
3566
+ "in": "path",
3567
+ "description": "The id of the topic you want to delete.",
3547
3568
  "required": true,
3548
3569
  "schema": {
3549
- "type": "string"
3570
+ "type": "string",
3571
+ "format": "uuid"
3550
3572
  }
3551
3573
  }
3552
3574
  ],
3553
3575
  "responses": {
3554
- "200": {
3555
- "description": "All topics belonging to a given user",
3556
- "content": {
3557
- "application/json": {
3558
- "schema": {
3559
- "type": "array",
3560
- "items": {
3561
- "$ref": "#/components/schemas/Topic"
3562
- }
3563
- }
3564
- }
3565
- }
3576
+ "204": {
3577
+ "description": "Confirmation that the topic was deleted"
3566
3578
  },
3567
3579
  "400": {
3568
- "description": "Service error relating to topic get",
3580
+ "description": "Service error relating to topic deletion",
3569
3581
  "content": {
3570
3582
  "application/json": {
3571
3583
  "schema": {
@@ -3634,7 +3646,7 @@
3634
3646
  ]
3635
3647
  }
3636
3648
  },
3637
- "/api/user/delete_api_key": {
3649
+ "/api/user/delete_api_key/{api_key_id}": {
3638
3650
  "delete": {
3639
3651
  "tags": [
3640
3652
  "user"
@@ -3642,17 +3654,18 @@
3642
3654
  "summary": "Delete User Api Key",
3643
3655
  "description": "Delete User Api Key\n\nDelete an api key for the auth'ed user.",
3644
3656
  "operationId": "delete_user_api_key",
3645
- "requestBody": {
3646
- "description": "JSON request payload to delete a user api key",
3647
- "content": {
3648
- "application/json": {
3649
- "schema": {
3650
- "$ref": "#/components/schemas/DeleteUserApiKeyRequest"
3651
- }
3657
+ "parameters": [
3658
+ {
3659
+ "name": "api_key_id",
3660
+ "in": "path",
3661
+ "description": "The id of the api key to delete",
3662
+ "required": true,
3663
+ "schema": {
3664
+ "type": "string",
3665
+ "format": "uuid"
3652
3666
  }
3653
- },
3654
- "required": true
3655
- },
3667
+ }
3668
+ ],
3656
3669
  "responses": {
3657
3670
  "200": {
3658
3671
  "description": "JSON body representing the api_key for the user",
@@ -4103,10 +4116,10 @@
4103
4116
  "value4"
4104
4117
  ],
4105
4118
  "range": {
4106
- "gt": 0.0,
4107
- "gte": 0.0,
4108
- "lt": 1.0,
4109
- "lte": 1.0
4119
+ "gt": 0,
4120
+ "gte": 0,
4121
+ "lt": 1,
4122
+ "lte": 1
4110
4123
  }
4111
4124
  }
4112
4125
  ],
@@ -4118,10 +4131,10 @@
4118
4131
  "value6"
4119
4132
  ],
4120
4133
  "range": {
4121
- "gt": 0.0,
4122
- "gte": 0.0,
4123
- "lt": 1.0,
4124
- "lte": 1.0
4134
+ "gt": 0,
4135
+ "gte": 0,
4136
+ "lt": 1,
4137
+ "lte": 1
4125
4138
  }
4126
4139
  }
4127
4140
  ],
@@ -4133,10 +4146,10 @@
4133
4146
  "value2"
4134
4147
  ],
4135
4148
  "range": {
4136
- "gt": 0.0,
4137
- "gte": 0.0,
4138
- "lt": 1.0,
4139
- "lte": 1.0
4149
+ "gt": 0,
4150
+ "gte": 0,
4151
+ "lt": 1,
4152
+ "lte": 1
4140
4153
  }
4141
4154
  }
4142
4155
  ]
@@ -4832,19 +4845,6 @@
4832
4845
  "id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3"
4833
4846
  }
4834
4847
  },
4835
- "DeleteDatasetRequest": {
4836
- "type": "object",
4837
- "required": [
4838
- "dataset_id"
4839
- ],
4840
- "properties": {
4841
- "dataset_id": {
4842
- "type": "string",
4843
- "format": "uuid",
4844
- "description": "The id of the dataset you want to delete."
4845
- }
4846
- }
4847
- },
4848
4848
  "DeleteTopicData": {
4849
4849
  "type": "object",
4850
4850
  "required": [
@@ -5029,10 +5029,10 @@
5029
5029
  "value2"
5030
5030
  ],
5031
5031
  "range": {
5032
- "gt": 0.0,
5033
- "gte": 0.0,
5034
- "lt": 1.0,
5035
- "lte": 1.0
5032
+ "gt": 0,
5033
+ "gte": 0,
5034
+ "lt": 1,
5035
+ "lte": 1
5036
5036
  }
5037
5037
  }
5038
5038
  },
@@ -5286,16 +5286,85 @@
5286
5286
  "type": "string",
5287
5287
  "format": "uuid"
5288
5288
  },
5289
+ "group_tracking_id": {
5290
+ "type": "string",
5291
+ "nullable": true
5292
+ },
5289
5293
  "metadata": {
5290
5294
  "type": "array",
5291
5295
  "items": {
5292
5296
  "$ref": "#/components/schemas/ScoreChunkDTO"
5293
5297
  }
5294
5298
  }
5295
- }
5296
- },
5297
- "InvitationData": {
5298
- "type": "object",
5299
+ },
5300
+ "example": {
5301
+ "group_id": "e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
5302
+ "metadata": [
5303
+ {
5304
+ "metadata": [
5305
+ {
5306
+ "content": "This is a test content",
5307
+ "id": "e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
5308
+ "link": "https://www.google.com",
5309
+ "metadata": {
5310
+ "key": "value"
5311
+ },
5312
+ "tag_set": "test",
5313
+ "time_stamp": "2021-01-01T00:00:00Z",
5314
+ "tracking_id": "e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
5315
+ "weight": 1
5316
+ }
5317
+ ],
5318
+ "score": 0.5
5319
+ }
5320
+ ]
5321
+ }
5322
+ },
5323
+ "GroupSlimChunksDTO": {
5324
+ "type": "object",
5325
+ "required": [
5326
+ "group_id",
5327
+ "metadata"
5328
+ ],
5329
+ "properties": {
5330
+ "group_id": {
5331
+ "type": "string",
5332
+ "format": "uuid"
5333
+ },
5334
+ "metadata": {
5335
+ "type": "array",
5336
+ "items": {
5337
+ "$ref": "#/components/schemas/ScoreSlimChunks"
5338
+ }
5339
+ }
5340
+ },
5341
+ "example": {
5342
+ "group_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
5343
+ "metadata": [
5344
+ {
5345
+ "metadata": [
5346
+ {
5347
+ "created_at": "2021-01-01T00:00:00",
5348
+ "id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
5349
+ "link": "https://trieve.ai",
5350
+ "metadata": {
5351
+ "key": "value"
5352
+ },
5353
+ "qdrant_point_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
5354
+ "tag_set": "tag1,tag2",
5355
+ "time_stamp": "2021-01-01T00:00:00",
5356
+ "tracking_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
5357
+ "updated_at": "2021-01-01T00:00:00",
5358
+ "weight": 0.5
5359
+ }
5360
+ ],
5361
+ "score": 0.5
5362
+ }
5363
+ ]
5364
+ }
5365
+ },
5366
+ "InvitationData": {
5367
+ "type": "object",
5299
5368
  "required": [
5300
5369
  "organization_id",
5301
5370
  "user_role",
@@ -5497,33 +5566,56 @@
5497
5566
  "type": "object",
5498
5567
  "properties": {
5499
5568
  "gt": {
5500
- "type": "number",
5501
- "format": "double",
5569
+ "allOf": [
5570
+ {
5571
+ "$ref": "#/components/schemas/RangeCondition"
5572
+ }
5573
+ ],
5502
5574
  "nullable": true
5503
5575
  },
5504
5576
  "gte": {
5505
- "type": "number",
5506
- "format": "double",
5577
+ "allOf": [
5578
+ {
5579
+ "$ref": "#/components/schemas/RangeCondition"
5580
+ }
5581
+ ],
5507
5582
  "nullable": true
5508
5583
  },
5509
5584
  "lt": {
5510
- "type": "number",
5511
- "format": "double",
5585
+ "allOf": [
5586
+ {
5587
+ "$ref": "#/components/schemas/RangeCondition"
5588
+ }
5589
+ ],
5512
5590
  "nullable": true
5513
5591
  },
5514
5592
  "lte": {
5515
- "type": "number",
5516
- "format": "double",
5593
+ "allOf": [
5594
+ {
5595
+ "$ref": "#/components/schemas/RangeCondition"
5596
+ }
5597
+ ],
5517
5598
  "nullable": true
5518
5599
  }
5519
5600
  },
5520
5601
  "example": {
5521
- "gt": 0.0,
5522
- "gte": 0.0,
5523
- "lt": 1.0,
5524
- "lte": 1.0
5602
+ "gt": 0,
5603
+ "gte": 0,
5604
+ "lt": 1,
5605
+ "lte": 1
5525
5606
  }
5526
5607
  },
5608
+ "RangeCondition": {
5609
+ "oneOf": [
5610
+ {
5611
+ "type": "string"
5612
+ },
5613
+ {
5614
+ "type": "number",
5615
+ "format": "double"
5616
+ }
5617
+ ]
5618
+ },
5527
5619
  "ReccomendGroupChunksRequest": {
5528
5620
  "type": "object",
5529
5621
  "properties": {
@@ -5582,6 +5674,11 @@
5582
5674
  },
5583
5675
  "description": "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.",
5584
5676
  "nullable": true
5677
+ },
5678
+ "slim_chunks": {
5679
+ "type": "boolean",
5680
+ "description": "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.",
5681
+ "nullable": true
5585
5682
  }
5586
5683
  }
5587
5684
  },
@@ -5636,9 +5733,127 @@
5636
5733
  },
5637
5734
  "description": "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.",
5638
5735
  "nullable": true
5736
+ },
5737
+ "slim_chunks": {
5738
+ "type": "boolean",
5739
+ "description": "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.",
5740
+ "nullable": true
5639
5741
  }
5640
5742
  }
5641
5743
  },
5744
+ "RecommendChunksResponseTypes": {
5745
+ "oneOf": [
5746
+ {
5747
+ "type": "array",
5748
+ "items": {
5749
+ "$ref": "#/components/schemas/ChunkMetadata"
5750
+ },
5751
+ "example": [
5752
+ {
5753
+ "chunk_html": "<p>Hello, world!</p>",
5754
+ "content": "Hello, world!",
5755
+ "created_at": "2021-01-01T00:00:00",
5756
+ "dataset_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
5757
+ "id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
5758
+ "link": "https://trieve.ai",
5759
+ "metadata": {
5760
+ "key": "value"
5761
+ },
5762
+ "qdrant_point_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
5763
+ "tag_set": "tag1,tag2",
5764
+ "time_stamp": "2021-01-01T00:00:00",
5765
+ "tracking_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
5766
+ "updated_at": "2021-01-01T00:00:00",
5767
+ "weight": 0.5
5768
+ }
5769
+ ]
5770
+ },
5771
+ {
5772
+ "type": "array",
5773
+ "items": {
5774
+ "$ref": "#/components/schemas/SlimChunkMetadata"
5775
+ },
5776
+ "example": [
5777
+ {
5778
+ "created_at": "2021-01-01T00:00:00",
5779
+ "dataset_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
5780
+ "id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
5781
+ "link": "https://trieve.ai",
5782
+ "metadata": {
5783
+ "key": "value"
5784
+ },
5785
+ "qdrant_point_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
5786
+ "tag_set": "tag1,tag2",
5787
+ "time_stamp": "2021-01-01T00:00:00",
5788
+ "tracking_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
5789
+ "updated_at": "2021-01-01T00:00:00",
5790
+ "weight": 0.5
5791
+ }
5792
+ ]
5793
+ }
5794
+ ]
5795
+ },
5796
+ "RecommendGroupChunkResponseTypes": {
5797
+ "oneOf": [
5798
+ {
5799
+ "type": "array",
5800
+ "items": {
5801
+ "$ref": "#/components/schemas/GroupSlimChunksDTO"
5802
+ },
5803
+ "example": [
5804
+ {
5805
+ "group_id": "e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
5806
+ "metadata": [
5807
+ {
5808
+ "metadata": [
5809
+ {
5810
+ "content": "This is a test content",
5811
+ "id": "e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
5812
+ "link": "https://www.google.com",
5813
+ "metadata": {
5814
+ "key": "value"
5815
+ },
5816
+ "tag_set": "test",
5817
+ "time_stamp": "2021-01-01T00:00:00Z",
5818
+ "tracking_id": "e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
5819
+ "weight": 1
5820
+ }
5821
+ ],
5822
+ "score": 0.5
5823
+ }
5824
+ ]
5825
+ }
5826
+ ]
5827
+ },
5828
+ {
5829
+ "type": "array",
5830
+ "items": {
5831
+ "$ref": "#/components/schemas/GroupScoreChunkDTO"
5832
+ },
5833
+ "example": {
5834
+ "group_id": "e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
5835
+ "metadata": [
5836
+ {
5837
+ "metadata": [
5838
+ {
5839
+ "id": "e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
5840
+ "link": "https://www.google.com",
5841
+ "metadata": {
5842
+ "key": "value"
5843
+ },
5844
+ "tag_set": "test",
5845
+ "time_stamp": "2021-01-01T00:00:00Z",
5846
+ "tracking_id": "e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
5847
+ "weight": 1
5848
+ }
5849
+ ],
5850
+ "score": 0.5
5851
+ }
5852
+ ]
5853
+ }
5854
+ }
5855
+ ]
5856
+ },
5642
5857
  "RegenerateMessageData": {
5643
5858
  "type": "object",
5644
5859
  "required": [
@@ -5721,6 +5936,44 @@
5721
5936
  "score": 0.5
5722
5937
  }
5723
5938
  },
5939
+ "ScoreSlimChunks": {
5940
+ "type": "object",
5941
+ "required": [
5942
+ "metadata",
5943
+ "score"
5944
+ ],
5945
+ "properties": {
5946
+ "metadata": {
5947
+ "type": "array",
5948
+ "items": {
5949
+ "$ref": "#/components/schemas/SlimChunkMetadata"
5950
+ }
5951
+ },
5952
+ "score": {
5953
+ "type": "number",
5954
+ "format": "double"
5955
+ }
5956
+ },
5957
+ "example": {
5958
+ "metadata": [
5959
+ {
5960
+ "created_at": "2021-01-01T00:00:00",
5961
+ "id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
5962
+ "link": "https://trieve.ai",
5963
+ "metadata": {
5964
+ "key": "value"
5965
+ },
5966
+ "qdrant_point_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
5967
+ "tag_set": "tag1,tag2",
5968
+ "time_stamp": "2021-01-01T00:00:00",
5969
+ "tracking_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
5970
+ "updated_at": "2021-01-01T00:00:00",
5971
+ "weight": 0.5
5972
+ }
5973
+ ],
5974
+ "score": 0.5
5975
+ }
5976
+ },
5724
5977
  "SearchChunkData": {
5725
5978
  "type": "object",
5726
5979
  "required": [
@@ -5777,6 +6030,11 @@
5777
6030
  "type": "string",
5778
6031
  "description": "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."
5779
6032
  },
6033
+ "quote_negated_words": {
6034
+ "type": "boolean",
6035
+ "description": "Turn on quote words and negated words to search for exact phrases and exclude words from the search results. Default is false.",
6036
+ "nullable": true
6037
+ },
5780
6038
  "score_threshold": {
5781
6039
  "type": "number",
5782
6040
  "format": "float",
@@ -5787,6 +6045,11 @@
5787
6045
  "type": "string",
5788
6046
  "description": "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."
5789
6047
  },
6048
+ "slim_chunks": {
6049
+ "type": "boolean",
6050
+ "description": "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.",
6051
+ "nullable": true
6052
+ },
5790
6053
  "use_weights": {
5791
6054
  "type": "boolean",
5792
6055
  "description": "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.",
@@ -5804,10 +6067,10 @@
5804
6067
  "value4"
5805
6068
  ],
5806
6069
  "range": {
5807
- "gt": 0.0,
5808
- "gte": 0.0,
5809
- "lt": 1.0,
5810
- "lte": 1.0
6070
+ "gt": 0,
6071
+ "gte": 0,
6072
+ "lt": 1,
6073
+ "lte": 1
5811
6074
  }
5812
6075
  }
5813
6076
  ],
@@ -5819,10 +6082,10 @@
5819
6082
  "value6"
5820
6083
  ],
5821
6084
  "range": {
5822
- "gt": 0.0,
5823
- "gte": 0.0,
5824
- "lt": 1.0,
5825
- "lte": 1.0
6085
+ "gt": 0,
6086
+ "gte": 0,
6087
+ "lt": 1,
6088
+ "lte": 1
5826
6089
  }
5827
6090
  }
5828
6091
  ],
@@ -5834,10 +6097,10 @@
5834
6097
  "value2"
5835
6098
  ],
5836
6099
  "range": {
5837
- "gt": 0.0,
5838
- "gte": 0.0,
5839
- "lt": 1.0,
5840
- "lte": 1.0
6100
+ "gt": 0,
6101
+ "gte": 0,
6102
+ "lt": 1,
6103
+ "lte": 1
5841
6104
  }
5842
6105
  }
5843
6106
  ]
@@ -5877,6 +6140,39 @@
5877
6140
  }
5878
6141
  }
5879
6142
  },
6143
+ "SearchChunkResponseTypes": {
6144
+ "oneOf": [
6145
+ {
6146
+ "$ref": "#/components/schemas/SearchSlimChunkQueryResponseBody"
6147
+ },
6148
+ {
6149
+ "$ref": "#/components/schemas/SearchChunkQueryResponseBody"
6150
+ }
6151
+ ]
6152
+ },
6153
+ "SearchGroupSlimChunksResult": {
6154
+ "type": "object",
6155
+ "required": [
6156
+ "bookmarks",
6157
+ "group",
6158
+ "total_pages"
6159
+ ],
6160
+ "properties": {
6161
+ "bookmarks": {
6162
+ "type": "array",
6163
+ "items": {
6164
+ "$ref": "#/components/schemas/ScoreSlimChunks"
6165
+ }
6166
+ },
6167
+ "group": {
6168
+ "$ref": "#/components/schemas/ChunkGroup"
6169
+ },
6170
+ "total_pages": {
6171
+ "type": "integer",
6172
+ "format": "int64"
6173
+ }
6174
+ }
6175
+ },
5880
6176
  "SearchGroupsResult": {
5881
6177
  "type": "object",
5882
6178
  "required": [
@@ -5957,6 +6253,11 @@
5957
6253
  "type": "string",
5958
6254
  "description": "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."
5959
6255
  },
6256
+ "quote_negated_words": {
6257
+ "type": "boolean",
6258
+ "description": "Turn on quote words and negated words to search for exact phrases and exclude words from the search results. Default is false.",
6259
+ "nullable": true
6260
+ },
5960
6261
  "score_threshold": {
5961
6262
  "type": "number",
5962
6263
  "format": "float",
@@ -5966,6 +6267,11 @@
5966
6267
  "search_type": {
5967
6268
  "type": "string",
5968
6269
  "description": "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."
6270
+ },
6271
+ "slim_chunks": {
6272
+ "type": "boolean",
6273
+ "description": "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.",
6274
+ "nullable": true
5969
6275
  }
5970
6276
  }
5971
6277
  },
@@ -5988,6 +6294,54 @@
5988
6294
  }
5989
6295
  }
5990
6296
  },
6297
+ "SearchOverGroupsResponseTypes": {
6298
+ "oneOf": [
6299
+ {
6300
+ "$ref": "#/components/schemas/SearchOverGroupsResponseBody"
6301
+ },
6302
+ {
6303
+ "$ref": "#/components/schemas/SearchOverGroupsSlimChunksResponseBody"
6304
+ }
6305
+ ]
6306
+ },
6307
+ "SearchOverGroupsSlimChunksResponseBody": {
6308
+ "type": "object",
6309
+ "required": [
6310
+ "group_chunks",
6311
+ "total_chunk_pages"
6312
+ ],
6313
+ "properties": {
6314
+ "group_chunks": {
6315
+ "type": "array",
6316
+ "items": {
6317
+ "$ref": "#/components/schemas/GroupSlimChunksDTO"
6318
+ }
6319
+ },
6320
+ "total_chunk_pages": {
6321
+ "type": "integer",
6322
+ "format": "int64"
6323
+ }
6324
+ }
6325
+ },
6326
+ "SearchSlimChunkQueryResponseBody": {
6327
+ "type": "object",
6328
+ "required": [
6329
+ "score_chunks",
6330
+ "total_chunk_pages"
6331
+ ],
6332
+ "properties": {
6333
+ "score_chunks": {
6334
+ "type": "array",
6335
+ "items": {
6336
+ "$ref": "#/components/schemas/ScoreSlimChunks"
6337
+ }
6338
+ },
6339
+ "total_chunk_pages": {
6340
+ "type": "integer",
6341
+ "format": "int64"
6342
+ }
6343
+ }
6344
+ },
5991
6345
  "SearchWithinGroupData": {
5992
6346
  "type": "object",
5993
6347
  "required": [
@@ -6050,6 +6404,11 @@
6050
6404
  "type": "string",
6051
6405
  "description": "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."
6052
6406
  },
6407
+ "quote_negated_words": {
6408
+ "type": "boolean",
6409
+ "description": "Turn on quote words and negated words to search for exact phrases and exclude words from the search results. Default is false.",
6410
+ "nullable": true
6411
+ },
6053
6412
  "score_threshold": {
6054
6413
  "type": "number",
6055
6414
  "format": "float",
@@ -6060,6 +6419,11 @@
6060
6419
  "type": "string",
6061
6420
  "description": "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."
6062
6421
  },
6422
+ "slim_chunks": {
6423
+ "type": "boolean",
6424
+ "description": "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.",
6425
+ "nullable": true
6426
+ },
6063
6427
  "use_weights": {
6064
6428
  "type": "boolean",
6065
6429
  "description": "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.",
@@ -6067,6 +6431,16 @@
6067
6431
  }
6068
6432
  }
6069
6433
  },
6434
+ "SearchWithinGroupResponseTypes": {
6435
+ "oneOf": [
6436
+ {
6437
+ "$ref": "#/components/schemas/SearchGroupsResult"
6438
+ },
6439
+ {
6440
+ "$ref": "#/components/schemas/SearchGroupSlimChunksResult"
6441
+ }
6442
+ ]
6443
+ },
6070
6444
  "SetUserApiKeyRequest": {
6071
6445
  "type": "object",
6072
6446
  "required": [
@@ -6140,6 +6514,73 @@
6140
6514
  "pos_in_queue": 1
6141
6515
  }
6142
6516
  },
6517
+ "SlimChunkMetadata": {
6518
+ "type": "object",
6519
+ "required": [
6520
+ "id",
6521
+ "created_at",
6522
+ "updated_at",
6523
+ "weight"
6524
+ ],
6525
+ "properties": {
6526
+ "created_at": {
6527
+ "type": "string",
6528
+ "format": "date-time"
6529
+ },
6530
+ "id": {
6531
+ "type": "string",
6532
+ "format": "uuid"
6533
+ },
6534
+ "link": {
6535
+ "type": "string",
6536
+ "nullable": true
6537
+ },
6538
+ "metadata": {
6539
+ "nullable": true
6540
+ },
6541
+ "qdrant_point_id": {
6542
+ "type": "string",
6543
+ "format": "uuid",
6544
+ "nullable": true
6545
+ },
6546
+ "tag_set": {
6547
+ "type": "string",
6548
+ "nullable": true
6549
+ },
6550
+ "time_stamp": {
6551
+ "type": "string",
6552
+ "format": "date-time",
6553
+ "nullable": true
6554
+ },
6555
+ "tracking_id": {
6556
+ "type": "string",
6557
+ "nullable": true
6558
+ },
6559
+ "updated_at": {
6560
+ "type": "string",
6561
+ "format": "date-time"
6562
+ },
6563
+ "weight": {
6564
+ "type": "number",
6565
+ "format": "double"
6566
+ }
6567
+ },
6568
+ "example": {
6569
+ "created_at": "2021-01-01T00:00:00",
6570
+ "dataset_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
6571
+ "id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
6572
+ "link": "https://trieve.ai",
6573
+ "metadata": {
6574
+ "key": "value"
6575
+ },
6576
+ "qdrant_point_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
6577
+ "tag_set": "tag1,tag2",
6578
+ "time_stamp": "2021-01-01T00:00:00",
6579
+ "tracking_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
6580
+ "updated_at": "2021-01-01T00:00:00",
6581
+ "weight": 0.5
6582
+ }
6583
+ },
6143
6584
  "SlimGroup": {
6144
6585
  "type": "object",
6145
6586
  "required": [
@@ -6176,7 +6617,6 @@
6176
6617
  "required": [
6177
6618
  "id",
6178
6619
  "email",
6179
- "visible_email",
6180
6620
  "user_orgs",
6181
6621
  "orgs"
6182
6622
  ],
@@ -6203,17 +6643,6 @@
6203
6643
  "items": {
6204
6644
  "$ref": "#/components/schemas/UserOrganization"
6205
6645
  }
6206
- },
6207
- "username": {
6208
- "type": "string",
6209
- "nullable": true
6210
- },
6211
- "visible_email": {
6212
- "type": "boolean"
6213
- },
6214
- "website": {
6215
- "type": "string",
6216
- "nullable": true
6217
6646
  }
6218
6647
  },
6219
6648
  "example": {
@@ -6238,10 +6667,7 @@
6238
6667
  "updated_at": "2021-01-01T00:00:00",
6239
6668
  "user_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3"
6240
6669
  }
6241
- ],
6242
- "username": "trieve",
6243
- "visible_email": true,
6244
- "website": "https://trieve.ai"
6670
+ ]
6245
6671
  }
6246
6672
  },
6247
6673
  "StripePlan": {
@@ -6486,6 +6912,14 @@
6486
6912
  "description": "The metadata is a JSON object which can be used to filter chunks. This is useful for when you want to filter chunks by arbitrary metadata. Unlike with tag filtering, there is a performance hit for filtering on metadata. If no metadata is provided, the existing metadata will be used.",
6487
6913
  "nullable": true
6488
6914
  },
6915
+ "tag_set": {
6916
+ "type": "array",
6917
+ "items": {
6918
+ "type": "string"
6919
+ },
6920
+ "description": "Tag set is a list of tags. This can be used to filter chunks by tag. Unlike with metadata filtering, HNSW indices will exist for each tag such that there is not a performance hit for filtering on them. If no tag_set is provided, the existing tag_set will be used.",
6921
+ "nullable": true
6922
+ },
6489
6923
  "time_stamp": {
6490
6924
  "type": "string",
6491
6925
  "description": "Time_stamp should be an ISO 8601 combined date and time without timezone. It is used for time window filtering and recency-biasing search results. If no time_stamp is provided, the existing time_stamp will be used.",
@@ -6661,21 +7095,6 @@
6661
7095
  "format": "uuid",
6662
7096
  "description": "The id of the user to update, if not provided, the auth'ed user will be updated. If provided, the auth'ed user must be an admin (1) or owner (2) of the organization.",
6663
7097
  "nullable": true
6664
- },
6665
- "username": {
6666
- "type": "string",
6667
- "description": "The new username to assign to the user, if not provided, the current username will be used.",
6668
- "nullable": true
6669
- },
6670
- "visible_email": {
6671
- "type": "boolean",
6672
- "description": "Determines if the user's email is visible to other users, if not provided, the current value will be used.",
6673
- "nullable": true
6674
- },
6675
- "website": {
6676
- "type": "string",
6677
- "description": "The new website to assign to the user, if not provided, the current website will be used. Used for linking to the user's personal or company website.",
6678
- "nullable": true
6679
7098
  }
6680
7099
  }
6681
7100
  },
@@ -6869,4 +7288,4 @@
6869
7288
  "description": "Health check endpoint. Used to check if the server is up and running."
6870
7289
  }
6871
7290
  ]
6872
- }
7291
+ }