carbon_ruby_sdk 0.1.11 → 0.1.13
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +6 -6
- data/README.md +28 -2
- data/lib/carbon_ruby_sdk/api/integrations_api.rb +66 -22
- data/lib/carbon_ruby_sdk/models/embedding_and_chunk.rb +15 -5
- data/lib/carbon_ruby_sdk/models/external_source_item.rb +11 -1
- data/lib/carbon_ruby_sdk/models/fresh_desk_connect_request.rb +15 -5
- data/lib/carbon_ruby_sdk/models/gitbook_connect_request.rb +15 -5
- data/lib/carbon_ruby_sdk/models/gitbook_sync_request.rb +15 -5
- data/lib/carbon_ruby_sdk/models/gmail_sync_input.rb +15 -5
- data/lib/carbon_ruby_sdk/models/list_data_source_items_request.rb +11 -1
- data/lib/carbon_ruby_sdk/models/list_items_filters.rb +250 -0
- data/lib/carbon_ruby_sdk/models/list_items_filters_nullable.rb +250 -0
- data/lib/carbon_ruby_sdk/models/o_auth_url_request.rb +16 -5
- data/lib/carbon_ruby_sdk/models/organization_user_files_to_sync_filters.rb +32 -4
- data/lib/carbon_ruby_sdk/models/outlook_sync_input.rb +15 -5
- data/lib/carbon_ruby_sdk/models/rss_feed_input.rb +15 -5
- data/lib/carbon_ruby_sdk/models/s3_file_sync_input.rb +15 -5
- data/lib/carbon_ruby_sdk/models/sync_files_request.rb +14 -4
- data/lib/carbon_ruby_sdk/models/user_file.rb +11 -1
- data/lib/carbon_ruby_sdk/version.rb +1 -1
- data/lib/carbon_ruby_sdk.rb +2 -0
- data/spec/models/embedding_and_chunk_spec.rb +6 -0
- data/spec/models/external_source_item_spec.rb +6 -0
- data/spec/models/fresh_desk_connect_request_spec.rb +6 -0
- data/spec/models/gitbook_connect_request_spec.rb +6 -0
- data/spec/models/gitbook_sync_request_spec.rb +6 -0
- data/spec/models/gmail_sync_input_spec.rb +6 -0
- data/spec/models/list_data_source_items_request_spec.rb +6 -0
- data/spec/models/list_items_filters_nullable_spec.rb +46 -0
- data/spec/models/list_items_filters_spec.rb +46 -0
- data/spec/models/o_auth_url_request_spec.rb +6 -0
- data/spec/models/organization_user_files_to_sync_filters_spec.rb +6 -0
- data/spec/models/outlook_sync_input_spec.rb +6 -0
- data/spec/models/rss_feed_input_spec.rb +6 -0
- data/spec/models/s3_file_sync_input_spec.rb +6 -0
- data/spec/models/sync_files_request_spec.rb +6 -0
- data/spec/models/user_file_spec.rb +6 -0
- metadata +9 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: f933446ddcb13014a55fd9b6f8744a083f495d54597cf898af90ca17caf3ac0b
|
4
|
+
data.tar.gz: b8d7e752e42e617d4faa0595a8cd41c6b0b3088c678542bc7a8f2be9abe506a3
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 9d76f26f825fdc1560d7a2b4e103b4b29da0b81bad1131d17583779cb6f5254e717732cb29838b5d80ce2dfebd62dd4ca4b59bb41a1d005f8f88f7f9c237dc47
|
7
|
+
data.tar.gz: 1130a78f7270d44827e133cc2a8b6deffb10040b27091e02ec5e54bae72969d0ab63b6716d704244983ad4979351f1c2e5ca0f84005f1e4eae8e7c57c2f87348
|
data/Gemfile.lock
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
PATH
|
2
2
|
remote: .
|
3
3
|
specs:
|
4
|
-
carbon_ruby_sdk (0.1.
|
4
|
+
carbon_ruby_sdk (0.1.12)
|
5
5
|
faraday (>= 1.0.1, < 3.0)
|
6
6
|
faraday-multipart (~> 1.0, >= 1.0.4)
|
7
7
|
|
@@ -42,7 +42,7 @@ GEM
|
|
42
42
|
rainbow (3.1.1)
|
43
43
|
rake (13.0.6)
|
44
44
|
regexp_parser (2.9.0)
|
45
|
-
reline (0.
|
45
|
+
reline (0.5.0)
|
46
46
|
io-console (~> 0.5)
|
47
47
|
rexml (3.2.6)
|
48
48
|
rspec (3.13.0)
|
@@ -67,14 +67,14 @@ GEM
|
|
67
67
|
rubocop-ast (>= 1.2.0, < 2.0)
|
68
68
|
ruby-progressbar (~> 1.7)
|
69
69
|
unicode-display_width (>= 1.4.0, < 3.0)
|
70
|
-
rubocop-ast (1.
|
71
|
-
parser (>= 3.
|
70
|
+
rubocop-ast (1.31.2)
|
71
|
+
parser (>= 3.3.0.4)
|
72
72
|
ruby-progressbar (1.13.0)
|
73
73
|
unicode-display_width (2.5.0)
|
74
74
|
uri (0.13.0)
|
75
75
|
|
76
76
|
PLATFORMS
|
77
|
-
arm64-darwin-
|
77
|
+
arm64-darwin-22
|
78
78
|
|
79
79
|
DEPENDENCIES
|
80
80
|
carbon_ruby_sdk!
|
@@ -86,4 +86,4 @@ DEPENDENCIES
|
|
86
86
|
rubocop (~> 1.12.1)
|
87
87
|
|
88
88
|
BUNDLED WITH
|
89
|
-
2.
|
89
|
+
2.4.19
|
data/README.md
CHANGED
@@ -6,7 +6,7 @@
|
|
6
6
|
|
7
7
|
Connect external data to LLMs, no matter the source.
|
8
8
|
|
9
|
-
[![npm](https://img.shields.io/badge/gem-v0.1.
|
9
|
+
[![npm](https://img.shields.io/badge/gem-v0.1.13-blue)](https://rubygems.org/gems/carbon_ruby_sdk/versions/0.1.13)
|
10
10
|
|
11
11
|
</div>
|
12
12
|
|
@@ -80,7 +80,7 @@ Connect external data to LLMs, no matter the source.
|
|
80
80
|
Add to Gemfile:
|
81
81
|
|
82
82
|
```ruby
|
83
|
-
gem 'carbon_ruby_sdk', '~> 0.1.
|
83
|
+
gem 'carbon_ruby_sdk', '~> 0.1.13'
|
84
84
|
```
|
85
85
|
|
86
86
|
## Getting Started<a id="getting-started"></a>
|
@@ -1230,6 +1230,7 @@ result = carbon.integrations.connect_freshdesk(
|
|
1230
1230
|
generate_sparse_vectors: false,
|
1231
1231
|
prepend_filename_to_chunks: false,
|
1232
1232
|
sync_files_on_connection: true,
|
1233
|
+
request_id: "string_example",
|
1233
1234
|
)
|
1234
1235
|
p result
|
1235
1236
|
```
|
@@ -1246,6 +1247,7 @@ p result
|
|
1246
1247
|
##### generate_sparse_vectors: `Boolean`<a id="generate_sparse_vectors-boolean"></a>
|
1247
1248
|
##### prepend_filename_to_chunks: `Boolean`<a id="prepend_filename_to_chunks-boolean"></a>
|
1248
1249
|
##### sync_files_on_connection: `Boolean`<a id="sync_files_on_connection-boolean"></a>
|
1250
|
+
##### request_id: `String`<a id="request_id-string"></a>
|
1249
1251
|
#### 🔄 Return<a id="🔄-return"></a>
|
1250
1252
|
|
1251
1253
|
[GenericSuccessResponse](./lib/carbon_ruby_sdk/models/generic_success_response.rb)
|
@@ -1280,6 +1282,7 @@ result = carbon.integrations.connect_gitbook(
|
|
1280
1282
|
generate_sparse_vectors: false,
|
1281
1283
|
prepend_filename_to_chunks: false,
|
1282
1284
|
sync_files_on_connection: true,
|
1285
|
+
request_id: "string_example",
|
1283
1286
|
)
|
1284
1287
|
p result
|
1285
1288
|
```
|
@@ -1296,6 +1299,7 @@ p result
|
|
1296
1299
|
##### generate_sparse_vectors: `Boolean`<a id="generate_sparse_vectors-boolean"></a>
|
1297
1300
|
##### prepend_filename_to_chunks: `Boolean`<a id="prepend_filename_to_chunks-boolean"></a>
|
1298
1301
|
##### sync_files_on_connection: `Boolean`<a id="sync_files_on_connection-boolean"></a>
|
1302
|
+
##### request_id: `String`<a id="request_id-string"></a>
|
1299
1303
|
#### 🔄 Return<a id="🔄-return"></a>
|
1300
1304
|
|
1301
1305
|
[GenericSuccessResponse](./lib/carbon_ruby_sdk/models/generic_success_response.rb)
|
@@ -1376,6 +1380,7 @@ result = carbon.integrations.get_oauth_url(
|
|
1376
1380
|
set_page_as_boundary: false,
|
1377
1381
|
data_source_id: 1,
|
1378
1382
|
connecting_new_account: false,
|
1383
|
+
request_id: "string_example",
|
1379
1384
|
)
|
1380
1385
|
p result
|
1381
1386
|
```
|
@@ -1415,6 +1420,10 @@ connecting a new account.
|
|
1415
1420
|
Used to connect a new data source. If not specified, we will attempt to create a
|
1416
1421
|
sync URL for an existing data source based on type and ID.
|
1417
1422
|
|
1423
|
+
##### request_id: `String`<a id="request_id-string"></a>
|
1424
|
+
This request id will be added to all files that get synced using the generated
|
1425
|
+
OAuth URL
|
1426
|
+
|
1418
1427
|
#### 🔄 Return<a id="🔄-return"></a>
|
1419
1428
|
|
1420
1429
|
[OuthURLResponse](./lib/carbon_ruby_sdk/models/outh_url_response.rb)
|
@@ -1475,6 +1484,8 @@ List Data Source Items
|
|
1475
1484
|
result = carbon.integrations.list_data_source_items(
|
1476
1485
|
data_source_id: 1,
|
1477
1486
|
parent_id: "string_example",
|
1487
|
+
filters: {
|
1488
|
+
},
|
1478
1489
|
pagination: {
|
1479
1490
|
"limit" => 10,
|
1480
1491
|
"offset" => 0,
|
@@ -1487,6 +1498,7 @@ p result
|
|
1487
1498
|
|
1488
1499
|
##### data_source_id: `Integer`<a id="data_source_id-integer"></a>
|
1489
1500
|
##### parent_id: `String`<a id="parent_id-string"></a>
|
1501
|
+
##### filters: [`ListItemsFiltersNullable`](./lib/carbon_ruby_sdk/models/list_items_filters_nullable.rb)<a id="filters-listitemsfiltersnullablelibcarbon_ruby_sdkmodelslist_items_filters_nullablerb"></a>
|
1490
1502
|
##### pagination: [`Pagination`](./lib/carbon_ruby_sdk/models/pagination.rb)<a id="pagination-paginationlibcarbon_ruby_sdkmodelspaginationrb"></a>
|
1491
1503
|
#### 🔄 Return<a id="🔄-return"></a>
|
1492
1504
|
|
@@ -1628,6 +1640,7 @@ result = carbon.integrations.sync_confluence(
|
|
1628
1640
|
prepend_filename_to_chunks: false,
|
1629
1641
|
max_items_per_chunk: 1,
|
1630
1642
|
set_page_as_boundary: false,
|
1643
|
+
request_id: "string_example",
|
1631
1644
|
)
|
1632
1645
|
p result
|
1633
1646
|
```
|
@@ -1647,6 +1660,7 @@ p result
|
|
1647
1660
|
Number of objects per chunk. For csv, tsv, xlsx, and json files only.
|
1648
1661
|
|
1649
1662
|
##### set_page_as_boundary: `Boolean`<a id="set_page_as_boundary-boolean"></a>
|
1663
|
+
##### request_id: `String`<a id="request_id-string"></a>
|
1650
1664
|
#### 🔄 Return<a id="🔄-return"></a>
|
1651
1665
|
|
1652
1666
|
[GenericSuccessResponse](./lib/carbon_ruby_sdk/models/generic_success_response.rb)
|
@@ -1713,6 +1727,7 @@ result = carbon.integrations.sync_files(
|
|
1713
1727
|
prepend_filename_to_chunks: false,
|
1714
1728
|
max_items_per_chunk: 1,
|
1715
1729
|
set_page_as_boundary: false,
|
1730
|
+
request_id: "string_example",
|
1716
1731
|
)
|
1717
1732
|
p result
|
1718
1733
|
```
|
@@ -1732,6 +1747,7 @@ p result
|
|
1732
1747
|
Number of objects per chunk. For csv, tsv, xlsx, and json files only.
|
1733
1748
|
|
1734
1749
|
##### set_page_as_boundary: `Boolean`<a id="set_page_as_boundary-boolean"></a>
|
1750
|
+
##### request_id: `String`<a id="request_id-string"></a>
|
1735
1751
|
#### 🔄 Return<a id="🔄-return"></a>
|
1736
1752
|
|
1737
1753
|
[GenericSuccessResponse](./lib/carbon_ruby_sdk/models/generic_success_response.rb)
|
@@ -1765,6 +1781,7 @@ result = carbon.integrations.sync_gitbook(
|
|
1765
1781
|
embedding_model: "OPENAI",
|
1766
1782
|
generate_sparse_vectors: false,
|
1767
1783
|
prepend_filename_to_chunks: false,
|
1784
|
+
request_id: "string_example",
|
1768
1785
|
)
|
1769
1786
|
p result
|
1770
1787
|
```
|
@@ -1780,6 +1797,7 @@ p result
|
|
1780
1797
|
##### embedding_model: [`EmbeddingGenerators`](./lib/carbon_ruby_sdk/models/embedding_generators.rb)<a id="embedding_model-embeddinggeneratorslibcarbon_ruby_sdkmodelsembedding_generatorsrb"></a>
|
1781
1798
|
##### generate_sparse_vectors: `Boolean`<a id="generate_sparse_vectors-boolean"></a>
|
1782
1799
|
##### prepend_filename_to_chunks: `Boolean`<a id="prepend_filename_to_chunks-boolean"></a>
|
1800
|
+
##### request_id: `String`<a id="request_id-string"></a>
|
1783
1801
|
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
1784
1802
|
|
1785
1803
|
`/integrations/gitbook/sync` `POST`
|
@@ -1855,6 +1873,7 @@ result = carbon.integrations.sync_gmail(
|
|
1855
1873
|
generate_sparse_vectors: false,
|
1856
1874
|
prepend_filename_to_chunks: false,
|
1857
1875
|
data_source_id: 1,
|
1876
|
+
request_id: "string_example",
|
1858
1877
|
)
|
1859
1878
|
p result
|
1860
1879
|
```
|
@@ -1870,6 +1889,7 @@ p result
|
|
1870
1889
|
##### generate_sparse_vectors: `Boolean`<a id="generate_sparse_vectors-boolean"></a>
|
1871
1890
|
##### prepend_filename_to_chunks: `Boolean`<a id="prepend_filename_to_chunks-boolean"></a>
|
1872
1891
|
##### data_source_id: `Integer`<a id="data_source_id-integer"></a>
|
1892
|
+
##### request_id: `String`<a id="request_id-string"></a>
|
1873
1893
|
#### 🔄 Return<a id="🔄-return"></a>
|
1874
1894
|
|
1875
1895
|
[GenericSuccessResponse](./lib/carbon_ruby_sdk/models/generic_success_response.rb)
|
@@ -1960,6 +1980,7 @@ result = carbon.integrations.sync_outlook(
|
|
1960
1980
|
generate_sparse_vectors: false,
|
1961
1981
|
prepend_filename_to_chunks: false,
|
1962
1982
|
data_source_id: 1,
|
1983
|
+
request_id: "string_example",
|
1963
1984
|
)
|
1964
1985
|
p result
|
1965
1986
|
```
|
@@ -1976,6 +1997,7 @@ p result
|
|
1976
1997
|
##### generate_sparse_vectors: `Boolean`<a id="generate_sparse_vectors-boolean"></a>
|
1977
1998
|
##### prepend_filename_to_chunks: `Boolean`<a id="prepend_filename_to_chunks-boolean"></a>
|
1978
1999
|
##### data_source_id: `Integer`<a id="data_source_id-integer"></a>
|
2000
|
+
##### request_id: `String`<a id="request_id-string"></a>
|
1979
2001
|
#### 🔄 Return<a id="🔄-return"></a>
|
1980
2002
|
|
1981
2003
|
[GenericSuccessResponse](./lib/carbon_ruby_sdk/models/generic_success_response.rb)
|
@@ -2005,6 +2027,7 @@ result = carbon.integrations.sync_rss_feed(
|
|
2005
2027
|
embedding_model: "OPENAI",
|
2006
2028
|
generate_sparse_vectors: false,
|
2007
2029
|
prepend_filename_to_chunks: false,
|
2030
|
+
request_id: "string_example",
|
2008
2031
|
)
|
2009
2032
|
p result
|
2010
2033
|
```
|
@@ -2019,6 +2042,7 @@ p result
|
|
2019
2042
|
##### embedding_model: [`EmbeddingGenerators`](./lib/carbon_ruby_sdk/models/embedding_generators.rb)<a id="embedding_model-embeddinggeneratorslibcarbon_ruby_sdkmodelsembedding_generatorsrb"></a>
|
2020
2043
|
##### generate_sparse_vectors: `Boolean`<a id="generate_sparse_vectors-boolean"></a>
|
2021
2044
|
##### prepend_filename_to_chunks: `Boolean`<a id="prepend_filename_to_chunks-boolean"></a>
|
2045
|
+
##### request_id: `String`<a id="request_id-string"></a>
|
2022
2046
|
#### 🔄 Return<a id="🔄-return"></a>
|
2023
2047
|
|
2024
2048
|
[GenericSuccessResponse](./lib/carbon_ruby_sdk/models/generic_success_response.rb)
|
@@ -2056,6 +2080,7 @@ result = carbon.integrations.sync_s3_files(
|
|
2056
2080
|
max_items_per_chunk: 1,
|
2057
2081
|
set_page_as_boundary: false,
|
2058
2082
|
data_source_id: 1,
|
2083
|
+
request_id: "string_example",
|
2059
2084
|
)
|
2060
2085
|
p result
|
2061
2086
|
```
|
@@ -2075,6 +2100,7 @@ Number of objects per chunk. For csv, tsv, xlsx, and json files only.
|
|
2075
2100
|
|
2076
2101
|
##### set_page_as_boundary: `Boolean`<a id="set_page_as_boundary-boolean"></a>
|
2077
2102
|
##### data_source_id: `Integer`<a id="data_source_id-integer"></a>
|
2103
|
+
##### request_id: `String`<a id="request_id-string"></a>
|
2078
2104
|
#### 🔄 Return<a id="🔄-return"></a>
|
2079
2105
|
|
2080
2106
|
[GenericSuccessResponse](./lib/carbon_ruby_sdk/models/generic_success_response.rb)
|