carbon_ruby_sdk 0.1.17 → 0.1.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 41b973ad8e62b552db19546d3a3755e4c16c9212de8cf9ea371ce39d1a505387
-  data.tar.gz: 18d9889d6e9f99f2c02d97408d4620d1c768eb7d2519f9cbebccedef375dd3c7
+  metadata.gz: 839fe56ac65336fa1bdf96a70f15650082dea496ad4a4c0b51a8b233fad54809
+  data.tar.gz: b5cbd86d98e6f0cf33b2aae90dd92a25cacdc3d669177699afe9529360749cc0
 SHA512:
-  metadata.gz: 8e66f4386a86fb62c0da7a79ddb0dc197b6de76a90ba267913d79e2136ee58e92b42f5ddc591c45b5e171b450e557276c2429d91e8f49937eab0cd8b13c1b58f
-  data.tar.gz: bb3f6bb1a28029ea0312dd539720c4d2f5cae934817d240eeee4b8b24a7ce27a663e584e2c44c7837a47f54f8d48784227eb7c13f0f50ef0164ca05c3174921e
+  metadata.gz: e0e78234fde535d43ec86edf82d88664c26576fdd58e9eb92c149d5785a2a2502da89ba4063798107b60603f39828294c4e8fd7229de9d4bb8af765e51b69f1c
+  data.tar.gz: 88af831f2ba0f5e216daaa6166889195757df579c401fd76bb28c61219a11c26d6ed05dce7b7d696b6ce9899d6b918d5f5560996d43f5a619d1859fcbd511fb7

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    carbon_ruby_sdk (0.1.17)
+    carbon_ruby_sdk (0.1.18)
       faraday (>= 1.0.1, < 3.0)
       faraday-multipart (~> 1.0, >= 1.0.4)
 
@@ -42,7 +42,7 @@ GEM
     rainbow (3.1.1)
     rake (13.0.6)
     regexp_parser (2.9.0)
-    reline (0.5.0)
+    reline (0.4.2)
       io-console (~> 0.5)
     rexml (3.2.6)
     rspec (3.13.0)
@@ -67,14 +67,14 @@ GEM
       rubocop-ast (>= 1.2.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.31.2)
-      parser (>= 3.3.0.4)
+    rubocop-ast (1.30.0)
+      parser (>= 3.2.1.0)
     ruby-progressbar (1.13.0)
     unicode-display_width (2.5.0)
     uri (0.13.0)
 
 PLATFORMS
-  arm64-darwin-22
+  arm64-darwin-21
 
 DEPENDENCIES
   carbon_ruby_sdk!
@@ -86,4 +86,4 @@ DEPENDENCIES
   rubocop (~> 1.12.1)
 
 BUNDLED WITH
-   2.4.19
+   2.3.7

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.17-blue)](https://rubygems.org/gems/carbon_ruby_sdk/versions/0.1.17)
+[![npm](https://img.shields.io/badge/gem-v0.1.18-blue)](https://rubygems.org/gems/carbon_ruby_sdk/versions/0.1.18)
 
 </div>
 
@@ -80,7 +80,7 @@ Connect external data to LLMs, no matter the source.
 Add to Gemfile:
 
 ```ruby
-gem 'carbon_ruby_sdk', '~> 0.1.17'
+gem 'carbon_ruby_sdk', '~> 0.1.18'
 ```
 
 ## Getting Started<a id="getting-started"></a>
@@ -356,6 +356,7 @@ result = carbon.embeddings.get_documents(
   parent_file_ids: [
         1
     ],
+  include_all_children: false,
   tags_v2: {
     },
   include_tags: true,
@@ -397,6 +398,10 @@ Optional list of file IDs to limit the search to
 Optional list of parent file IDs to limit the search to. A parent file describes
 a file to which another file belongs (e.g. a folder)
 
+##### include_all_children: `Boolean`<a id="include_all_children-boolean"></a>
+Flag to control whether or not to include all children of filtered files in the
+embedding search.
+
 ##### tags_v2: `Object`<a id="tags_v2-object"></a>
 A set of tags to limit the search to. Use this instead of `tags`, which is
 deprecated.
@@ -1434,7 +1439,7 @@ Enable OCR for files that support it. Supported formats: pdf
 ##### parse_pdf_tables_with_ocr: `Boolean`<a id="parse_pdf_tables_with_ocr-boolean"></a>
 ##### enable_file_picker: `Boolean`<a id="enable_file_picker-boolean"></a>
 Enable integration's file picker for sources that support it. Supported sources:
-DROPBOX, BOX, GOOGLE_DRIVE, SHAREPOINT, ONEDRIVE
+GOOGLE_DRIVE, ONEDRIVE, BOX, SHAREPOINT, DROPBOX
 
 #### 🔄 Return<a id="🔄-return"></a>
 

data/lib/carbon_ruby_sdk/api/embeddings_api.rb

@@ -119,6 +119,7 @@ module Carbon
     # @param query_vector [Array<Float>] Optional query vector for which to get related chunks and embeddings. It must have been generated by the same model used to generate the embeddings across which the search is being conducted. Cannot provide both `query` and `query_vector`.
     # @param file_ids [Array<Integer>] Optional list of file IDs to limit the search to
     # @param parent_file_ids [Array<Integer>] Optional list of parent file IDs to limit the search to. A parent file describes a file to which another file belongs (e.g. a folder)
+    # @param include_all_children [Boolean] Flag to control whether or not to include all children of filtered files in the embedding search.
     # @param tags_v2 [Object] A set of tags to limit the search to. Use this instead of `tags`, which is deprecated.
     # @param include_tags [Boolean] Flag to control whether or not to include tags for each chunk in the response.
     # @param include_vectors [Boolean] Flag to control whether or not to include embedding vectors in the response.
@@ -129,7 +130,7 @@ module Carbon
     # @param embedding_model [EmbeddingGeneratorsNullable] 
     # @param body [GetEmbeddingDocumentsBody] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
-    def get_documents(query:, k:, tags: SENTINEL, query_vector: SENTINEL, file_ids: SENTINEL, parent_file_ids: SENTINEL, tags_v2: SENTINEL, include_tags: SENTINEL, include_vectors: SENTINEL, include_raw_file: SENTINEL, hybrid_search: SENTINEL, hybrid_search_tuning_parameters: SENTINEL, media_type: 'TEXT', embedding_model: 'OPENAI', extra: {})
+    def get_documents(query:, k:, tags: SENTINEL, query_vector: SENTINEL, file_ids: SENTINEL, parent_file_ids: SENTINEL, include_all_children: false, tags_v2: SENTINEL, include_tags: SENTINEL, include_vectors: SENTINEL, include_raw_file: SENTINEL, hybrid_search: SENTINEL, hybrid_search_tuning_parameters: SENTINEL, media_type: 'TEXT', embedding_model: 'OPENAI', extra: {})
       _body = {}
       _body[:tags] = tags if tags != SENTINEL
       _body[:query] = query if query != SENTINEL
@@ -137,6 +138,7 @@ module Carbon
       _body[:k] = k if k != SENTINEL
       _body[:file_ids] = file_ids if file_ids != SENTINEL
       _body[:parent_file_ids] = parent_file_ids if parent_file_ids != SENTINEL
+      _body[:include_all_children] = include_all_children if include_all_children != SENTINEL
       _body[:tags_v2] = tags_v2 if tags_v2 != SENTINEL
       _body[:include_tags] = include_tags if include_tags != SENTINEL
       _body[:include_vectors] = include_vectors if include_vectors != SENTINEL
@@ -253,6 +255,7 @@ module Carbon
     # @param query_vector [Array<Float>] Optional query vector for which to get related chunks and embeddings. It must have been generated by the same model used to generate the embeddings across which the search is being conducted. Cannot provide both `query` and `query_vector`.
     # @param file_ids [Array<Integer>] Optional list of file IDs to limit the search to
     # @param parent_file_ids [Array<Integer>] Optional list of parent file IDs to limit the search to. A parent file describes a file to which another file belongs (e.g. a folder)
+    # @param include_all_children [Boolean] Flag to control whether or not to include all children of filtered files in the embedding search.
     # @param tags_v2 [Object] A set of tags to limit the search to. Use this instead of `tags`, which is deprecated.
     # @param include_tags [Boolean] Flag to control whether or not to include tags for each chunk in the response.
     # @param include_vectors [Boolean] Flag to control whether or not to include embedding vectors in the response.
@@ -263,7 +266,7 @@ module Carbon
     # @param embedding_model [EmbeddingGeneratorsNullable] 
     # @param body [GetEmbeddingDocumentsBody] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
-    def get_documents_with_http_info(query:, k:, tags: SENTINEL, query_vector: SENTINEL, file_ids: SENTINEL, parent_file_ids: SENTINEL, tags_v2: SENTINEL, include_tags: SENTINEL, include_vectors: SENTINEL, include_raw_file: SENTINEL, hybrid_search: SENTINEL, hybrid_search_tuning_parameters: SENTINEL, media_type: 'TEXT', embedding_model: 'OPENAI', extra: {})
+    def get_documents_with_http_info(query:, k:, tags: SENTINEL, query_vector: SENTINEL, file_ids: SENTINEL, parent_file_ids: SENTINEL, include_all_children: false, tags_v2: SENTINEL, include_tags: SENTINEL, include_vectors: SENTINEL, include_raw_file: SENTINEL, hybrid_search: SENTINEL, hybrid_search_tuning_parameters: SENTINEL, media_type: 'TEXT', embedding_model: 'OPENAI', extra: {})
       _body = {}
       _body[:tags] = tags if tags != SENTINEL
       _body[:query] = query if query != SENTINEL
@@ -271,6 +274,7 @@ module Carbon
       _body[:k] = k if k != SENTINEL
       _body[:file_ids] = file_ids if file_ids != SENTINEL
       _body[:parent_file_ids] = parent_file_ids if parent_file_ids != SENTINEL
+      _body[:include_all_children] = include_all_children if include_all_children != SENTINEL
       _body[:tags_v2] = tags_v2 if tags_v2 != SENTINEL
       _body[:include_tags] = include_tags if include_tags != SENTINEL
       _body[:include_vectors] = include_vectors if include_vectors != SENTINEL

data/lib/carbon_ruby_sdk/api/integrations_api.rb

@@ -545,7 +545,7 @@ module Carbon
     # @param request_id [String] This request id will be added to all files that get synced using the generated OAuth URL
     # @param use_ocr [Boolean] Enable OCR for files that support it. Supported formats: pdf
     # @param parse_pdf_tables_with_ocr [Boolean] 
-    # @param enable_file_picker [Boolean] Enable integration's file picker for sources that support it. Supported sources: DROPBOX, BOX, GOOGLE_DRIVE, SHAREPOINT, ONEDRIVE
+    # @param enable_file_picker [Boolean] Enable integration's file picker for sources that support it. Supported sources: GOOGLE_DRIVE, ONEDRIVE, BOX, SHAREPOINT, DROPBOX
     # @param body [OAuthURLRequest] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def get_oauth_url(service:, tags: SENTINEL, scope: SENTINEL, chunk_size: 1500, chunk_overlap: 20, skip_embedding_generation: false, embedding_model: 'OPENAI', zendesk_subdomain: SENTINEL, microsoft_tenant: SENTINEL, sharepoint_site_name: SENTINEL, confluence_subdomain: SENTINEL, generate_sparse_vectors: false, prepend_filename_to_chunks: false, max_items_per_chunk: SENTINEL, salesforce_domain: SENTINEL, sync_files_on_connection: true, set_page_as_boundary: false, data_source_id: SENTINEL, connecting_new_account: false, request_id: SENTINEL, use_ocr: false, parse_pdf_tables_with_ocr: false, enable_file_picker: true, extra: {})
@@ -607,7 +607,7 @@ module Carbon
     # @param request_id [String] This request id will be added to all files that get synced using the generated OAuth URL
     # @param use_ocr [Boolean] Enable OCR for files that support it. Supported formats: pdf
     # @param parse_pdf_tables_with_ocr [Boolean] 
-    # @param enable_file_picker [Boolean] Enable integration's file picker for sources that support it. Supported sources: DROPBOX, BOX, GOOGLE_DRIVE, SHAREPOINT, ONEDRIVE
+    # @param enable_file_picker [Boolean] Enable integration's file picker for sources that support it. Supported sources: GOOGLE_DRIVE, ONEDRIVE, BOX, SHAREPOINT, DROPBOX
     # @param body [OAuthURLRequest] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def get_oauth_url_with_http_info(service:, tags: SENTINEL, scope: SENTINEL, chunk_size: 1500, chunk_overlap: 20, skip_embedding_generation: false, embedding_model: 'OPENAI', zendesk_subdomain: SENTINEL, microsoft_tenant: SENTINEL, sharepoint_site_name: SENTINEL, confluence_subdomain: SENTINEL, generate_sparse_vectors: false, prepend_filename_to_chunks: false, max_items_per_chunk: SENTINEL, salesforce_domain: SENTINEL, sync_files_on_connection: true, set_page_as_boundary: false, data_source_id: SENTINEL, connecting_new_account: false, request_id: SENTINEL, use_ocr: false, parse_pdf_tables_with_ocr: false, enable_file_picker: true, extra: {})

data/lib/carbon_ruby_sdk/models/get_embedding_documents_body.rb

@@ -29,6 +29,9 @@ module Carbon
     # Optional list of parent file IDs to limit the search to. A parent file describes a file to which         another file belongs (e.g. a folder)
     attr_accessor :parent_file_ids
 
+    # Flag to control whether or not to include all children of filtered files in the embedding search.
+    attr_accessor :include_all_children
+
     # A set of tags to limit the search to. Use this instead of `tags`, which is deprecated.
     attr_accessor :tags_v2
 
@@ -60,6 +63,7 @@ module Carbon
         :'k' => :'k',
         :'file_ids' => :'file_ids',
         :'parent_file_ids' => :'parent_file_ids',
+        :'include_all_children' => :'include_all_children',
         :'tags_v2' => :'tags_v2',
         :'include_tags' => :'include_tags',
         :'include_vectors' => :'include_vectors',
@@ -85,6 +89,7 @@ module Carbon
         :'k' => :'Integer',
         :'file_ids' => :'Array<Integer>',
         :'parent_file_ids' => :'Array<Integer>',
+        :'include_all_children' => :'Boolean',
         :'tags_v2' => :'Object',
         :'include_tags' => :'Boolean',
         :'include_vectors' => :'Boolean',
@@ -161,6 +166,12 @@ module Carbon
         end
       end
 
+      if attributes.key?(:'include_all_children')
+        self.include_all_children = attributes[:'include_all_children']
+      else
+        self.include_all_children = false
+      end
+
       if attributes.key?(:'tags_v2')
         self.tags_v2 = attributes[:'tags_v2']
       end
@@ -270,6 +281,7 @@ module Carbon
           k == o.k &&
           file_ids == o.file_ids &&
           parent_file_ids == o.parent_file_ids &&
+          include_all_children == o.include_all_children &&
           tags_v2 == o.tags_v2 &&
           include_tags == o.include_tags &&
           include_vectors == o.include_vectors &&
@@ -289,7 +301,7 @@ module Carbon
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [tags, query, query_vector, k, file_ids, parent_file_ids, tags_v2, include_tags, include_vectors, include_raw_file, hybrid_search, hybrid_search_tuning_parameters, media_type, embedding_model].hash
+      [tags, query, query_vector, k, file_ids, parent_file_ids, include_all_children, tags_v2, include_tags, include_vectors, include_raw_file, hybrid_search, hybrid_search_tuning_parameters, media_type, embedding_model].hash
     end
 
     # Builds the object from hash

data/lib/carbon_ruby_sdk/models/o_auth_url_request.rb

@@ -61,7 +61,7 @@ module Carbon
 
     attr_accessor :parse_pdf_tables_with_ocr
 
-    # Enable integration's file picker for sources that support it. Supported sources: DROPBOX, BOX, GOOGLE_DRIVE, SHAREPOINT, ONEDRIVE
+    # Enable integration's file picker for sources that support it. Supported sources: GOOGLE_DRIVE, ONEDRIVE, BOX, SHAREPOINT, DROPBOX
     attr_accessor :enable_file_picker
 
     # 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.17'
+  VERSION = '0.1.18'
 end

data/spec/models/get_embedding_documents_body_spec.rb

@@ -55,6 +55,12 @@ describe Carbon::GetEmbeddingDocumentsBody do
     end
   end
 
+  describe 'test attribute "include_all_children"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   describe 'test attribute "tags_v2"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: carbon_ruby_sdk
 version: !ruby/object:Gem::Version
-  version: 0.1.17
+  version: 0.1.18
 platform: ruby
 authors:
 - Konfig
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-12 00:00:00.000000000 Z
+date: 2024-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -372,7 +372,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Carbon Ruby Gem