ragie_ruby_sdk 1.0.15 → 1.0.17

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 (55) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +20 -5
  3. data/docs/BetaApi.md +140 -0
  4. data/docs/CodeInterpreterOutput.md +28 -0
  5. data/docs/CodeInterpreterOutputLogs.md +20 -0
  6. data/docs/FileSearchOutput.md +26 -0
  7. data/docs/FileSearchResult.md +26 -0
  8. data/docs/FinalAnswerStepsInner.md +4 -0
  9. data/docs/PartitionsApi.md +140 -0
  10. data/docs/QueryDetails.md +24 -0
  11. data/docs/ReasoningOutput.md +28 -0
  12. data/docs/ReasoningSummary.md +20 -0
  13. data/docs/ReasoningText.md +20 -0
  14. data/docs/Response.md +1 -1
  15. data/docs/ResponseOutputInner.md +40 -0
  16. data/docs/{ResponseOutput.md → ResponseOutputMessage.md} +2 -2
  17. data/docs/SearchEffort.md +15 -0
  18. data/docs/SearchStep.md +1 -1
  19. data/docs/SearchStepWithQueryDetails.md +24 -0
  20. data/lib/ragie_ruby_sdk/api/beta_api.rb +126 -0
  21. data/lib/ragie_ruby_sdk/api/partitions_api.rb +126 -0
  22. data/lib/ragie_ruby_sdk/models/code_interpreter_output.rb +389 -0
  23. data/lib/ragie_ruby_sdk/models/code_interpreter_output_logs.rb +283 -0
  24. data/lib/ragie_ruby_sdk/models/file_search_output.rb +368 -0
  25. data/lib/ragie_ruby_sdk/models/file_search_result.rb +348 -0
  26. data/lib/ragie_ruby_sdk/models/final_answer_steps_inner.rb +1 -0
  27. data/lib/ragie_ruby_sdk/models/metadata_value.rb +1 -0
  28. data/lib/ragie_ruby_sdk/models/query_details.rb +341 -0
  29. data/lib/ragie_ruby_sdk/models/reasoning_output.rb +391 -0
  30. data/lib/ragie_ruby_sdk/models/reasoning_summary.rb +283 -0
  31. data/lib/ragie_ruby_sdk/models/reasoning_text.rb +283 -0
  32. data/lib/ragie_ruby_sdk/models/response.rb +1 -1
  33. data/lib/ragie_ruby_sdk/models/response_output_inner.rb +105 -0
  34. data/lib/ragie_ruby_sdk/models/{response_output.rb → response_output_message.rb} +3 -3
  35. data/lib/ragie_ruby_sdk/models/search_effort.rb +41 -0
  36. data/lib/ragie_ruby_sdk/models/search_step.rb +3 -3
  37. data/lib/ragie_ruby_sdk/models/search_step_with_query_details.rb +306 -0
  38. data/lib/ragie_ruby_sdk/version.rb +1 -1
  39. data/lib/ragie_ruby_sdk.rb +12 -1
  40. data/spec/api/beta_api_spec.rb +24 -0
  41. data/spec/api/partitions_api_spec.rb +24 -0
  42. data/spec/models/code_interpreter_output_logs_spec.rb +46 -0
  43. data/spec/models/code_interpreter_output_spec.rb +74 -0
  44. data/spec/models/file_search_output_spec.rb +68 -0
  45. data/spec/models/file_search_result_spec.rb +60 -0
  46. data/spec/models/query_details_spec.rb +54 -0
  47. data/spec/models/reasoning_output_spec.rb +74 -0
  48. data/spec/models/reasoning_summary_spec.rb +46 -0
  49. data/spec/models/reasoning_text_spec.rb +46 -0
  50. data/spec/models/response_output_inner_spec.rb +21 -0
  51. data/spec/models/{response_output_spec.rb → response_output_message_spec.rb} +6 -6
  52. data/spec/models/search_effort_spec.rb +30 -0
  53. data/spec/models/search_step_spec.rb +1 -1
  54. data/spec/models/search_step_with_query_details_spec.rb +58 -0
  55. metadata +49 -5
@@ -0,0 +1,40 @@
1
+ # RagieRubySdk::ResponseOutputInner
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **type** | **String** | | [default to 'message'] |
8
+ | **id** | **String** | | |
9
+ | **role** | **String** | | [optional][default to 'assistant'] |
10
+ | **content** | [**Array<ReasoningText>**](ReasoningText.md) | The content of the reasoning. | |
11
+ | **summary** | [**Array<ReasoningSummary>**](ReasoningSummary.md) | The summary of the reasoning. | |
12
+ | **encrypted_content** | **String** | The encrypted content of the reasoning output. | |
13
+ | **status** | **String** | | [optional][default to 'searching'] |
14
+ | **code** | **String** | The code executed by the code interpreter. | |
15
+ | **container_id** | **String** | The ID of the container used to run the code. | |
16
+ | **outputs** | [**Array<CodeInterpreterOutputLogs>**](CodeInterpreterOutputLogs.md) | The outputs generated by the code interpreter, such as logs or images. | |
17
+ | **queries** | **Array<String>** | The queries used to search for files. | |
18
+ | **results** | [**Array<FileSearchResult>**](FileSearchResult.md) | The results of the file search tool call. | |
19
+
20
+ ## Example
21
+
22
+ ```ruby
23
+ require 'ragie_ruby_sdk'
24
+
25
+ instance = RagieRubySdk::ResponseOutputInner.new(
26
+ type: null,
27
+ id: null,
28
+ role: null,
29
+ content: null,
30
+ summary: null,
31
+ encrypted_content: null,
32
+ status: null,
33
+ code: null,
34
+ container_id: null,
35
+ outputs: null,
36
+ queries: null,
37
+ results: null
38
+ )
39
+ ```
40
+
@@ -1,4 +1,4 @@
1
- # RagieRubySdk::ResponseOutput
1
+ # RagieRubySdk::ResponseOutputMessage
2
2
 
3
3
  ## Properties
4
4
 
@@ -14,7 +14,7 @@
14
14
  ```ruby
15
15
  require 'ragie_ruby_sdk'
16
16
 
17
- instance = RagieRubySdk::ResponseOutput.new(
17
+ instance = RagieRubySdk::ResponseOutputMessage.new(
18
18
  type: null,
19
19
  id: null,
20
20
  role: null,
@@ -0,0 +1,15 @@
1
+ # RagieRubySdk::SearchEffort
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+
8
+ ## Example
9
+
10
+ ```ruby
11
+ require 'ragie_ruby_sdk'
12
+
13
+ instance = RagieRubySdk::SearchEffort.new()
14
+ ```
15
+
data/docs/SearchStep.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **type** | **String** | | [optional][default to 'search'] |
7
+ | **type** | **String** | | [optional][default to 'base_search'] |
8
8
  | **think** | **String** | | |
9
9
  | **current_question** | **String** | | |
10
10
  | **search** | [**Search**](Search.md) | The search request to be made. | |
@@ -0,0 +1,24 @@
1
+ # RagieRubySdk::SearchStepWithQueryDetails
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **type** | **String** | | [optional][default to 'search'] |
8
+ | **search** | [**Search**](Search.md) | The search request to be made. | |
9
+ | **query_details** | [**Array<QueryDetails>**](QueryDetails.md) | | [optional] |
10
+ | **search_log** | **String** | A log of the search results you found. | [optional][default to ''] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'ragie_ruby_sdk'
16
+
17
+ instance = RagieRubySdk::SearchStepWithQueryDetails.new(
18
+ type: null,
19
+ search: null,
20
+ query_details: null,
21
+ search_log: null
22
+ )
23
+ ```
24
+
@@ -292,6 +292,132 @@ module RagieRubySdk
292
292
  return data, status_code, headers
293
293
  end
294
294
 
295
+ # Disable Mcp
296
+ # Disables context-aware descriptions for a partition. This will stop automatically generating descriptions for the partition.
297
+ # @param partition_id [String]
298
+ # @param [Hash] opts the optional parameters
299
+ # @return [Object]
300
+ def disable_mcp_partitions_partition_id_mcp_delete(partition_id, opts = {})
301
+ data, _status_code, _headers = disable_mcp_partitions_partition_id_mcp_delete_with_http_info(partition_id, opts)
302
+ data
303
+ end
304
+
305
+ # Disable Mcp
306
+ # Disables context-aware descriptions for a partition. This will stop automatically generating descriptions for the partition.
307
+ # @param partition_id [String]
308
+ # @param [Hash] opts the optional parameters
309
+ # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
310
+ def disable_mcp_partitions_partition_id_mcp_delete_with_http_info(partition_id, opts = {})
311
+ if @api_client.config.debugging
312
+ @api_client.config.logger.debug 'Calling API: BetaApi.disable_mcp_partitions_partition_id_mcp_delete ...'
313
+ end
314
+ # verify the required parameter 'partition_id' is set
315
+ if @api_client.config.client_side_validation && partition_id.nil?
316
+ fail ArgumentError, "Missing the required parameter 'partition_id' when calling BetaApi.disable_mcp_partitions_partition_id_mcp_delete"
317
+ end
318
+ # resource path
319
+ local_var_path = '/partitions/{partition_id}/mcp'.sub('{' + 'partition_id' + '}', CGI.escape(partition_id.to_s))
320
+
321
+ # query parameters
322
+ query_params = opts[:query_params] || {}
323
+
324
+ # header parameters
325
+ header_params = opts[:header_params] || {}
326
+ # HTTP header 'Accept' (if needed)
327
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
328
+
329
+ # form parameters
330
+ form_params = opts[:form_params] || {}
331
+
332
+ # http body (model)
333
+ post_body = opts[:debug_body]
334
+
335
+ # return_type
336
+ return_type = opts[:debug_return_type] || 'Object'
337
+
338
+ # auth_names
339
+ auth_names = opts[:debug_auth_names] || ['auth']
340
+
341
+ new_options = opts.merge(
342
+ :operation => :"BetaApi.disable_mcp_partitions_partition_id_mcp_delete",
343
+ :header_params => header_params,
344
+ :query_params => query_params,
345
+ :form_params => form_params,
346
+ :body => post_body,
347
+ :auth_names => auth_names,
348
+ :return_type => return_type
349
+ )
350
+
351
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
352
+ if @api_client.config.debugging
353
+ @api_client.config.logger.debug "API called: BetaApi#disable_mcp_partitions_partition_id_mcp_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
354
+ end
355
+ return data, status_code, headers
356
+ end
357
+
358
+ # Enable Mcp
359
+ # Enables context-aware descriptions for a partition. This will allow the automatically generate a desccription for based on the documents in the partition.
360
+ # @param partition_id [String]
361
+ # @param [Hash] opts the optional parameters
362
+ # @return [Object]
363
+ def enable_mcp_partitions_partition_id_mcp_post(partition_id, opts = {})
364
+ data, _status_code, _headers = enable_mcp_partitions_partition_id_mcp_post_with_http_info(partition_id, opts)
365
+ data
366
+ end
367
+
368
+ # Enable Mcp
369
+ # Enables context-aware descriptions for a partition. This will allow the automatically generate a desccription for based on the documents in the partition.
370
+ # @param partition_id [String]
371
+ # @param [Hash] opts the optional parameters
372
+ # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
373
+ def enable_mcp_partitions_partition_id_mcp_post_with_http_info(partition_id, opts = {})
374
+ if @api_client.config.debugging
375
+ @api_client.config.logger.debug 'Calling API: BetaApi.enable_mcp_partitions_partition_id_mcp_post ...'
376
+ end
377
+ # verify the required parameter 'partition_id' is set
378
+ if @api_client.config.client_side_validation && partition_id.nil?
379
+ fail ArgumentError, "Missing the required parameter 'partition_id' when calling BetaApi.enable_mcp_partitions_partition_id_mcp_post"
380
+ end
381
+ # resource path
382
+ local_var_path = '/partitions/{partition_id}/mcp'.sub('{' + 'partition_id' + '}', CGI.escape(partition_id.to_s))
383
+
384
+ # query parameters
385
+ query_params = opts[:query_params] || {}
386
+
387
+ # header parameters
388
+ header_params = opts[:header_params] || {}
389
+ # HTTP header 'Accept' (if needed)
390
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
391
+
392
+ # form parameters
393
+ form_params = opts[:form_params] || {}
394
+
395
+ # http body (model)
396
+ post_body = opts[:debug_body]
397
+
398
+ # return_type
399
+ return_type = opts[:debug_return_type] || 'Object'
400
+
401
+ # auth_names
402
+ auth_names = opts[:debug_auth_names] || ['auth']
403
+
404
+ new_options = opts.merge(
405
+ :operation => :"BetaApi.enable_mcp_partitions_partition_id_mcp_post",
406
+ :header_params => header_params,
407
+ :query_params => query_params,
408
+ :form_params => form_params,
409
+ :body => post_body,
410
+ :auth_names => auth_names,
411
+ :return_type => return_type
412
+ )
413
+
414
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
415
+ if @api_client.config.debugging
416
+ @api_client.config.logger.debug "API called: BetaApi#enable_mcp_partitions_partition_id_mcp_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
417
+ end
418
+ return data, status_code, headers
419
+ end
420
+
295
421
  # List Authenticators
296
422
  # List all authenticators sorted by created_at in descending order. Results are paginated with a max limit of 100. When more authenticators are available, a `cursor` will be provided. Use the `cursor` parameter to retrieve the subsequent page.
297
423
  # @param [Hash] opts the optional parameters
@@ -150,6 +150,132 @@ module RagieRubySdk
150
150
  return data, status_code, headers
151
151
  end
152
152
 
153
+ # Disable Mcp
154
+ # Disables context-aware descriptions for a partition. This will stop automatically generating descriptions for the partition.
155
+ # @param partition_id [String]
156
+ # @param [Hash] opts the optional parameters
157
+ # @return [Object]
158
+ def disable_mcp_partitions_partition_id_mcp_delete(partition_id, opts = {})
159
+ data, _status_code, _headers = disable_mcp_partitions_partition_id_mcp_delete_with_http_info(partition_id, opts)
160
+ data
161
+ end
162
+
163
+ # Disable Mcp
164
+ # Disables context-aware descriptions for a partition. This will stop automatically generating descriptions for the partition.
165
+ # @param partition_id [String]
166
+ # @param [Hash] opts the optional parameters
167
+ # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
168
+ def disable_mcp_partitions_partition_id_mcp_delete_with_http_info(partition_id, opts = {})
169
+ if @api_client.config.debugging
170
+ @api_client.config.logger.debug 'Calling API: PartitionsApi.disable_mcp_partitions_partition_id_mcp_delete ...'
171
+ end
172
+ # verify the required parameter 'partition_id' is set
173
+ if @api_client.config.client_side_validation && partition_id.nil?
174
+ fail ArgumentError, "Missing the required parameter 'partition_id' when calling PartitionsApi.disable_mcp_partitions_partition_id_mcp_delete"
175
+ end
176
+ # resource path
177
+ local_var_path = '/partitions/{partition_id}/mcp'.sub('{' + 'partition_id' + '}', CGI.escape(partition_id.to_s))
178
+
179
+ # query parameters
180
+ query_params = opts[:query_params] || {}
181
+
182
+ # header parameters
183
+ header_params = opts[:header_params] || {}
184
+ # HTTP header 'Accept' (if needed)
185
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
186
+
187
+ # form parameters
188
+ form_params = opts[:form_params] || {}
189
+
190
+ # http body (model)
191
+ post_body = opts[:debug_body]
192
+
193
+ # return_type
194
+ return_type = opts[:debug_return_type] || 'Object'
195
+
196
+ # auth_names
197
+ auth_names = opts[:debug_auth_names] || ['auth']
198
+
199
+ new_options = opts.merge(
200
+ :operation => :"PartitionsApi.disable_mcp_partitions_partition_id_mcp_delete",
201
+ :header_params => header_params,
202
+ :query_params => query_params,
203
+ :form_params => form_params,
204
+ :body => post_body,
205
+ :auth_names => auth_names,
206
+ :return_type => return_type
207
+ )
208
+
209
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
210
+ if @api_client.config.debugging
211
+ @api_client.config.logger.debug "API called: PartitionsApi#disable_mcp_partitions_partition_id_mcp_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
212
+ end
213
+ return data, status_code, headers
214
+ end
215
+
216
+ # Enable Mcp
217
+ # Enables context-aware descriptions for a partition. This will allow the automatically generate a desccription for based on the documents in the partition.
218
+ # @param partition_id [String]
219
+ # @param [Hash] opts the optional parameters
220
+ # @return [Object]
221
+ def enable_mcp_partitions_partition_id_mcp_post(partition_id, opts = {})
222
+ data, _status_code, _headers = enable_mcp_partitions_partition_id_mcp_post_with_http_info(partition_id, opts)
223
+ data
224
+ end
225
+
226
+ # Enable Mcp
227
+ # Enables context-aware descriptions for a partition. This will allow the automatically generate a desccription for based on the documents in the partition.
228
+ # @param partition_id [String]
229
+ # @param [Hash] opts the optional parameters
230
+ # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
231
+ def enable_mcp_partitions_partition_id_mcp_post_with_http_info(partition_id, opts = {})
232
+ if @api_client.config.debugging
233
+ @api_client.config.logger.debug 'Calling API: PartitionsApi.enable_mcp_partitions_partition_id_mcp_post ...'
234
+ end
235
+ # verify the required parameter 'partition_id' is set
236
+ if @api_client.config.client_side_validation && partition_id.nil?
237
+ fail ArgumentError, "Missing the required parameter 'partition_id' when calling PartitionsApi.enable_mcp_partitions_partition_id_mcp_post"
238
+ end
239
+ # resource path
240
+ local_var_path = '/partitions/{partition_id}/mcp'.sub('{' + 'partition_id' + '}', CGI.escape(partition_id.to_s))
241
+
242
+ # query parameters
243
+ query_params = opts[:query_params] || {}
244
+
245
+ # header parameters
246
+ header_params = opts[:header_params] || {}
247
+ # HTTP header 'Accept' (if needed)
248
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
249
+
250
+ # form parameters
251
+ form_params = opts[:form_params] || {}
252
+
253
+ # http body (model)
254
+ post_body = opts[:debug_body]
255
+
256
+ # return_type
257
+ return_type = opts[:debug_return_type] || 'Object'
258
+
259
+ # auth_names
260
+ auth_names = opts[:debug_auth_names] || ['auth']
261
+
262
+ new_options = opts.merge(
263
+ :operation => :"PartitionsApi.enable_mcp_partitions_partition_id_mcp_post",
264
+ :header_params => header_params,
265
+ :query_params => query_params,
266
+ :form_params => form_params,
267
+ :body => post_body,
268
+ :auth_names => auth_names,
269
+ :return_type => return_type
270
+ )
271
+
272
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
273
+ if @api_client.config.debugging
274
+ @api_client.config.logger.debug "API called: PartitionsApi#enable_mcp_partitions_partition_id_mcp_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
275
+ end
276
+ return data, status_code, headers
277
+ end
278
+
153
279
  # Get Partition
154
280
  # Get a partition by its ID. Includes usage information such as the number of documents and pages hosted and processed. The partition's limits are also included.
155
281
  # @param partition_id [String]