trieve_ruby_client 0.3.4 → 0.4.0

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 (128) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +78 -81
  3. data/docs/AuthApi.md +29 -40
  4. data/docs/AuthQuery.md +22 -0
  5. data/docs/BatchQueuedChunkResponse.md +20 -0
  6. data/docs/ChunkApi.md +80 -214
  7. data/docs/ChunkData.md +42 -0
  8. data/docs/ChunkGroupApi.md +183 -174
  9. data/docs/CreateChunkData.md +41 -34
  10. data/docs/DatasetApi.md +37 -67
  11. data/docs/EventsApi.md +14 -19
  12. data/docs/FileApi.md +25 -45
  13. data/docs/GetEventsData.md +22 -0
  14. data/docs/HealthApi.md +6 -4
  15. data/docs/InvitationApi.md +7 -12
  16. data/docs/MessageApi.md +25 -45
  17. data/docs/OrganizationApi.md +37 -67
  18. data/docs/ReturnQueuedChunk.md +39 -10
  19. data/docs/SingleQueuedChunkResponse.md +20 -0
  20. data/docs/StripeApi.md +23 -25
  21. data/docs/TopicApi.md +25 -45
  22. data/docs/UserApi.md +19 -34
  23. data/lib/trieve_ruby_client/api/auth_api.rb +28 -35
  24. data/lib/trieve_ruby_client/api/chunk_api.rb +68 -143
  25. data/lib/trieve_ruby_client/api/chunk_group_api.rb +164 -76
  26. data/lib/trieve_ruby_client/api/dataset_api.rb +31 -31
  27. data/lib/trieve_ruby_client/api/events_api.rb +22 -17
  28. data/lib/trieve_ruby_client/api/file_api.rb +21 -21
  29. data/lib/trieve_ruby_client/api/health_api.rb +5 -1
  30. data/lib/trieve_ruby_client/api/invitation_api.rb +6 -6
  31. data/lib/trieve_ruby_client/api/message_api.rb +21 -21
  32. data/lib/trieve_ruby_client/api/organization_api.rb +31 -31
  33. data/lib/trieve_ruby_client/api/stripe_api.rb +19 -3
  34. data/lib/trieve_ruby_client/api/topic_api.rb +21 -21
  35. data/lib/trieve_ruby_client/api/user_api.rb +16 -16
  36. data/lib/trieve_ruby_client/api_client.rb +1 -1
  37. data/lib/trieve_ruby_client/api_error.rb +1 -1
  38. data/lib/trieve_ruby_client/configuration.rb +8 -11
  39. data/lib/trieve_ruby_client/models/add_chunk_to_group_data.rb +1 -1
  40. data/lib/trieve_ruby_client/models/api_key_dto.rb +1 -1
  41. data/lib/trieve_ruby_client/models/auth_query.rb +238 -0
  42. data/lib/trieve_ruby_client/models/batch_queued_chunk_response.rb +240 -0
  43. data/lib/trieve_ruby_client/models/bookmark_data.rb +1 -1
  44. data/lib/trieve_ruby_client/models/bookmark_group_result.rb +1 -1
  45. data/lib/trieve_ruby_client/models/chat_message_proxy.rb +1 -1
  46. data/lib/trieve_ruby_client/models/chunk_data.rb +356 -0
  47. data/lib/trieve_ruby_client/models/chunk_filter.rb +1 -1
  48. data/lib/trieve_ruby_client/models/chunk_group.rb +1 -1
  49. data/lib/trieve_ruby_client/models/chunk_group_and_file.rb +1 -1
  50. data/lib/trieve_ruby_client/models/chunk_metadata.rb +1 -1
  51. data/lib/trieve_ruby_client/models/chunk_metadata_with_file_data.rb +1 -1
  52. data/lib/trieve_ruby_client/models/client_dataset_configuration.rb +1 -1
  53. data/lib/trieve_ruby_client/models/create_chunk_data.rb +79 -330
  54. data/lib/trieve_ruby_client/models/create_chunk_group_data.rb +1 -1
  55. data/lib/trieve_ruby_client/models/create_dataset_request.rb +1 -1
  56. data/lib/trieve_ruby_client/models/create_message_data.rb +1 -1
  57. data/lib/trieve_ruby_client/models/create_organization_data.rb +1 -1
  58. data/lib/trieve_ruby_client/models/create_topic_data.rb +1 -1
  59. data/lib/trieve_ruby_client/models/dataset.rb +1 -1
  60. data/lib/trieve_ruby_client/models/dataset_and_usage.rb +1 -1
  61. data/lib/trieve_ruby_client/models/dataset_dto.rb +1 -1
  62. data/lib/trieve_ruby_client/models/dataset_usage_count.rb +1 -1
  63. data/lib/trieve_ruby_client/models/delete_dataset_request.rb +1 -1
  64. data/lib/trieve_ruby_client/models/delete_topic_data.rb +1 -1
  65. data/lib/trieve_ruby_client/models/delete_user_api_key_request.rb +1 -1
  66. data/lib/trieve_ruby_client/models/edit_message_data.rb +1 -1
  67. data/lib/trieve_ruby_client/models/error_response_body.rb +1 -1
  68. data/lib/trieve_ruby_client/models/event.rb +1 -1
  69. data/lib/trieve_ruby_client/models/event_return.rb +1 -1
  70. data/lib/trieve_ruby_client/models/field_condition.rb +1 -1
  71. data/lib/trieve_ruby_client/models/file.rb +1 -1
  72. data/lib/trieve_ruby_client/models/file_dto.rb +1 -1
  73. data/lib/trieve_ruby_client/models/generate_chunks_request.rb +1 -1
  74. data/lib/trieve_ruby_client/models/get_events_data.rb +240 -0
  75. data/lib/trieve_ruby_client/models/get_groups_for_chunks_data.rb +1 -1
  76. data/lib/trieve_ruby_client/models/group_data.rb +1 -1
  77. data/lib/trieve_ruby_client/models/group_score_chunk_dto.rb +1 -1
  78. data/lib/trieve_ruby_client/models/invitation_data.rb +1 -1
  79. data/lib/trieve_ruby_client/models/match_condition.rb +1 -1
  80. data/lib/trieve_ruby_client/models/message.rb +1 -1
  81. data/lib/trieve_ruby_client/models/organization.rb +1 -1
  82. data/lib/trieve_ruby_client/models/organization_usage_count.rb +1 -1
  83. data/lib/trieve_ruby_client/models/range.rb +1 -1
  84. data/lib/trieve_ruby_client/models/reccomend_group_chunks_request.rb +1 -1
  85. data/lib/trieve_ruby_client/models/recommend_chunks_request.rb +1 -1
  86. data/lib/trieve_ruby_client/models/regenerate_message_data.rb +1 -1
  87. data/lib/trieve_ruby_client/models/return_queued_chunk.rb +75 -207
  88. data/lib/trieve_ruby_client/models/score_chunk_dto.rb +1 -1
  89. data/lib/trieve_ruby_client/models/search_chunk_data.rb +1 -1
  90. data/lib/trieve_ruby_client/models/search_chunk_query_response_body.rb +1 -1
  91. data/lib/trieve_ruby_client/models/search_groups_result.rb +1 -1
  92. data/lib/trieve_ruby_client/models/search_over_groups_data.rb +1 -1
  93. data/lib/trieve_ruby_client/models/search_over_groups_response_body.rb +1 -1
  94. data/lib/trieve_ruby_client/models/search_within_group_data.rb +1 -1
  95. data/lib/trieve_ruby_client/models/set_user_api_key_request.rb +1 -1
  96. data/lib/trieve_ruby_client/models/set_user_api_key_response.rb +1 -1
  97. data/lib/trieve_ruby_client/models/single_queued_chunk_response.rb +238 -0
  98. data/lib/trieve_ruby_client/models/slim_group.rb +1 -1
  99. data/lib/trieve_ruby_client/models/slim_user.rb +1 -1
  100. data/lib/trieve_ruby_client/models/stripe_plan.rb +1 -1
  101. data/lib/trieve_ruby_client/models/stripe_subscription.rb +1 -1
  102. data/lib/trieve_ruby_client/models/suggested_queries_request.rb +1 -1
  103. data/lib/trieve_ruby_client/models/suggested_queries_response.rb +1 -1
  104. data/lib/trieve_ruby_client/models/topic.rb +1 -1
  105. data/lib/trieve_ruby_client/models/update_chunk_by_tracking_id_data.rb +1 -1
  106. data/lib/trieve_ruby_client/models/update_chunk_data.rb +1 -1
  107. data/lib/trieve_ruby_client/models/update_chunk_group_data.rb +1 -1
  108. data/lib/trieve_ruby_client/models/update_dataset_request.rb +1 -1
  109. data/lib/trieve_ruby_client/models/update_group_by_tracking_id_data.rb +1 -1
  110. data/lib/trieve_ruby_client/models/update_organization_data.rb +1 -1
  111. data/lib/trieve_ruby_client/models/update_topic_data.rb +1 -1
  112. data/lib/trieve_ruby_client/models/update_user_data.rb +1 -1
  113. data/lib/trieve_ruby_client/models/upload_file_data.rb +1 -1
  114. data/lib/trieve_ruby_client/models/upload_file_result.rb +1 -1
  115. data/lib/trieve_ruby_client/models/user_organization.rb +1 -1
  116. data/lib/trieve_ruby_client/version.rb +2 -2
  117. data/lib/trieve_ruby_client.rb +6 -2
  118. data/openapi-generator.yaml +2 -2
  119. data/openapi.json +1280 -876
  120. data/spec/models/auth_query_spec.rb +48 -0
  121. data/spec/models/batch_queued_chunk_response_spec.rb +42 -0
  122. data/spec/models/chunk_data_spec.rb +108 -0
  123. data/spec/models/get_events_data_spec.rb +48 -0
  124. data/spec/models/single_queued_chunk_response_spec.rb +42 -0
  125. data/spec/spec_helper.rb +1 -1
  126. data/trieve_ruby_client-0.3.5.gem +0 -0
  127. data/trieve_ruby_client.gemspec +2 -2
  128. metadata +25 -3
data/docs/ChunkApi.md CHANGED
@@ -1,108 +1,29 @@
1
1
  # TrieveRubyClient::ChunkApi
2
2
 
3
- All URIs are relative to *http://localhost*
3
+ All URIs are relative to *http://localhost:8090*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
7
- | [**bulk_create_chunk**](ChunkApi.md#bulk_create_chunk) | **POST** /api/chunk/bulk | bulk_create_chunk |
8
- | [**create_chunk**](ChunkApi.md#create_chunk) | **POST** /api/chunk | create_chunk |
9
- | [**create_suggested_queries_handler**](ChunkApi.md#create_suggested_queries_handler) | **POST** /api/chunk/gen_suggestions | get_suggested_queries |
10
- | [**delete_chunk**](ChunkApi.md#delete_chunk) | **DELETE** /api/{tracking_or_chunk}/{chunk_id} | delete_chunk |
11
- | [**delete_chunk_by_tracking_id**](ChunkApi.md#delete_chunk_by_tracking_id) | **DELETE** /api/chunk/tracking_id/{tracking_id} | delete_chunk_by_tracking_id |
12
- | [**generate_off_chunks**](ChunkApi.md#generate_off_chunks) | **POST** /api/chunk/generate | augmented_generation_from_chunks |
13
- | [**get_chunk_by_id**](ChunkApi.md#get_chunk_by_id) | **GET** /api/{tracking_or_chunk}/{chunk_id} | get_chunk |
14
- | [**get_chunk_by_tracking_id**](ChunkApi.md#get_chunk_by_tracking_id) | **GET** /api/chunk/tracking_id/{tracking_id} | get_chunk_by_tracking_id |
15
- | [**get_recommended_chunks**](ChunkApi.md#get_recommended_chunks) | **POST** /api/chunk/recommend | get_recommended_chunks |
16
- | [**search_chunk**](ChunkApi.md#search_chunk) | **POST** /api/chunk/search | search |
17
- | [**update_chunk**](ChunkApi.md#update_chunk) | **PUT** /api/chunk/update | update_chunk |
18
- | [**update_chunk_by_tracking_id**](ChunkApi.md#update_chunk_by_tracking_id) | **PUT** /api/chunk/tracking_id/update | update_chunk_by_tracking_id |
19
-
20
-
21
- ## bulk_create_chunk
22
-
23
- > <ReturnQueuedChunk> bulk_create_chunk(tr_dataset, create_chunk_data)
24
-
25
- bulk_create_chunk
26
-
27
- bulk_create_chunk Create a new chunk from an array of chunks. If the chunk has the same tracking_id as an existing chunk, the request will fail. Once a chunk is created, it can be searched for using the search endpoint.
28
-
29
- ### Examples
30
-
31
- ```ruby
32
- require 'time'
33
- require 'trieve_ruby_client'
34
- # setup authorization
35
- TrieveRubyClient.configure do |config|
36
- # Configure API key authorization: Cookie
37
- config.api_key['Cookie'] = 'YOUR API KEY'
38
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
39
- # config.api_key_prefix['Cookie'] = 'Bearer'
40
-
41
- # Configure API key authorization: ApiKey
42
- config.api_key['ApiKey'] = 'YOUR API KEY'
43
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
44
- # config.api_key_prefix['ApiKey'] = 'Bearer'
45
- end
46
-
47
- api_instance = TrieveRubyClient::ChunkApi.new
48
- tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
49
- create_chunk_data = TrieveRubyClient::CreateChunkData.new # CreateChunkData | JSON request payload to create a new chunk (chunk)
50
-
51
- begin
52
- # bulk_create_chunk
53
- result = api_instance.bulk_create_chunk(tr_dataset, create_chunk_data)
54
- p result
55
- rescue TrieveRubyClient::ApiError => e
56
- puts "Error when calling ChunkApi->bulk_create_chunk: #{e}"
57
- end
58
- ```
59
-
60
- #### Using the bulk_create_chunk_with_http_info variant
61
-
62
- This returns an Array which contains the response data, status code and headers.
63
-
64
- > <Array(<ReturnQueuedChunk>, Integer, Hash)> bulk_create_chunk_with_http_info(tr_dataset, create_chunk_data)
65
-
66
- ```ruby
67
- begin
68
- # bulk_create_chunk
69
- data, status_code, headers = api_instance.bulk_create_chunk_with_http_info(tr_dataset, create_chunk_data)
70
- p status_code # => 2xx
71
- p headers # => { ... }
72
- p data # => <ReturnQueuedChunk>
73
- rescue TrieveRubyClient::ApiError => e
74
- puts "Error when calling ChunkApi->bulk_create_chunk_with_http_info: #{e}"
75
- end
76
- ```
77
-
78
- ### Parameters
79
-
80
- | Name | Type | Description | Notes |
81
- | ---- | ---- | ----------- | ----- |
82
- | **tr_dataset** | **String** | The dataset id to use for the request | |
83
- | **create_chunk_data** | [**CreateChunkData**](CreateChunkData.md) | JSON request payload to create a new chunk (chunk) | |
84
-
85
- ### Return type
86
-
87
- [**ReturnQueuedChunk**](ReturnQueuedChunk.md)
88
-
89
- ### Authorization
90
-
91
- [Cookie](../README.md#Cookie), [ApiKey](../README.md#ApiKey)
92
-
93
- ### HTTP request headers
94
-
95
- - **Content-Type**: application/json
96
- - **Accept**: application/json
7
+ | [**create_chunk**](ChunkApi.md#create_chunk) | **POST** /api/chunk | Create Chunk |
8
+ | [**create_suggested_queries_handler**](ChunkApi.md#create_suggested_queries_handler) | **POST** /api/chunk/gen_suggestions | Generate suggested queries |
9
+ | [**delete_chunk**](ChunkApi.md#delete_chunk) | **DELETE** /api/chunk/{tracking_or_chunk}/{chunk_id} | Delete Chunk |
10
+ | [**delete_chunk_by_tracking_id**](ChunkApi.md#delete_chunk_by_tracking_id) | **DELETE** /api/chunk/tracking_id/{tracking_id} | Delete Chunk By Tracking Id |
11
+ | [**generate_off_chunks**](ChunkApi.md#generate_off_chunks) | **POST** /api/chunk/generate | RAG on User Defined Chunks |
12
+ | [**get_chunk_by_id**](ChunkApi.md#get_chunk_by_id) | **GET** /api/chunk/{tracking_or_chunk}/{chunk_id} | Get Chunk By Id |
13
+ | [**get_chunk_by_tracking_id**](ChunkApi.md#get_chunk_by_tracking_id) | **GET** /api/chunk/tracking_id/{tracking_id} | Get Chunk By Tracking Id |
14
+ | [**get_recommended_chunks**](ChunkApi.md#get_recommended_chunks) | **POST** /api/chunk/recommend | Get Recommended Chunks |
15
+ | [**search_chunk**](ChunkApi.md#search_chunk) | **POST** /api/chunk/search | Search |
16
+ | [**update_chunk**](ChunkApi.md#update_chunk) | **PUT** /api/chunk/update | Update Chunk |
17
+ | [**update_chunk_by_tracking_id**](ChunkApi.md#update_chunk_by_tracking_id) | **PUT** /api/chunk/tracking_id/update | Update Chunk By Tracking Id |
97
18
 
98
19
 
99
20
  ## create_chunk
100
21
 
101
22
  > <ReturnQueuedChunk> create_chunk(tr_dataset, create_chunk_data)
102
23
 
103
- create_chunk
24
+ Create Chunk
104
25
 
105
- create_chunk Create a new chunk. If the chunk has the same tracking_id as an existing chunk, the request will fail. Once a chunk is created, it can be searched for using the search endpoint.
26
+ Create Chunk Create a new chunk. If the chunk has the same tracking_id as an existing chunk, the request will fail. Once a chunk is created, it can be searched for using the search endpoint.
106
27
 
107
28
  ### Examples
108
29
 
@@ -111,11 +32,6 @@ require 'time'
111
32
  require 'trieve_ruby_client'
112
33
  # setup authorization
113
34
  TrieveRubyClient.configure do |config|
114
- # Configure API key authorization: Cookie
115
- config.api_key['Cookie'] = 'YOUR API KEY'
116
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
117
- # config.api_key_prefix['Cookie'] = 'Bearer'
118
-
119
35
  # Configure API key authorization: ApiKey
120
36
  config.api_key['ApiKey'] = 'YOUR API KEY'
121
37
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
@@ -124,10 +40,10 @@ end
124
40
 
125
41
  api_instance = TrieveRubyClient::ChunkApi.new
126
42
  tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
127
- create_chunk_data = TrieveRubyClient::CreateChunkData.new # CreateChunkData | JSON request payload to create a new chunk (chunk)
43
+ create_chunk_data = nil # CreateChunkData | JSON request payload to create a new chunk (chunk)
128
44
 
129
45
  begin
130
- # create_chunk
46
+ # Create Chunk
131
47
  result = api_instance.create_chunk(tr_dataset, create_chunk_data)
132
48
  p result
133
49
  rescue TrieveRubyClient::ApiError => e
@@ -143,7 +59,7 @@ This returns an Array which contains the response data, status code and headers.
143
59
 
144
60
  ```ruby
145
61
  begin
146
- # create_chunk
62
+ # Create Chunk
147
63
  data, status_code, headers = api_instance.create_chunk_with_http_info(tr_dataset, create_chunk_data)
148
64
  p status_code # => 2xx
149
65
  p headers # => { ... }
@@ -166,7 +82,7 @@ end
166
82
 
167
83
  ### Authorization
168
84
 
169
- [Cookie](../README.md#Cookie), [ApiKey](../README.md#ApiKey)
85
+ [ApiKey](../README.md#ApiKey)
170
86
 
171
87
  ### HTTP request headers
172
88
 
@@ -178,9 +94,9 @@ end
178
94
 
179
95
  > <SuggestedQueriesResponse> create_suggested_queries_handler(tr_dataset, suggested_queries_request)
180
96
 
181
- get_suggested_queries
97
+ Generate suggested queries
182
98
 
183
- get_suggested_queries This endpoint will generate 3 suggested queries based off the query provided in the request body and return them as a JSON object.
99
+ Generate suggested queries This endpoint will generate 3 suggested queries based off the query provided in the request body and return them as a JSON object.
184
100
 
185
101
  ### Examples
186
102
 
@@ -189,11 +105,6 @@ require 'time'
189
105
  require 'trieve_ruby_client'
190
106
  # setup authorization
191
107
  TrieveRubyClient.configure do |config|
192
- # Configure API key authorization: Cookie
193
- config.api_key['Cookie'] = 'YOUR API KEY'
194
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
195
- # config.api_key_prefix['Cookie'] = 'Bearer'
196
-
197
108
  # Configure API key authorization: ApiKey
198
109
  config.api_key['ApiKey'] = 'YOUR API KEY'
199
110
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
@@ -205,7 +116,7 @@ tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the reque
205
116
  suggested_queries_request = TrieveRubyClient::SuggestedQueriesRequest.new({query: 'query_example'}) # SuggestedQueriesRequest | JSON request payload to get alternative suggested queries
206
117
 
207
118
  begin
208
- # get_suggested_queries
119
+ # Generate suggested queries
209
120
  result = api_instance.create_suggested_queries_handler(tr_dataset, suggested_queries_request)
210
121
  p result
211
122
  rescue TrieveRubyClient::ApiError => e
@@ -221,7 +132,7 @@ This returns an Array which contains the response data, status code and headers.
221
132
 
222
133
  ```ruby
223
134
  begin
224
- # get_suggested_queries
135
+ # Generate suggested queries
225
136
  data, status_code, headers = api_instance.create_suggested_queries_handler_with_http_info(tr_dataset, suggested_queries_request)
226
137
  p status_code # => 2xx
227
138
  p headers # => { ... }
@@ -244,7 +155,7 @@ end
244
155
 
245
156
  ### Authorization
246
157
 
247
- [Cookie](../README.md#Cookie), [ApiKey](../README.md#ApiKey)
158
+ [ApiKey](../README.md#ApiKey)
248
159
 
249
160
  ### HTTP request headers
250
161
 
@@ -254,11 +165,11 @@ end
254
165
 
255
166
  ## delete_chunk
256
167
 
257
- > delete_chunk(tr_dataset, chunk_id, tracking_or_chunk)
168
+ > delete_chunk(tr_dataset, tracking_or_chunk, chunk_id)
258
169
 
259
- delete_chunk
170
+ Delete Chunk
260
171
 
261
- delete_chunk Delete a chunk by its id. If deleting a root chunk which has a collision, the most recently created collision will become a new root chunk.
172
+ Delete Chunk Delete a chunk by its id. If deleting a root chunk which has a collision, the most recently created collision will become a new root chunk.
262
173
 
263
174
  ### Examples
264
175
 
@@ -267,11 +178,6 @@ require 'time'
267
178
  require 'trieve_ruby_client'
268
179
  # setup authorization
269
180
  TrieveRubyClient.configure do |config|
270
- # Configure API key authorization: Cookie
271
- config.api_key['Cookie'] = 'YOUR API KEY'
272
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
273
- # config.api_key_prefix['Cookie'] = 'Bearer'
274
-
275
181
  # Configure API key authorization: ApiKey
276
182
  config.api_key['ApiKey'] = 'YOUR API KEY'
277
183
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
@@ -280,12 +186,12 @@ end
280
186
 
281
187
  api_instance = TrieveRubyClient::ChunkApi.new
282
188
  tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
283
- chunk_id = TODO # Uuid | Id of the chunk you want to fetch. This can be either the chunk_id or the tracking_id.
284
189
  tracking_or_chunk = 'tracking_or_chunk_example' # String | The type of id you are using to search for the chunk. This can be either 'chunk' or 'tracking_id'
190
+ chunk_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Id of the chunk you want to fetch. This can be either the chunk_id or the tracking_id.
285
191
 
286
192
  begin
287
- # delete_chunk
288
- api_instance.delete_chunk(tr_dataset, chunk_id, tracking_or_chunk)
193
+ # Delete Chunk
194
+ api_instance.delete_chunk(tr_dataset, tracking_or_chunk, chunk_id)
289
195
  rescue TrieveRubyClient::ApiError => e
290
196
  puts "Error when calling ChunkApi->delete_chunk: #{e}"
291
197
  end
@@ -295,12 +201,12 @@ end
295
201
 
296
202
  This returns an Array which contains the response data (`nil` in this case), status code and headers.
297
203
 
298
- > <Array(nil, Integer, Hash)> delete_chunk_with_http_info(tr_dataset, chunk_id, tracking_or_chunk)
204
+ > <Array(nil, Integer, Hash)> delete_chunk_with_http_info(tr_dataset, tracking_or_chunk, chunk_id)
299
205
 
300
206
  ```ruby
301
207
  begin
302
- # delete_chunk
303
- data, status_code, headers = api_instance.delete_chunk_with_http_info(tr_dataset, chunk_id, tracking_or_chunk)
208
+ # Delete Chunk
209
+ data, status_code, headers = api_instance.delete_chunk_with_http_info(tr_dataset, tracking_or_chunk, chunk_id)
304
210
  p status_code # => 2xx
305
211
  p headers # => { ... }
306
212
  p data # => nil
@@ -314,8 +220,8 @@ end
314
220
  | Name | Type | Description | Notes |
315
221
  | ---- | ---- | ----------- | ----- |
316
222
  | **tr_dataset** | **String** | The dataset id to use for the request | |
317
- | **chunk_id** | [**Uuid**](.md) | Id of the chunk you want to fetch. This can be either the chunk_id or the tracking_id. | |
318
223
  | **tracking_or_chunk** | **String** | The type of id you are using to search for the chunk. This can be either &#39;chunk&#39; or &#39;tracking_id&#39; | |
224
+ | **chunk_id** | **String** | Id of the chunk you want to fetch. This can be either the chunk_id or the tracking_id. | |
319
225
 
320
226
  ### Return type
321
227
 
@@ -323,7 +229,7 @@ nil (empty response body)
323
229
 
324
230
  ### Authorization
325
231
 
326
- [Cookie](../README.md#Cookie), [ApiKey](../README.md#ApiKey)
232
+ [ApiKey](../README.md#ApiKey)
327
233
 
328
234
  ### HTTP request headers
329
235
 
@@ -335,9 +241,9 @@ nil (empty response body)
335
241
 
336
242
  > delete_chunk_by_tracking_id(tr_dataset, tracking_id)
337
243
 
338
- delete_chunk_by_tracking_id
244
+ Delete Chunk By Tracking Id
339
245
 
340
- delete_chunk_by_tracking_id Delete a chunk by tracking_id. This is useful for when you are coordinating with an external system and want to use the tracking_id to identify the chunk. If deleting a root chunk which has a collision, the most recently created collision will become a new root chunk.
246
+ Delete Chunk By Tracking Id Delete a chunk by tracking_id. This is useful for when you are coordinating with an external system and want to use the tracking_id to identify the chunk. If deleting a root chunk which has a collision, the most recently created collision will become a new root chunk.
341
247
 
342
248
  ### Examples
343
249
 
@@ -346,11 +252,6 @@ require 'time'
346
252
  require 'trieve_ruby_client'
347
253
  # setup authorization
348
254
  TrieveRubyClient.configure do |config|
349
- # Configure API key authorization: Cookie
350
- config.api_key['Cookie'] = 'YOUR API KEY'
351
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
352
- # config.api_key_prefix['Cookie'] = 'Bearer'
353
-
354
255
  # Configure API key authorization: ApiKey
355
256
  config.api_key['ApiKey'] = 'YOUR API KEY'
356
257
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
@@ -362,7 +263,7 @@ tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the reque
362
263
  tracking_id = 'tracking_id_example' # String | tracking_id of the chunk you want to delete
363
264
 
364
265
  begin
365
- # delete_chunk_by_tracking_id
266
+ # Delete Chunk By Tracking Id
366
267
  api_instance.delete_chunk_by_tracking_id(tr_dataset, tracking_id)
367
268
  rescue TrieveRubyClient::ApiError => e
368
269
  puts "Error when calling ChunkApi->delete_chunk_by_tracking_id: #{e}"
@@ -377,7 +278,7 @@ This returns an Array which contains the response data (`nil` in this case), sta
377
278
 
378
279
  ```ruby
379
280
  begin
380
- # delete_chunk_by_tracking_id
281
+ # Delete Chunk By Tracking Id
381
282
  data, status_code, headers = api_instance.delete_chunk_by_tracking_id_with_http_info(tr_dataset, tracking_id)
382
283
  p status_code # => 2xx
383
284
  p headers # => { ... }
@@ -400,7 +301,7 @@ nil (empty response body)
400
301
 
401
302
  ### Authorization
402
303
 
403
- [Cookie](../README.md#Cookie), [ApiKey](../README.md#ApiKey)
304
+ [ApiKey](../README.md#ApiKey)
404
305
 
405
306
  ### HTTP request headers
406
307
 
@@ -412,9 +313,9 @@ nil (empty response body)
412
313
 
413
314
  > String generate_off_chunks(tr_dataset, generate_chunks_request)
414
315
 
415
- augmented_generation_from_chunks
316
+ RAG on User Defined Chunks
416
317
 
417
- augmented_generation_from_chunks This endpoint exists as an alternative to the topic+message concept where our API handles chat memory. With this endpoint, the user is responsible for providing the context window and the prompt. See more in the \"search before generate\" page at docs.trieve.ai.
318
+ RAG on User Defined Chunks This endpoint exists as an alternative to the topic+message concept where our API handles chat memory. With this endpoint, the user is responsible for providing the context window and the prompt. See more in the \"search before generate\" page at docs.trieve.ai.
418
319
 
419
320
  ### Examples
420
321
 
@@ -423,11 +324,6 @@ require 'time'
423
324
  require 'trieve_ruby_client'
424
325
  # setup authorization
425
326
  TrieveRubyClient.configure do |config|
426
- # Configure API key authorization: Cookie
427
- config.api_key['Cookie'] = 'YOUR API KEY'
428
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
429
- # config.api_key_prefix['Cookie'] = 'Bearer'
430
-
431
327
  # Configure API key authorization: ApiKey
432
328
  config.api_key['ApiKey'] = 'YOUR API KEY'
433
329
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
@@ -439,7 +335,7 @@ tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the reque
439
335
  generate_chunks_request = TrieveRubyClient::GenerateChunksRequest.new({chunk_ids: ['chunk_ids_example'], prev_messages: [TrieveRubyClient::ChatMessageProxy.new({content: 'content_example', role: 'role_example'})]}) # GenerateChunksRequest | JSON request payload to perform RAG on some chunks (chunks)
440
336
 
441
337
  begin
442
- # augmented_generation_from_chunks
338
+ # RAG on User Defined Chunks
443
339
  result = api_instance.generate_off_chunks(tr_dataset, generate_chunks_request)
444
340
  p result
445
341
  rescue TrieveRubyClient::ApiError => e
@@ -455,7 +351,7 @@ This returns an Array which contains the response data, status code and headers.
455
351
 
456
352
  ```ruby
457
353
  begin
458
- # augmented_generation_from_chunks
354
+ # RAG on User Defined Chunks
459
355
  data, status_code, headers = api_instance.generate_off_chunks_with_http_info(tr_dataset, generate_chunks_request)
460
356
  p status_code # => 2xx
461
357
  p headers # => { ... }
@@ -478,7 +374,7 @@ end
478
374
 
479
375
  ### Authorization
480
376
 
481
- [Cookie](../README.md#Cookie), [ApiKey](../README.md#ApiKey)
377
+ [ApiKey](../README.md#ApiKey)
482
378
 
483
379
  ### HTTP request headers
484
380
 
@@ -488,11 +384,11 @@ end
488
384
 
489
385
  ## get_chunk_by_id
490
386
 
491
- > <ChunkMetadata> get_chunk_by_id(tr_dataset, chunk_id, tracking_or_chunk)
387
+ > <ChunkMetadata> get_chunk_by_id(tr_dataset, tracking_or_chunk, chunk_id)
492
388
 
493
- get_chunk
389
+ Get Chunk By Id
494
390
 
495
- get_chunk Get a singular chunk by id.
391
+ Get Chunk By Id Get a singular chunk by id.
496
392
 
497
393
  ### Examples
498
394
 
@@ -501,11 +397,6 @@ require 'time'
501
397
  require 'trieve_ruby_client'
502
398
  # setup authorization
503
399
  TrieveRubyClient.configure do |config|
504
- # Configure API key authorization: Cookie
505
- config.api_key['Cookie'] = 'YOUR API KEY'
506
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
507
- # config.api_key_prefix['Cookie'] = 'Bearer'
508
-
509
400
  # Configure API key authorization: ApiKey
510
401
  config.api_key['ApiKey'] = 'YOUR API KEY'
511
402
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
@@ -514,12 +405,12 @@ end
514
405
 
515
406
  api_instance = TrieveRubyClient::ChunkApi.new
516
407
  tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
517
- chunk_id = TODO # Uuid | Id of the chunk you want to fetch. This can be either the chunk_id or the tracking_id.
518
408
  tracking_or_chunk = 'tracking_or_chunk_example' # String | The type of id you are using to search for the chunk. This can be either 'chunk' or 'tracking_id'
409
+ chunk_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Id of the chunk you want to fetch. This can be either the chunk_id or the tracking_id.
519
410
 
520
411
  begin
521
- # get_chunk
522
- result = api_instance.get_chunk_by_id(tr_dataset, chunk_id, tracking_or_chunk)
412
+ # Get Chunk By Id
413
+ result = api_instance.get_chunk_by_id(tr_dataset, tracking_or_chunk, chunk_id)
523
414
  p result
524
415
  rescue TrieveRubyClient::ApiError => e
525
416
  puts "Error when calling ChunkApi->get_chunk_by_id: #{e}"
@@ -530,12 +421,12 @@ end
530
421
 
531
422
  This returns an Array which contains the response data, status code and headers.
532
423
 
533
- > <Array(<ChunkMetadata>, Integer, Hash)> get_chunk_by_id_with_http_info(tr_dataset, chunk_id, tracking_or_chunk)
424
+ > <Array(<ChunkMetadata>, Integer, Hash)> get_chunk_by_id_with_http_info(tr_dataset, tracking_or_chunk, chunk_id)
534
425
 
535
426
  ```ruby
536
427
  begin
537
- # get_chunk
538
- data, status_code, headers = api_instance.get_chunk_by_id_with_http_info(tr_dataset, chunk_id, tracking_or_chunk)
428
+ # Get Chunk By Id
429
+ data, status_code, headers = api_instance.get_chunk_by_id_with_http_info(tr_dataset, tracking_or_chunk, chunk_id)
539
430
  p status_code # => 2xx
540
431
  p headers # => { ... }
541
432
  p data # => <ChunkMetadata>
@@ -549,8 +440,8 @@ end
549
440
  | Name | Type | Description | Notes |
550
441
  | ---- | ---- | ----------- | ----- |
551
442
  | **tr_dataset** | **String** | The dataset id to use for the request | |
552
- | **chunk_id** | [**Uuid**](.md) | Id of the chunk you want to fetch. This can be either the chunk_id or the tracking_id. | |
553
443
  | **tracking_or_chunk** | **String** | The type of id you are using to search for the chunk. This can be either &#39;chunk&#39; or &#39;tracking_id&#39; | |
444
+ | **chunk_id** | **String** | Id of the chunk you want to fetch. This can be either the chunk_id or the tracking_id. | |
554
445
 
555
446
  ### Return type
556
447
 
@@ -558,7 +449,7 @@ end
558
449
 
559
450
  ### Authorization
560
451
 
561
- [Cookie](../README.md#Cookie), [ApiKey](../README.md#ApiKey)
452
+ [ApiKey](../README.md#ApiKey)
562
453
 
563
454
  ### HTTP request headers
564
455
 
@@ -570,9 +461,9 @@ end
570
461
 
571
462
  > <ChunkMetadata> get_chunk_by_tracking_id(tr_dataset, tracking_id)
572
463
 
573
- get_chunk_by_tracking_id
464
+ Get Chunk By Tracking Id
574
465
 
575
- get_chunk_by_tracking_id Get a singular chunk by tracking_id. This is useful for when you are coordinating with an external system and want to use your own id as the primary reference for a chunk.
466
+ Get Chunk By Tracking Id Get a singular chunk by tracking_id. This is useful for when you are coordinating with an external system and want to use your own id as the primary reference for a chunk.
576
467
 
577
468
  ### Examples
578
469
 
@@ -581,11 +472,6 @@ require 'time'
581
472
  require 'trieve_ruby_client'
582
473
  # setup authorization
583
474
  TrieveRubyClient.configure do |config|
584
- # Configure API key authorization: Cookie
585
- config.api_key['Cookie'] = 'YOUR API KEY'
586
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
587
- # config.api_key_prefix['Cookie'] = 'Bearer'
588
-
589
475
  # Configure API key authorization: ApiKey
590
476
  config.api_key['ApiKey'] = 'YOUR API KEY'
591
477
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
@@ -597,7 +483,7 @@ tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the reque
597
483
  tracking_id = 'tracking_id_example' # String | tracking_id of the chunk you want to fetch
598
484
 
599
485
  begin
600
- # get_chunk_by_tracking_id
486
+ # Get Chunk By Tracking Id
601
487
  result = api_instance.get_chunk_by_tracking_id(tr_dataset, tracking_id)
602
488
  p result
603
489
  rescue TrieveRubyClient::ApiError => e
@@ -613,7 +499,7 @@ This returns an Array which contains the response data, status code and headers.
613
499
 
614
500
  ```ruby
615
501
  begin
616
- # get_chunk_by_tracking_id
502
+ # Get Chunk By Tracking Id
617
503
  data, status_code, headers = api_instance.get_chunk_by_tracking_id_with_http_info(tr_dataset, tracking_id)
618
504
  p status_code # => 2xx
619
505
  p headers # => { ... }
@@ -636,7 +522,7 @@ end
636
522
 
637
523
  ### Authorization
638
524
 
639
- [Cookie](../README.md#Cookie), [ApiKey](../README.md#ApiKey)
525
+ [ApiKey](../README.md#ApiKey)
640
526
 
641
527
  ### HTTP request headers
642
528
 
@@ -648,9 +534,9 @@ end
648
534
 
649
535
  > <Array<ChunkMetadataWithFileData>> get_recommended_chunks(tr_dataset, recommend_chunks_request)
650
536
 
651
- get_recommended_chunks
537
+ Get Recommended Chunks
652
538
 
653
- get_recommended_chunks Get recommendations of chunks similar to the chunks in the request. Think about this as a feature similar to the \"add to playlist\" recommendation feature on Spotify. This request pairs especially well with our groups endpoint.
539
+ Get Recommended Chunks Get recommendations of chunks similar to the chunks in the request. Think about this as a feature similar to the \"add to playlist\" recommendation feature on Spotify. This request pairs especially well with our groups endpoint.
654
540
 
655
541
  ### Examples
656
542
 
@@ -659,11 +545,6 @@ require 'time'
659
545
  require 'trieve_ruby_client'
660
546
  # setup authorization
661
547
  TrieveRubyClient.configure do |config|
662
- # Configure API key authorization: Cookie
663
- config.api_key['Cookie'] = 'YOUR API KEY'
664
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
665
- # config.api_key_prefix['Cookie'] = 'Bearer'
666
-
667
548
  # Configure API key authorization: ApiKey
668
549
  config.api_key['ApiKey'] = 'YOUR API KEY'
669
550
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
@@ -675,7 +556,7 @@ tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the reque
675
556
  recommend_chunks_request = TrieveRubyClient::RecommendChunksRequest.new # RecommendChunksRequest | JSON request payload to get recommendations of chunks similar to the chunks in the request
676
557
 
677
558
  begin
678
- # get_recommended_chunks
559
+ # Get Recommended Chunks
679
560
  result = api_instance.get_recommended_chunks(tr_dataset, recommend_chunks_request)
680
561
  p result
681
562
  rescue TrieveRubyClient::ApiError => e
@@ -691,7 +572,7 @@ This returns an Array which contains the response data, status code and headers.
691
572
 
692
573
  ```ruby
693
574
  begin
694
- # get_recommended_chunks
575
+ # Get Recommended Chunks
695
576
  data, status_code, headers = api_instance.get_recommended_chunks_with_http_info(tr_dataset, recommend_chunks_request)
696
577
  p status_code # => 2xx
697
578
  p headers # => { ... }
@@ -714,7 +595,7 @@ end
714
595
 
715
596
  ### Authorization
716
597
 
717
- [Cookie](../README.md#Cookie), [ApiKey](../README.md#ApiKey)
598
+ [ApiKey](../README.md#ApiKey)
718
599
 
719
600
  ### HTTP request headers
720
601
 
@@ -726,9 +607,9 @@ end
726
607
 
727
608
  > <SearchChunkQueryResponseBody> search_chunk(tr_dataset, search_chunk_data)
728
609
 
729
- search
610
+ Search
730
611
 
731
- search This route provides the primary search functionality for the API. It can be used to search for chunks by semantic similarity, full-text similarity, or a combination of both. Results' `chunk_html` values will be modified with `<b>` tags for sub-sentence highlighting.
612
+ Search This route provides the primary search functionality for the API. It can be used to search for chunks by semantic similarity, full-text similarity, or a combination of both. Results' `chunk_html` values will be modified with `<b>` tags for sub-sentence highlighting.
732
613
 
733
614
  ### Examples
734
615
 
@@ -737,11 +618,6 @@ require 'time'
737
618
  require 'trieve_ruby_client'
738
619
  # setup authorization
739
620
  TrieveRubyClient.configure do |config|
740
- # Configure API key authorization: Cookie
741
- config.api_key['Cookie'] = 'YOUR API KEY'
742
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
743
- # config.api_key_prefix['Cookie'] = 'Bearer'
744
-
745
621
  # Configure API key authorization: ApiKey
746
622
  config.api_key['ApiKey'] = 'YOUR API KEY'
747
623
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
@@ -753,7 +629,7 @@ tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the reque
753
629
  search_chunk_data = TrieveRubyClient::SearchChunkData.new({query: 'query_example', search_type: 'search_type_example'}) # SearchChunkData | JSON request payload to semantically search for chunks (chunks)
754
630
 
755
631
  begin
756
- # search
632
+ # Search
757
633
  result = api_instance.search_chunk(tr_dataset, search_chunk_data)
758
634
  p result
759
635
  rescue TrieveRubyClient::ApiError => e
@@ -769,7 +645,7 @@ This returns an Array which contains the response data, status code and headers.
769
645
 
770
646
  ```ruby
771
647
  begin
772
- # search
648
+ # Search
773
649
  data, status_code, headers = api_instance.search_chunk_with_http_info(tr_dataset, search_chunk_data)
774
650
  p status_code # => 2xx
775
651
  p headers # => { ... }
@@ -792,7 +668,7 @@ end
792
668
 
793
669
  ### Authorization
794
670
 
795
- [Cookie](../README.md#Cookie), [ApiKey](../README.md#ApiKey)
671
+ [ApiKey](../README.md#ApiKey)
796
672
 
797
673
  ### HTTP request headers
798
674
 
@@ -804,9 +680,9 @@ end
804
680
 
805
681
  > update_chunk(tr_dataset, update_chunk_data)
806
682
 
807
- update_chunk
683
+ Update Chunk
808
684
 
809
- update_chunk Update a chunk. If you try to change the tracking_id of the chunk to have the same tracking_id as an existing chunk, the request will fail.
685
+ Update Chunk Update a chunk. If you try to change the tracking_id of the chunk to have the same tracking_id as an existing chunk, the request will fail.
810
686
 
811
687
  ### Examples
812
688
 
@@ -815,11 +691,6 @@ require 'time'
815
691
  require 'trieve_ruby_client'
816
692
  # setup authorization
817
693
  TrieveRubyClient.configure do |config|
818
- # Configure API key authorization: Cookie
819
- config.api_key['Cookie'] = 'YOUR API KEY'
820
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
821
- # config.api_key_prefix['Cookie'] = 'Bearer'
822
-
823
694
  # Configure API key authorization: ApiKey
824
695
  config.api_key['ApiKey'] = 'YOUR API KEY'
825
696
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
@@ -831,7 +702,7 @@ tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the reque
831
702
  update_chunk_data = TrieveRubyClient::UpdateChunkData.new # UpdateChunkData | JSON request payload to update a chunk (chunk)
832
703
 
833
704
  begin
834
- # update_chunk
705
+ # Update Chunk
835
706
  api_instance.update_chunk(tr_dataset, update_chunk_data)
836
707
  rescue TrieveRubyClient::ApiError => e
837
708
  puts "Error when calling ChunkApi->update_chunk: #{e}"
@@ -846,7 +717,7 @@ This returns an Array which contains the response data (`nil` in this case), sta
846
717
 
847
718
  ```ruby
848
719
  begin
849
- # update_chunk
720
+ # Update Chunk
850
721
  data, status_code, headers = api_instance.update_chunk_with_http_info(tr_dataset, update_chunk_data)
851
722
  p status_code # => 2xx
852
723
  p headers # => { ... }
@@ -869,7 +740,7 @@ nil (empty response body)
869
740
 
870
741
  ### Authorization
871
742
 
872
- [Cookie](../README.md#Cookie), [ApiKey](../README.md#ApiKey)
743
+ [ApiKey](../README.md#ApiKey)
873
744
 
874
745
  ### HTTP request headers
875
746
 
@@ -881,9 +752,9 @@ nil (empty response body)
881
752
 
882
753
  > update_chunk_by_tracking_id(tr_dataset, update_chunk_by_tracking_id_data)
883
754
 
884
- update_chunk_by_tracking_id
755
+ Update Chunk By Tracking Id
885
756
 
886
- update_chunk_by_tracking_id Update a chunk by tracking_id. This is useful for when you are coordinating with an external system and want to use the tracking_id to identify the chunk.
757
+ Update Chunk By Tracking Id Update a chunk by tracking_id. This is useful for when you are coordinating with an external system and want to use the tracking_id to identify the chunk.
887
758
 
888
759
  ### Examples
889
760
 
@@ -892,11 +763,6 @@ require 'time'
892
763
  require 'trieve_ruby_client'
893
764
  # setup authorization
894
765
  TrieveRubyClient.configure do |config|
895
- # Configure API key authorization: Cookie
896
- config.api_key['Cookie'] = 'YOUR API KEY'
897
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
898
- # config.api_key_prefix['Cookie'] = 'Bearer'
899
-
900
766
  # Configure API key authorization: ApiKey
901
767
  config.api_key['ApiKey'] = 'YOUR API KEY'
902
768
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
@@ -908,7 +774,7 @@ tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the reque
908
774
  update_chunk_by_tracking_id_data = TrieveRubyClient::UpdateChunkByTrackingIdData.new({tracking_id: 'tracking_id_example'}) # UpdateChunkByTrackingIdData | JSON request payload to update a chunk by tracking_id (chunks)
909
775
 
910
776
  begin
911
- # update_chunk_by_tracking_id
777
+ # Update Chunk By Tracking Id
912
778
  api_instance.update_chunk_by_tracking_id(tr_dataset, update_chunk_by_tracking_id_data)
913
779
  rescue TrieveRubyClient::ApiError => e
914
780
  puts "Error when calling ChunkApi->update_chunk_by_tracking_id: #{e}"
@@ -923,7 +789,7 @@ This returns an Array which contains the response data (`nil` in this case), sta
923
789
 
924
790
  ```ruby
925
791
  begin
926
- # update_chunk_by_tracking_id
792
+ # Update Chunk By Tracking Id
927
793
  data, status_code, headers = api_instance.update_chunk_by_tracking_id_with_http_info(tr_dataset, update_chunk_by_tracking_id_data)
928
794
  p status_code # => 2xx
929
795
  p headers # => { ... }
@@ -946,7 +812,7 @@ nil (empty response body)
946
812
 
947
813
  ### Authorization
948
814
 
949
- [Cookie](../README.md#Cookie), [ApiKey](../README.md#ApiKey)
815
+ [ApiKey](../README.md#ApiKey)
950
816
 
951
817
  ### HTTP request headers
952
818