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
@@ -0,0 +1,49 @@
1
+ # TrieveRubyClient::RecommendChunksResponseTypes
2
+
3
+ ## Class instance methods
4
+
5
+ ### `openapi_one_of`
6
+
7
+ Returns the list of classes defined in oneOf.
8
+
9
+ #### Example
10
+
11
+ ```ruby
12
+ require 'trieve_ruby_client'
13
+
14
+ TrieveRubyClient::RecommendChunksResponseTypes.openapi_one_of
15
+ # =>
16
+ # [
17
+ # :'Array<ChunkMetadata>',
18
+ # :'Array<SlimChunkMetadata>'
19
+ # ]
20
+ ```
21
+
22
+ ### build
23
+
24
+ Find the appropriate object from the `openapi_one_of` list and casts the data into it.
25
+
26
+ #### Example
27
+
28
+ ```ruby
29
+ require 'trieve_ruby_client'
30
+
31
+ TrieveRubyClient::RecommendChunksResponseTypes.build(data)
32
+ # => #<Array<ChunkMetadata>:0x00007fdd4aab02a0>
33
+
34
+ TrieveRubyClient::RecommendChunksResponseTypes.build(data_that_doesnt_match)
35
+ # => nil
36
+ ```
37
+
38
+ #### Parameters
39
+
40
+ | Name | Type | Description |
41
+ | ---- | ---- | ----------- |
42
+ | **data** | **Mixed** | data to be matched against the list of oneOf items |
43
+
44
+ #### Return type
45
+
46
+ - `Array<ChunkMetadata>`
47
+ - `Array<SlimChunkMetadata>`
48
+ - `nil` (if no type matches)
49
+
@@ -0,0 +1,49 @@
1
+ # TrieveRubyClient::RecommendGroupChunkResponseTypes
2
+
3
+ ## Class instance methods
4
+
5
+ ### `openapi_one_of`
6
+
7
+ Returns the list of classes defined in oneOf.
8
+
9
+ #### Example
10
+
11
+ ```ruby
12
+ require 'trieve_ruby_client'
13
+
14
+ TrieveRubyClient::RecommendGroupChunkResponseTypes.openapi_one_of
15
+ # =>
16
+ # [
17
+ # :'Array<GroupScoreChunkDTO>',
18
+ # :'Array<GroupSlimChunksDTO>'
19
+ # ]
20
+ ```
21
+
22
+ ### build
23
+
24
+ Find the appropriate object from the `openapi_one_of` list and casts the data into it.
25
+
26
+ #### Example
27
+
28
+ ```ruby
29
+ require 'trieve_ruby_client'
30
+
31
+ TrieveRubyClient::RecommendGroupChunkResponseTypes.build(data)
32
+ # => #<Array<GroupScoreChunkDTO>:0x00007fdd4aab02a0>
33
+
34
+ TrieveRubyClient::RecommendGroupChunkResponseTypes.build(data_that_doesnt_match)
35
+ # => nil
36
+ ```
37
+
38
+ #### Parameters
39
+
40
+ | Name | Type | Description |
41
+ | ---- | ---- | ----------- |
42
+ | **data** | **Mixed** | data to be matched against the list of oneOf items |
43
+
44
+ #### Return type
45
+
46
+ - `Array<GroupScoreChunkDTO>`
47
+ - `Array<GroupSlimChunksDTO>`
48
+ - `nil` (if no type matches)
49
+
@@ -0,0 +1,20 @@
1
+ # TrieveRubyClient::ScoreSlimChunks
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **metadata** | [**Array&lt;SlimChunkMetadata&gt;**](SlimChunkMetadata.md) | | |
8
+ | **score** | **Float** | | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'trieve_ruby_client'
14
+
15
+ instance = TrieveRubyClient::ScoreSlimChunks.new(
16
+ metadata: null,
17
+ score: null
18
+ )
19
+ ```
20
+
@@ -12,8 +12,10 @@
12
12
  | **page** | **Integer** | Page of chunks to fetch. Each page is 10 chunks. Support for custom page size is coming soon. | [optional] |
13
13
  | **page_size** | **Integer** | Page size is the number of chunks to fetch. This can be used to fetch more than 10 chunks at a time. | [optional] |
14
14
  | **query** | **String** | Query is the search query. This can be any string. The query will be used to create an embedding vector and/or SPLADE vector which will be used to find the result set. | |
15
+ | **quote_negated_words** | **Boolean** | Turn on quote words and negated words to search for exact phrases and exclude words from the search results. Default is false. | [optional] |
15
16
  | **score_threshold** | **Float** | Set score_threshold to a float to filter out chunks with a score below the threshold. | [optional] |
16
17
  | **search_type** | **String** | Can be either \&quot;semantic\&quot;, \&quot;fulltext\&quot;, or \&quot;hybrid\&quot;. \&quot;hybrid\&quot; will pull in one page (10 chunks) of both semantic and full-text results then re-rank them using BAAI/bge-reranker-large. \&quot;semantic\&quot; will pull in one page (10 chunks) of the nearest cosine distant vectors. \&quot;fulltext\&quot; will pull in one page (10 chunks) of full-text results based on SPLADE. | |
18
+ | **slim_chunks** | **Boolean** | Set slim_chunks to true to avoid returning the content and chunk_html of the chunks. This is useful for when you want to reduce amount of data over the wire for latency improvement. Default is false. | [optional] |
17
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] |
18
20
 
19
21
  ## Example
@@ -30,8 +32,10 @@ instance = TrieveRubyClient::SearchChunkData.new(
30
32
  page: null,
31
33
  page_size: null,
32
34
  query: null,
35
+ quote_negated_words: null,
33
36
  score_threshold: null,
34
37
  search_type: null,
38
+ slim_chunks: null,
35
39
  use_weights: null
36
40
  )
37
41
  ```
@@ -0,0 +1,49 @@
1
+ # TrieveRubyClient::SearchChunkResponseTypes
2
+
3
+ ## Class instance methods
4
+
5
+ ### `openapi_one_of`
6
+
7
+ Returns the list of classes defined in oneOf.
8
+
9
+ #### Example
10
+
11
+ ```ruby
12
+ require 'trieve_ruby_client'
13
+
14
+ TrieveRubyClient::SearchChunkResponseTypes.openapi_one_of
15
+ # =>
16
+ # [
17
+ # :'SearchChunkQueryResponseBody',
18
+ # :'SearchSlimChunkQueryResponseBody'
19
+ # ]
20
+ ```
21
+
22
+ ### build
23
+
24
+ Find the appropriate object from the `openapi_one_of` list and casts the data into it.
25
+
26
+ #### Example
27
+
28
+ ```ruby
29
+ require 'trieve_ruby_client'
30
+
31
+ TrieveRubyClient::SearchChunkResponseTypes.build(data)
32
+ # => #<SearchChunkQueryResponseBody:0x00007fdd4aab02a0>
33
+
34
+ TrieveRubyClient::SearchChunkResponseTypes.build(data_that_doesnt_match)
35
+ # => nil
36
+ ```
37
+
38
+ #### Parameters
39
+
40
+ | Name | Type | Description |
41
+ | ---- | ---- | ----------- |
42
+ | **data** | **Mixed** | data to be matched against the list of oneOf items |
43
+
44
+ #### Return type
45
+
46
+ - `SearchChunkQueryResponseBody`
47
+ - `SearchSlimChunkQueryResponseBody`
48
+ - `nil` (if no type matches)
49
+
@@ -0,0 +1,22 @@
1
+ # TrieveRubyClient::SearchGroupSlimChunksResult
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **bookmarks** | [**Array&lt;ScoreSlimChunks&gt;**](ScoreSlimChunks.md) | | |
8
+ | **group** | [**ChunkGroup**](ChunkGroup.md) | | |
9
+ | **total_pages** | **Integer** | | |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'trieve_ruby_client'
15
+
16
+ instance = TrieveRubyClient::SearchGroupSlimChunksResult.new(
17
+ bookmarks: null,
18
+ group: null,
19
+ total_pages: null
20
+ )
21
+ ```
22
+
@@ -12,8 +12,10 @@
12
12
  | **page** | **Integer** | Page of chunks to fetch. Each page is 10 chunks. Support for custom page size is coming soon. | [optional] |
13
13
  | **page_size** | **Integer** | Page size is the number of chunks to fetch. This can be used to fetch more than 10 chunks at a time. | [optional] |
14
14
  | **query** | **String** | Query is the search query. This can be any string. The query will be used to create an embedding vector and/or SPLADE vector which will be used to find the result set. | |
15
+ | **quote_negated_words** | **Boolean** | Turn on quote words and negated words to search for exact phrases and exclude words from the search results. Default is false. | [optional] |
15
16
  | **score_threshold** | **Float** | Set score_threshold to a float to filter out chunks with a score below the threshold. | [optional] |
16
17
  | **search_type** | **String** | Can be either \&quot;semantic\&quot;, \&quot;fulltext\&quot;, or \&quot;hybrid\&quot;. \&quot;hybrid\&quot; will pull in one page (10 chunks) of both semantic and full-text results then re-rank them using BAAI/bge-reranker-large. \&quot;semantic\&quot; will pull in one page (10 chunks) of the nearest cosine distant vectors. \&quot;fulltext\&quot; will pull in one page (10 chunks) of full-text results based on SPLADE. | |
18
+ | **slim_chunks** | **Boolean** | Set slim_chunks to true to avoid returning the content and chunk_html of the chunks. This is useful for when you want to reduce amount of data over the wire for latency improvement. Default is false. | [optional] |
17
19
 
18
20
  ## Example
19
21
 
@@ -29,8 +31,10 @@ instance = TrieveRubyClient::SearchOverGroupsData.new(
29
31
  page: null,
30
32
  page_size: null,
31
33
  query: null,
34
+ quote_negated_words: null,
32
35
  score_threshold: null,
33
- search_type: null
36
+ search_type: null,
37
+ slim_chunks: null
34
38
  )
35
39
  ```
36
40
 
@@ -0,0 +1,49 @@
1
+ # TrieveRubyClient::SearchOverGroupsResponseTypes
2
+
3
+ ## Class instance methods
4
+
5
+ ### `openapi_one_of`
6
+
7
+ Returns the list of classes defined in oneOf.
8
+
9
+ #### Example
10
+
11
+ ```ruby
12
+ require 'trieve_ruby_client'
13
+
14
+ TrieveRubyClient::SearchOverGroupsResponseTypes.openapi_one_of
15
+ # =>
16
+ # [
17
+ # :'SearchOverGroupsResponseBody',
18
+ # :'SearchOverGroupsSlimChunksResponseBody'
19
+ # ]
20
+ ```
21
+
22
+ ### build
23
+
24
+ Find the appropriate object from the `openapi_one_of` list and casts the data into it.
25
+
26
+ #### Example
27
+
28
+ ```ruby
29
+ require 'trieve_ruby_client'
30
+
31
+ TrieveRubyClient::SearchOverGroupsResponseTypes.build(data)
32
+ # => #<SearchOverGroupsResponseBody:0x00007fdd4aab02a0>
33
+
34
+ TrieveRubyClient::SearchOverGroupsResponseTypes.build(data_that_doesnt_match)
35
+ # => nil
36
+ ```
37
+
38
+ #### Parameters
39
+
40
+ | Name | Type | Description |
41
+ | ---- | ---- | ----------- |
42
+ | **data** | **Mixed** | data to be matched against the list of oneOf items |
43
+
44
+ #### Return type
45
+
46
+ - `SearchOverGroupsResponseBody`
47
+ - `SearchOverGroupsSlimChunksResponseBody`
48
+ - `nil` (if no type matches)
49
+
@@ -0,0 +1,20 @@
1
+ # TrieveRubyClient::SearchOverGroupsSlimChunksResponseBody
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **group_chunks** | [**Array&lt;GroupSlimChunksDTO&gt;**](GroupSlimChunksDTO.md) | | |
8
+ | **total_chunk_pages** | **Integer** | | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'trieve_ruby_client'
14
+
15
+ instance = TrieveRubyClient::SearchOverGroupsSlimChunksResponseBody.new(
16
+ group_chunks: null,
17
+ total_chunk_pages: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,20 @@
1
+ # TrieveRubyClient::SearchSlimChunkQueryResponseBody
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **score_chunks** | [**Array&lt;ScoreSlimChunks&gt;**](ScoreSlimChunks.md) | | |
8
+ | **total_chunk_pages** | **Integer** | | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'trieve_ruby_client'
14
+
15
+ instance = TrieveRubyClient::SearchSlimChunkQueryResponseBody.new(
16
+ score_chunks: null,
17
+ total_chunk_pages: null
18
+ )
19
+ ```
20
+
@@ -13,8 +13,10 @@
13
13
  | **page** | **Integer** | The page of chunks to fetch. Each page is 10 chunks. Support for custom page size is coming soon. | [optional] |
14
14
  | **page_size** | **Integer** | The page size is the number of chunks to fetch. This can be used to fetch more than 10 chunks at a time. | [optional] |
15
15
  | **query** | **String** | The query is the search query. This can be any string. The query will be used to create an embedding vector and/or SPLADE vector which will be used to find the result set. | |
16
+ | **quote_negated_words** | **Boolean** | Turn on quote words and negated words to search for exact phrases and exclude words from the search results. Default is false. | [optional] |
16
17
  | **score_threshold** | **Float** | Set score_threshold to a float to filter out chunks with a score below the threshold. | [optional] |
17
18
  | **search_type** | **String** | Search_type can be either \&quot;semantic\&quot;, \&quot;fulltext\&quot;, or \&quot;hybrid\&quot;. \&quot;hybrid\&quot; will pull in one page (10 chunks) of both semantic and full-text results then re-rank them using BAAI/bge-reranker-large. \&quot;semantic\&quot; will pull in one page (10 chunks) of the nearest cosine distant vectors. \&quot;fulltext\&quot; will pull in one page (10 chunks) of full-text results based on SPLADE. | |
19
+ | **slim_chunks** | **Boolean** | Set slim_chunks to true to avoid returning the content and chunk_html of the chunks. This is useful for when you want to reduce amount of data over the wire for latency improvement. Default is false. | [optional] |
18
20
  | **use_weights** | **Boolean** | Set use_weights to true to use the weights of the chunks in the result set in order to sort them. If not specified, this defaults to true. | [optional] |
19
21
 
20
22
  ## Example
@@ -32,8 +34,10 @@ instance = TrieveRubyClient::SearchWithinGroupData.new(
32
34
  page: null,
33
35
  page_size: null,
34
36
  query: null,
37
+ quote_negated_words: null,
35
38
  score_threshold: null,
36
39
  search_type: null,
40
+ slim_chunks: null,
37
41
  use_weights: null
38
42
  )
39
43
  ```
@@ -0,0 +1,49 @@
1
+ # TrieveRubyClient::SearchWithinGroupResponseTypes
2
+
3
+ ## Class instance methods
4
+
5
+ ### `openapi_one_of`
6
+
7
+ Returns the list of classes defined in oneOf.
8
+
9
+ #### Example
10
+
11
+ ```ruby
12
+ require 'trieve_ruby_client'
13
+
14
+ TrieveRubyClient::SearchWithinGroupResponseTypes.openapi_one_of
15
+ # =>
16
+ # [
17
+ # :'SearchGroupSlimChunksResult',
18
+ # :'SearchGroupsResult'
19
+ # ]
20
+ ```
21
+
22
+ ### build
23
+
24
+ Find the appropriate object from the `openapi_one_of` list and casts the data into it.
25
+
26
+ #### Example
27
+
28
+ ```ruby
29
+ require 'trieve_ruby_client'
30
+
31
+ TrieveRubyClient::SearchWithinGroupResponseTypes.build(data)
32
+ # => #<SearchGroupSlimChunksResult:0x00007fdd4aab02a0>
33
+
34
+ TrieveRubyClient::SearchWithinGroupResponseTypes.build(data_that_doesnt_match)
35
+ # => nil
36
+ ```
37
+
38
+ #### Parameters
39
+
40
+ | Name | Type | Description |
41
+ | ---- | ---- | ----------- |
42
+ | **data** | **Mixed** | data to be matched against the list of oneOf items |
43
+
44
+ #### Return type
45
+
46
+ - `SearchGroupSlimChunksResult`
47
+ - `SearchGroupsResult`
48
+ - `nil` (if no type matches)
49
+
@@ -0,0 +1,36 @@
1
+ # TrieveRubyClient::SlimChunkMetadata
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **created_at** | **Time** | | |
8
+ | **id** | **String** | | |
9
+ | **link** | **String** | | [optional] |
10
+ | **metadata** | **Object** | | [optional] |
11
+ | **qdrant_point_id** | **String** | | [optional] |
12
+ | **tag_set** | **String** | | [optional] |
13
+ | **time_stamp** | **Time** | | [optional] |
14
+ | **tracking_id** | **String** | | [optional] |
15
+ | **updated_at** | **Time** | | |
16
+ | **weight** | **Float** | | |
17
+
18
+ ## Example
19
+
20
+ ```ruby
21
+ require 'trieve_ruby_client'
22
+
23
+ instance = TrieveRubyClient::SlimChunkMetadata.new(
24
+ created_at: null,
25
+ id: null,
26
+ link: null,
27
+ metadata: null,
28
+ qdrant_point_id: null,
29
+ tag_set: null,
30
+ time_stamp: null,
31
+ tracking_id: null,
32
+ updated_at: null,
33
+ weight: null
34
+ )
35
+ ```
36
+
data/docs/SlimUser.md CHANGED
@@ -9,9 +9,6 @@
9
9
  | **name** | **String** | | [optional] |
10
10
  | **orgs** | [**Array&lt;Organization&gt;**](Organization.md) | | |
11
11
  | **user_orgs** | [**Array&lt;UserOrganization&gt;**](UserOrganization.md) | | |
12
- | **username** | **String** | | [optional] |
13
- | **visible_email** | **Boolean** | | |
14
- | **website** | **String** | | [optional] |
15
12
 
16
13
  ## Example
17
14
 
@@ -23,10 +20,7 @@ instance = TrieveRubyClient::SlimUser.new(
23
20
  id: null,
24
21
  name: null,
25
22
  orgs: null,
26
- user_orgs: null,
27
- username: null,
28
- visible_email: null,
29
- website: null
23
+ user_orgs: null
30
24
  )
31
25
  ```
32
26
 
data/docs/StripeApi.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # TrieveRubyClient::StripeApi
2
2
 
3
- All URIs are relative to *http://localhost:8090*
3
+ All URIs are relative to *https://api.trieve.ai*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
data/docs/TopicApi.md CHANGED
@@ -1,11 +1,11 @@
1
1
  # TrieveRubyClient::TopicApi
2
2
 
3
- All URIs are relative to *http://localhost:8090*
3
+ All URIs are relative to *https://api.trieve.ai*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
7
7
  | [**create_topic**](TopicApi.md#create_topic) | **POST** /api/topic | Create Topic |
8
- | [**delete_topic**](TopicApi.md#delete_topic) | **DELETE** /api/topic | Delete Topic |
8
+ | [**delete_topic**](TopicApi.md#delete_topic) | **DELETE** /api/topic/{topic_id} | Delete Topic |
9
9
  | [**get_all_topics_for_user**](TopicApi.md#get_all_topics_for_user) | **GET** /api/topic/user/{user_id} | Get All Topics for User |
10
10
  | [**update_topic**](TopicApi.md#update_topic) | **PUT** /api/topic | Update Topic |
11
11
 
@@ -85,7 +85,7 @@ end
85
85
 
86
86
  ## delete_topic
87
87
 
88
- > delete_topic(tr_dataset, delete_topic_data)
88
+ > delete_topic(tr_dataset, topic_id)
89
89
 
90
90
  Delete Topic
91
91
 
@@ -106,11 +106,11 @@ end
106
106
 
107
107
  api_instance = TrieveRubyClient::TopicApi.new
108
108
  tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
109
- delete_topic_data = TrieveRubyClient::DeleteTopicData.new({topic_id: 'topic_id_example'}) # DeleteTopicData | JSON request payload to delete a chat topic
109
+ topic_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The id of the topic you want to delete.
110
110
 
111
111
  begin
112
112
  # Delete Topic
113
- api_instance.delete_topic(tr_dataset, delete_topic_data)
113
+ api_instance.delete_topic(tr_dataset, topic_id)
114
114
  rescue TrieveRubyClient::ApiError => e
115
115
  puts "Error when calling TopicApi->delete_topic: #{e}"
116
116
  end
@@ -120,12 +120,12 @@ end
120
120
 
121
121
  This returns an Array which contains the response data (`nil` in this case), status code and headers.
122
122
 
123
- > <Array(nil, Integer, Hash)> delete_topic_with_http_info(tr_dataset, delete_topic_data)
123
+ > <Array(nil, Integer, Hash)> delete_topic_with_http_info(tr_dataset, topic_id)
124
124
 
125
125
  ```ruby
126
126
  begin
127
127
  # Delete Topic
128
- data, status_code, headers = api_instance.delete_topic_with_http_info(tr_dataset, delete_topic_data)
128
+ data, status_code, headers = api_instance.delete_topic_with_http_info(tr_dataset, topic_id)
129
129
  p status_code # => 2xx
130
130
  p headers # => { ... }
131
131
  p data # => nil
@@ -139,7 +139,7 @@ end
139
139
  | Name | Type | Description | Notes |
140
140
  | ---- | ---- | ----------- | ----- |
141
141
  | **tr_dataset** | **String** | The dataset id to use for the request | |
142
- | **delete_topic_data** | [**DeleteTopicData**](DeleteTopicData.md) | JSON request payload to delete a chat topic | |
142
+ | **topic_id** | **String** | The id of the topic you want to delete. | |
143
143
 
144
144
  ### Return type
145
145
 
@@ -151,7 +151,7 @@ nil (empty response body)
151
151
 
152
152
  ### HTTP request headers
153
153
 
154
- - **Content-Type**: application/json
154
+ - **Content-Type**: Not defined
155
155
  - **Accept**: application/json
156
156
 
157
157
 
@@ -10,6 +10,7 @@
10
10
  | **group_tracking_ids** | **Array&lt;String&gt;** | Group tracking_ids are the tracking_ids of the groups that the chunk should be placed into. This is useful for when you want to update a chunk and add it to a group or multiple groups in one request. | [optional] |
11
11
  | **link** | **String** | Link of the chunk you want to update. This can also be any string. Frequently, this is a link to the source of the chunk. The link value will not affect the embedding creation. If no link is provided, the existing link will be used. | [optional] |
12
12
  | **metadata** | **Object** | 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. | [optional] |
13
+ | **tag_set** | **Array&lt;String&gt;** | 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. | [optional] |
13
14
  | **time_stamp** | **String** | 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. | [optional] |
14
15
  | **tracking_id** | **String** | Tracking_id of the chunk you want to update. This is required to match an existing chunk. | [optional] |
15
16
  | **weight** | **Float** | Weight is a float which can be used to bias search results. This is useful for when you want to bias search results for a chunk. The magnitude only matters relative to other chunks in the chunk&#39;s dataset dataset. If no weight is provided, the existing weight will be used. | [optional] |
@@ -26,6 +27,7 @@ instance = TrieveRubyClient::UpdateChunkData.new(
26
27
  group_tracking_ids: null,
27
28
  link: null,
28
29
  metadata: null,
30
+ tag_set: null,
29
31
  time_stamp: null,
30
32
  tracking_id: null,
31
33
  weight: null
@@ -8,9 +8,6 @@
8
8
  | **organization_id** | **String** | The id of the organization to update the user for. | |
9
9
  | **role** | **Integer** | Either 0 (user), 1 (admin), or 2 (owner). If not provided, the current role will be used. The auth&#39;ed user must have a role greater than or equal to the role being assigned. | [optional] |
10
10
  | **user_id** | **String** | The id of the user to update, if not provided, the auth&#39;ed user will be updated. If provided, the auth&#39;ed user must be an admin (1) or owner (2) of the organization. | [optional] |
11
- | **username** | **String** | The new username to assign to the user, if not provided, the current username will be used. | [optional] |
12
- | **visible_email** | **Boolean** | Determines if the user&#39;s email is visible to other users, if not provided, the current value will be used. | [optional] |
13
- | **website** | **String** | The new website to assign to the user, if not provided, the current website will be used. Used for linking to the user&#39;s personal or company website. | [optional] |
14
11
 
15
12
  ## Example
16
13
 
@@ -21,10 +18,7 @@ instance = TrieveRubyClient::UpdateUserData.new(
21
18
  name: null,
22
19
  organization_id: null,
23
20
  role: null,
24
- user_id: null,
25
- username: null,
26
- visible_email: null,
27
- website: null
21
+ user_id: null
28
22
  )
29
23
  ```
30
24
 
data/docs/UserApi.md CHANGED
@@ -1,17 +1,17 @@
1
1
  # TrieveRubyClient::UserApi
2
2
 
3
- All URIs are relative to *http://localhost:8090*
3
+ All URIs are relative to *https://api.trieve.ai*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
7
- | [**delete_user_api_key**](UserApi.md#delete_user_api_key) | **DELETE** /api/user/delete_api_key | Delete User Api Key |
7
+ | [**delete_user_api_key**](UserApi.md#delete_user_api_key) | **DELETE** /api/user/delete_api_key/{api_key_id} | Delete User Api Key |
8
8
  | [**set_user_api_key**](UserApi.md#set_user_api_key) | **POST** /api/user/set_api_key | Set User Api Key |
9
9
  | [**update_user**](UserApi.md#update_user) | **PUT** /api/user | Update User |
10
10
 
11
11
 
12
12
  ## delete_user_api_key
13
13
 
14
- > <Array<ApiKeyDTO>> delete_user_api_key(delete_user_api_key_request)
14
+ > <Array<ApiKeyDTO>> delete_user_api_key(api_key_id)
15
15
 
16
16
  Delete User Api Key
17
17
 
@@ -31,11 +31,11 @@ TrieveRubyClient.configure do |config|
31
31
  end
32
32
 
33
33
  api_instance = TrieveRubyClient::UserApi.new
34
- delete_user_api_key_request = TrieveRubyClient::DeleteUserApiKeyRequest.new({api_key_id: 'api_key_id_example'}) # DeleteUserApiKeyRequest | JSON request payload to delete a user api key
34
+ api_key_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The id of the api key to delete
35
35
 
36
36
  begin
37
37
  # Delete User Api Key
38
- result = api_instance.delete_user_api_key(delete_user_api_key_request)
38
+ result = api_instance.delete_user_api_key(api_key_id)
39
39
  p result
40
40
  rescue TrieveRubyClient::ApiError => e
41
41
  puts "Error when calling UserApi->delete_user_api_key: #{e}"
@@ -46,12 +46,12 @@ end
46
46
 
47
47
  This returns an Array which contains the response data, status code and headers.
48
48
 
49
- > <Array(<Array<ApiKeyDTO>>, Integer, Hash)> delete_user_api_key_with_http_info(delete_user_api_key_request)
49
+ > <Array(<Array<ApiKeyDTO>>, Integer, Hash)> delete_user_api_key_with_http_info(api_key_id)
50
50
 
51
51
  ```ruby
52
52
  begin
53
53
  # Delete User Api Key
54
- data, status_code, headers = api_instance.delete_user_api_key_with_http_info(delete_user_api_key_request)
54
+ data, status_code, headers = api_instance.delete_user_api_key_with_http_info(api_key_id)
55
55
  p status_code # => 2xx
56
56
  p headers # => { ... }
57
57
  p data # => <Array<ApiKeyDTO>>
@@ -64,7 +64,7 @@ end
64
64
 
65
65
  | Name | Type | Description | Notes |
66
66
  | ---- | ---- | ----------- | ----- |
67
- | **delete_user_api_key_request** | [**DeleteUserApiKeyRequest**](DeleteUserApiKeyRequest.md) | JSON request payload to delete a user api key | |
67
+ | **api_key_id** | **String** | The id of the api key to delete | |
68
68
 
69
69
  ### Return type
70
70
 
@@ -76,7 +76,7 @@ end
76
76
 
77
77
  ### HTTP request headers
78
78
 
79
- - **Content-Type**: application/json
79
+ - **Content-Type**: Not defined
80
80
  - **Accept**: application/json
81
81
 
82
82
 
@@ -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.5.0
6
+ The version of the OpenAPI document: 0.5.7
7
7
  Contact: developers@trieve.ai
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.4.0