ragie_ruby_sdk 1.0.20 → 1.0.22
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 +6 -8
- data/docs/BetaApi.md +0 -140
- data/docs/CreatePartitionParams.md +2 -0
- data/docs/Partition.md +6 -0
- data/docs/PartitionDetail.md +6 -0
- data/docs/PartitionsApi.md +64 -132
- data/docs/UpdatePartitionParams.md +22 -0
- data/lib/ragie_ruby_sdk/api/beta_api.rb +0 -126
- data/lib/ragie_ruby_sdk/api/partitions_api.rb +74 -126
- data/lib/ragie_ruby_sdk/models/create_partition_params.rb +11 -1
- data/lib/ragie_ruby_sdk/models/partition.rb +53 -1
- data/lib/ragie_ruby_sdk/models/partition_detail.rb +53 -1
- data/lib/ragie_ruby_sdk/models/update_partition_params.rb +243 -0
- data/lib/ragie_ruby_sdk/version.rb +1 -1
- data/lib/ragie_ruby_sdk.rb +1 -0
- data/spec/api/beta_api_spec.rb +0 -24
- data/spec/api/partitions_api_spec.rb +13 -24
- data/spec/models/create_partition_params_spec.rb +6 -0
- data/spec/models/partition_detail_spec.rb +18 -0
- data/spec/models/partition_spec.rb +18 -0
- data/spec/models/update_partition_params_spec.rb +48 -0
- metadata +5 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 39f6dced7e5fe1e8c4845fcf3e6457d8b320a0b949c8a7ebcf8c5e481a5c77ca
|
|
4
|
+
data.tar.gz: 3914ef6a0da18a5d4ca4c9d9781a65c9a53af2e394e6e61d3b2a5b6925d1ed9d
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: f2029025387e7a95f159574e87cb4300414fb1f9efa7d2419753e1757d01aecff437b573930a8a0f7a1b6c846eae9bda5d293c8864dc2565d8da275698b06ec7
|
|
7
|
+
data.tar.gz: 3b0c257db13a0112a47df65bd8b05af2f1910f06ab1fa6aea42a8ffb497494ed098d61d0bab8ec9d4a469616b5d4efeab3679170ddfc429465afc4cef03cdf4f
|
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.21
|
|
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.21.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.21.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.21'
|
|
37
37
|
|
|
38
38
|
### Install from Git
|
|
39
39
|
|
|
@@ -94,8 +94,6 @@ 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
|
|
99
97
|
*RagieRubySdk::BetaApi* | [**list_authenticators**](docs/BetaApi.md#list_authenticators) | **GET** /authenticators | List Authenticators
|
|
100
98
|
*RagieRubySdk::ConnectionsApi* | [**create_connection**](docs/ConnectionsApi.md#create_connection) | **POST** /connection | Create Connection
|
|
101
99
|
*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
|
|
@@ -137,11 +135,10 @@ Class | Method | HTTP request | Description
|
|
|
137
135
|
*RagieRubySdk::EntitiesApi* | [**update_instruction**](docs/EntitiesApi.md#update_instruction) | **PUT** /instructions/{instruction_id} | Update Instruction
|
|
138
136
|
*RagieRubySdk::PartitionsApi* | [**create_partition_partitions_post**](docs/PartitionsApi.md#create_partition_partitions_post) | **POST** /partitions | Create Partition
|
|
139
137
|
*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
|
|
142
138
|
*RagieRubySdk::PartitionsApi* | [**get_partition_partitions_partition_id_get**](docs/PartitionsApi.md#get_partition_partitions_partition_id_get) | **GET** /partitions/{partition_id} | Get Partition
|
|
143
139
|
*RagieRubySdk::PartitionsApi* | [**list_partitions_partitions_get**](docs/PartitionsApi.md#list_partitions_partitions_get) | **GET** /partitions | List Partitions
|
|
144
140
|
*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
|
|
141
|
+
*RagieRubySdk::PartitionsApi* | [**update_partition_partitions_partition_id_patch**](docs/PartitionsApi.md#update_partition_partitions_partition_id_patch) | **PATCH** /partitions/{partition_id} | Update Partition
|
|
145
142
|
*RagieRubySdk::ResponsesApi* | [**create_response_responses_post**](docs/ResponsesApi.md#create_response_responses_post) | **POST** /responses | Create Response
|
|
146
143
|
*RagieRubySdk::ResponsesApi* | [**get_response_responses_response_id_get**](docs/ResponsesApi.md#get_response_responses_response_id_get) | **GET** /responses/{response_id} | Get Response
|
|
147
144
|
*RagieRubySdk::RetrievalsApi* | [**retrieve**](docs/RetrievalsApi.md#retrieve) | **POST** /retrievals | Retrieve
|
|
@@ -317,6 +314,7 @@ Class | Method | HTTP request | Description
|
|
|
317
314
|
- [RagieRubySdk::UpdateDocumentFromUrlParams](docs/UpdateDocumentFromUrlParams.md)
|
|
318
315
|
- [RagieRubySdk::UpdateDocumentRawParams](docs/UpdateDocumentRawParams.md)
|
|
319
316
|
- [RagieRubySdk::UpdateInstructionParams](docs/UpdateInstructionParams.md)
|
|
317
|
+
- [RagieRubySdk::UpdatePartitionParams](docs/UpdatePartitionParams.md)
|
|
320
318
|
- [RagieRubySdk::ValidationError](docs/ValidationError.md)
|
|
321
319
|
- [RagieRubySdk::ValidationErrorLocInner](docs/ValidationErrorLocInner.md)
|
|
322
320
|
- [RagieRubySdk::VideoModalityData](docs/VideoModalityData.md)
|
data/docs/BetaApi.md
CHANGED
|
@@ -8,8 +8,6 @@ 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 |
|
|
13
11
|
| [**list_authenticators**](BetaApi.md#list_authenticators) | **GET** /authenticators | List Authenticators |
|
|
14
12
|
|
|
15
13
|
|
|
@@ -291,144 +289,6 @@ end
|
|
|
291
289
|
- **Accept**: application/json
|
|
292
290
|
|
|
293
291
|
|
|
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
|
-
|
|
432
292
|
## list_authenticators
|
|
433
293
|
|
|
434
294
|
> <AuthenticatorList> list_authenticators(opts)
|
|
@@ -5,6 +5,7 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **name** | **String** | | |
|
|
8
|
+
| **description** | **String** | | [optional] |
|
|
8
9
|
| **pages_hosted_limit_monthly** | **Integer** | | [optional] |
|
|
9
10
|
| **pages_processed_limit_monthly** | **Integer** | | [optional] |
|
|
10
11
|
| **pages_hosted_limit_max** | **Integer** | | [optional] |
|
|
@@ -26,6 +27,7 @@ require 'ragie_ruby_sdk'
|
|
|
26
27
|
|
|
27
28
|
instance = RagieRubySdk::CreatePartitionParams.new(
|
|
28
29
|
name: null,
|
|
30
|
+
description: null,
|
|
29
31
|
pages_hosted_limit_monthly: null,
|
|
30
32
|
pages_processed_limit_monthly: null,
|
|
31
33
|
pages_hosted_limit_max: null,
|
data/docs/Partition.md
CHANGED
|
@@ -7,6 +7,9 @@
|
|
|
7
7
|
| **name** | **String** | | |
|
|
8
8
|
| **is_default** | **Boolean** | | |
|
|
9
9
|
| **limit_exceeded_at** | **Time** | | [optional] |
|
|
10
|
+
| **description** | **String** | | |
|
|
11
|
+
| **context_aware** | **Boolean** | | |
|
|
12
|
+
| **metadata_schema** | [**Hash<String, CreatePartitionParamsMetadataSchemaValue>**](CreatePartitionParamsMetadataSchemaValue.md) | | |
|
|
10
13
|
| **limits** | [**PartitionLimits**](PartitionLimits.md) | | |
|
|
11
14
|
|
|
12
15
|
## Example
|
|
@@ -18,6 +21,9 @@ instance = RagieRubySdk::Partition.new(
|
|
|
18
21
|
name: null,
|
|
19
22
|
is_default: null,
|
|
20
23
|
limit_exceeded_at: null,
|
|
24
|
+
description: null,
|
|
25
|
+
context_aware: null,
|
|
26
|
+
metadata_schema: null,
|
|
21
27
|
limits: null
|
|
22
28
|
)
|
|
23
29
|
```
|
data/docs/PartitionDetail.md
CHANGED
|
@@ -7,6 +7,9 @@
|
|
|
7
7
|
| **name** | **String** | | |
|
|
8
8
|
| **is_default** | **Boolean** | | |
|
|
9
9
|
| **limit_exceeded_at** | **Time** | | [optional] |
|
|
10
|
+
| **description** | **String** | | |
|
|
11
|
+
| **context_aware** | **Boolean** | | |
|
|
12
|
+
| **metadata_schema** | [**Hash<String, CreatePartitionParamsMetadataSchemaValue>**](CreatePartitionParamsMetadataSchemaValue.md) | | |
|
|
10
13
|
| **limits** | [**PartitionLimits**](PartitionLimits.md) | | |
|
|
11
14
|
| **stats** | [**PartitionStats**](PartitionStats.md) | | |
|
|
12
15
|
|
|
@@ -19,6 +22,9 @@ instance = RagieRubySdk::PartitionDetail.new(
|
|
|
19
22
|
name: null,
|
|
20
23
|
is_default: null,
|
|
21
24
|
limit_exceeded_at: null,
|
|
25
|
+
description: null,
|
|
26
|
+
context_aware: null,
|
|
27
|
+
metadata_schema: null,
|
|
22
28
|
limits: null,
|
|
23
29
|
stats: null
|
|
24
30
|
)
|
data/docs/PartitionsApi.md
CHANGED
|
@@ -6,11 +6,10 @@ 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 |
|
|
11
9
|
| [**get_partition_partitions_partition_id_get**](PartitionsApi.md#get_partition_partitions_partition_id_get) | **GET** /partitions/{partition_id} | Get Partition |
|
|
12
10
|
| [**list_partitions_partitions_get**](PartitionsApi.md#list_partitions_partitions_get) | **GET** /partitions | List Partitions |
|
|
13
11
|
| [**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 |
|
|
12
|
+
| [**update_partition_partitions_partition_id_patch**](PartitionsApi.md#update_partition_partitions_partition_id_patch) | **PATCH** /partitions/{partition_id} | Update Partition |
|
|
14
13
|
|
|
15
14
|
|
|
16
15
|
## create_partition_partitions_post
|
|
@@ -151,13 +150,13 @@ end
|
|
|
151
150
|
- **Accept**: application/json
|
|
152
151
|
|
|
153
152
|
|
|
154
|
-
##
|
|
153
|
+
## get_partition_partitions_partition_id_get
|
|
155
154
|
|
|
156
|
-
>
|
|
155
|
+
> <PartitionDetail> get_partition_partitions_partition_id_get(partition_id)
|
|
157
156
|
|
|
158
|
-
|
|
157
|
+
Get Partition
|
|
159
158
|
|
|
160
|
-
|
|
159
|
+
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.
|
|
161
160
|
|
|
162
161
|
### Examples
|
|
163
162
|
|
|
@@ -174,29 +173,29 @@ api_instance = RagieRubySdk::PartitionsApi.new
|
|
|
174
173
|
partition_id = 'partition_id_example' # String |
|
|
175
174
|
|
|
176
175
|
begin
|
|
177
|
-
#
|
|
178
|
-
result = api_instance.
|
|
176
|
+
# Get Partition
|
|
177
|
+
result = api_instance.get_partition_partitions_partition_id_get(partition_id)
|
|
179
178
|
p result
|
|
180
179
|
rescue RagieRubySdk::ApiError => e
|
|
181
|
-
puts "Error when calling PartitionsApi->
|
|
180
|
+
puts "Error when calling PartitionsApi->get_partition_partitions_partition_id_get: #{e}"
|
|
182
181
|
end
|
|
183
182
|
```
|
|
184
183
|
|
|
185
|
-
#### Using the
|
|
184
|
+
#### Using the get_partition_partitions_partition_id_get_with_http_info variant
|
|
186
185
|
|
|
187
186
|
This returns an Array which contains the response data, status code and headers.
|
|
188
187
|
|
|
189
|
-
> <Array(
|
|
188
|
+
> <Array(<PartitionDetail>, Integer, Hash)> get_partition_partitions_partition_id_get_with_http_info(partition_id)
|
|
190
189
|
|
|
191
190
|
```ruby
|
|
192
191
|
begin
|
|
193
|
-
#
|
|
194
|
-
data, status_code, headers = api_instance.
|
|
192
|
+
# Get Partition
|
|
193
|
+
data, status_code, headers = api_instance.get_partition_partitions_partition_id_get_with_http_info(partition_id)
|
|
195
194
|
p status_code # => 2xx
|
|
196
195
|
p headers # => { ... }
|
|
197
|
-
p data # =>
|
|
196
|
+
p data # => <PartitionDetail>
|
|
198
197
|
rescue RagieRubySdk::ApiError => e
|
|
199
|
-
puts "Error when calling PartitionsApi->
|
|
198
|
+
puts "Error when calling PartitionsApi->get_partition_partitions_partition_id_get_with_http_info: #{e}"
|
|
200
199
|
end
|
|
201
200
|
```
|
|
202
201
|
|
|
@@ -208,7 +207,7 @@ end
|
|
|
208
207
|
|
|
209
208
|
### Return type
|
|
210
209
|
|
|
211
|
-
**
|
|
210
|
+
[**PartitionDetail**](PartitionDetail.md)
|
|
212
211
|
|
|
213
212
|
### Authorization
|
|
214
213
|
|
|
@@ -220,13 +219,13 @@ end
|
|
|
220
219
|
- **Accept**: application/json
|
|
221
220
|
|
|
222
221
|
|
|
223
|
-
##
|
|
222
|
+
## list_partitions_partitions_get
|
|
224
223
|
|
|
225
|
-
>
|
|
224
|
+
> <PartitionList> list_partitions_partitions_get(opts)
|
|
226
225
|
|
|
227
|
-
|
|
226
|
+
List Partitions
|
|
228
227
|
|
|
229
|
-
|
|
228
|
+
List all partitions sorted by name in ascending order. Results are paginated with a max limit of 100. When more partitions are available, a `cursor` will be provided. Use the `cursor` parameter to retrieve the subsequent page.
|
|
230
229
|
|
|
231
230
|
### Examples
|
|
232
231
|
|
|
@@ -240,32 +239,35 @@ RagieRubySdk.configure do |config|
|
|
|
240
239
|
end
|
|
241
240
|
|
|
242
241
|
api_instance = RagieRubySdk::PartitionsApi.new
|
|
243
|
-
|
|
242
|
+
opts = {
|
|
243
|
+
cursor: 'cursor_example', # String | An opaque cursor for pagination
|
|
244
|
+
page_size: 56 # Integer | The number of items per page (must be greater than 0 and less than or equal to 100)
|
|
245
|
+
}
|
|
244
246
|
|
|
245
247
|
begin
|
|
246
|
-
#
|
|
247
|
-
result = api_instance.
|
|
248
|
+
# List Partitions
|
|
249
|
+
result = api_instance.list_partitions_partitions_get(opts)
|
|
248
250
|
p result
|
|
249
251
|
rescue RagieRubySdk::ApiError => e
|
|
250
|
-
puts "Error when calling PartitionsApi->
|
|
252
|
+
puts "Error when calling PartitionsApi->list_partitions_partitions_get: #{e}"
|
|
251
253
|
end
|
|
252
254
|
```
|
|
253
255
|
|
|
254
|
-
#### Using the
|
|
256
|
+
#### Using the list_partitions_partitions_get_with_http_info variant
|
|
255
257
|
|
|
256
258
|
This returns an Array which contains the response data, status code and headers.
|
|
257
259
|
|
|
258
|
-
> <Array(
|
|
260
|
+
> <Array(<PartitionList>, Integer, Hash)> list_partitions_partitions_get_with_http_info(opts)
|
|
259
261
|
|
|
260
262
|
```ruby
|
|
261
263
|
begin
|
|
262
|
-
#
|
|
263
|
-
data, status_code, headers = api_instance.
|
|
264
|
+
# List Partitions
|
|
265
|
+
data, status_code, headers = api_instance.list_partitions_partitions_get_with_http_info(opts)
|
|
264
266
|
p status_code # => 2xx
|
|
265
267
|
p headers # => { ... }
|
|
266
|
-
p data # =>
|
|
268
|
+
p data # => <PartitionList>
|
|
267
269
|
rescue RagieRubySdk::ApiError => e
|
|
268
|
-
puts "Error when calling PartitionsApi->
|
|
270
|
+
puts "Error when calling PartitionsApi->list_partitions_partitions_get_with_http_info: #{e}"
|
|
269
271
|
end
|
|
270
272
|
```
|
|
271
273
|
|
|
@@ -273,11 +275,12 @@ end
|
|
|
273
275
|
|
|
274
276
|
| Name | Type | Description | Notes |
|
|
275
277
|
| ---- | ---- | ----------- | ----- |
|
|
276
|
-
| **
|
|
278
|
+
| **cursor** | **String** | An opaque cursor for pagination | [optional] |
|
|
279
|
+
| **page_size** | **Integer** | The number of items per page (must be greater than 0 and less than or equal to 100) | [optional][default to 10] |
|
|
277
280
|
|
|
278
281
|
### Return type
|
|
279
282
|
|
|
280
|
-
**
|
|
283
|
+
[**PartitionList**](PartitionList.md)
|
|
281
284
|
|
|
282
285
|
### Authorization
|
|
283
286
|
|
|
@@ -289,13 +292,13 @@ end
|
|
|
289
292
|
- **Accept**: application/json
|
|
290
293
|
|
|
291
294
|
|
|
292
|
-
##
|
|
295
|
+
## set_partition_limits_partitions_partition_id_limits_put
|
|
293
296
|
|
|
294
|
-
> <PartitionDetail>
|
|
297
|
+
> <PartitionDetail> set_partition_limits_partitions_partition_id_limits_put(partition_id, partition_limit_params)
|
|
295
298
|
|
|
296
|
-
|
|
299
|
+
Set Partition Limits
|
|
297
300
|
|
|
298
|
-
|
|
301
|
+
Sets limits on a partition. Limits can be set on the total number of pages a partition can host and process. When the limit is reached, the partition will be disabled. A limit may be removed by setting it to `null`.
|
|
299
302
|
|
|
300
303
|
### Examples
|
|
301
304
|
|
|
@@ -310,31 +313,32 @@ end
|
|
|
310
313
|
|
|
311
314
|
api_instance = RagieRubySdk::PartitionsApi.new
|
|
312
315
|
partition_id = 'partition_id_example' # String |
|
|
316
|
+
partition_limit_params = RagieRubySdk::PartitionLimitParams.new # PartitionLimitParams |
|
|
313
317
|
|
|
314
318
|
begin
|
|
315
|
-
#
|
|
316
|
-
result = api_instance.
|
|
319
|
+
# Set Partition Limits
|
|
320
|
+
result = api_instance.set_partition_limits_partitions_partition_id_limits_put(partition_id, partition_limit_params)
|
|
317
321
|
p result
|
|
318
322
|
rescue RagieRubySdk::ApiError => e
|
|
319
|
-
puts "Error when calling PartitionsApi->
|
|
323
|
+
puts "Error when calling PartitionsApi->set_partition_limits_partitions_partition_id_limits_put: #{e}"
|
|
320
324
|
end
|
|
321
325
|
```
|
|
322
326
|
|
|
323
|
-
#### Using the
|
|
327
|
+
#### Using the set_partition_limits_partitions_partition_id_limits_put_with_http_info variant
|
|
324
328
|
|
|
325
329
|
This returns an Array which contains the response data, status code and headers.
|
|
326
330
|
|
|
327
|
-
> <Array(<PartitionDetail>, Integer, Hash)>
|
|
331
|
+
> <Array(<PartitionDetail>, Integer, Hash)> set_partition_limits_partitions_partition_id_limits_put_with_http_info(partition_id, partition_limit_params)
|
|
328
332
|
|
|
329
333
|
```ruby
|
|
330
334
|
begin
|
|
331
|
-
#
|
|
332
|
-
data, status_code, headers = api_instance.
|
|
335
|
+
# Set Partition Limits
|
|
336
|
+
data, status_code, headers = api_instance.set_partition_limits_partitions_partition_id_limits_put_with_http_info(partition_id, partition_limit_params)
|
|
333
337
|
p status_code # => 2xx
|
|
334
338
|
p headers # => { ... }
|
|
335
339
|
p data # => <PartitionDetail>
|
|
336
340
|
rescue RagieRubySdk::ApiError => e
|
|
337
|
-
puts "Error when calling PartitionsApi->
|
|
341
|
+
puts "Error when calling PartitionsApi->set_partition_limits_partitions_partition_id_limits_put_with_http_info: #{e}"
|
|
338
342
|
end
|
|
339
343
|
```
|
|
340
344
|
|
|
@@ -343,6 +347,7 @@ end
|
|
|
343
347
|
| Name | Type | Description | Notes |
|
|
344
348
|
| ---- | ---- | ----------- | ----- |
|
|
345
349
|
| **partition_id** | **String** | | |
|
|
350
|
+
| **partition_limit_params** | [**PartitionLimitParams**](PartitionLimitParams.md) | | |
|
|
346
351
|
|
|
347
352
|
### Return type
|
|
348
353
|
|
|
@@ -354,90 +359,17 @@ end
|
|
|
354
359
|
|
|
355
360
|
### HTTP request headers
|
|
356
361
|
|
|
357
|
-
- **Content-Type**:
|
|
358
|
-
- **Accept**: application/json
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
## list_partitions_partitions_get
|
|
362
|
-
|
|
363
|
-
> <PartitionList> list_partitions_partitions_get(opts)
|
|
364
|
-
|
|
365
|
-
List Partitions
|
|
366
|
-
|
|
367
|
-
List all partitions sorted by name in ascending order. Results are paginated with a max limit of 100. When more partitions are available, a `cursor` will be provided. Use the `cursor` parameter to retrieve the subsequent page.
|
|
368
|
-
|
|
369
|
-
### Examples
|
|
370
|
-
|
|
371
|
-
```ruby
|
|
372
|
-
require 'time'
|
|
373
|
-
require 'ragie_ruby_sdk'
|
|
374
|
-
# setup authorization
|
|
375
|
-
RagieRubySdk.configure do |config|
|
|
376
|
-
# Configure Bearer authorization: auth
|
|
377
|
-
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
378
|
-
end
|
|
379
|
-
|
|
380
|
-
api_instance = RagieRubySdk::PartitionsApi.new
|
|
381
|
-
opts = {
|
|
382
|
-
cursor: 'cursor_example', # String | An opaque cursor for pagination
|
|
383
|
-
page_size: 56 # Integer | The number of items per page (must be greater than 0 and less than or equal to 100)
|
|
384
|
-
}
|
|
385
|
-
|
|
386
|
-
begin
|
|
387
|
-
# List Partitions
|
|
388
|
-
result = api_instance.list_partitions_partitions_get(opts)
|
|
389
|
-
p result
|
|
390
|
-
rescue RagieRubySdk::ApiError => e
|
|
391
|
-
puts "Error when calling PartitionsApi->list_partitions_partitions_get: #{e}"
|
|
392
|
-
end
|
|
393
|
-
```
|
|
394
|
-
|
|
395
|
-
#### Using the list_partitions_partitions_get_with_http_info variant
|
|
396
|
-
|
|
397
|
-
This returns an Array which contains the response data, status code and headers.
|
|
398
|
-
|
|
399
|
-
> <Array(<PartitionList>, Integer, Hash)> list_partitions_partitions_get_with_http_info(opts)
|
|
400
|
-
|
|
401
|
-
```ruby
|
|
402
|
-
begin
|
|
403
|
-
# List Partitions
|
|
404
|
-
data, status_code, headers = api_instance.list_partitions_partitions_get_with_http_info(opts)
|
|
405
|
-
p status_code # => 2xx
|
|
406
|
-
p headers # => { ... }
|
|
407
|
-
p data # => <PartitionList>
|
|
408
|
-
rescue RagieRubySdk::ApiError => e
|
|
409
|
-
puts "Error when calling PartitionsApi->list_partitions_partitions_get_with_http_info: #{e}"
|
|
410
|
-
end
|
|
411
|
-
```
|
|
412
|
-
|
|
413
|
-
### Parameters
|
|
414
|
-
|
|
415
|
-
| Name | Type | Description | Notes |
|
|
416
|
-
| ---- | ---- | ----------- | ----- |
|
|
417
|
-
| **cursor** | **String** | An opaque cursor for pagination | [optional] |
|
|
418
|
-
| **page_size** | **Integer** | The number of items per page (must be greater than 0 and less than or equal to 100) | [optional][default to 10] |
|
|
419
|
-
|
|
420
|
-
### Return type
|
|
421
|
-
|
|
422
|
-
[**PartitionList**](PartitionList.md)
|
|
423
|
-
|
|
424
|
-
### Authorization
|
|
425
|
-
|
|
426
|
-
[auth](../README.md#auth)
|
|
427
|
-
|
|
428
|
-
### HTTP request headers
|
|
429
|
-
|
|
430
|
-
- **Content-Type**: Not defined
|
|
362
|
+
- **Content-Type**: application/json
|
|
431
363
|
- **Accept**: application/json
|
|
432
364
|
|
|
433
365
|
|
|
434
|
-
##
|
|
366
|
+
## update_partition_partitions_partition_id_patch
|
|
435
367
|
|
|
436
|
-
> <PartitionDetail>
|
|
368
|
+
> <PartitionDetail> update_partition_partitions_partition_id_patch(partition_id, update_partition_params)
|
|
437
369
|
|
|
438
|
-
|
|
370
|
+
Update Partition
|
|
439
371
|
|
|
440
|
-
|
|
372
|
+
Updates a partition. This includes the partition's description and metadata schema.
|
|
441
373
|
|
|
442
374
|
### Examples
|
|
443
375
|
|
|
@@ -452,32 +384,32 @@ end
|
|
|
452
384
|
|
|
453
385
|
api_instance = RagieRubySdk::PartitionsApi.new
|
|
454
386
|
partition_id = 'partition_id_example' # String |
|
|
455
|
-
|
|
387
|
+
update_partition_params = RagieRubySdk::UpdatePartitionParams.new # UpdatePartitionParams |
|
|
456
388
|
|
|
457
389
|
begin
|
|
458
|
-
#
|
|
459
|
-
result = api_instance.
|
|
390
|
+
# Update Partition
|
|
391
|
+
result = api_instance.update_partition_partitions_partition_id_patch(partition_id, update_partition_params)
|
|
460
392
|
p result
|
|
461
393
|
rescue RagieRubySdk::ApiError => e
|
|
462
|
-
puts "Error when calling PartitionsApi->
|
|
394
|
+
puts "Error when calling PartitionsApi->update_partition_partitions_partition_id_patch: #{e}"
|
|
463
395
|
end
|
|
464
396
|
```
|
|
465
397
|
|
|
466
|
-
#### Using the
|
|
398
|
+
#### Using the update_partition_partitions_partition_id_patch_with_http_info variant
|
|
467
399
|
|
|
468
400
|
This returns an Array which contains the response data, status code and headers.
|
|
469
401
|
|
|
470
|
-
> <Array(<PartitionDetail>, Integer, Hash)>
|
|
402
|
+
> <Array(<PartitionDetail>, Integer, Hash)> update_partition_partitions_partition_id_patch_with_http_info(partition_id, update_partition_params)
|
|
471
403
|
|
|
472
404
|
```ruby
|
|
473
405
|
begin
|
|
474
|
-
#
|
|
475
|
-
data, status_code, headers = api_instance.
|
|
406
|
+
# Update Partition
|
|
407
|
+
data, status_code, headers = api_instance.update_partition_partitions_partition_id_patch_with_http_info(partition_id, update_partition_params)
|
|
476
408
|
p status_code # => 2xx
|
|
477
409
|
p headers # => { ... }
|
|
478
410
|
p data # => <PartitionDetail>
|
|
479
411
|
rescue RagieRubySdk::ApiError => e
|
|
480
|
-
puts "Error when calling PartitionsApi->
|
|
412
|
+
puts "Error when calling PartitionsApi->update_partition_partitions_partition_id_patch_with_http_info: #{e}"
|
|
481
413
|
end
|
|
482
414
|
```
|
|
483
415
|
|
|
@@ -486,7 +418,7 @@ end
|
|
|
486
418
|
| Name | Type | Description | Notes |
|
|
487
419
|
| ---- | ---- | ----------- | ----- |
|
|
488
420
|
| **partition_id** | **String** | | |
|
|
489
|
-
| **
|
|
421
|
+
| **update_partition_params** | [**UpdatePartitionParams**](UpdatePartitionParams.md) | | |
|
|
490
422
|
|
|
491
423
|
### Return type
|
|
492
424
|
|