carbon_ruby_sdk 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd7974b2da45db33f2f9b12525479855314a2a4c894ba085df0e7743052b0e85
-  data.tar.gz: 12583c34578f4a0dfe0ea096f471a3d7329305afca38d255bc0f5f1c97f8a6b6
+  metadata.gz: c209fcd399aa1413a587d8fb3bc56ab173b56052522fdb5aa6f180a5bec9b5d3
+  data.tar.gz: 43aceb3e7bb7ac9dd9ad1a5e16746acc79d90a7de5fd907fbcc26ff3b6f1e2d1
 SHA512:
-  metadata.gz: 9be2791c4adac413d756ef78aa17e7ad0851293ad7b5ef6ed6ad530e80e6d5e14e97759028870bc04c16e7f5d15bca0a548b4b9710f1c807740b03aa8aae474d
-  data.tar.gz: 1e139cb78829fe2757e2b629a08146d7b899e7b542f93ca57b4224200cead60ec641a1152b5339eed9e7353015123545d937f4930b8e5b6444dff186d6906739
+  metadata.gz: 28401ee97a6b8271954bac68c85cc0bdbc2ff5c75f6489f7d588fde1842745ddde812f9e969f4d7d3b9837af6ff5eaa2e53480e3cba4928bc2d4e2d76131a4fa
+  data.tar.gz: fdc346900eb6f16ecf77464d9d2b08d80b3a22464dec67c218a501f2410685fe578c4870577d62bceb9d7dc918e03c50840135c65dc43c8060f230084c1b20e6

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    carbon_ruby_sdk (0.1.7)
+    carbon_ruby_sdk (0.1.8)
       faraday (>= 1.0.1, < 3.0)
       faraday-multipart (~> 1.0, >= 1.0.4)
 

data/README.md

@@ -6,7 +6,7 @@
 
 Connect external data to LLMs, no matter the source.
 
-[![npm](https://img.shields.io/badge/gem-v0.1.7-blue)](https://rubygems.org/gems/carbon_ruby_sdk/versions/0.1.7)
+[![npm](https://img.shields.io/badge/gem-v0.1.8-blue)](https://rubygems.org/gems/carbon_ruby_sdk/versions/0.1.8)
 
 </div>
 
@@ -78,7 +78,7 @@ Connect external data to LLMs, no matter the source.
 Add to Gemfile:
 
 ```ruby
-gem 'carbon_ruby_sdk', '~> 0.1.7'
+gem 'carbon_ruby_sdk', '~> 0.1.8'
 ```
 
 ## Getting Started<a id="getting-started"></a>
@@ -981,7 +981,7 @@ the file to be a candidate for hybrid search.
 Whether or not to prepend the file's name to chunks.
 
 ##### max_items_per_chunk: `Integer`<a id="max_items_per_chunk-integer"></a>
-Number of objects per chunk. For json files only.
+Number of objects per chunk. For csv, tsv, xlsx, and json files only.
 
 #### 🔄 Return<a id="🔄-return"></a>
 
@@ -1032,6 +1032,8 @@ p result
 ##### use_textract: `Boolean`<a id="use_textract-boolean"></a>
 ##### prepend_filename_to_chunks: `Boolean`<a id="prepend_filename_to_chunks-boolean"></a>
 ##### max_items_per_chunk: `Integer`<a id="max_items_per_chunk-integer"></a>
+Number of objects per chunk. For csv, tsv, xlsx, and json files only.
+
 #### 🔄 Return<a id="🔄-return"></a>
 
 [UserFile](./lib/carbon_ruby_sdk/models/user_file.rb)
@@ -1348,6 +1350,8 @@ p result
 ##### generate_sparse_vectors: `Boolean`<a id="generate_sparse_vectors-boolean"></a>
 ##### prepend_filename_to_chunks: `Boolean`<a id="prepend_filename_to_chunks-boolean"></a>
 ##### max_items_per_chunk: `Integer`<a id="max_items_per_chunk-integer"></a>
+Number of objects per chunk. For csv, tsv, xlsx, and json files only.
+
 ##### salesforce_domain: `String`<a id="salesforce_domain-string"></a>
 ##### sync_files_on_connection: `Boolean`<a id="sync_files_on_connection-boolean"></a>
 Used to specify whether Carbon should attempt to sync all your files
@@ -1594,6 +1598,8 @@ p result
 ##### generate_sparse_vectors: `Boolean`<a id="generate_sparse_vectors-boolean"></a>
 ##### prepend_filename_to_chunks: `Boolean`<a id="prepend_filename_to_chunks-boolean"></a>
 ##### max_items_per_chunk: `Integer`<a id="max_items_per_chunk-integer"></a>
+Number of objects per chunk. For csv, tsv, xlsx, and json files only.
+
 ##### set_page_as_boundary: `Boolean`<a id="set_page_as_boundary-boolean"></a>
 #### 🔄 Return<a id="🔄-return"></a>
 
@@ -1677,6 +1683,8 @@ p result
 ##### generate_sparse_vectors: `Boolean`<a id="generate_sparse_vectors-boolean"></a>
 ##### prepend_filename_to_chunks: `Boolean`<a id="prepend_filename_to_chunks-boolean"></a>
 ##### max_items_per_chunk: `Integer`<a id="max_items_per_chunk-integer"></a>
+Number of objects per chunk. For csv, tsv, xlsx, and json files only.
+
 ##### set_page_as_boundary: `Boolean`<a id="set_page_as_boundary-boolean"></a>
 #### 🔄 Return<a id="🔄-return"></a>
 
@@ -2017,6 +2025,8 @@ p result
 ##### generate_sparse_vectors: `Boolean`<a id="generate_sparse_vectors-boolean"></a>
 ##### prepend_filename_to_chunks: `Boolean`<a id="prepend_filename_to_chunks-boolean"></a>
 ##### max_items_per_chunk: `Integer`<a id="max_items_per_chunk-integer"></a>
+Number of objects per chunk. For csv, tsv, xlsx, and json files only.
+
 ##### set_page_as_boundary: `Boolean`<a id="set_page_as_boundary-boolean"></a>
 ##### data_source_id: `Integer`<a id="data_source_id-integer"></a>
 #### 🔄 Return<a id="🔄-return"></a>

data/lib/carbon_ruby_sdk/api/files_api.rb

@@ -1074,7 +1074,7 @@ module Carbon
     # @param use_ocr [Boolean] Whether or not to use OCR when processing files. Only valid for PDFs. Useful for documents with tables, images, and/or scanned text.
     # @param generate_sparse_vectors [Boolean] Whether or not to generate sparse vectors for the file. This is *required* for the file to be a candidate for hybrid search.
     # @param prepend_filename_to_chunks [Boolean] Whether or not to prepend the file's name to chunks.
-    # @param max_items_per_chunk [Integer] Number of objects per chunk. For json files only.
+    # @param max_items_per_chunk [Integer] Number of objects per chunk. For csv, tsv, xlsx, and json files only.
     # @param body [BodyCreateUploadFileUploadfilePost] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def upload(file:, chunk_size: SENTINEL, chunk_overlap: SENTINEL, skip_embedding_generation: false, set_page_as_boundary: false, embedding_model: SENTINEL, use_ocr: false, generate_sparse_vectors: false, prepend_filename_to_chunks: false, max_items_per_chunk: SENTINEL, extra: {})
@@ -1131,7 +1131,7 @@ module Carbon
     # @param use_ocr [Boolean] Whether or not to use OCR when processing files. Only valid for PDFs. Useful for documents with tables, images, and/or scanned text.
     # @param generate_sparse_vectors [Boolean] Whether or not to generate sparse vectors for the file. This is *required* for the file to be a candidate for hybrid search.
     # @param prepend_filename_to_chunks [Boolean] Whether or not to prepend the file's name to chunks.
-    # @param max_items_per_chunk [Integer] Number of objects per chunk. For json files only.
+    # @param max_items_per_chunk [Integer] Number of objects per chunk. For csv, tsv, xlsx, and json files only.
     # @param body [BodyCreateUploadFileUploadfilePost] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def upload_with_http_info(file:, chunk_size: SENTINEL, chunk_overlap: SENTINEL, skip_embedding_generation: false, set_page_as_boundary: false, embedding_model: SENTINEL, use_ocr: false, generate_sparse_vectors: false, prepend_filename_to_chunks: false, max_items_per_chunk: SENTINEL, extra: {})
@@ -1163,7 +1163,7 @@ module Carbon
     # @option opts [Boolean] :use_ocr Whether or not to use OCR when processing files. Only valid for PDFs. Useful for documents with             tables, images, and/or scanned text. (default to false)
     # @option opts [Boolean] :generate_sparse_vectors Whether or not to generate sparse vectors for the file. This is *required* for the file to be a             candidate for hybrid search. (default to false)
     # @option opts [Boolean] :prepend_filename_to_chunks Whether or not to prepend the file's name to chunks. (default to false)
-    # @option opts [Integer] :max_items_per_chunk Number of objects per chunk. For json files only.
+    # @option opts [Integer] :max_items_per_chunk Number of objects per chunk. For csv, tsv, xlsx, and json files only.
     # @return [UserFile]
     private def upload_impl(file, body_create_upload_file_uploadfile_post, opts = {})
       data, _status_code, _headers = upload_with_http_info(file, body_create_upload_file_uploadfile_post, opts)
@@ -1183,7 +1183,7 @@ module Carbon
     # @option opts [Boolean] :use_ocr Whether or not to use OCR when processing files. Only valid for PDFs. Useful for documents with             tables, images, and/or scanned text. (default to false)
     # @option opts [Boolean] :generate_sparse_vectors Whether or not to generate sparse vectors for the file. This is *required* for the file to be a             candidate for hybrid search. (default to false)
     # @option opts [Boolean] :prepend_filename_to_chunks Whether or not to prepend the file's name to chunks. (default to false)
-    # @option opts [Integer] :max_items_per_chunk Number of objects per chunk. For json files only.
+    # @option opts [Integer] :max_items_per_chunk Number of objects per chunk. For csv, tsv, xlsx, and json files only.
     # @return [APIResponse] data is UserFile, status code, headers and response
     private def upload_with_http_info_impl(file, body_create_upload_file_uploadfile_post, opts = {})
       if @api_client.config.debugging
@@ -1265,7 +1265,7 @@ module Carbon
     # @param generate_sparse_vectors [Boolean] 
     # @param use_textract [Boolean] 
     # @param prepend_filename_to_chunks [Boolean] 
-    # @param max_items_per_chunk [Integer] 
+    # @param max_items_per_chunk [Integer] Number of objects per chunk. For csv, tsv, xlsx, and json files only.
     # @param body [UploadFileFromUrlInput] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def upload_from_url(url:, file_name: SENTINEL, chunk_size: SENTINEL, chunk_overlap: SENTINEL, skip_embedding_generation: false, set_page_as_boundary: false, embedding_model: 'OPENAI', generate_sparse_vectors: false, use_textract: false, prepend_filename_to_chunks: false, max_items_per_chunk: SENTINEL, extra: {})
@@ -1298,7 +1298,7 @@ module Carbon
     # @param generate_sparse_vectors [Boolean] 
     # @param use_textract [Boolean] 
     # @param prepend_filename_to_chunks [Boolean] 
-    # @param max_items_per_chunk [Integer] 
+    # @param max_items_per_chunk [Integer] Number of objects per chunk. For csv, tsv, xlsx, and json files only.
     # @param body [UploadFileFromUrlInput] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def upload_from_url_with_http_info(url:, file_name: SENTINEL, chunk_size: SENTINEL, chunk_overlap: SENTINEL, skip_embedding_generation: false, set_page_as_boundary: false, embedding_model: 'OPENAI', generate_sparse_vectors: false, use_textract: false, prepend_filename_to_chunks: false, max_items_per_chunk: SENTINEL, extra: {})

data/lib/carbon_ruby_sdk/api/integrations_api.rb

@@ -528,7 +528,7 @@ module Carbon
     # @param confluence_subdomain [String] 
     # @param generate_sparse_vectors [Boolean] 
     # @param prepend_filename_to_chunks [Boolean] 
-    # @param max_items_per_chunk [Integer] 
+    # @param max_items_per_chunk [Integer] Number of objects per chunk. For csv, tsv, xlsx, and json files only.
     # @param salesforce_domain [String] 
     # @param sync_files_on_connection [Boolean] Used to specify whether Carbon should attempt to sync all your files automatically when authorization is complete. This is only supported for a subset of connectors and will be ignored for the rest. Supported connectors: Intercom, Zendesk, Gitbook, Confluence, Salesforce, Freshdesk
     # @param set_page_as_boundary [Boolean] 
@@ -582,7 +582,7 @@ module Carbon
     # @param confluence_subdomain [String] 
     # @param generate_sparse_vectors [Boolean] 
     # @param prepend_filename_to_chunks [Boolean] 
-    # @param max_items_per_chunk [Integer] 
+    # @param max_items_per_chunk [Integer] Number of objects per chunk. For csv, tsv, xlsx, and json files only.
     # @param salesforce_domain [String] 
     # @param sync_files_on_connection [Boolean] Used to specify whether Carbon should attempt to sync all your files automatically when authorization is complete. This is only supported for a subset of connectors and will be ignored for the rest. Supported connectors: Intercom, Zendesk, Gitbook, Confluence, Salesforce, Freshdesk
     # @param set_page_as_boundary [Boolean] 
@@ -1258,7 +1258,7 @@ module Carbon
     # @param embedding_model [EmbeddingGeneratorsNullable] 
     # @param generate_sparse_vectors [Boolean] 
     # @param prepend_filename_to_chunks [Boolean] 
-    # @param max_items_per_chunk [Integer] 
+    # @param max_items_per_chunk [Integer] Number of objects per chunk. For csv, tsv, xlsx, and json files only.
     # @param set_page_as_boundary [Boolean] 
     # @param body [SyncFilesRequest] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -1296,7 +1296,7 @@ module Carbon
     # @param embedding_model [EmbeddingGeneratorsNullable] 
     # @param generate_sparse_vectors [Boolean] 
     # @param prepend_filename_to_chunks [Boolean] 
-    # @param max_items_per_chunk [Integer] 
+    # @param max_items_per_chunk [Integer] Number of objects per chunk. For csv, tsv, xlsx, and json files only.
     # @param set_page_as_boundary [Boolean] 
     # @param body [SyncFilesRequest] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -1494,7 +1494,7 @@ module Carbon
     # @param embedding_model [EmbeddingGeneratorsNullable] 
     # @param generate_sparse_vectors [Boolean] 
     # @param prepend_filename_to_chunks [Boolean] 
-    # @param max_items_per_chunk [Integer] 
+    # @param max_items_per_chunk [Integer] Number of objects per chunk. For csv, tsv, xlsx, and json files only.
     # @param set_page_as_boundary [Boolean] 
     # @param body [SyncFilesRequest] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -1532,7 +1532,7 @@ module Carbon
     # @param embedding_model [EmbeddingGeneratorsNullable] 
     # @param generate_sparse_vectors [Boolean] 
     # @param prepend_filename_to_chunks [Boolean] 
-    # @param max_items_per_chunk [Integer] 
+    # @param max_items_per_chunk [Integer] Number of objects per chunk. For csv, tsv, xlsx, and json files only.
     # @param set_page_as_boundary [Boolean] 
     # @param body [SyncFilesRequest] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -2368,7 +2368,7 @@ module Carbon
     # @param embedding_model [EmbeddingGenerators] 
     # @param generate_sparse_vectors [Boolean] 
     # @param prepend_filename_to_chunks [Boolean] 
-    # @param max_items_per_chunk [Integer] 
+    # @param max_items_per_chunk [Integer] Number of objects per chunk. For csv, tsv, xlsx, and json files only.
     # @param set_page_as_boundary [Boolean] 
     # @param data_source_id [Integer] 
     # @param body [S3FileSyncInput] 
@@ -2405,7 +2405,7 @@ module Carbon
     # @param embedding_model [EmbeddingGenerators] 
     # @param generate_sparse_vectors [Boolean] 
     # @param prepend_filename_to_chunks [Boolean] 
-    # @param max_items_per_chunk [Integer] 
+    # @param max_items_per_chunk [Integer] Number of objects per chunk. For csv, tsv, xlsx, and json files only.
     # @param set_page_as_boundary [Boolean] 
     # @param data_source_id [Integer] 
     # @param body [S3FileSyncInput] 

data/lib/carbon_ruby_sdk/models/o_auth_url_request.rb

@@ -37,6 +37,7 @@ module Carbon
 
     attr_accessor :prepend_filename_to_chunks
 
+    # Number of objects per chunk. For csv, tsv, xlsx, and json files only.
     attr_accessor :max_items_per_chunk
 
     attr_accessor :salesforce_domain

data/lib/carbon_ruby_sdk/models/s3_file_sync_input.rb

@@ -27,6 +27,7 @@ module Carbon
 
     attr_accessor :prepend_filename_to_chunks
 
+    # Number of objects per chunk. For csv, tsv, xlsx, and json files only.
     attr_accessor :max_items_per_chunk
 
     attr_accessor :set_page_as_boundary

data/lib/carbon_ruby_sdk/models/sync_files_request.rb

@@ -29,6 +29,7 @@ module Carbon
 
     attr_accessor :prepend_filename_to_chunks
 
+    # Number of objects per chunk. For csv, tsv, xlsx, and json files only.
     attr_accessor :max_items_per_chunk
 
     attr_accessor :set_page_as_boundary

data/lib/carbon_ruby_sdk/models/sync_options.rb

@@ -25,6 +25,7 @@ module Carbon
 
     attr_accessor :prepend_filename_to_chunks
 
+    # Number of objects per chunk. For csv, tsv, xlsx, and json files only.
     attr_accessor :max_items_per_chunk
 
     # Used to specify whether Carbon should attempt to sync all your files automatically when authorization         is complete. This is only supported for a subset of connectors and will be ignored for the rest. Supported         connectors: Intercom, Zendesk, Gitbook, Confluence, Salesforce, Freshdesk

data/lib/carbon_ruby_sdk/models/upload_file_from_url_input.rb

@@ -31,6 +31,7 @@ module Carbon
 
     attr_accessor :prepend_filename_to_chunks
 
+    # Number of objects per chunk. For csv, tsv, xlsx, and json files only.
     attr_accessor :max_items_per_chunk
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/carbon_ruby_sdk/version.rb

@@ -7,5 +7,5 @@ The version of the OpenAPI document: 1.0.0
 =end
 
 module Carbon
-  VERSION = '0.1.7'
+  VERSION = '0.1.8'
 end

data/spec/api/files_api_spec.rb

@@ -144,7 +144,7 @@ describe 'FilesApi' do
   # @option opts [Boolean] :use_ocr Whether or not to use OCR when processing files. Only valid for PDFs. Useful for documents with             tables, images, and/or scanned text.
   # @option opts [Boolean] :generate_sparse_vectors Whether or not to generate sparse vectors for the file. This is *required* for the file to be a             candidate for hybrid search.
   # @option opts [Boolean] :prepend_filename_to_chunks Whether or not to prepend the file's name to chunks.
-  # @option opts [Integer] :max_items_per_chunk Number of objects per chunk. For json files only.
+  # @option opts [Integer] :max_items_per_chunk Number of objects per chunk. For csv, tsv, xlsx, and json files only.
   # @return [UserFile]
   describe 'upload test' do
     it 'should work' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: carbon_ruby_sdk
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - Konfig
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-14 00:00:00.000000000 Z
+date: 2024-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday