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.
- checksums.yaml +4 -4
- data/README.md +20 -5
- data/docs/BetaApi.md +140 -0
- data/docs/CodeInterpreterOutput.md +28 -0
- data/docs/CodeInterpreterOutputLogs.md +20 -0
- data/docs/FileSearchOutput.md +26 -0
- data/docs/FileSearchResult.md +26 -0
- data/docs/FinalAnswerStepsInner.md +4 -0
- data/docs/PartitionsApi.md +140 -0
- data/docs/QueryDetails.md +24 -0
- data/docs/ReasoningOutput.md +28 -0
- data/docs/ReasoningSummary.md +20 -0
- data/docs/ReasoningText.md +20 -0
- data/docs/Response.md +1 -1
- data/docs/ResponseOutputInner.md +40 -0
- data/docs/{ResponseOutput.md → ResponseOutputMessage.md} +2 -2
- data/docs/SearchEffort.md +15 -0
- data/docs/SearchStep.md +1 -1
- data/docs/SearchStepWithQueryDetails.md +24 -0
- data/lib/ragie_ruby_sdk/api/beta_api.rb +126 -0
- data/lib/ragie_ruby_sdk/api/partitions_api.rb +126 -0
- data/lib/ragie_ruby_sdk/models/code_interpreter_output.rb +389 -0
- data/lib/ragie_ruby_sdk/models/code_interpreter_output_logs.rb +283 -0
- data/lib/ragie_ruby_sdk/models/file_search_output.rb +368 -0
- data/lib/ragie_ruby_sdk/models/file_search_result.rb +348 -0
- data/lib/ragie_ruby_sdk/models/final_answer_steps_inner.rb +1 -0
- data/lib/ragie_ruby_sdk/models/metadata_value.rb +1 -0
- data/lib/ragie_ruby_sdk/models/query_details.rb +341 -0
- data/lib/ragie_ruby_sdk/models/reasoning_output.rb +391 -0
- data/lib/ragie_ruby_sdk/models/reasoning_summary.rb +283 -0
- data/lib/ragie_ruby_sdk/models/reasoning_text.rb +283 -0
- data/lib/ragie_ruby_sdk/models/response.rb +1 -1
- data/lib/ragie_ruby_sdk/models/response_output_inner.rb +105 -0
- data/lib/ragie_ruby_sdk/models/{response_output.rb → response_output_message.rb} +3 -3
- data/lib/ragie_ruby_sdk/models/search_effort.rb +41 -0
- data/lib/ragie_ruby_sdk/models/search_step.rb +3 -3
- data/lib/ragie_ruby_sdk/models/search_step_with_query_details.rb +306 -0
- data/lib/ragie_ruby_sdk/version.rb +1 -1
- data/lib/ragie_ruby_sdk.rb +12 -1
- data/spec/api/beta_api_spec.rb +24 -0
- data/spec/api/partitions_api_spec.rb +24 -0
- data/spec/models/code_interpreter_output_logs_spec.rb +46 -0
- data/spec/models/code_interpreter_output_spec.rb +74 -0
- data/spec/models/file_search_output_spec.rb +68 -0
- data/spec/models/file_search_result_spec.rb +60 -0
- data/spec/models/query_details_spec.rb +54 -0
- data/spec/models/reasoning_output_spec.rb +74 -0
- data/spec/models/reasoning_summary_spec.rb +46 -0
- data/spec/models/reasoning_text_spec.rb +46 -0
- data/spec/models/response_output_inner_spec.rb +21 -0
- data/spec/models/{response_output_spec.rb → response_output_message_spec.rb} +6 -6
- data/spec/models/search_effort_spec.rb +30 -0
- data/spec/models/search_step_spec.rb +1 -1
- data/spec/models/search_step_with_query_details_spec.rb +58 -0
- metadata +49 -5
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: cfe3b2c480ab35d9b6d15864337fc784d9b643beb15b5c7c68ebea233b3a8751
|
|
4
|
+
data.tar.gz: 2e4ced50df79622c78e0cfe6d6d02261ccc8053ca27098b5f713d0d3eba538df
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 5257c810502691db0ff9859d2e00373ea666bfdd4c45efd36050395d696511b631cf789a06decc9808862ccad597c1043d48fe632326ade4be1ba144ae73db0c
|
|
7
|
+
data.tar.gz: 0fb5cb55e4f833c2afa6ede62547fd2bd2d196424ccdcf390c80a246d6556b1eccf845d817baf7ae777b5b4ea3cff0fb01c04c7dee8e44de01a804b9d2140dd6
|
data/README.md
CHANGED
|
@@ -7,7 +7,7 @@ No description provided (generated by Openapi Generator https://github.com/opena
|
|
|
7
7
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
8
8
|
|
|
9
9
|
- API version: 1.0.0
|
|
10
|
-
- Package version: 1.0.
|
|
10
|
+
- Package version: 1.0.16
|
|
11
11
|
- Generator version: 7.17.0-SNAPSHOT
|
|
12
12
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
|
13
13
|
|
|
@@ -24,16 +24,16 @@ gem build ragie_ruby_sdk.gemspec
|
|
|
24
24
|
Then either install the gem locally:
|
|
25
25
|
|
|
26
26
|
```shell
|
|
27
|
-
gem install ./ragie_ruby_sdk-1.0.
|
|
27
|
+
gem install ./ragie_ruby_sdk-1.0.16.gem
|
|
28
28
|
```
|
|
29
29
|
|
|
30
|
-
(for development, run `gem install --dev ./ragie_ruby_sdk-1.0.
|
|
30
|
+
(for development, run `gem install --dev ./ragie_ruby_sdk-1.0.16.gem` to install the development dependencies)
|
|
31
31
|
|
|
32
32
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
|
33
33
|
|
|
34
34
|
Finally add this to the Gemfile:
|
|
35
35
|
|
|
36
|
-
gem 'ragie_ruby_sdk', '~> 1.0.
|
|
36
|
+
gem 'ragie_ruby_sdk', '~> 1.0.16'
|
|
37
37
|
|
|
38
38
|
### Install from Git
|
|
39
39
|
|
|
@@ -94,6 +94,8 @@ Class | Method | HTTP request | Description
|
|
|
94
94
|
*RagieRubySdk::BetaApi* | [**create_authenticator_connection**](docs/BetaApi.md#create_authenticator_connection) | **POST** /authenticators/{authenticator_id}/connection | Create Authenticator Connection
|
|
95
95
|
*RagieRubySdk::BetaApi* | [**create_connection**](docs/BetaApi.md#create_connection) | **POST** /connection | Create Connection
|
|
96
96
|
*RagieRubySdk::BetaApi* | [**delete_authenticator_connection**](docs/BetaApi.md#delete_authenticator_connection) | **DELETE** /authenticators/{authenticator_id} | Delete Authenticator
|
|
97
|
+
*RagieRubySdk::BetaApi* | [**disable_mcp_partitions_partition_id_mcp_delete**](docs/BetaApi.md#disable_mcp_partitions_partition_id_mcp_delete) | **DELETE** /partitions/{partition_id}/mcp | Disable Mcp
|
|
98
|
+
*RagieRubySdk::BetaApi* | [**enable_mcp_partitions_partition_id_mcp_post**](docs/BetaApi.md#enable_mcp_partitions_partition_id_mcp_post) | **POST** /partitions/{partition_id}/mcp | Enable Mcp
|
|
97
99
|
*RagieRubySdk::BetaApi* | [**list_authenticators**](docs/BetaApi.md#list_authenticators) | **GET** /authenticators | List Authenticators
|
|
98
100
|
*RagieRubySdk::ConnectionsApi* | [**create_connection**](docs/ConnectionsApi.md#create_connection) | **POST** /connection | Create Connection
|
|
99
101
|
*RagieRubySdk::ConnectionsApi* | [**create_oauth_redirect_url_connections_oauth_post**](docs/ConnectionsApi.md#create_oauth_redirect_url_connections_oauth_post) | **POST** /connections/oauth | Create Oauth Redirect Url
|
|
@@ -135,6 +137,8 @@ Class | Method | HTTP request | Description
|
|
|
135
137
|
*RagieRubySdk::EntitiesApi* | [**update_instruction**](docs/EntitiesApi.md#update_instruction) | **PUT** /instructions/{instruction_id} | Update Instruction
|
|
136
138
|
*RagieRubySdk::PartitionsApi* | [**create_partition_partitions_post**](docs/PartitionsApi.md#create_partition_partitions_post) | **POST** /partitions | Create Partition
|
|
137
139
|
*RagieRubySdk::PartitionsApi* | [**delete_partition_partitions_partition_id_delete**](docs/PartitionsApi.md#delete_partition_partitions_partition_id_delete) | **DELETE** /partitions/{partition_id} | Delete Partition
|
|
140
|
+
*RagieRubySdk::PartitionsApi* | [**disable_mcp_partitions_partition_id_mcp_delete**](docs/PartitionsApi.md#disable_mcp_partitions_partition_id_mcp_delete) | **DELETE** /partitions/{partition_id}/mcp | Disable Mcp
|
|
141
|
+
*RagieRubySdk::PartitionsApi* | [**enable_mcp_partitions_partition_id_mcp_post**](docs/PartitionsApi.md#enable_mcp_partitions_partition_id_mcp_post) | **POST** /partitions/{partition_id}/mcp | Enable Mcp
|
|
138
142
|
*RagieRubySdk::PartitionsApi* | [**get_partition_partitions_partition_id_get**](docs/PartitionsApi.md#get_partition_partitions_partition_id_get) | **GET** /partitions/{partition_id} | Get Partition
|
|
139
143
|
*RagieRubySdk::PartitionsApi* | [**list_partitions_partitions_get**](docs/PartitionsApi.md#list_partitions_partitions_get) | **GET** /partitions | List Partitions
|
|
140
144
|
*RagieRubySdk::PartitionsApi* | [**set_partition_limits_partitions_partition_id_limits_put**](docs/PartitionsApi.md#set_partition_limits_partitions_partition_id_limits_put) | **PUT** /partitions/{partition_id}/limits | Set Partition Limits
|
|
@@ -170,6 +174,8 @@ Class | Method | HTTP request | Description
|
|
|
170
174
|
- [RagieRubySdk::BodyUpdateDocumentFile](docs/BodyUpdateDocumentFile.md)
|
|
171
175
|
- [RagieRubySdk::BucketData](docs/BucketData.md)
|
|
172
176
|
- [RagieRubySdk::CodeInterpreterEvidence](docs/CodeInterpreterEvidence.md)
|
|
177
|
+
- [RagieRubySdk::CodeInterpreterOutput](docs/CodeInterpreterOutput.md)
|
|
178
|
+
- [RagieRubySdk::CodeInterpreterOutputLogs](docs/CodeInterpreterOutputLogs.md)
|
|
173
179
|
- [RagieRubySdk::CodeStep](docs/CodeStep.md)
|
|
174
180
|
- [RagieRubySdk::ConfluenceData](docs/ConfluenceData.md)
|
|
175
181
|
- [RagieRubySdk::Connection](docs/Connection.md)
|
|
@@ -222,6 +228,8 @@ Class | Method | HTTP request | Description
|
|
|
222
228
|
- [RagieRubySdk::EntityList](docs/EntityList.md)
|
|
223
229
|
- [RagieRubySdk::ErrorMessage](docs/ErrorMessage.md)
|
|
224
230
|
- [RagieRubySdk::EvaluatedAnswerStep](docs/EvaluatedAnswerStep.md)
|
|
231
|
+
- [RagieRubySdk::FileSearchOutput](docs/FileSearchOutput.md)
|
|
232
|
+
- [RagieRubySdk::FileSearchResult](docs/FileSearchResult.md)
|
|
225
233
|
- [RagieRubySdk::FinalAnswer](docs/FinalAnswer.md)
|
|
226
234
|
- [RagieRubySdk::FinalAnswerEvidenceInner](docs/FinalAnswerEvidenceInner.md)
|
|
227
235
|
- [RagieRubySdk::FinalAnswerStepsInner](docs/FinalAnswerStepsInner.md)
|
|
@@ -274,22 +282,29 @@ Class | Method | HTTP request | Description
|
|
|
274
282
|
- [RagieRubySdk::PublicIntercomConnection](docs/PublicIntercomConnection.md)
|
|
275
283
|
- [RagieRubySdk::PublicS3CompatibleConnection](docs/PublicS3CompatibleConnection.md)
|
|
276
284
|
- [RagieRubySdk::PublicZendeskConnection](docs/PublicZendeskConnection.md)
|
|
285
|
+
- [RagieRubySdk::QueryDetails](docs/QueryDetails.md)
|
|
277
286
|
- [RagieRubySdk::RagieApiSchemaResponseUsage](docs/RagieApiSchemaResponseUsage.md)
|
|
278
287
|
- [RagieRubySdk::RagieEvidence](docs/RagieEvidence.md)
|
|
279
288
|
- [RagieRubySdk::Reasoning](docs/Reasoning.md)
|
|
289
|
+
- [RagieRubySdk::ReasoningOutput](docs/ReasoningOutput.md)
|
|
290
|
+
- [RagieRubySdk::ReasoningSummary](docs/ReasoningSummary.md)
|
|
291
|
+
- [RagieRubySdk::ReasoningText](docs/ReasoningText.md)
|
|
280
292
|
- [RagieRubySdk::Request](docs/Request.md)
|
|
281
293
|
- [RagieRubySdk::Response](docs/Response.md)
|
|
282
294
|
- [RagieRubySdk::ResponseContent](docs/ResponseContent.md)
|
|
283
295
|
- [RagieRubySdk::ResponseOK](docs/ResponseOK.md)
|
|
284
|
-
- [RagieRubySdk::
|
|
296
|
+
- [RagieRubySdk::ResponseOutputInner](docs/ResponseOutputInner.md)
|
|
297
|
+
- [RagieRubySdk::ResponseOutputMessage](docs/ResponseOutputMessage.md)
|
|
285
298
|
- [RagieRubySdk::ResponsePatchdocumentmetadata](docs/ResponsePatchdocumentmetadata.md)
|
|
286
299
|
- [RagieRubySdk::Retrieval](docs/Retrieval.md)
|
|
287
300
|
- [RagieRubySdk::RetrieveParams](docs/RetrieveParams.md)
|
|
288
301
|
- [RagieRubySdk::S3CompatibleCredentials](docs/S3CompatibleCredentials.md)
|
|
289
302
|
- [RagieRubySdk::ScoredChunk](docs/ScoredChunk.md)
|
|
290
303
|
- [RagieRubySdk::Search](docs/Search.md)
|
|
304
|
+
- [RagieRubySdk::SearchEffort](docs/SearchEffort.md)
|
|
291
305
|
- [RagieRubySdk::SearchResultLink](docs/SearchResultLink.md)
|
|
292
306
|
- [RagieRubySdk::SearchStep](docs/SearchStep.md)
|
|
307
|
+
- [RagieRubySdk::SearchStepWithQueryDetails](docs/SearchStepWithQueryDetails.md)
|
|
293
308
|
- [RagieRubySdk::SetConnectionEnabledPayload](docs/SetConnectionEnabledPayload.md)
|
|
294
309
|
- [RagieRubySdk::SharepointData](docs/SharepointData.md)
|
|
295
310
|
- [RagieRubySdk::SharepointFileData](docs/SharepointFileData.md)
|
data/docs/BetaApi.md
CHANGED
|
@@ -8,6 +8,8 @@ All URIs are relative to *https://api.ragie.ai*
|
|
|
8
8
|
| [**create_authenticator_connection**](BetaApi.md#create_authenticator_connection) | **POST** /authenticators/{authenticator_id}/connection | Create Authenticator Connection |
|
|
9
9
|
| [**create_connection**](BetaApi.md#create_connection) | **POST** /connection | Create Connection |
|
|
10
10
|
| [**delete_authenticator_connection**](BetaApi.md#delete_authenticator_connection) | **DELETE** /authenticators/{authenticator_id} | Delete Authenticator |
|
|
11
|
+
| [**disable_mcp_partitions_partition_id_mcp_delete**](BetaApi.md#disable_mcp_partitions_partition_id_mcp_delete) | **DELETE** /partitions/{partition_id}/mcp | Disable Mcp |
|
|
12
|
+
| [**enable_mcp_partitions_partition_id_mcp_post**](BetaApi.md#enable_mcp_partitions_partition_id_mcp_post) | **POST** /partitions/{partition_id}/mcp | Enable Mcp |
|
|
11
13
|
| [**list_authenticators**](BetaApi.md#list_authenticators) | **GET** /authenticators | List Authenticators |
|
|
12
14
|
|
|
13
15
|
|
|
@@ -289,6 +291,144 @@ end
|
|
|
289
291
|
- **Accept**: application/json
|
|
290
292
|
|
|
291
293
|
|
|
294
|
+
## disable_mcp_partitions_partition_id_mcp_delete
|
|
295
|
+
|
|
296
|
+
> Object disable_mcp_partitions_partition_id_mcp_delete(partition_id)
|
|
297
|
+
|
|
298
|
+
Disable Mcp
|
|
299
|
+
|
|
300
|
+
Disables context-aware descriptions for a partition. This will stop automatically generating descriptions for the partition.
|
|
301
|
+
|
|
302
|
+
### Examples
|
|
303
|
+
|
|
304
|
+
```ruby
|
|
305
|
+
require 'time'
|
|
306
|
+
require 'ragie_ruby_sdk'
|
|
307
|
+
# setup authorization
|
|
308
|
+
RagieRubySdk.configure do |config|
|
|
309
|
+
# Configure Bearer authorization: auth
|
|
310
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
311
|
+
end
|
|
312
|
+
|
|
313
|
+
api_instance = RagieRubySdk::BetaApi.new
|
|
314
|
+
partition_id = 'partition_id_example' # String |
|
|
315
|
+
|
|
316
|
+
begin
|
|
317
|
+
# Disable Mcp
|
|
318
|
+
result = api_instance.disable_mcp_partitions_partition_id_mcp_delete(partition_id)
|
|
319
|
+
p result
|
|
320
|
+
rescue RagieRubySdk::ApiError => e
|
|
321
|
+
puts "Error when calling BetaApi->disable_mcp_partitions_partition_id_mcp_delete: #{e}"
|
|
322
|
+
end
|
|
323
|
+
```
|
|
324
|
+
|
|
325
|
+
#### Using the disable_mcp_partitions_partition_id_mcp_delete_with_http_info variant
|
|
326
|
+
|
|
327
|
+
This returns an Array which contains the response data, status code and headers.
|
|
328
|
+
|
|
329
|
+
> <Array(Object, Integer, Hash)> disable_mcp_partitions_partition_id_mcp_delete_with_http_info(partition_id)
|
|
330
|
+
|
|
331
|
+
```ruby
|
|
332
|
+
begin
|
|
333
|
+
# Disable Mcp
|
|
334
|
+
data, status_code, headers = api_instance.disable_mcp_partitions_partition_id_mcp_delete_with_http_info(partition_id)
|
|
335
|
+
p status_code # => 2xx
|
|
336
|
+
p headers # => { ... }
|
|
337
|
+
p data # => Object
|
|
338
|
+
rescue RagieRubySdk::ApiError => e
|
|
339
|
+
puts "Error when calling BetaApi->disable_mcp_partitions_partition_id_mcp_delete_with_http_info: #{e}"
|
|
340
|
+
end
|
|
341
|
+
```
|
|
342
|
+
|
|
343
|
+
### Parameters
|
|
344
|
+
|
|
345
|
+
| Name | Type | Description | Notes |
|
|
346
|
+
| ---- | ---- | ----------- | ----- |
|
|
347
|
+
| **partition_id** | **String** | | |
|
|
348
|
+
|
|
349
|
+
### Return type
|
|
350
|
+
|
|
351
|
+
**Object**
|
|
352
|
+
|
|
353
|
+
### Authorization
|
|
354
|
+
|
|
355
|
+
[auth](../README.md#auth)
|
|
356
|
+
|
|
357
|
+
### HTTP request headers
|
|
358
|
+
|
|
359
|
+
- **Content-Type**: Not defined
|
|
360
|
+
- **Accept**: application/json
|
|
361
|
+
|
|
362
|
+
|
|
363
|
+
## enable_mcp_partitions_partition_id_mcp_post
|
|
364
|
+
|
|
365
|
+
> Object enable_mcp_partitions_partition_id_mcp_post(partition_id)
|
|
366
|
+
|
|
367
|
+
Enable Mcp
|
|
368
|
+
|
|
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
|
+
|
|
371
|
+
### Examples
|
|
372
|
+
|
|
373
|
+
```ruby
|
|
374
|
+
require 'time'
|
|
375
|
+
require 'ragie_ruby_sdk'
|
|
376
|
+
# setup authorization
|
|
377
|
+
RagieRubySdk.configure do |config|
|
|
378
|
+
# Configure Bearer authorization: auth
|
|
379
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
380
|
+
end
|
|
381
|
+
|
|
382
|
+
api_instance = RagieRubySdk::BetaApi.new
|
|
383
|
+
partition_id = 'partition_id_example' # String |
|
|
384
|
+
|
|
385
|
+
begin
|
|
386
|
+
# Enable Mcp
|
|
387
|
+
result = api_instance.enable_mcp_partitions_partition_id_mcp_post(partition_id)
|
|
388
|
+
p result
|
|
389
|
+
rescue RagieRubySdk::ApiError => e
|
|
390
|
+
puts "Error when calling BetaApi->enable_mcp_partitions_partition_id_mcp_post: #{e}"
|
|
391
|
+
end
|
|
392
|
+
```
|
|
393
|
+
|
|
394
|
+
#### Using the enable_mcp_partitions_partition_id_mcp_post_with_http_info variant
|
|
395
|
+
|
|
396
|
+
This returns an Array which contains the response data, status code and headers.
|
|
397
|
+
|
|
398
|
+
> <Array(Object, Integer, Hash)> enable_mcp_partitions_partition_id_mcp_post_with_http_info(partition_id)
|
|
399
|
+
|
|
400
|
+
```ruby
|
|
401
|
+
begin
|
|
402
|
+
# Enable Mcp
|
|
403
|
+
data, status_code, headers = api_instance.enable_mcp_partitions_partition_id_mcp_post_with_http_info(partition_id)
|
|
404
|
+
p status_code # => 2xx
|
|
405
|
+
p headers # => { ... }
|
|
406
|
+
p data # => Object
|
|
407
|
+
rescue RagieRubySdk::ApiError => e
|
|
408
|
+
puts "Error when calling BetaApi->enable_mcp_partitions_partition_id_mcp_post_with_http_info: #{e}"
|
|
409
|
+
end
|
|
410
|
+
```
|
|
411
|
+
|
|
412
|
+
### Parameters
|
|
413
|
+
|
|
414
|
+
| Name | Type | Description | Notes |
|
|
415
|
+
| ---- | ---- | ----------- | ----- |
|
|
416
|
+
| **partition_id** | **String** | | |
|
|
417
|
+
|
|
418
|
+
### Return type
|
|
419
|
+
|
|
420
|
+
**Object**
|
|
421
|
+
|
|
422
|
+
### Authorization
|
|
423
|
+
|
|
424
|
+
[auth](../README.md#auth)
|
|
425
|
+
|
|
426
|
+
### HTTP request headers
|
|
427
|
+
|
|
428
|
+
- **Content-Type**: Not defined
|
|
429
|
+
- **Accept**: application/json
|
|
430
|
+
|
|
431
|
+
|
|
292
432
|
## list_authenticators
|
|
293
433
|
|
|
294
434
|
> <AuthenticatorList> list_authenticators(opts)
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# RagieRubySdk::CodeInterpreterOutput
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | The unique ID of the code interpreter tool call. | |
|
|
8
|
+
| **code** | **String** | The code executed by the code interpreter. | |
|
|
9
|
+
| **container_id** | **String** | The ID of the container used to run the code. | |
|
|
10
|
+
| **outputs** | [**Array<CodeInterpreterOutputLogs>**](CodeInterpreterOutputLogs.md) | The outputs generated by the code interpreter, such as logs or images. | |
|
|
11
|
+
| **type** | **String** | | [optional][default to 'code_interpreter_output'] |
|
|
12
|
+
| **status** | **String** | | [optional][default to 'completed'] |
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'ragie_ruby_sdk'
|
|
18
|
+
|
|
19
|
+
instance = RagieRubySdk::CodeInterpreterOutput.new(
|
|
20
|
+
id: null,
|
|
21
|
+
code: null,
|
|
22
|
+
container_id: null,
|
|
23
|
+
outputs: null,
|
|
24
|
+
type: null,
|
|
25
|
+
status: null
|
|
26
|
+
)
|
|
27
|
+
```
|
|
28
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# RagieRubySdk::CodeInterpreterOutputLogs
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **logs** | **String** | The logs output from the code interpreter. | |
|
|
8
|
+
| **type** | **String** | | [optional][default to 'logs'] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'ragie_ruby_sdk'
|
|
14
|
+
|
|
15
|
+
instance = RagieRubySdk::CodeInterpreterOutputLogs.new(
|
|
16
|
+
logs: null,
|
|
17
|
+
type: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# RagieRubySdk::FileSearchOutput
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | | |
|
|
8
|
+
| **queries** | **Array<String>** | The queries used to search for files. | |
|
|
9
|
+
| **status** | **String** | | [optional][default to 'searching'] |
|
|
10
|
+
| **type** | **String** | | |
|
|
11
|
+
| **results** | [**Array<FileSearchResult>**](FileSearchResult.md) | The results of the file search tool call. | |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'ragie_ruby_sdk'
|
|
17
|
+
|
|
18
|
+
instance = RagieRubySdk::FileSearchOutput.new(
|
|
19
|
+
id: null,
|
|
20
|
+
queries: null,
|
|
21
|
+
status: null,
|
|
22
|
+
type: null,
|
|
23
|
+
results: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# RagieRubySdk::FileSearchResult
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **file_id** | **String** | The unique ID of the document. | |
|
|
8
|
+
| **filename** | **String** | The name of the document. | |
|
|
9
|
+
| **score** | **Float** | The relevance score of the chunk - a value between 0 and 1. | |
|
|
10
|
+
| **text** | **String** | The text content of the chunk. | |
|
|
11
|
+
| **attributes** | **Hash<String, Object>** | The attributes of the chunk. | |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'ragie_ruby_sdk'
|
|
17
|
+
|
|
18
|
+
instance = RagieRubySdk::FileSearchResult.new(
|
|
19
|
+
file_id: null,
|
|
20
|
+
filename: null,
|
|
21
|
+
score: null,
|
|
22
|
+
text: null,
|
|
23
|
+
attributes: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -10,6 +10,8 @@
|
|
|
10
10
|
| **other_resolved_question_ids** | **Array<String>** | A list of questions ids that are no longer relevant to the current answer referenced by their IDs. | [optional] |
|
|
11
11
|
| **answer** | [**Answer**](Answer.md) | | |
|
|
12
12
|
| **search** | [**Search**](Search.md) | The search request to be made. | |
|
|
13
|
+
| **query_details** | [**Array<QueryDetails>**](QueryDetails.md) | | [optional] |
|
|
14
|
+
| **search_log** | **String** | A log of the search results you found. | [optional][default to ''] |
|
|
13
15
|
| **questions_to_answer** | **Array<String>** | The questions that need to be answered to answer the original question. | [optional] |
|
|
14
16
|
| **code_issue** | **String** | The natural language description of the code issue you need to solve. | |
|
|
15
17
|
| **code** | **String** | The code you generated to solve the code issue. | [optional][default to ''] |
|
|
@@ -30,6 +32,8 @@ instance = RagieRubySdk::FinalAnswerStepsInner.new(
|
|
|
30
32
|
other_resolved_question_ids: null,
|
|
31
33
|
answer: null,
|
|
32
34
|
search: null,
|
|
35
|
+
query_details: null,
|
|
36
|
+
search_log: null,
|
|
33
37
|
questions_to_answer: null,
|
|
34
38
|
code_issue: null,
|
|
35
39
|
code: null,
|
data/docs/PartitionsApi.md
CHANGED
|
@@ -6,6 +6,8 @@ All URIs are relative to *https://api.ragie.ai*
|
|
|
6
6
|
| ------ | ------------ | ----------- |
|
|
7
7
|
| [**create_partition_partitions_post**](PartitionsApi.md#create_partition_partitions_post) | **POST** /partitions | Create Partition |
|
|
8
8
|
| [**delete_partition_partitions_partition_id_delete**](PartitionsApi.md#delete_partition_partitions_partition_id_delete) | **DELETE** /partitions/{partition_id} | Delete Partition |
|
|
9
|
+
| [**disable_mcp_partitions_partition_id_mcp_delete**](PartitionsApi.md#disable_mcp_partitions_partition_id_mcp_delete) | **DELETE** /partitions/{partition_id}/mcp | Disable Mcp |
|
|
10
|
+
| [**enable_mcp_partitions_partition_id_mcp_post**](PartitionsApi.md#enable_mcp_partitions_partition_id_mcp_post) | **POST** /partitions/{partition_id}/mcp | Enable Mcp |
|
|
9
11
|
| [**get_partition_partitions_partition_id_get**](PartitionsApi.md#get_partition_partitions_partition_id_get) | **GET** /partitions/{partition_id} | Get Partition |
|
|
10
12
|
| [**list_partitions_partitions_get**](PartitionsApi.md#list_partitions_partitions_get) | **GET** /partitions | List Partitions |
|
|
11
13
|
| [**set_partition_limits_partitions_partition_id_limits_put**](PartitionsApi.md#set_partition_limits_partitions_partition_id_limits_put) | **PUT** /partitions/{partition_id}/limits | Set Partition Limits |
|
|
@@ -149,6 +151,144 @@ end
|
|
|
149
151
|
- **Accept**: application/json
|
|
150
152
|
|
|
151
153
|
|
|
154
|
+
## disable_mcp_partitions_partition_id_mcp_delete
|
|
155
|
+
|
|
156
|
+
> Object disable_mcp_partitions_partition_id_mcp_delete(partition_id)
|
|
157
|
+
|
|
158
|
+
Disable Mcp
|
|
159
|
+
|
|
160
|
+
Disables context-aware descriptions for a partition. This will stop automatically generating descriptions for the partition.
|
|
161
|
+
|
|
162
|
+
### Examples
|
|
163
|
+
|
|
164
|
+
```ruby
|
|
165
|
+
require 'time'
|
|
166
|
+
require 'ragie_ruby_sdk'
|
|
167
|
+
# setup authorization
|
|
168
|
+
RagieRubySdk.configure do |config|
|
|
169
|
+
# Configure Bearer authorization: auth
|
|
170
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
171
|
+
end
|
|
172
|
+
|
|
173
|
+
api_instance = RagieRubySdk::PartitionsApi.new
|
|
174
|
+
partition_id = 'partition_id_example' # String |
|
|
175
|
+
|
|
176
|
+
begin
|
|
177
|
+
# Disable Mcp
|
|
178
|
+
result = api_instance.disable_mcp_partitions_partition_id_mcp_delete(partition_id)
|
|
179
|
+
p result
|
|
180
|
+
rescue RagieRubySdk::ApiError => e
|
|
181
|
+
puts "Error when calling PartitionsApi->disable_mcp_partitions_partition_id_mcp_delete: #{e}"
|
|
182
|
+
end
|
|
183
|
+
```
|
|
184
|
+
|
|
185
|
+
#### Using the disable_mcp_partitions_partition_id_mcp_delete_with_http_info variant
|
|
186
|
+
|
|
187
|
+
This returns an Array which contains the response data, status code and headers.
|
|
188
|
+
|
|
189
|
+
> <Array(Object, Integer, Hash)> disable_mcp_partitions_partition_id_mcp_delete_with_http_info(partition_id)
|
|
190
|
+
|
|
191
|
+
```ruby
|
|
192
|
+
begin
|
|
193
|
+
# Disable Mcp
|
|
194
|
+
data, status_code, headers = api_instance.disable_mcp_partitions_partition_id_mcp_delete_with_http_info(partition_id)
|
|
195
|
+
p status_code # => 2xx
|
|
196
|
+
p headers # => { ... }
|
|
197
|
+
p data # => Object
|
|
198
|
+
rescue RagieRubySdk::ApiError => e
|
|
199
|
+
puts "Error when calling PartitionsApi->disable_mcp_partitions_partition_id_mcp_delete_with_http_info: #{e}"
|
|
200
|
+
end
|
|
201
|
+
```
|
|
202
|
+
|
|
203
|
+
### Parameters
|
|
204
|
+
|
|
205
|
+
| Name | Type | Description | Notes |
|
|
206
|
+
| ---- | ---- | ----------- | ----- |
|
|
207
|
+
| **partition_id** | **String** | | |
|
|
208
|
+
|
|
209
|
+
### Return type
|
|
210
|
+
|
|
211
|
+
**Object**
|
|
212
|
+
|
|
213
|
+
### Authorization
|
|
214
|
+
|
|
215
|
+
[auth](../README.md#auth)
|
|
216
|
+
|
|
217
|
+
### HTTP request headers
|
|
218
|
+
|
|
219
|
+
- **Content-Type**: Not defined
|
|
220
|
+
- **Accept**: application/json
|
|
221
|
+
|
|
222
|
+
|
|
223
|
+
## enable_mcp_partitions_partition_id_mcp_post
|
|
224
|
+
|
|
225
|
+
> Object enable_mcp_partitions_partition_id_mcp_post(partition_id)
|
|
226
|
+
|
|
227
|
+
Enable Mcp
|
|
228
|
+
|
|
229
|
+
Enables context-aware descriptions for a partition. This will allow the automatically generate a desccription for based on the documents in the partition.
|
|
230
|
+
|
|
231
|
+
### Examples
|
|
232
|
+
|
|
233
|
+
```ruby
|
|
234
|
+
require 'time'
|
|
235
|
+
require 'ragie_ruby_sdk'
|
|
236
|
+
# setup authorization
|
|
237
|
+
RagieRubySdk.configure do |config|
|
|
238
|
+
# Configure Bearer authorization: auth
|
|
239
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
240
|
+
end
|
|
241
|
+
|
|
242
|
+
api_instance = RagieRubySdk::PartitionsApi.new
|
|
243
|
+
partition_id = 'partition_id_example' # String |
|
|
244
|
+
|
|
245
|
+
begin
|
|
246
|
+
# Enable Mcp
|
|
247
|
+
result = api_instance.enable_mcp_partitions_partition_id_mcp_post(partition_id)
|
|
248
|
+
p result
|
|
249
|
+
rescue RagieRubySdk::ApiError => e
|
|
250
|
+
puts "Error when calling PartitionsApi->enable_mcp_partitions_partition_id_mcp_post: #{e}"
|
|
251
|
+
end
|
|
252
|
+
```
|
|
253
|
+
|
|
254
|
+
#### Using the enable_mcp_partitions_partition_id_mcp_post_with_http_info variant
|
|
255
|
+
|
|
256
|
+
This returns an Array which contains the response data, status code and headers.
|
|
257
|
+
|
|
258
|
+
> <Array(Object, Integer, Hash)> enable_mcp_partitions_partition_id_mcp_post_with_http_info(partition_id)
|
|
259
|
+
|
|
260
|
+
```ruby
|
|
261
|
+
begin
|
|
262
|
+
# Enable Mcp
|
|
263
|
+
data, status_code, headers = api_instance.enable_mcp_partitions_partition_id_mcp_post_with_http_info(partition_id)
|
|
264
|
+
p status_code # => 2xx
|
|
265
|
+
p headers # => { ... }
|
|
266
|
+
p data # => Object
|
|
267
|
+
rescue RagieRubySdk::ApiError => e
|
|
268
|
+
puts "Error when calling PartitionsApi->enable_mcp_partitions_partition_id_mcp_post_with_http_info: #{e}"
|
|
269
|
+
end
|
|
270
|
+
```
|
|
271
|
+
|
|
272
|
+
### Parameters
|
|
273
|
+
|
|
274
|
+
| Name | Type | Description | Notes |
|
|
275
|
+
| ---- | ---- | ----------- | ----- |
|
|
276
|
+
| **partition_id** | **String** | | |
|
|
277
|
+
|
|
278
|
+
### Return type
|
|
279
|
+
|
|
280
|
+
**Object**
|
|
281
|
+
|
|
282
|
+
### Authorization
|
|
283
|
+
|
|
284
|
+
[auth](../README.md#auth)
|
|
285
|
+
|
|
286
|
+
### HTTP request headers
|
|
287
|
+
|
|
288
|
+
- **Content-Type**: Not defined
|
|
289
|
+
- **Accept**: application/json
|
|
290
|
+
|
|
291
|
+
|
|
152
292
|
## get_partition_partitions_partition_id_get
|
|
153
293
|
|
|
154
294
|
> <PartitionDetail> get_partition_partitions_partition_id_get(partition_id)
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# RagieRubySdk::QueryDetails
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **query** | **String** | | |
|
|
8
|
+
| **search_effort** | [**SearchEffort**](SearchEffort.md) | | |
|
|
9
|
+
| **metadata_filter** | **Hash<String, Object>** | | |
|
|
10
|
+
| **search_results** | [**Array<RagieEvidence>**](RagieEvidence.md) | | |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'ragie_ruby_sdk'
|
|
16
|
+
|
|
17
|
+
instance = RagieRubySdk::QueryDetails.new(
|
|
18
|
+
query: null,
|
|
19
|
+
search_effort: null,
|
|
20
|
+
metadata_filter: null,
|
|
21
|
+
search_results: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# RagieRubySdk::ReasoningOutput
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | The unique ID of the reasoning output. | |
|
|
8
|
+
| **summary** | [**Array<ReasoningSummary>**](ReasoningSummary.md) | The summary of the reasoning. | |
|
|
9
|
+
| **type** | **String** | | [optional][default to 'reasoning'] |
|
|
10
|
+
| **content** | [**Array<ReasoningText>**](ReasoningText.md) | The content of the reasoning. | |
|
|
11
|
+
| **encrypted_content** | **String** | The encrypted content of the reasoning output. | |
|
|
12
|
+
| **status** | **String** | | [optional][default to 'completed'] |
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'ragie_ruby_sdk'
|
|
18
|
+
|
|
19
|
+
instance = RagieRubySdk::ReasoningOutput.new(
|
|
20
|
+
id: null,
|
|
21
|
+
summary: null,
|
|
22
|
+
type: null,
|
|
23
|
+
content: null,
|
|
24
|
+
encrypted_content: null,
|
|
25
|
+
status: null
|
|
26
|
+
)
|
|
27
|
+
```
|
|
28
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# RagieRubySdk::ReasoningSummary
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **summary** | **String** | The summary of the reasoning. | |
|
|
8
|
+
| **type** | **String** | | [optional][default to 'summary'] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'ragie_ruby_sdk'
|
|
14
|
+
|
|
15
|
+
instance = RagieRubySdk::ReasoningSummary.new(
|
|
16
|
+
summary: null,
|
|
17
|
+
type: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# RagieRubySdk::ReasoningText
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **text** | **String** | The text of the reasoning. | |
|
|
8
|
+
| **type** | **String** | | [optional][default to 'reasoning_text'] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'ragie_ruby_sdk'
|
|
14
|
+
|
|
15
|
+
instance = RagieRubySdk::ReasoningText.new(
|
|
16
|
+
text: null,
|
|
17
|
+
type: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
data/docs/Response.md
CHANGED
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
| **instructions** | **String** | | [optional] |
|
|
14
14
|
| **max_output_tokens** | **Object** | | [optional] |
|
|
15
15
|
| **model** | **String** | | [optional][default to 'deep-search'] |
|
|
16
|
-
| **output** | [**Array<
|
|
16
|
+
| **output** | [**Array<ResponseOutputInner>**](ResponseOutputInner.md) | | |
|
|
17
17
|
| **output_parsed** | [**FinalAnswer**](FinalAnswer.md) | | [optional] |
|
|
18
18
|
| **tools** | [**Array<Tool>**](Tool.md) | | |
|
|
19
19
|
| **reasoning** | [**Reasoning**](Reasoning.md) | | |
|