carbon_ruby_sdk 0.1.12 → 0.1.14
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 +43 -2
- data/lib/carbon_ruby_sdk/api/integrations_api.rb +92 -20
- data/lib/carbon_ruby_sdk/models/document_response.rb +15 -5
- data/lib/carbon_ruby_sdk/models/embedding_and_chunk.rb +15 -5
- 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/o_auth_url_request.rb +41 -5
- data/lib/carbon_ruby_sdk/models/organization_user_data_source_api.rb +11 -1
- 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 +39 -5
- data/lib/carbon_ruby_sdk/models/sync_files_request.rb +38 -4
- data/lib/carbon_ruby_sdk/models/user_file.rb +11 -1
- data/lib/carbon_ruby_sdk/version.rb +1 -1
- data/spec/models/document_response_spec.rb +6 -0
- data/spec/models/embedding_and_chunk_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/o_auth_url_request_spec.rb +18 -0
- data/spec/models/organization_user_data_source_api_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 +18 -0
- data/spec/models/sync_files_request_spec.rb +18 -0
- data/spec/models/user_file_spec.rb +6 -0
- metadata +3 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 0e7c6ef6b04b7ca939bc372bbe9bef6764c4e050a3df80e03c262582b597ee7b
|
4
|
+
data.tar.gz: b5a104d83fa479ad58b9b3b4f68c244e7dd76a850acb821421cdfb3a7212b8bb
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: e577bfd0bcd1d9cf1d8e42a7e25a7ea33de2cb713c8e24bff9b53431d4825178d747359be5dd88c387658c73fb7e93d71655827848bd6c3f61d0b58ebbc43910
|
7
|
+
data.tar.gz: 1668d9d53d1ab1df1cf2f27d09c2c412e72799f8a049f79e8a4d91ed0db2e8e2695c1811e894536e0bf62403d541a25b55612d4cd3df45e243417d4a3d3b4666
|
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.13)
|
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.14-blue)](https://rubygems.org/gems/carbon_ruby_sdk/versions/0.1.14)
|
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.14'
|
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,9 @@ 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",
|
1384
|
+
use_ocr: false,
|
1385
|
+
parse_pdf_tables_with_ocr: false,
|
1379
1386
|
)
|
1380
1387
|
p result
|
1381
1388
|
```
|
@@ -1415,6 +1422,14 @@ connecting a new account.
|
|
1415
1422
|
Used to connect a new data source. If not specified, we will attempt to create a
|
1416
1423
|
sync URL for an existing data source based on type and ID.
|
1417
1424
|
|
1425
|
+
##### request_id: `String`<a id="request_id-string"></a>
|
1426
|
+
This request id will be added to all files that get synced using the generated
|
1427
|
+
OAuth URL
|
1428
|
+
|
1429
|
+
##### use_ocr: `Boolean`<a id="use_ocr-boolean"></a>
|
1430
|
+
Enable OCR for files that support it. Supported formats: pdf
|
1431
|
+
|
1432
|
+
##### parse_pdf_tables_with_ocr: `Boolean`<a id="parse_pdf_tables_with_ocr-boolean"></a>
|
1418
1433
|
#### 🔄 Return<a id="🔄-return"></a>
|
1419
1434
|
|
1420
1435
|
[OuthURLResponse](./lib/carbon_ruby_sdk/models/outh_url_response.rb)
|
@@ -1631,6 +1646,9 @@ result = carbon.integrations.sync_confluence(
|
|
1631
1646
|
prepend_filename_to_chunks: false,
|
1632
1647
|
max_items_per_chunk: 1,
|
1633
1648
|
set_page_as_boundary: false,
|
1649
|
+
request_id: "string_example",
|
1650
|
+
use_ocr: false,
|
1651
|
+
parse_pdf_tables_with_ocr: false,
|
1634
1652
|
)
|
1635
1653
|
p result
|
1636
1654
|
```
|
@@ -1650,6 +1668,9 @@ p result
|
|
1650
1668
|
Number of objects per chunk. For csv, tsv, xlsx, and json files only.
|
1651
1669
|
|
1652
1670
|
##### set_page_as_boundary: `Boolean`<a id="set_page_as_boundary-boolean"></a>
|
1671
|
+
##### request_id: `String`<a id="request_id-string"></a>
|
1672
|
+
##### use_ocr: `Boolean`<a id="use_ocr-boolean"></a>
|
1673
|
+
##### parse_pdf_tables_with_ocr: `Boolean`<a id="parse_pdf_tables_with_ocr-boolean"></a>
|
1653
1674
|
#### 🔄 Return<a id="🔄-return"></a>
|
1654
1675
|
|
1655
1676
|
[GenericSuccessResponse](./lib/carbon_ruby_sdk/models/generic_success_response.rb)
|
@@ -1716,6 +1737,9 @@ result = carbon.integrations.sync_files(
|
|
1716
1737
|
prepend_filename_to_chunks: false,
|
1717
1738
|
max_items_per_chunk: 1,
|
1718
1739
|
set_page_as_boundary: false,
|
1740
|
+
request_id: "string_example",
|
1741
|
+
use_ocr: false,
|
1742
|
+
parse_pdf_tables_with_ocr: false,
|
1719
1743
|
)
|
1720
1744
|
p result
|
1721
1745
|
```
|
@@ -1735,6 +1759,9 @@ p result
|
|
1735
1759
|
Number of objects per chunk. For csv, tsv, xlsx, and json files only.
|
1736
1760
|
|
1737
1761
|
##### set_page_as_boundary: `Boolean`<a id="set_page_as_boundary-boolean"></a>
|
1762
|
+
##### request_id: `String`<a id="request_id-string"></a>
|
1763
|
+
##### use_ocr: `Boolean`<a id="use_ocr-boolean"></a>
|
1764
|
+
##### parse_pdf_tables_with_ocr: `Boolean`<a id="parse_pdf_tables_with_ocr-boolean"></a>
|
1738
1765
|
#### 🔄 Return<a id="🔄-return"></a>
|
1739
1766
|
|
1740
1767
|
[GenericSuccessResponse](./lib/carbon_ruby_sdk/models/generic_success_response.rb)
|
@@ -1768,6 +1795,7 @@ result = carbon.integrations.sync_gitbook(
|
|
1768
1795
|
embedding_model: "OPENAI",
|
1769
1796
|
generate_sparse_vectors: false,
|
1770
1797
|
prepend_filename_to_chunks: false,
|
1798
|
+
request_id: "string_example",
|
1771
1799
|
)
|
1772
1800
|
p result
|
1773
1801
|
```
|
@@ -1783,6 +1811,7 @@ p result
|
|
1783
1811
|
##### embedding_model: [`EmbeddingGenerators`](./lib/carbon_ruby_sdk/models/embedding_generators.rb)<a id="embedding_model-embeddinggeneratorslibcarbon_ruby_sdkmodelsembedding_generatorsrb"></a>
|
1784
1812
|
##### generate_sparse_vectors: `Boolean`<a id="generate_sparse_vectors-boolean"></a>
|
1785
1813
|
##### prepend_filename_to_chunks: `Boolean`<a id="prepend_filename_to_chunks-boolean"></a>
|
1814
|
+
##### request_id: `String`<a id="request_id-string"></a>
|
1786
1815
|
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
1787
1816
|
|
1788
1817
|
`/integrations/gitbook/sync` `POST`
|
@@ -1858,6 +1887,7 @@ result = carbon.integrations.sync_gmail(
|
|
1858
1887
|
generate_sparse_vectors: false,
|
1859
1888
|
prepend_filename_to_chunks: false,
|
1860
1889
|
data_source_id: 1,
|
1890
|
+
request_id: "string_example",
|
1861
1891
|
)
|
1862
1892
|
p result
|
1863
1893
|
```
|
@@ -1873,6 +1903,7 @@ p result
|
|
1873
1903
|
##### generate_sparse_vectors: `Boolean`<a id="generate_sparse_vectors-boolean"></a>
|
1874
1904
|
##### prepend_filename_to_chunks: `Boolean`<a id="prepend_filename_to_chunks-boolean"></a>
|
1875
1905
|
##### data_source_id: `Integer`<a id="data_source_id-integer"></a>
|
1906
|
+
##### request_id: `String`<a id="request_id-string"></a>
|
1876
1907
|
#### 🔄 Return<a id="🔄-return"></a>
|
1877
1908
|
|
1878
1909
|
[GenericSuccessResponse](./lib/carbon_ruby_sdk/models/generic_success_response.rb)
|
@@ -1963,6 +1994,7 @@ result = carbon.integrations.sync_outlook(
|
|
1963
1994
|
generate_sparse_vectors: false,
|
1964
1995
|
prepend_filename_to_chunks: false,
|
1965
1996
|
data_source_id: 1,
|
1997
|
+
request_id: "string_example",
|
1966
1998
|
)
|
1967
1999
|
p result
|
1968
2000
|
```
|
@@ -1979,6 +2011,7 @@ p result
|
|
1979
2011
|
##### generate_sparse_vectors: `Boolean`<a id="generate_sparse_vectors-boolean"></a>
|
1980
2012
|
##### prepend_filename_to_chunks: `Boolean`<a id="prepend_filename_to_chunks-boolean"></a>
|
1981
2013
|
##### data_source_id: `Integer`<a id="data_source_id-integer"></a>
|
2014
|
+
##### request_id: `String`<a id="request_id-string"></a>
|
1982
2015
|
#### 🔄 Return<a id="🔄-return"></a>
|
1983
2016
|
|
1984
2017
|
[GenericSuccessResponse](./lib/carbon_ruby_sdk/models/generic_success_response.rb)
|
@@ -2008,6 +2041,7 @@ result = carbon.integrations.sync_rss_feed(
|
|
2008
2041
|
embedding_model: "OPENAI",
|
2009
2042
|
generate_sparse_vectors: false,
|
2010
2043
|
prepend_filename_to_chunks: false,
|
2044
|
+
request_id: "string_example",
|
2011
2045
|
)
|
2012
2046
|
p result
|
2013
2047
|
```
|
@@ -2022,6 +2056,7 @@ p result
|
|
2022
2056
|
##### embedding_model: [`EmbeddingGenerators`](./lib/carbon_ruby_sdk/models/embedding_generators.rb)<a id="embedding_model-embeddinggeneratorslibcarbon_ruby_sdkmodelsembedding_generatorsrb"></a>
|
2023
2057
|
##### generate_sparse_vectors: `Boolean`<a id="generate_sparse_vectors-boolean"></a>
|
2024
2058
|
##### prepend_filename_to_chunks: `Boolean`<a id="prepend_filename_to_chunks-boolean"></a>
|
2059
|
+
##### request_id: `String`<a id="request_id-string"></a>
|
2025
2060
|
#### 🔄 Return<a id="🔄-return"></a>
|
2026
2061
|
|
2027
2062
|
[GenericSuccessResponse](./lib/carbon_ruby_sdk/models/generic_success_response.rb)
|
@@ -2059,6 +2094,9 @@ result = carbon.integrations.sync_s3_files(
|
|
2059
2094
|
max_items_per_chunk: 1,
|
2060
2095
|
set_page_as_boundary: false,
|
2061
2096
|
data_source_id: 1,
|
2097
|
+
request_id: "string_example",
|
2098
|
+
use_ocr: false,
|
2099
|
+
parse_pdf_tables_with_ocr: false,
|
2062
2100
|
)
|
2063
2101
|
p result
|
2064
2102
|
```
|
@@ -2078,6 +2116,9 @@ Number of objects per chunk. For csv, tsv, xlsx, and json files only.
|
|
2078
2116
|
|
2079
2117
|
##### set_page_as_boundary: `Boolean`<a id="set_page_as_boundary-boolean"></a>
|
2080
2118
|
##### data_source_id: `Integer`<a id="data_source_id-integer"></a>
|
2119
|
+
##### request_id: `String`<a id="request_id-string"></a>
|
2120
|
+
##### use_ocr: `Boolean`<a id="use_ocr-boolean"></a>
|
2121
|
+
##### parse_pdf_tables_with_ocr: `Boolean`<a id="parse_pdf_tables_with_ocr-boolean"></a>
|
2081
2122
|
#### 🔄 Return<a id="🔄-return"></a>
|
2082
2123
|
|
2083
2124
|
[GenericSuccessResponse](./lib/carbon_ruby_sdk/models/generic_success_response.rb)
|