carbon_ruby_sdk 0.2.19 → 0.2.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95f581b191a1ac4df7f158fa8ab692fe1056150fc2de70657f5dfd3562f1b77b
-  data.tar.gz: 652b517db6dbe9e474f2a2e76b77205fbd67176daea3afa3b28ec32186727c88
+  metadata.gz: 9fa0e098dce1b18a1c27c9543458607ab26711fa0601b770f20c9577dff455ce
+  data.tar.gz: 4eb9b53e86e7c71b0876322b68eca33cb75d7b82fcbd49f1a720e6ff31eac399
 SHA512:
-  metadata.gz: 8de8c90a61acc9f1a4d85341ae9e2dcae84ba5879a675e96e39ef2f3da4cb5b4e8d4b7f04ab172f2dc38a8a460ecd22da17f4de14befafa7a6621c50dd56350e
-  data.tar.gz: de9de5613a5f71f9a4fd2c0145be4332cf038ede8acb0c997ffb3b9fe38ee360edd5407db509e11afd07d261824f8507dc1f4ea392010e62a7a30810e2158a94
+  metadata.gz: a84bd1ec35d79783e5e0e142363ad872b6afaa3a2d495f93c40ec0bceec3ed3044c7c19043500856673ad87bd847353e4360ca61962f45ebff3909f7d7da7456
+  data.tar.gz: 63d99d8282239f0225ded43449c8bf69a6921aa38bd4d4ffff3f22dbb62b4f925a7060ef570445507888a2a96533bf0930e3d056c15a0a5b0bf31fe9e888ec32

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    carbon_ruby_sdk (0.2.19)
+    carbon_ruby_sdk (0.2.21)
       faraday (>= 1.0.1, < 3.0)
       faraday-multipart (~> 1.0, >= 1.0.4)
 
@@ -28,8 +28,8 @@ GEM
       reline (>= 0.3.0)
     method_source (1.1.0)
     multipart-post (2.4.1)
-    parallel (1.25.1)
-    parser (3.3.4.0)
+    parallel (1.26.2)
+    parser (3.3.4.2)
       ast (~> 2.4.1)
       racc
     pry (0.14.2)
@@ -44,7 +44,7 @@ GEM
     regexp_parser (2.9.2)
     reline (0.5.9)
       io-console (~> 0.5)
-    rexml (3.3.4)
+    rexml (3.3.5)
       strscan
     rspec (3.13.0)
       rspec-core (~> 3.13.0)

data/README.md

@@ -6,7 +6,7 @@
 
 Connect external data to LLMs, no matter the source.
 
-[![npm](https://img.shields.io/badge/gem-v0.2.19-blue)](https://rubygems.org/gems/carbon_ruby_sdk/versions/0.2.19)
+[![npm](https://img.shields.io/badge/gem-v0.2.21-blue)](https://rubygems.org/gems/carbon_ruby_sdk/versions/0.2.21)
 
 </div>
 
@@ -33,6 +33,8 @@ Connect external data to LLMs, no matter the source.
   * [`carbon.files.delete_v2`](#carbonfilesdelete_v2)
   * [`carbon.files.get_parsed_file`](#carbonfilesget_parsed_file)
   * [`carbon.files.get_raw_file`](#carbonfilesget_raw_file)
+  * [`carbon.files.modify_cold_storage_parameters`](#carbonfilesmodify_cold_storage_parameters)
+  * [`carbon.files.move_to_hot_storage`](#carbonfilesmove_to_hot_storage)
   * [`carbon.files.query_user_files`](#carbonfilesquery_user_files)
   * [`carbon.files.query_user_files_deprecated`](#carbonfilesquery_user_files_deprecated)
   * [`carbon.files.resync`](#carbonfilesresync)
@@ -91,7 +93,7 @@ Connect external data to LLMs, no matter the source.
 Add to Gemfile:
 
 ```ruby
-gem 'carbon_ruby_sdk', '~> 0.2.19'
+gem 'carbon_ruby_sdk', '~> 0.2.21'
 ```
 
 ## Getting Started<a id="getting-started"></a>
@@ -388,6 +390,7 @@ result = carbon.embeddings.get_documents(
   file_types_at_source: [
         "string_example"
     ],
+  exclude_cold_storage_files: false,
 )
 p result
 ```
@@ -456,6 +459,11 @@ results, but may take longer to complete.
 Filter files based on their type at the source (for example help center tickets
 and articles)
 
+##### exclude_cold_storage_files: `Boolean`<a id="exclude_cold_storage_files-boolean"></a>
+Flag to control whether or not to exclude files that are not in hot storage. If
+set to False, then an error will be returned if any filtered files are in cold
+storage.
+
 #### 🔄 Return<a id="🔄-return"></a>
 
 [DocumentResponseList](./lib/carbon_ruby_sdk/models/document_response_list.rb)
@@ -855,6 +863,66 @@ p result
 ---
 
 
+### `carbon.files.modify_cold_storage_parameters`<a id="carbonfilesmodify_cold_storage_parameters"></a>
+
+Modify Cold Storage Parameters
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```ruby
+result = carbon.files.modify_cold_storage_parameters(
+  filters: {
+        "include_all_children" => false,
+        "non_synced_only" => false,
+    },
+  enable_cold_storage: true,
+  hot_storage_time_to_live: 1,
+)
+p result
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### filters: [`OrganizationUserFilesToSyncFilters`](./lib/carbon_ruby_sdk/models/organization_user_files_to_sync_filters.rb)<a id="filters-organizationuserfilestosyncfilterslibcarbon_ruby_sdkmodelsorganization_user_files_to_sync_filtersrb"></a>
+##### enable_cold_storage: `Boolean`<a id="enable_cold_storage-boolean"></a>
+##### hot_storage_time_to_live: `Integer`<a id="hot_storage_time_to_live-integer"></a>
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/modify_cold_storage_parameters` `POST`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+
+### `carbon.files.move_to_hot_storage`<a id="carbonfilesmove_to_hot_storage"></a>
+
+Move To Hot Storage
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```ruby
+result = carbon.files.move_to_hot_storage(
+  filters: {
+        "include_all_children" => false,
+        "non_synced_only" => false,
+    },
+)
+p result
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### filters: [`OrganizationUserFilesToSyncFilters`](./lib/carbon_ruby_sdk/models/organization_user_files_to_sync_filters.rb)<a id="filters-organizationuserfilestosyncfilterslibcarbon_ruby_sdkmodelsorganization_user_files_to_sync_filtersrb"></a>
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/move_to_hot_storage` `POST`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+
 ### `carbon.files.query_user_files`<a id="carbonfilesquery_user_files"></a>
 
 For pre-filtering documents, using `tags_v2` is preferred to using `tags` (which is now deprecated). If both `tags_v2`
@@ -1079,8 +1147,11 @@ result = carbon.files.upload(
   parse_pdf_tables_with_ocr: false,
   detect_audio_language: false,
   transcription_service: "assemblyai",
+  include_speaker_labels: false,
   media_type: "TEXT",
   split_rows: false,
+  enable_cold_storage: false,
+  hot_storage_time_to_live: 1,
 )
 p result
 ```
@@ -1130,6 +1201,10 @@ Whether to automatically detect the language of the uploaded audio file.
 The transcription service to use for audio files. If no service is specified,
 'deepgram' will be used.
 
+##### include_speaker_labels: `Boolean`<a id="include_speaker_labels-boolean"></a>
+Detect multiple speakers and label segments of speech by speaker for audio
+files.
+
 ##### media_type: [`FileContentTypesNullable`](./lib/carbon_ruby_sdk/models/file_content_types_nullable.rb)<a id="media_type-filecontenttypesnullablelibcarbon_ruby_sdkmodelsfile_content_types_nullablerb"></a>
 The media type of the file. If not provided, it will be inferred from the file
 extension.
@@ -1138,6 +1213,13 @@ extension.
 Whether to split tabular rows into chunks. Currently only valid for CSV, TSV,
 and XLSX files.
 
+##### enable_cold_storage: `Boolean`<a id="enable_cold_storage-boolean"></a>
+Enable cold storage for the file. If set to true, the file will be moved to cold
+storage after a certain period of inactivity. Default is false.
+
+##### hot_storage_time_to_live: `Integer`<a id="hot_storage_time_to_live-integer"></a>
+Time in seconds after which the file will be moved to cold storage.
+
 #### 🔄 Return<a id="🔄-return"></a>
 
 [UserFile](./lib/carbon_ruby_sdk/models/user_file.rb)
@@ -1173,8 +1255,12 @@ result = carbon.files.upload_from_url(
   parse_pdf_tables_with_ocr: false,
   detect_audio_language: false,
   transcription_service: "assemblyai",
+  include_speaker_labels: false,
   media_type: "TEXT",
   split_rows: false,
+  cold_storage_params: {
+        "enable_cold_storage" => false,
+    },
 )
 p result
 ```
@@ -1197,8 +1283,10 @@ Number of objects per chunk. For csv, tsv, xlsx, and json files only.
 ##### parse_pdf_tables_with_ocr: `Boolean`<a id="parse_pdf_tables_with_ocr-boolean"></a>
 ##### detect_audio_language: `Boolean`<a id="detect_audio_language-boolean"></a>
 ##### transcription_service: [`TranscriptionServiceNullable`](./lib/carbon_ruby_sdk/models/transcription_service_nullable.rb)<a id="transcription_service-transcriptionservicenullablelibcarbon_ruby_sdkmodelstranscription_service_nullablerb"></a>
+##### include_speaker_labels: `Boolean`<a id="include_speaker_labels-boolean"></a>
 ##### media_type: [`FileContentTypesNullable`](./lib/carbon_ruby_sdk/models/file_content_types_nullable.rb)<a id="media_type-filecontenttypesnullablelibcarbon_ruby_sdkmodelsfile_content_types_nullablerb"></a>
 ##### split_rows: `Boolean`<a id="split_rows-boolean"></a>
+##### cold_storage_params: [`ColdStorageProps`](./lib/carbon_ruby_sdk/models/cold_storage_props.rb)<a id="cold_storage_params-coldstoragepropslibcarbon_ruby_sdkmodelscold_storage_propsrb"></a>
 #### 🔄 Return<a id="🔄-return"></a>
 
 [UserFile](./lib/carbon_ruby_sdk/models/user_file.rb)
@@ -1237,6 +1325,9 @@ result = carbon.files.upload_text(
   overwrite_file_id: 1,
   embedding_model: "OPENAI",
   generate_sparse_vectors: false,
+  cold_storage_params: {
+        "enable_cold_storage" => false,
+    },
 )
 p result
 ```
@@ -1251,6 +1342,7 @@ p result
 ##### overwrite_file_id: `Integer`<a id="overwrite_file_id-integer"></a>
 ##### embedding_model: [`EmbeddingGeneratorsNullable`](./lib/carbon_ruby_sdk/models/embedding_generators_nullable.rb)<a id="embedding_model-embeddinggeneratorsnullablelibcarbon_ruby_sdkmodelsembedding_generators_nullablerb"></a>
 ##### generate_sparse_vectors: `Boolean`<a id="generate_sparse_vectors-boolean"></a>
+##### cold_storage_params: [`ColdStorageProps`](./lib/carbon_ruby_sdk/models/cold_storage_props.rb)<a id="cold_storage_params-coldstoragepropslibcarbon_ruby_sdkmodelscold_storage_propsrb"></a>
 #### 🔄 Return<a id="🔄-return"></a>
 
 [UserFile](./lib/carbon_ruby_sdk/models/user_file.rb)
@@ -1368,6 +1460,7 @@ result = carbon.integrations.connect_freshdesk(
         "sync_attachments" => false,
         "detect_audio_language" => false,
         "transcription_service" => "assemblyai",
+        "include_speaker_labels" => false,
         "split_rows" => false,
     },
 )
@@ -1554,8 +1647,10 @@ result = carbon.integrations.get_oauth_url(
         "sync_attachments" => false,
         "detect_audio_language" => false,
         "transcription_service" => "assemblyai",
+        "include_speaker_labels" => false,
         "split_rows" => false,
     },
+  automatically_open_file_picker: true,
 )
 p result
 ```
@@ -1614,10 +1709,15 @@ via list items endpoint
 ##### incremental_sync: `Boolean`<a id="incremental_sync-boolean"></a>
 Only sync files if they have not already been synced or if the embedding
 properties have changed. This flag is currently supported by ONEDRIVE,
-GOOGLE_DRIVE, BOX, DROPBOX, INTERCOM, GMAIL, OUTLOOK. It will be ignored for
-other data sources.
+GOOGLE_DRIVE, BOX, DROPBOX, INTERCOM, GMAIL, OUTLOOK, ZENDESK, CONFLUENCE,
+NOTION, SHAREPOINT. It will be ignored for other data sources.
 
 ##### file_sync_config: [`FileSyncConfigNullable`](./lib/carbon_ruby_sdk/models/file_sync_config_nullable.rb)<a id="file_sync_config-filesyncconfignullablelibcarbon_ruby_sdkmodelsfile_sync_config_nullablerb"></a>
+##### automatically_open_file_picker: `Boolean`<a id="automatically_open_file_picker-boolean"></a>
+Automatically open source file picker after the OAuth flow is complete. This
+flag is currently supported by BOX, DROPBOX, GOOGLE_DRIVE, ONEDRIVE, SHAREPOINT.
+It will be ignored for other data sources.
+
 #### 🔄 Return<a id="🔄-return"></a>
 
 [OuthURLResponse](./lib/carbon_ruby_sdk/models/outh_url_response.rb)
@@ -1920,6 +2020,7 @@ result = carbon.integrations.sync_confluence(
         "sync_attachments" => false,
         "detect_audio_language" => false,
         "transcription_service" => "assemblyai",
+        "include_speaker_labels" => false,
         "split_rows" => false,
     },
 )
@@ -1947,8 +2048,8 @@ Number of objects per chunk. For csv, tsv, xlsx, and json files only.
 ##### incremental_sync: `Boolean`<a id="incremental_sync-boolean"></a>
 Only sync files if they have not already been synced or if the embedding
 properties have changed. This flag is currently supported by ONEDRIVE,
-GOOGLE_DRIVE, BOX, DROPBOX, INTERCOM, GMAIL, OUTLOOK. It will be ignored for
-other data sources.
+GOOGLE_DRIVE, BOX, DROPBOX, INTERCOM, GMAIL, OUTLOOK, ZENDESK, CONFLUENCE,
+NOTION, SHAREPOINT. It will be ignored for other data sources.
 
 ##### file_sync_config: [`FileSyncConfigNullable`](./lib/carbon_ruby_sdk/models/file_sync_config_nullable.rb)<a id="file_sync_config-filesyncconfignullablelibcarbon_ruby_sdkmodelsfile_sync_config_nullablerb"></a>
 #### 🔄 Return<a id="🔄-return"></a>
@@ -2026,6 +2127,7 @@ result = carbon.integrations.sync_files(
         "sync_attachments" => false,
         "detect_audio_language" => false,
         "transcription_service" => "assemblyai",
+        "include_speaker_labels" => false,
         "split_rows" => false,
     },
 )
@@ -2053,8 +2155,8 @@ Number of objects per chunk. For csv, tsv, xlsx, and json files only.
 ##### incremental_sync: `Boolean`<a id="incremental_sync-boolean"></a>
 Only sync files if they have not already been synced or if the embedding
 properties have changed. This flag is currently supported by ONEDRIVE,
-GOOGLE_DRIVE, BOX, DROPBOX, INTERCOM, GMAIL, OUTLOOK. It will be ignored for
-other data sources.
+GOOGLE_DRIVE, BOX, DROPBOX, INTERCOM, GMAIL, OUTLOOK, ZENDESK, CONFLUENCE,
+NOTION, SHAREPOINT. It will be ignored for other data sources.
 
 ##### file_sync_config: [`FileSyncConfigNullable`](./lib/carbon_ruby_sdk/models/file_sync_config_nullable.rb)<a id="file_sync_config-filesyncconfignullablelibcarbon_ruby_sdkmodelsfile_sync_config_nullablerb"></a>
 #### 🔄 Return<a id="🔄-return"></a>
@@ -2229,6 +2331,7 @@ result = carbon.integrations.sync_gmail(
         "sync_attachments" => false,
         "detect_audio_language" => false,
         "transcription_service" => "assemblyai",
+        "include_speaker_labels" => false,
         "split_rows" => false,
     },
   incremental_sync: false,
@@ -2349,6 +2452,7 @@ result = carbon.integrations.sync_outlook(
         "sync_attachments" => false,
         "detect_audio_language" => false,
         "transcription_service" => "assemblyai",
+        "include_speaker_labels" => false,
         "split_rows" => false,
     },
   incremental_sync: false,
@@ -2493,6 +2597,7 @@ result = carbon.integrations.sync_s3_files(
         "sync_attachments" => false,
         "detect_audio_language" => false,
         "transcription_service" => "assemblyai",
+        "include_speaker_labels" => false,
         "split_rows" => false,
     },
 )

data/lib/carbon_ruby_sdk/api/embeddings_api.rb

@@ -132,9 +132,10 @@ module Carbon
     # @param high_accuracy [Boolean] Flag to control whether or not to perform a high accuracy embedding search. By default, this is set to false. If true, the search may return more accurate results, but may take longer to complete.
     # @param rerank [RerankParamsNullable] 
     # @param file_types_at_source [Array<HelpdeskFileTypes>] Filter files based on their type at the source (for example help center tickets and articles)
+    # @param exclude_cold_storage_files [Boolean] Flag to control whether or not to exclude files that are not in hot storage. If set to False, then an error will be returned if any filtered files are in cold storage.
     # @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, 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: SENTINEL, embedding_model: 'OPENAI', include_file_level_metadata: false, high_accuracy: false, rerank: SENTINEL, file_types_at_source: SENTINEL, 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: SENTINEL, embedding_model: 'OPENAI', include_file_level_metadata: false, high_accuracy: false, rerank: SENTINEL, file_types_at_source: SENTINEL, exclude_cold_storage_files: false, extra: {})
       _body = {}
       _body[:tags] = tags if tags != SENTINEL
       _body[:query] = query if query != SENTINEL
@@ -155,6 +156,7 @@ module Carbon
       _body[:high_accuracy] = high_accuracy if high_accuracy != SENTINEL
       _body[:rerank] = rerank if rerank != SENTINEL
       _body[:file_types_at_source] = file_types_at_source if file_types_at_source != SENTINEL
+      _body[:exclude_cold_storage_files] = exclude_cold_storage_files if exclude_cold_storage_files != SENTINEL
       get_embedding_documents_body = _body
       api_response = get_documents_with_http_info_impl(get_embedding_documents_body, extra)
       api_response.data
@@ -276,9 +278,10 @@ module Carbon
     # @param high_accuracy [Boolean] Flag to control whether or not to perform a high accuracy embedding search. By default, this is set to false. If true, the search may return more accurate results, but may take longer to complete.
     # @param rerank [RerankParamsNullable] 
     # @param file_types_at_source [Array<HelpdeskFileTypes>] Filter files based on their type at the source (for example help center tickets and articles)
+    # @param exclude_cold_storage_files [Boolean] Flag to control whether or not to exclude files that are not in hot storage. If set to False, then an error will be returned if any filtered files are in cold storage.
     # @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, 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: SENTINEL, embedding_model: 'OPENAI', include_file_level_metadata: false, high_accuracy: false, rerank: SENTINEL, file_types_at_source: SENTINEL, 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: SENTINEL, embedding_model: 'OPENAI', include_file_level_metadata: false, high_accuracy: false, rerank: SENTINEL, file_types_at_source: SENTINEL, exclude_cold_storage_files: false, extra: {})
       _body = {}
       _body[:tags] = tags if tags != SENTINEL
       _body[:query] = query if query != SENTINEL
@@ -299,6 +302,7 @@ module Carbon
       _body[:high_accuracy] = high_accuracy if high_accuracy != SENTINEL
       _body[:rerank] = rerank if rerank != SENTINEL
       _body[:file_types_at_source] = file_types_at_source if file_types_at_source != SENTINEL
+      _body[:exclude_cold_storage_files] = exclude_cold_storage_files if exclude_cold_storage_files != SENTINEL
       get_embedding_documents_body = _body
       get_documents_with_http_info_impl(get_embedding_documents_body, extra)
     end