carbon_ruby_sdk 0.2.9 → 0.2.10

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: fda5b1ec1c730f2f9a580a276304ac423b05d02cd9ed4f14696d0c49bd67b0c0
4
- data.tar.gz: ab62de83823f3bea5defd1d30500f92e36241a679d3df90a0fcfc73f67143981
3
+ metadata.gz: 0452b3148ad8c62797e52048a749496808ff574b6eba205e50e10eb514e373e8
4
+ data.tar.gz: 0d0c67926c3a58fd000729a39961f7ec09590b9150993de85ea7795125ada5ab
5
5
  SHA512:
6
- metadata.gz: c3c676f58227aee9663ac184703f8da022ad568055233a99db2c700e00d687b82f7392ed2957f98b36cb3b2c9896c7ccb48641e4f8ca9131c0df34c1c65c7d79
7
- data.tar.gz: 7463c9e146c1350f304bb2610756c1d78ee9790a942edb6566c1df62ab8bd929e383532c362c0bdf64a3a3f54b4e278ba085ba914f3e866b6ba3ee34358ec9db
6
+ metadata.gz: ff2a8b2277d6274d6832544fc74f43554a3a006da0f09fd8b08f039bafc835a5948a27237c7a452f2b27f21353a4599e5cff7c343c4322615ff40d99bc96beb1
7
+ data.tar.gz: 65c402649df16ef2af3f1e4dedac7128d04d35af85e4c02c03315263f2138d7003a934bf6cb8cf758e171ccb8ee5c6db08e93b75d03e2524e9eec642464b7905
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.2.9-blue)](https://rubygems.org/gems/carbon_ruby_sdk/versions/0.2.9)
9
+ [![npm](https://img.shields.io/badge/gem-v0.2.10-blue)](https://rubygems.org/gems/carbon_ruby_sdk/versions/0.2.10)
10
10
 
11
11
  </div>
12
12
 
@@ -69,6 +69,7 @@ Connect external data to LLMs, no matter the source.
69
69
  * [`carbon.organizations.update_stats`](#carbonorganizationsupdate_stats)
70
70
  * [`carbon.users.delete`](#carbonusersdelete)
71
71
  * [`carbon.users.get`](#carbonusersget)
72
+ * [`carbon.users.list`](#carbonuserslist)
72
73
  * [`carbon.users.toggle_user_features`](#carbonuserstoggle_user_features)
73
74
  * [`carbon.users.update_users`](#carbonusersupdate_users)
74
75
  * [`carbon.utilities.fetch_urls`](#carbonutilitiesfetch_urls)
@@ -90,7 +91,7 @@ Connect external data to LLMs, no matter the source.
90
91
  Add to Gemfile:
91
92
 
92
93
  ```ruby
93
- gem 'carbon_ruby_sdk', '~> 0.2.9'
94
+ gem 'carbon_ruby_sdk', '~> 0.2.10'
94
95
  ```
95
96
 
96
97
  ## Getting Started<a id="getting-started"></a>
@@ -379,6 +380,7 @@ result = carbon.embeddings.get_documents(
379
380
  },
380
381
  media_type: "TEXT",
381
382
  embedding_model: "OPENAI",
383
+ include_file_level_metadata: false,
382
384
  )
383
385
  p result
384
386
  ```
@@ -432,6 +434,11 @@ Flag to control whether or not to perform hybrid search.
432
434
  ##### hybrid_search_tuning_parameters: [`HybridSearchTuningParamsNullable`](./lib/carbon_ruby_sdk/models/hybrid_search_tuning_params_nullable.rb)<a id="hybrid_search_tuning_parameters-hybridsearchtuningparamsnullablelibcarbon_ruby_sdkmodelshybrid_search_tuning_params_nullablerb"></a>
433
435
  ##### media_type: [`FileContentTypesNullable`](./lib/carbon_ruby_sdk/models/file_content_types_nullable.rb)<a id="media_type-filecontenttypesnullablelibcarbon_ruby_sdkmodelsfile_content_types_nullablerb"></a>
434
436
  ##### embedding_model: [`EmbeddingGeneratorsNullable`](./lib/carbon_ruby_sdk/models/embedding_generators_nullable.rb)<a id="embedding_model-embeddinggeneratorsnullablelibcarbon_ruby_sdkmodelsembedding_generators_nullablerb"></a>
437
+ ##### include_file_level_metadata: `Boolean`<a id="include_file_level_metadata-boolean"></a>
438
+ Flag to control whether or not to include file-level metadata in the response.
439
+ This metadata will be included in the `content_metadata` field of each document
440
+ along with chunk/embedding level metadata.
441
+
435
442
  #### 🔄 Return<a id="🔄-return"></a>
436
443
 
437
444
  [DocumentResponseList](./lib/carbon_ruby_sdk/models/document_response_list.rb)
@@ -1274,7 +1281,7 @@ result = carbon.integrations.connect_data_source(
1274
1281
  "prepend_filename_to_chunks" => false,
1275
1282
  "sync_files_on_connection" => true,
1276
1283
  "set_page_as_boundary" => false,
1277
- "request_id" => "ae8cd936-69c9-42cd-affb-87f3bea6d8eb",
1284
+ "request_id" => "7b23cde6-ec28-417a-9bff-b10e9042394c",
1278
1285
  "enable_file_picker" => true,
1279
1286
  "sync_source_items" => true,
1280
1287
  "incremental_sync" => false,
@@ -1494,7 +1501,7 @@ result = carbon.integrations.get_oauth_url(
1494
1501
  set_page_as_boundary: false,
1495
1502
  data_source_id: 1,
1496
1503
  connecting_new_account: false,
1497
- request_id: "6c38b4bb-1536-46c9-ade7-72fabf05b3bb",
1504
+ request_id: "dbc54493-ce4f-4a1d-a78b-862f21f1e3d7",
1498
1505
  use_ocr: false,
1499
1506
  parse_pdf_tables_with_ocr: false,
1500
1507
  enable_file_picker: true,
@@ -1555,7 +1562,7 @@ Enable OCR for files that support it. Supported formats: pdf
1555
1562
  ##### parse_pdf_tables_with_ocr: `Boolean`<a id="parse_pdf_tables_with_ocr-boolean"></a>
1556
1563
  ##### enable_file_picker: `Boolean`<a id="enable_file_picker-boolean"></a>
1557
1564
  Enable integration's file picker for sources that support it. Supported sources:
1558
- ONEDRIVE, GOOGLE_DRIVE, DROPBOX, BOX, SHAREPOINT
1565
+ GOOGLE_DRIVE, SHAREPOINT, ONEDRIVE, BOX, DROPBOX
1559
1566
 
1560
1567
  ##### sync_source_items: `Boolean`<a id="sync_source_items-boolean"></a>
1561
1568
  Enabling this flag will fetch all available content from the source to be listed
@@ -1854,7 +1861,7 @@ result = carbon.integrations.sync_confluence(
1854
1861
  prepend_filename_to_chunks: false,
1855
1862
  max_items_per_chunk: 1,
1856
1863
  set_page_as_boundary: false,
1857
- request_id: "bcd3ae91-8bae-4d50-9046-94dc62b2078f",
1864
+ request_id: "6e21ecc1-8385-46ac-abea-01ca0b2b268d",
1858
1865
  use_ocr: false,
1859
1866
  parse_pdf_tables_with_ocr: false,
1860
1867
  incremental_sync: false,
@@ -1958,7 +1965,7 @@ result = carbon.integrations.sync_files(
1958
1965
  prepend_filename_to_chunks: false,
1959
1966
  max_items_per_chunk: 1,
1960
1967
  set_page_as_boundary: false,
1961
- request_id: "bcd3ae91-8bae-4d50-9046-94dc62b2078f",
1968
+ request_id: "6e21ecc1-8385-46ac-abea-01ca0b2b268d",
1962
1969
  use_ocr: false,
1963
1970
  parse_pdf_tables_with_ocr: false,
1964
1971
  incremental_sync: false,
@@ -2651,6 +2658,47 @@ p result
2651
2658
  ---
2652
2659
 
2653
2660
 
2661
+ ### `carbon.users.list`<a id="carbonuserslist"></a>
2662
+
2663
+ List users within an organization
2664
+
2665
+ #### 🛠️ Usage<a id="🛠️-usage"></a>
2666
+
2667
+ ```ruby
2668
+ result = carbon.users.list(
2669
+ pagination: {
2670
+ "limit" => 10,
2671
+ "offset" => 0,
2672
+ },
2673
+ filters: {
2674
+ },
2675
+ order_by: "created_at",
2676
+ order_dir: "asc",
2677
+ include_count: false,
2678
+ )
2679
+ p result
2680
+ ```
2681
+
2682
+ #### ⚙️ Parameters<a id="⚙️-parameters"></a>
2683
+
2684
+ ##### pagination: [`Pagination`](./lib/carbon_ruby_sdk/models/pagination.rb)<a id="pagination-paginationlibcarbon_ruby_sdkmodelspaginationrb"></a>
2685
+ ##### filters: [`ListUsersFilters`](./lib/carbon_ruby_sdk/models/list_users_filters.rb)<a id="filters-listusersfilterslibcarbon_ruby_sdkmodelslist_users_filtersrb"></a>
2686
+ ##### order_by: [`ListUsersOrderByTypes`](./lib/carbon_ruby_sdk/models/list_users_order_by_types.rb)<a id="order_by-listusersorderbytypeslibcarbon_ruby_sdkmodelslist_users_order_by_typesrb"></a>
2687
+ ##### order_dir: [`OrderDirV2`](./lib/carbon_ruby_sdk/models/order_dir_v2.rb)<a id="order_dir-orderdirv2libcarbon_ruby_sdkmodelsorder_dir_v2rb"></a>
2688
+ ##### include_count: `Boolean`<a id="include_count-boolean"></a>
2689
+ #### 🔄 Return<a id="🔄-return"></a>
2690
+
2691
+ [UserListResponse](./lib/carbon_ruby_sdk/models/user_list_response.rb)
2692
+
2693
+ #### 🌐 Endpoint<a id="🌐-endpoint"></a>
2694
+
2695
+ `/list_users` `POST`
2696
+
2697
+ [🔙 **Back to Table of Contents**](#table-of-contents)
2698
+
2699
+ ---
2700
+
2701
+
2654
2702
  ### `carbon.users.toggle_user_features`<a id="carbonuserstoggle_user_features"></a>
2655
2703
  ![Deprecated](https://img.shields.io/badge/deprecated-yellow)
2656
2704
 
@@ -128,9 +128,10 @@ module Carbon
128
128
  # @param hybrid_search_tuning_parameters [HybridSearchTuningParamsNullable]
129
129
  # @param media_type [FileContentTypesNullable]
130
130
  # @param embedding_model [EmbeddingGeneratorsNullable]
131
+ # @param include_file_level_metadata [Boolean] Flag to control whether or not to include file-level metadata in the response. This metadata will be included in the `content_metadata` field of each document along with chunk/embedding level metadata.
131
132
  # @param body [GetEmbeddingDocumentsBody]
132
133
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
133
- 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', extra: {})
134
+ 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, extra: {})
134
135
  _body = {}
135
136
  _body[:tags] = tags if tags != SENTINEL
136
137
  _body[:query] = query if query != SENTINEL
@@ -147,6 +148,7 @@ module Carbon
147
148
  _body[:hybrid_search_tuning_parameters] = hybrid_search_tuning_parameters if hybrid_search_tuning_parameters != SENTINEL
148
149
  _body[:media_type] = media_type if media_type != SENTINEL
149
150
  _body[:embedding_model] = embedding_model if embedding_model != SENTINEL
151
+ _body[:include_file_level_metadata] = include_file_level_metadata if include_file_level_metadata != SENTINEL
150
152
  get_embedding_documents_body = _body
151
153
  api_response = get_documents_with_http_info_impl(get_embedding_documents_body, extra)
152
154
  api_response.data
@@ -264,9 +266,10 @@ module Carbon
264
266
  # @param hybrid_search_tuning_parameters [HybridSearchTuningParamsNullable]
265
267
  # @param media_type [FileContentTypesNullable]
266
268
  # @param embedding_model [EmbeddingGeneratorsNullable]
269
+ # @param include_file_level_metadata [Boolean] Flag to control whether or not to include file-level metadata in the response. This metadata will be included in the `content_metadata` field of each document along with chunk/embedding level metadata.
267
270
  # @param body [GetEmbeddingDocumentsBody]
268
271
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
269
- 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', extra: {})
272
+ 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, extra: {})
270
273
  _body = {}
271
274
  _body[:tags] = tags if tags != SENTINEL
272
275
  _body[:query] = query if query != SENTINEL
@@ -283,6 +286,7 @@ module Carbon
283
286
  _body[:hybrid_search_tuning_parameters] = hybrid_search_tuning_parameters if hybrid_search_tuning_parameters != SENTINEL
284
287
  _body[:media_type] = media_type if media_type != SENTINEL
285
288
  _body[:embedding_model] = embedding_model if embedding_model != SENTINEL
289
+ _body[:include_file_level_metadata] = include_file_level_metadata if include_file_level_metadata != SENTINEL
286
290
  get_embedding_documents_body = _body
287
291
  get_documents_with_http_info_impl(get_embedding_documents_body, extra)
288
292
  end
@@ -653,13 +653,13 @@ module Carbon
653
653
  # @param request_id [String] This request id will be added to all files that get synced using the generated OAuth URL
654
654
  # @param use_ocr [Boolean] Enable OCR for files that support it. Supported formats: pdf
655
655
  # @param parse_pdf_tables_with_ocr [Boolean]
656
- # @param enable_file_picker [Boolean] Enable integration's file picker for sources that support it. Supported sources: ONEDRIVE, GOOGLE_DRIVE, DROPBOX, BOX, SHAREPOINT
656
+ # @param enable_file_picker [Boolean] Enable integration's file picker for sources that support it. Supported sources: GOOGLE_DRIVE, SHAREPOINT, ONEDRIVE, BOX, DROPBOX
657
657
  # @param sync_source_items [Boolean] Enabling this flag will fetch all available content from the source to be listed via list items endpoint
658
658
  # @param incremental_sync [Boolean] 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. It will be ignored for other data sources.
659
659
  # @param file_sync_config [FileSyncConfigNullable]
660
660
  # @param body [OAuthURLRequest]
661
661
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
662
- 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: '6c38b4bb-1536-46c9-ade7-72fabf05b3bb', use_ocr: false, parse_pdf_tables_with_ocr: false, enable_file_picker: true, sync_source_items: true, incremental_sync: false, file_sync_config: SENTINEL, extra: {})
662
+ 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: 'dbc54493-ce4f-4a1d-a78b-862f21f1e3d7', use_ocr: false, parse_pdf_tables_with_ocr: false, enable_file_picker: true, sync_source_items: true, incremental_sync: false, file_sync_config: SENTINEL, extra: {})
663
663
  _body = {}
664
664
  _body[:tags] = tags if tags != SENTINEL
665
665
  _body[:scope] = scope if scope != SENTINEL
@@ -721,13 +721,13 @@ module Carbon
721
721
  # @param request_id [String] This request id will be added to all files that get synced using the generated OAuth URL
722
722
  # @param use_ocr [Boolean] Enable OCR for files that support it. Supported formats: pdf
723
723
  # @param parse_pdf_tables_with_ocr [Boolean]
724
- # @param enable_file_picker [Boolean] Enable integration's file picker for sources that support it. Supported sources: ONEDRIVE, GOOGLE_DRIVE, DROPBOX, BOX, SHAREPOINT
724
+ # @param enable_file_picker [Boolean] Enable integration's file picker for sources that support it. Supported sources: GOOGLE_DRIVE, SHAREPOINT, ONEDRIVE, BOX, DROPBOX
725
725
  # @param sync_source_items [Boolean] Enabling this flag will fetch all available content from the source to be listed via list items endpoint
726
726
  # @param incremental_sync [Boolean] 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. It will be ignored for other data sources.
727
727
  # @param file_sync_config [FileSyncConfigNullable]
728
728
  # @param body [OAuthURLRequest]
729
729
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
730
- 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: '6c38b4bb-1536-46c9-ade7-72fabf05b3bb', use_ocr: false, parse_pdf_tables_with_ocr: false, enable_file_picker: true, sync_source_items: true, incremental_sync: false, file_sync_config: SENTINEL, extra: {})
730
+ 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: 'dbc54493-ce4f-4a1d-a78b-862f21f1e3d7', use_ocr: false, parse_pdf_tables_with_ocr: false, enable_file_picker: true, sync_source_items: true, incremental_sync: false, file_sync_config: SENTINEL, extra: {})
731
731
  _body = {}
732
732
  _body[:tags] = tags if tags != SENTINEL
733
733
  _body[:scope] = scope if scope != SENTINEL
@@ -1640,7 +1640,7 @@ module Carbon
1640
1640
  # @param file_sync_config [FileSyncConfigNullable]
1641
1641
  # @param body [SyncFilesRequest]
1642
1642
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
1643
- def sync_confluence(data_source_id:, ids:, tags: SENTINEL, chunk_size: 1500, chunk_overlap: 20, skip_embedding_generation: false, embedding_model: 'OPENAI', generate_sparse_vectors: false, prepend_filename_to_chunks: false, max_items_per_chunk: SENTINEL, set_page_as_boundary: false, request_id: 'bcd3ae91-8bae-4d50-9046-94dc62b2078f', use_ocr: false, parse_pdf_tables_with_ocr: false, incremental_sync: false, file_sync_config: SENTINEL, extra: {})
1643
+ def sync_confluence(data_source_id:, ids:, tags: SENTINEL, chunk_size: 1500, chunk_overlap: 20, skip_embedding_generation: false, embedding_model: 'OPENAI', generate_sparse_vectors: false, prepend_filename_to_chunks: false, max_items_per_chunk: SENTINEL, set_page_as_boundary: false, request_id: '6e21ecc1-8385-46ac-abea-01ca0b2b268d', use_ocr: false, parse_pdf_tables_with_ocr: false, incremental_sync: false, file_sync_config: SENTINEL, extra: {})
1644
1644
  _body = {}
1645
1645
  _body[:tags] = tags if tags != SENTINEL
1646
1646
  _body[:data_source_id] = data_source_id if data_source_id != SENTINEL
@@ -1688,7 +1688,7 @@ module Carbon
1688
1688
  # @param file_sync_config [FileSyncConfigNullable]
1689
1689
  # @param body [SyncFilesRequest]
1690
1690
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
1691
- def sync_confluence_with_http_info(data_source_id:, ids:, tags: SENTINEL, chunk_size: 1500, chunk_overlap: 20, skip_embedding_generation: false, embedding_model: 'OPENAI', generate_sparse_vectors: false, prepend_filename_to_chunks: false, max_items_per_chunk: SENTINEL, set_page_as_boundary: false, request_id: 'bcd3ae91-8bae-4d50-9046-94dc62b2078f', use_ocr: false, parse_pdf_tables_with_ocr: false, incremental_sync: false, file_sync_config: SENTINEL, extra: {})
1691
+ def sync_confluence_with_http_info(data_source_id:, ids:, tags: SENTINEL, chunk_size: 1500, chunk_overlap: 20, skip_embedding_generation: false, embedding_model: 'OPENAI', generate_sparse_vectors: false, prepend_filename_to_chunks: false, max_items_per_chunk: SENTINEL, set_page_as_boundary: false, request_id: '6e21ecc1-8385-46ac-abea-01ca0b2b268d', use_ocr: false, parse_pdf_tables_with_ocr: false, incremental_sync: false, file_sync_config: SENTINEL, extra: {})
1692
1692
  _body = {}
1693
1693
  _body[:tags] = tags if tags != SENTINEL
1694
1694
  _body[:data_source_id] = data_source_id if data_source_id != SENTINEL
@@ -1896,7 +1896,7 @@ module Carbon
1896
1896
  # @param file_sync_config [FileSyncConfigNullable]
1897
1897
  # @param body [SyncFilesRequest]
1898
1898
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
1899
- def sync_files(data_source_id:, ids:, tags: SENTINEL, chunk_size: 1500, chunk_overlap: 20, skip_embedding_generation: false, embedding_model: 'OPENAI', generate_sparse_vectors: false, prepend_filename_to_chunks: false, max_items_per_chunk: SENTINEL, set_page_as_boundary: false, request_id: 'bcd3ae91-8bae-4d50-9046-94dc62b2078f', use_ocr: false, parse_pdf_tables_with_ocr: false, incremental_sync: false, file_sync_config: SENTINEL, extra: {})
1899
+ def sync_files(data_source_id:, ids:, tags: SENTINEL, chunk_size: 1500, chunk_overlap: 20, skip_embedding_generation: false, embedding_model: 'OPENAI', generate_sparse_vectors: false, prepend_filename_to_chunks: false, max_items_per_chunk: SENTINEL, set_page_as_boundary: false, request_id: '6e21ecc1-8385-46ac-abea-01ca0b2b268d', use_ocr: false, parse_pdf_tables_with_ocr: false, incremental_sync: false, file_sync_config: SENTINEL, extra: {})
1900
1900
  _body = {}
1901
1901
  _body[:tags] = tags if tags != SENTINEL
1902
1902
  _body[:data_source_id] = data_source_id if data_source_id != SENTINEL
@@ -1944,7 +1944,7 @@ module Carbon
1944
1944
  # @param file_sync_config [FileSyncConfigNullable]
1945
1945
  # @param body [SyncFilesRequest]
1946
1946
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
1947
- def sync_files_with_http_info(data_source_id:, ids:, tags: SENTINEL, chunk_size: 1500, chunk_overlap: 20, skip_embedding_generation: false, embedding_model: 'OPENAI', generate_sparse_vectors: false, prepend_filename_to_chunks: false, max_items_per_chunk: SENTINEL, set_page_as_boundary: false, request_id: 'bcd3ae91-8bae-4d50-9046-94dc62b2078f', use_ocr: false, parse_pdf_tables_with_ocr: false, incremental_sync: false, file_sync_config: SENTINEL, extra: {})
1947
+ def sync_files_with_http_info(data_source_id:, ids:, tags: SENTINEL, chunk_size: 1500, chunk_overlap: 20, skip_embedding_generation: false, embedding_model: 'OPENAI', generate_sparse_vectors: false, prepend_filename_to_chunks: false, max_items_per_chunk: SENTINEL, set_page_as_boundary: false, request_id: '6e21ecc1-8385-46ac-abea-01ca0b2b268d', use_ocr: false, parse_pdf_tables_with_ocr: false, incremental_sync: false, file_sync_config: SENTINEL, extra: {})
1948
1948
  _body = {}
1949
1949
  _body[:tags] = tags if tags != SENTINEL
1950
1950
  _body[:data_source_id] = data_source_id if data_source_id != SENTINEL
@@ -200,6 +200,120 @@ module Carbon
200
200
  end
201
201
 
202
202
 
203
+ # List Users Endpoint
204
+ #
205
+ # List users within an organization
206
+ #
207
+ # @param pagination [Pagination]
208
+ # @param filters [ListUsersFilters]
209
+ # @param order_by [ListUsersOrderByTypes]
210
+ # @param order_dir [OrderDirV2]
211
+ # @param include_count [Boolean]
212
+ # @param body [ListUsersRequest]
213
+ # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
214
+ def list(pagination: SENTINEL, filters: SENTINEL, order_by: 'created_at', order_dir: 'desc', include_count: false, extra: {})
215
+ _body = {}
216
+ _body[:pagination] = pagination if pagination != SENTINEL
217
+ _body[:filters] = filters if filters != SENTINEL
218
+ _body[:order_by] = order_by if order_by != SENTINEL
219
+ _body[:order_dir] = order_dir if order_dir != SENTINEL
220
+ _body[:include_count] = include_count if include_count != SENTINEL
221
+ list_users_request = _body
222
+ api_response = list_with_http_info_impl(list_users_request, extra)
223
+ api_response.data
224
+ end
225
+
226
+ # List Users Endpoint
227
+ #
228
+ # List users within an organization
229
+ #
230
+ # @param pagination [Pagination]
231
+ # @param filters [ListUsersFilters]
232
+ # @param order_by [ListUsersOrderByTypes]
233
+ # @param order_dir [OrderDirV2]
234
+ # @param include_count [Boolean]
235
+ # @param body [ListUsersRequest]
236
+ # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
237
+ def list_with_http_info(pagination: SENTINEL, filters: SENTINEL, order_by: 'created_at', order_dir: 'desc', include_count: false, extra: {})
238
+ _body = {}
239
+ _body[:pagination] = pagination if pagination != SENTINEL
240
+ _body[:filters] = filters if filters != SENTINEL
241
+ _body[:order_by] = order_by if order_by != SENTINEL
242
+ _body[:order_dir] = order_dir if order_dir != SENTINEL
243
+ _body[:include_count] = include_count if include_count != SENTINEL
244
+ list_users_request = _body
245
+ list_with_http_info_impl(list_users_request, extra)
246
+ end
247
+
248
+ # List Users Endpoint
249
+ # List users within an organization
250
+ # @param list_users_request [ListUsersRequest]
251
+ # @param [Hash] opts the optional parameters
252
+ # @return [UserListResponse]
253
+ private def list_impl(list_users_request, opts = {})
254
+ data, _status_code, _headers = list_with_http_info(list_users_request, opts)
255
+ data
256
+ end
257
+
258
+ # List Users Endpoint
259
+ # List users within an organization
260
+ # @param list_users_request [ListUsersRequest]
261
+ # @param [Hash] opts the optional parameters
262
+ # @return [APIResponse] data is UserListResponse, status code, headers and response
263
+ private def list_with_http_info_impl(list_users_request, opts = {})
264
+ if @api_client.config.debugging
265
+ @api_client.config.logger.debug 'Calling API: UsersApi.list ...'
266
+ end
267
+ # verify the required parameter 'list_users_request' is set
268
+ if @api_client.config.client_side_validation && list_users_request.nil?
269
+ fail ArgumentError, "Missing the required parameter 'list_users_request' when calling UsersApi.list"
270
+ end
271
+ # resource path
272
+ local_var_path = '/list_users'
273
+
274
+ # query parameters
275
+ query_params = opts[:query_params] || {}
276
+
277
+ # header parameters
278
+ header_params = opts[:header_params] || {}
279
+ # HTTP header 'Accept' (if needed)
280
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
281
+ # HTTP header 'Content-Type'
282
+ content_type = @api_client.select_header_content_type(['application/json'])
283
+ if !content_type.nil?
284
+ header_params['Content-Type'] = content_type
285
+ end
286
+
287
+ # form parameters
288
+ form_params = opts[:form_params] || {}
289
+
290
+ # http body (model)
291
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(list_users_request)
292
+
293
+ # return_type
294
+ return_type = opts[:debug_return_type] || 'UserListResponse'
295
+
296
+ # auth_names
297
+ auth_names = opts[:debug_auth_names] || ['apiKey']
298
+
299
+ new_options = opts.merge(
300
+ :operation => :"UsersApi.list",
301
+ :header_params => header_params,
302
+ :query_params => query_params,
303
+ :form_params => form_params,
304
+ :body => post_body,
305
+ :auth_names => auth_names,
306
+ :return_type => return_type
307
+ )
308
+
309
+ data, status_code, headers, response = @api_client.call_api(:POST, local_var_path, new_options)
310
+ if @api_client.config.debugging
311
+ @api_client.config.logger.debug "API called: UsersApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
312
+ end
313
+ APIResponse::new(data, status_code, headers, response)
314
+ end
315
+
316
+
203
317
  # Toggle User Features
204
318
  #
205
319
  # @param configuration_key_name [String]
@@ -53,6 +53,9 @@ module Carbon
53
53
 
54
54
  attr_accessor :embedding_model
55
55
 
56
+ # Flag to control whether or not to include file-level metadata in the response. This metadata will be included in the `content_metadata` field of each document along with chunk/embedding level metadata.
57
+ attr_accessor :include_file_level_metadata
58
+
56
59
  # Attribute mapping from ruby-style variable name to JSON key.
57
60
  def self.attribute_map
58
61
  {
@@ -70,7 +73,8 @@ module Carbon
70
73
  :'hybrid_search' => :'hybrid_search',
71
74
  :'hybrid_search_tuning_parameters' => :'hybrid_search_tuning_parameters',
72
75
  :'media_type' => :'media_type',
73
- :'embedding_model' => :'embedding_model'
76
+ :'embedding_model' => :'embedding_model',
77
+ :'include_file_level_metadata' => :'include_file_level_metadata'
74
78
  }
75
79
  end
76
80
 
@@ -96,7 +100,8 @@ module Carbon
96
100
  :'hybrid_search' => :'Boolean',
97
101
  :'hybrid_search_tuning_parameters' => :'HybridSearchTuningParamsNullable',
98
102
  :'media_type' => :'FileContentTypesNullable',
99
- :'embedding_model' => :'EmbeddingGeneratorsNullable'
103
+ :'embedding_model' => :'EmbeddingGeneratorsNullable',
104
+ :'include_file_level_metadata' => :'Boolean'
100
105
  }
101
106
  end
102
107
 
@@ -114,7 +119,8 @@ module Carbon
114
119
  :'hybrid_search',
115
120
  :'hybrid_search_tuning_parameters',
116
121
  :'media_type',
117
- :'embedding_model'
122
+ :'embedding_model',
123
+ :'include_file_level_metadata'
118
124
  ])
119
125
  end
120
126
 
@@ -204,6 +210,12 @@ module Carbon
204
210
  else
205
211
  self.embedding_model = 'OPENAI'
206
212
  end
213
+
214
+ if attributes.key?(:'include_file_level_metadata')
215
+ self.include_file_level_metadata = attributes[:'include_file_level_metadata']
216
+ else
217
+ self.include_file_level_metadata = false
218
+ end
207
219
  end
208
220
 
209
221
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -286,7 +298,8 @@ module Carbon
286
298
  hybrid_search == o.hybrid_search &&
287
299
  hybrid_search_tuning_parameters == o.hybrid_search_tuning_parameters &&
288
300
  media_type == o.media_type &&
289
- embedding_model == o.embedding_model
301
+ embedding_model == o.embedding_model &&
302
+ include_file_level_metadata == o.include_file_level_metadata
290
303
  end
291
304
 
292
305
  # @see the `==` method
@@ -298,7 +311,7 @@ module Carbon
298
311
  # Calculates hash code according to all attributes.
299
312
  # @return [Integer] Hash code
300
313
  def hash
301
- [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
314
+ [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, include_file_level_metadata].hash
302
315
  end
303
316
 
304
317
  # Builds the object from hash