[![Visit Carbon](./header.png)](https://carbon.ai) # [Carbon](https://carbon.ai) Connect external data to LLMs, no matter the source. [![npm](https://img.shields.io/badge/gem-v0.1.23-blue)](https://rubygems.org/gems/carbon_ruby_sdk/versions/0.1.23)

## Table of Contents - [Installation](#installation) - [Getting Started](#getting-started) - [Raw HTTP Response](#raw-http-response) - [Reference](#reference) * [`carbon.auth.get_access_token`](#carbonauthget_access_token) * [`carbon.auth.get_white_labeling`](#carbonauthget_white_labeling) * [`carbon.data_sources.query_user_data_sources`](#carbondata_sourcesquery_user_data_sources) * [`carbon.data_sources.revoke_access_token`](#carbondata_sourcesrevoke_access_token) * [`carbon.embeddings.get_documents`](#carbonembeddingsget_documents) * [`carbon.embeddings.get_embeddings_and_chunks`](#carbonembeddingsget_embeddings_and_chunks) * [`carbon.embeddings.upload_chunks_and_embeddings`](#carbonembeddingsupload_chunks_and_embeddings) * [`carbon.files.create_user_file_tags`](#carbonfilescreate_user_file_tags) * [`carbon.files.delete`](#carbonfilesdelete) * [`carbon.files.delete_file_tags`](#carbonfilesdelete_file_tags) * [`carbon.files.delete_many`](#carbonfilesdelete_many) * [`carbon.files.delete_v2`](#carbonfilesdelete_v2) * [`carbon.files.get_parsed_file`](#carbonfilesget_parsed_file) * [`carbon.files.get_raw_file`](#carbonfilesget_raw_file) * [`carbon.files.query_user_files`](#carbonfilesquery_user_files) * [`carbon.files.query_user_files_deprecated`](#carbonfilesquery_user_files_deprecated) * [`carbon.files.resync`](#carbonfilesresync) * [`carbon.files.upload`](#carbonfilesupload) * [`carbon.files.upload_from_url`](#carbonfilesupload_from_url) * [`carbon.files.upload_text`](#carbonfilesupload_text) * [`carbon.health.check`](#carbonhealthcheck) * [`carbon.integrations.connect_data_source`](#carbonintegrationsconnect_data_source) * [`carbon.integrations.connect_freshdesk`](#carbonintegrationsconnect_freshdesk) * [`carbon.integrations.connect_gitbook`](#carbonintegrationsconnect_gitbook) * [`carbon.integrations.create_aws_iam_user`](#carbonintegrationscreate_aws_iam_user) * [`carbon.integrations.get_oauth_url`](#carbonintegrationsget_oauth_url) * [`carbon.integrations.list_confluence_pages`](#carbonintegrationslist_confluence_pages) * [`carbon.integrations.list_data_source_items`](#carbonintegrationslist_data_source_items) * [`carbon.integrations.list_folders`](#carbonintegrationslist_folders) * [`carbon.integrations.list_gitbook_spaces`](#carbonintegrationslist_gitbook_spaces) * [`carbon.integrations.list_labels`](#carbonintegrationslist_labels) * [`carbon.integrations.list_outlook_categories`](#carbonintegrationslist_outlook_categories) * [`carbon.integrations.sync_confluence`](#carbonintegrationssync_confluence) * [`carbon.integrations.sync_data_source_items`](#carbonintegrationssync_data_source_items) * [`carbon.integrations.sync_files`](#carbonintegrationssync_files) * [`carbon.integrations.sync_git_hub`](#carbonintegrationssync_git_hub) * [`carbon.integrations.sync_gitbook`](#carbonintegrationssync_gitbook) * [`carbon.integrations.sync_gmail`](#carbonintegrationssync_gmail) * [`carbon.integrations.sync_outlook`](#carbonintegrationssync_outlook) * [`carbon.integrations.sync_rss_feed`](#carbonintegrationssync_rss_feed) * [`carbon.integrations.sync_s3_files`](#carbonintegrationssync_s3_files) * [`carbon.organizations.get`](#carbonorganizationsget) * [`carbon.users.delete`](#carbonusersdelete) * [`carbon.users.get`](#carbonusersget) * [`carbon.users.toggle_user_features`](#carbonuserstoggle_user_features) * [`carbon.users.update_users`](#carbonusersupdate_users) * [`carbon.utilities.fetch_urls`](#carbonutilitiesfetch_urls) * [`carbon.utilities.fetch_youtube_transcripts`](#carbonutilitiesfetch_youtube_transcripts) * [`carbon.utilities.process_sitemap`](#carbonutilitiesprocess_sitemap) * [`carbon.utilities.scrape_sitemap`](#carbonutilitiesscrape_sitemap) * [`carbon.utilities.scrape_web`](#carbonutilitiesscrape_web) * [`carbon.utilities.search_urls`](#carbonutilitiessearch_urls) * [`carbon.webhooks.add_url`](#carbonwebhooksadd_url) * [`carbon.webhooks.delete_url`](#carbonwebhooksdelete_url) * [`carbon.webhooks.urls`](#carbonwebhooksurls) ## Installation Add to Gemfile: ```ruby gem 'carbon_ruby_sdk', '~> 0.1.23' ``` ## Getting Started ```ruby require 'carbon_ruby_sdk' # 1) Get an access token for a customer configuration = Carbon::Configuration.new configuration.api_key = "YOUR_API_KEY" configuration.customer_id = "YOUR_CUSTOMER_ID" carbon = Carbon::Client.new(configuration) token = carbon.auth.get_access_token # 2) Use the access token to authenticate moving forward configuration = Carbon::Configuration.new configuration.access_token = token.access_token carbon = Carbon::Client.new(configuration) # use SDK as usual white_labeling = carbon.auth.get_white_labeling ``` ## Raw HTTP Response To access the raw HTTP response, suffix any method with `_with_http_info`. ```ruby result = carbon.auth.get_access_token_with_http_info p result.data # [TokenResponse] Deserialized data p.result.status_code # [Integer] HTTP status code p.result.headers # [Hash] HTTP headers p.result.response # [Faraday::Response] Raw HTTP response ``` ## Reference ### `carbon.auth.get_access_token` Get Access Token #### 🛠️ Usage ```ruby result = carbon.auth.get_access_token p result ``` #### 🔄 Return [TokenResponse](./lib/carbon_ruby_sdk/models/token_response.rb) #### 🌐 Endpoint `/auth/v1/access_token` `GET` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `carbon.auth.get_white_labeling` Returns whether or not the organization is white labeled and which integrations are white labeled :param current_user: the current user :param db: the database session :return: a WhiteLabelingResponse #### 🛠️ Usage ```ruby result = carbon.auth.get_white_labeling p result ``` #### 🔄 Return [WhiteLabelingResponse](./lib/carbon_ruby_sdk/models/white_labeling_response.rb) #### 🌐 Endpoint `/auth/v1/white_labeling` `GET` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `carbon.data_sources.query_user_data_sources` User Data Sources #### 🛠️ Usage ```ruby result = carbon.data_sources.query_user_data_sources( pagination: { "limit" => 10, "offset" => 0, }, order_by: "created_at", order_dir: "desc", filters: { "source" => "GOOGLE_DRIVE", }, ) p result ``` #### ⚙️ Parameters ##### pagination: [`Pagination`](./lib/carbon_ruby_sdk/models/pagination.rb) ##### order_by: [`OrganizationUserDataSourceOrderByColumns`](./lib/carbon_ruby_sdk/models/organization_user_data_source_order_by_columns.rb) ##### order_dir: [`OrderDir`](./lib/carbon_ruby_sdk/models/order_dir.rb) ##### filters: [`OrganizationUserDataSourceFilters`](./lib/carbon_ruby_sdk/models/organization_user_data_source_filters.rb) #### 🔄 Return [OrganizationUserDataSourceResponse](./lib/carbon_ruby_sdk/models/organization_user_data_source_response.rb) #### 🌐 Endpoint `/user_data_sources` `POST` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `carbon.data_sources.revoke_access_token` Revoke Access Token #### 🛠️ Usage ```ruby result = carbon.data_sources.revoke_access_token( data_source_id: 1, ) p result ``` #### ⚙️ Parameters ##### data_source_id: `Integer` #### 🔄 Return [GenericSuccessResponse](./lib/carbon_ruby_sdk/models/generic_success_response.rb) #### 🌐 Endpoint `/revoke_access_token` `POST` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `carbon.embeddings.get_documents` For pre-filtering documents, using `tags_v2` is preferred to using `tags` (which is now deprecated). If both `tags_v2` and `tags` are specified, `tags` is ignored. `tags_v2` enables building complex filters through the use of "AND", "OR", and negation logic. Take the below input as an example: ```json { "OR": [ { "key": "subject", "value": "holy-bible", "negate": false }, { "key": "person-of-interest", "value": "jesus christ", "negate": false }, { "key": "genre", "value": "religion", "negate": true } { "AND": [ { "key": "subject", "value": "tao-te-ching", "negate": false }, { "key": "author", "value": "lao-tzu", "negate": false } ] } ] } ``` In this case, files will be filtered such that: 1. "subject" = "holy-bible" OR 2. "person-of-interest" = "jesus christ" OR 3. "genre" != "religion" OR 4. "subject" = "tao-te-ching" AND "author" = "lao-tzu" Note that the top level of the query must be either an "OR" or "AND" array. Currently, nesting is limited to 3. For tag blocks (those with "key", "value", and "negate" keys), the following typing rules apply: 1. "key" isn't optional and must be a `string` 2. "value" isn't optional and can be `any` or list[`any`] 3. "negate" is optional and must be `true` or `false`. If present and `true`, then the filter block is negated in the resulting query. It is `false` by default. When querying embeddings, you can optionally specify the `media_type` parameter in your request. By default (if not set), it is equal to "TEXT". This means that the query will be performed over files that have been parsed as text (for now, this covers all files except image files). If it is equal to "IMAGE", the query will be performed over image files (for now, `.jpg` and `.png` files). You can think of this field as an additional filter on top of any filters set in `file_ids` and When `hybrid_search` is set to true, a combination of keyword search and semantic search are used to rank and select candidate embeddings during information retrieval. By default, these search methods are weighted equally during the ranking process. To adjust the weight (or "importance") of each search method, you can use the `hybrid_search_tuning_parameters` property. The description for the different tuning parameters are: - `weight_a`: weight to assign to semantic search - `weight_b`: weight to assign to keyword search You must ensure that `sum(weight_a, weight_b,..., weight_n)` for all *n* weights is equal to 1. The equality has an error tolerance of 0.001 to account for possible floating point issues. In order to use hybrid search for a customer across a set of documents, two flags need to be enabled: 1. Use the `/modify_user_configuration` endpoint to to enable `sparse_vectors` for the customer. The payload body for this request is below: ``` { "configuration_key_name": "sparse_vectors", "value": { "enabled": true } } ``` 2. Make sure hybrid search is enabled for the documents across which you want to perform the search. For the `/uploadfile` endpoint, this can be done by setting the following query parameter: `generate_sparse_vectors=true` Carbon supports multiple models for use in generating embeddings for files. For images, we support Vertex AI's multimodal model; for text, we support OpenAI's `text-embedding-ada-002` and Cohere's embed-multilingual-v3.0. The model can be specified via the `embedding_model` parameter (in the POST body for `/embeddings`, and a query parameter in `/uploadfile`). If no model is supplied, the `text-embedding-ada-002` is used by default. When performing embedding queries, embeddings from files that used the specified model will be considered in the query. For example, if files A and B have embeddings generated with `OPENAI`, and files C and D have embeddings generated with `COHERE_MULTILINGUAL_V3`, then by default, queries will only consider files A and B. If `COHERE_MULTILINGUAL_V3` is specified as the `embedding_model` in `/embeddings`, then only files C and D will be considered. Make sure that the set of all files you want considered for a query have embeddings generated via the same model. For now, **do not** set `VERTEX_MULTIMODAL` as an `embedding_model`. This model is used automatically by Carbon when it detects an image file. #### 🛠️ Usage ```ruby result = carbon.embeddings.get_documents( query: "a", k: 1, tags: { "key": "string_example", }, query_vector: [ 3.14 ], file_ids: [ 1 ], parent_file_ids: [ 1 ], include_all_children: false, tags_v2: { }, include_tags: true, include_vectors: true, include_raw_file: true, hybrid_search: true, hybrid_search_tuning_parameters: { "weight_a" => 0.5, "weight_b" => 0.5, }, media_type: "TEXT", embedding_model: "OPENAI", ) p result ``` #### ⚙️ Parameters ##### query: `String` Query for which to get related chunks and embeddings. ##### k: `Integer` Number of related chunks to return. ##### tags: Hash A set of tags to limit the search to. Deprecated and may be removed in the future. ##### 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`. ##### file_ids: Array<`Integer`> Optional list of file IDs to limit the search to ##### 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) ##### include_all_children: `Boolean` Flag to control whether or not to include all children of filtered files in the embedding search. ##### tags_v2: `Object` A set of tags to limit the search to. Use this instead of `tags`, which is deprecated. ##### include_tags: `Boolean` Flag to control whether or not to include tags for each chunk in the response. ##### include_vectors: `Boolean` Flag to control whether or not to include embedding vectors in the response. ##### include_raw_file: `Boolean` Flag to control whether or not to include a signed URL to the raw file containing each chunk in the response. ##### hybrid_search: `Boolean` Flag to control whether or not to perform hybrid search. ##### hybrid_search_tuning_parameters: [`HybridSearchTuningParamsNullable`](./lib/carbon_ruby_sdk/models/hybrid_search_tuning_params_nullable.rb) ##### media_type: [`FileContentTypesNullable`](./lib/carbon_ruby_sdk/models/file_content_types_nullable.rb) Used to filter the kind of files (e.g. `TEXT` or `IMAGE`) over which to perform the search. Also plays a role in determining what embedding model is used to embed the query. If `IMAGE` is chosen as the media type, then the embedding model used will be an embedding model that is not text-only, *regardless* of what value is passed for `embedding_model`. ##### embedding_model: [`EmbeddingGeneratorsNullable`](./lib/carbon_ruby_sdk/models/embedding_generators_nullable.rb) #### 🔄 Return [DocumentResponseList](./lib/carbon_ruby_sdk/models/document_response_list.rb) #### 🌐 Endpoint `/embeddings` `POST` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `carbon.embeddings.get_embeddings_and_chunks` Retrieve Embeddings And Content #### 🛠️ Usage ```ruby result = carbon.embeddings.get_embeddings_and_chunks( filters: { "user_file_id" => 1, "embedding_model" => "OPENAI", }, pagination: { "limit" => 10, "offset" => 0, }, order_by: "created_at", order_dir: "desc", include_vectors: false, ) p result ``` #### ⚙️ Parameters ##### filters: [`EmbeddingsAndChunksFilters`](./lib/carbon_ruby_sdk/models/embeddings_and_chunks_filters.rb) ##### pagination: [`Pagination`](./lib/carbon_ruby_sdk/models/pagination.rb) ##### order_by: [`EmbeddingsAndChunksOrderByColumns`](./lib/carbon_ruby_sdk/models/embeddings_and_chunks_order_by_columns.rb) ##### order_dir: [`OrderDir`](./lib/carbon_ruby_sdk/models/order_dir.rb) ##### include_vectors: `Boolean` #### 🔄 Return [EmbeddingsAndChunksResponse](./lib/carbon_ruby_sdk/models/embeddings_and_chunks_response.rb) #### 🌐 Endpoint `/text_chunks` `POST` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `carbon.embeddings.upload_chunks_and_embeddings` Upload Chunks And Embeddings #### 🛠️ Usage ```ruby result = carbon.embeddings.upload_chunks_and_embeddings( embedding_model: "OPENAI", chunks_and_embeddings: [ { "file_id" => 1, "chunks_and_embeddings" => [ { "chunk_number" => 1, "chunk" => "chunk_example", } ], } ], overwrite_existing: false, chunks_only: false, custom_credentials: {}, ) p result ``` #### ⚙️ Parameters ##### embedding_model: [`EmbeddingGenerators`](./lib/carbon_ruby_sdk/models/embedding_generators.rb) ##### chunks_and_embeddings: Array<[`SingleChunksAndEmbeddingsUploadInput`](./lib/carbon_ruby_sdk/models/single_chunks_and_embeddings_upload_input.rb)> ##### overwrite_existing: `Boolean` ##### chunks_only: `Boolean` ##### custom_credentials: `Object` #### 🔄 Return [GenericSuccessResponse](./lib/carbon_ruby_sdk/models/generic_success_response.rb) #### 🌐 Endpoint `/upload_chunks_and_embeddings` `POST` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `carbon.files.create_user_file_tags` A tag is a key-value pair that can be added to a file. This pair can then be used for searches (e.g. embedding searches) in order to narrow down the scope of the search. A file can have any number of tags. The following are reserved keys that cannot be used: - db_embedding_id - organization_id - user_id - organization_user_file_id Carbon currently supports two data types for tag values - `string` and `list`. Keys can only be `string`. If values other than `string` and `list` are used, they're automatically converted to strings (e.g. 4 will become "4"). #### 🛠️ Usage ```ruby result = carbon.files.create_user_file_tags( tags: { "key": "string_example", }, organization_user_file_id: 1, ) p result ``` #### ⚙️ Parameters ##### tags: Hash ##### organization_user_file_id: `Integer` #### 🔄 Return [UserFile](./lib/carbon_ruby_sdk/models/user_file.rb) #### 🌐 Endpoint `/create_user_file_tags` `POST` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `carbon.files.delete` Delete File Endpoint #### 🛠️ Usage ```ruby result = carbon.files.delete( file_id: 1, ) p result ``` #### ⚙️ Parameters ##### file_id: `Integer` #### 🔄 Return [GenericSuccessResponse](./lib/carbon_ruby_sdk/models/generic_success_response.rb) #### 🌐 Endpoint `/deletefile/{file_id}` `DELETE` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `carbon.files.delete_file_tags` Delete File Tags #### 🛠️ Usage ```ruby result = carbon.files.delete_file_tags( tags: [ "string_example" ], organization_user_file_id: 1, ) p result ``` #### ⚙️ Parameters ##### tags: Array<`String`> ##### organization_user_file_id: `Integer` #### 🔄 Return [UserFile](./lib/carbon_ruby_sdk/models/user_file.rb) #### 🌐 Endpoint `/delete_user_file_tags` `POST` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `carbon.files.delete_many` Delete Files Endpoint #### 🛠️ Usage ```ruby result = carbon.files.delete_many( file_ids: [ 1 ], sync_statuses: [ "string_example" ], delete_non_synced_only: false, send_webhook: false, delete_child_files: false, ) p result ``` #### ⚙️ Parameters ##### file_ids: Array<`Integer`> ##### sync_statuses: Array<[`ExternalFileSyncStatuses`](./lib/carbon_ruby_sdk/models/external_file_sync_statuses.rb)> ##### delete_non_synced_only: `Boolean` ##### send_webhook: `Boolean` ##### delete_child_files: `Boolean` #### 🔄 Return [GenericSuccessResponse](./lib/carbon_ruby_sdk/models/generic_success_response.rb) #### 🌐 Endpoint `/delete_files` `POST` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `carbon.files.delete_v2` Delete Files V2 Endpoint #### 🛠️ Usage ```ruby result = carbon.files.delete_v2( filters: { "include_all_children" => false, "non_synced_only" => false, }, send_webhook: false, ) p result ``` #### ⚙️ Parameters ##### filters: [`OrganizationUserFilesToSyncFilters`](./lib/carbon_ruby_sdk/models/organization_user_files_to_sync_filters.rb) ##### send_webhook: `Boolean` #### 🔄 Return [GenericSuccessResponse](./lib/carbon_ruby_sdk/models/generic_success_response.rb) #### 🌐 Endpoint `/delete_files_v2` `POST` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `carbon.files.get_parsed_file` This route is deprecated. Use `/user_files_v2` instead. #### 🛠️ Usage ```ruby result = carbon.files.get_parsed_file( file_id: 1, ) p result ``` #### ⚙️ Parameters ##### file_id: `Integer` #### 🔄 Return [PresignedURLResponse](./lib/carbon_ruby_sdk/models/presigned_url_response.rb) #### 🌐 Endpoint `/parsed_file/{file_id}` `GET` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `carbon.files.get_raw_file` This route is deprecated. Use `/user_files_v2` instead. #### 🛠️ Usage ```ruby result = carbon.files.get_raw_file( file_id: 1, ) p result ``` #### ⚙️ Parameters ##### file_id: `Integer` #### 🔄 Return [PresignedURLResponse](./lib/carbon_ruby_sdk/models/presigned_url_response.rb) #### 🌐 Endpoint `/raw_file/{file_id}` `GET` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `carbon.files.query_user_files` For pre-filtering documents, using `tags_v2` is preferred to using `tags` (which is now deprecated). If both `tags_v2` and `tags` are specified, `tags` is ignored. `tags_v2` enables building complex filters through the use of "AND", "OR", and negation logic. Take the below input as an example: ```json { "OR": [ { "key": "subject", "value": "holy-bible", "negate": false }, { "key": "person-of-interest", "value": "jesus christ", "negate": false }, { "key": "genre", "value": "religion", "negate": true } { "AND": [ { "key": "subject", "value": "tao-te-ching", "negate": false }, { "key": "author", "value": "lao-tzu", "negate": false } ] } ] } ``` In this case, files will be filtered such that: 1. "subject" = "holy-bible" OR 2. "person-of-interest" = "jesus christ" OR 3. "genre" != "religion" OR 4. "subject" = "tao-te-ching" AND "author" = "lao-tzu" Note that the top level of the query must be either an "OR" or "AND" array. Currently, nesting is limited to 3. For tag blocks (those with "key", "value", and "negate" keys), the following typing rules apply: 1. "key" isn't optional and must be a `string` 2. "value" isn't optional and can be `any` or list[`any`] 3. "negate" is optional and must be `true` or `false`. If present and `true`, then the filter block is negated in the resulting query. It is `false` by default. #### 🛠️ Usage ```ruby result = carbon.files.query_user_files( pagination: { "limit" => 10, "offset" => 0, }, order_by: "created_at", order_dir: "desc", filters: { "include_all_children" => false, "non_synced_only" => false, }, include_raw_file: true, include_parsed_text_file: true, include_additional_files: true, ) p result ``` #### ⚙️ Parameters ##### pagination: [`Pagination`](./lib/carbon_ruby_sdk/models/pagination.rb) ##### order_by: [`OrganizationUserFilesToSyncOrderByTypes`](./lib/carbon_ruby_sdk/models/organization_user_files_to_sync_order_by_types.rb) ##### order_dir: [`OrderDir`](./lib/carbon_ruby_sdk/models/order_dir.rb) ##### filters: [`OrganizationUserFilesToSyncFilters`](./lib/carbon_ruby_sdk/models/organization_user_files_to_sync_filters.rb) ##### include_raw_file: `Boolean` ##### include_parsed_text_file: `Boolean` ##### include_additional_files: `Boolean` #### 🔄 Return [UserFilesV2](./lib/carbon_ruby_sdk/models/user_files_v2.rb) #### 🌐 Endpoint `/user_files_v2` `POST` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `carbon.files.query_user_files_deprecated` This route is deprecated. Use `/user_files_v2` instead. #### 🛠️ Usage ```ruby result = carbon.files.query_user_files_deprecated( pagination: { "limit" => 10, "offset" => 0, }, order_by: "created_at", order_dir: "desc", filters: { "include_all_children" => false, "non_synced_only" => false, }, include_raw_file: true, include_parsed_text_file: true, include_additional_files: true, ) p result ``` #### ⚙️ Parameters ##### pagination: [`Pagination`](./lib/carbon_ruby_sdk/models/pagination.rb) ##### order_by: [`OrganizationUserFilesToSyncOrderByTypes`](./lib/carbon_ruby_sdk/models/organization_user_files_to_sync_order_by_types.rb) ##### order_dir: [`OrderDir`](./lib/carbon_ruby_sdk/models/order_dir.rb) ##### filters: [`OrganizationUserFilesToSyncFilters`](./lib/carbon_ruby_sdk/models/organization_user_files_to_sync_filters.rb) ##### include_raw_file: `Boolean` ##### include_parsed_text_file: `Boolean` ##### include_additional_files: `Boolean` #### 🔄 Return [UserFile](./lib/carbon_ruby_sdk/models/user_file.rb) #### 🌐 Endpoint `/user_files` `POST` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `carbon.files.resync` Resync File #### 🛠️ Usage ```ruby result = carbon.files.resync( file_id: 1, chunk_size: 1, chunk_overlap: 1, force_embedding_generation: false, ) p result ``` #### ⚙️ Parameters ##### file_id: `Integer` ##### chunk_size: `Integer` ##### chunk_overlap: `Integer` ##### force_embedding_generation: `Boolean` #### 🔄 Return [UserFile](./lib/carbon_ruby_sdk/models/user_file.rb) #### 🌐 Endpoint `/resync_file` `POST` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `carbon.files.upload` This endpoint is used to directly upload local files to Carbon. The `POST` request should be a multipart form request. Note that the `set_page_as_boundary` query parameter is applicable only to PDFs for now. When this value is set, PDF chunks are at most one page long. Additional information can be retrieved for each chunk, however, namely the coordinates of the bounding box around the chunk (this can be used for things like text highlighting). Following is a description of all possible query parameters: - `chunk_size`: the chunk size (in tokens) applied when splitting the document - `chunk_overlap`: the chunk overlap (in tokens) applied when splitting the document - `skip_embedding_generation`: whether or not to skip the generation of chunks and embeddings - `set_page_as_boundary`: described above - `embedding_model`: the model used to generate embeddings for the document chunks - `use_ocr`: whether or not to use OCR as a preprocessing step prior to generating chunks (only valid for PDFs currently) - `generate_sparse_vectors`: whether or not to generate sparse vectors for the file. Required for hybrid search. - `prepend_filename_to_chunks`: whether or not to prepend the filename to the chunk text Carbon supports multiple models for use in generating embeddings for files. For images, we support Vertex AI's multimodal model; for text, we support OpenAI's `text-embedding-ada-002` and Cohere's embed-multilingual-v3.0. The model can be specified via the `embedding_model` parameter (in the POST body for `/embeddings`, and a query parameter in `/uploadfile`). If no model is supplied, the `text-embedding-ada-002` is used by default. When performing embedding queries, embeddings from files that used the specified model will be considered in the query. For example, if files A and B have embeddings generated with `OPENAI`, and files C and D have embeddings generated with `COHERE_MULTILINGUAL_V3`, then by default, queries will only consider files A and B. If `COHERE_MULTILINGUAL_V3` is specified as the `embedding_model` in `/embeddings`, then only files C and D will be considered. Make sure that the set of all files you want considered for a query have embeddings generated via the same model. For now, **do not** set `VERTEX_MULTIMODAL` as an `embedding_model`. This model is used automatically by Carbon when it detects an image file. #### 🛠️ Usage ```ruby result = carbon.files.upload( file: File.open("path/to/file", "rb"), chunk_size: 1, chunk_overlap: 1, skip_embedding_generation: false, set_page_as_boundary: false, embedding_model: "OPENAI", use_ocr: false, generate_sparse_vectors: false, prepend_filename_to_chunks: false, max_items_per_chunk: 1, parse_pdf_tables_with_ocr: false, ) p result ``` #### ⚙️ Parameters ##### file: `File` ##### chunk_size: `Integer` Chunk size in tiktoken tokens to be used when processing file. ##### chunk_overlap: `Integer` Chunk overlap in tiktoken tokens to be used when processing file. ##### skip_embedding_generation: `Boolean` Flag to control whether or not embeddings should be generated and stored when processing file. ##### set_page_as_boundary: `Boolean` Flag to control whether or not to set the a page's worth of content as the maximum amount of content that can appear in a chunk. Only valid for PDFs. See description route description for more information. ##### embedding_model: [`TextEmbeddingGenerators`](./lib/carbon_ruby_sdk/models/text_embedding_generators.rb) Embedding model that will be used to embed file chunks. ##### 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. ##### 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. ##### prepend_filename_to_chunks: `Boolean` Whether or not to prepend the file's name to chunks. ##### max_items_per_chunk: `Integer` Number of objects per chunk. For csv, tsv, xlsx, and json files only. ##### parse_pdf_tables_with_ocr: `Boolean` Whether to use rich table parsing when `use_ocr` is enabled. #### 🔄 Return [UserFile](./lib/carbon_ruby_sdk/models/user_file.rb) #### 🌐 Endpoint `/uploadfile` `POST` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `carbon.files.upload_from_url` Create Upload File From Url #### 🛠️ Usage ```ruby result = carbon.files.upload_from_url( url: "string_example", file_name: "string_example", chunk_size: 1, chunk_overlap: 1, 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: 1, parse_pdf_tables_with_ocr: false, ) p result ``` #### ⚙️ Parameters ##### url: `String` ##### file_name: `String` ##### chunk_size: `Integer` ##### chunk_overlap: `Integer` ##### skip_embedding_generation: `Boolean` ##### set_page_as_boundary: `Boolean` ##### embedding_model: [`EmbeddingGenerators`](./lib/carbon_ruby_sdk/models/embedding_generators.rb) ##### generate_sparse_vectors: `Boolean` ##### use_textract: `Boolean` ##### prepend_filename_to_chunks: `Boolean` ##### max_items_per_chunk: `Integer` Number of objects per chunk. For csv, tsv, xlsx, and json files only. ##### parse_pdf_tables_with_ocr: `Boolean` #### 🔄 Return [UserFile](./lib/carbon_ruby_sdk/models/user_file.rb) #### 🌐 Endpoint `/upload_file_from_url` `POST` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `carbon.files.upload_text` Carbon supports multiple models for use in generating embeddings for files. For images, we support Vertex AI's multimodal model; for text, we support OpenAI's `text-embedding-ada-002` and Cohere's embed-multilingual-v3.0. The model can be specified via the `embedding_model` parameter (in the POST body for `/embeddings`, and a query parameter in `/uploadfile`). If no model is supplied, the `text-embedding-ada-002` is used by default. When performing embedding queries, embeddings from files that used the specified model will be considered in the query. For example, if files A and B have embeddings generated with `OPENAI`, and files C and D have embeddings generated with `COHERE_MULTILINGUAL_V3`, then by default, queries will only consider files A and B. If `COHERE_MULTILINGUAL_V3` is specified as the `embedding_model` in `/embeddings`, then only files C and D will be considered. Make sure that the set of all files you want considered for a query have embeddings generated via the same model. For now, **do not** set `VERTEX_MULTIMODAL` as an `embedding_model`. This model is used automatically by Carbon when it detects an image file. #### 🛠️ Usage ```ruby result = carbon.files.upload_text( contents: "string_example", name: "string_example", chunk_size: 1, chunk_overlap: 1, skip_embedding_generation: false, overwrite_file_id: 1, embedding_model: "OPENAI", generate_sparse_vectors: false, ) p result ``` #### ⚙️ Parameters ##### contents: `String` ##### name: `String` ##### chunk_size: `Integer` ##### chunk_overlap: `Integer` ##### skip_embedding_generation: `Boolean` ##### overwrite_file_id: `Integer` ##### embedding_model: [`EmbeddingGeneratorsNullable`](./lib/carbon_ruby_sdk/models/embedding_generators_nullable.rb) ##### generate_sparse_vectors: `Boolean` #### 🔄 Return [UserFile](./lib/carbon_ruby_sdk/models/user_file.rb) #### 🌐 Endpoint `/upload_text` `POST` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `carbon.health.check` Health #### 🛠️ Usage ```ruby result = carbon.health.check p result ``` #### 🌐 Endpoint `/health` `GET` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `carbon.integrations.connect_data_source` Connect Data Source #### 🛠️ Usage ```ruby result = carbon.integrations.connect_data_source( authentication: { "source" => "GOOGLE_DRIVE", "access_token" => "access_token_example", }, sync_options: { "chunk_size" => 1500, "chunk_overlap" => 20, "skip_embedding_generation" => false, "embedding_model" => "OPENAI", "generate_sparse_vectors" => false, "prepend_filename_to_chunks" => false, "sync_files_on_connection" => true, "set_page_as_boundary" => false, "request_id" => "e8fddc9a-4810-48b2-b1b5-b1ec0159625a", "enable_file_picker" => true, }, ) p result ``` #### ⚙️ Parameters ##### authentication: [`AuthenticationProperty`](./lib/carbon_ruby_sdk/models/authentication_property.rb) ##### sync_options: [`SyncOptions`](./lib/carbon_ruby_sdk/models/sync_options.rb) #### 🔄 Return [ConnectDataSourceResponse](./lib/carbon_ruby_sdk/models/connect_data_source_response.rb) #### 🌐 Endpoint `/integrations/connect` `POST` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `carbon.integrations.connect_freshdesk` Refer this article to obtain an API key https://support.freshdesk.com/en/support/solutions/articles/215517. Make sure that your API key has the permission to read solutions from your account and you are on a paid plan. Once you have an API key, you can make a request to this endpoint along with your freshdesk domain. This will trigger an automatic sync of the articles in your "solutions" tab. Additional parameters below can be used to associate data with the synced articles or modify the sync behavior. #### 🛠️ Usage ```ruby result = carbon.integrations.connect_freshdesk( domain: "string_example", api_key: "string_example", tags: {}, chunk_size: 1500, chunk_overlap: 20, skip_embedding_generation: false, embedding_model: "OPENAI", generate_sparse_vectors: false, prepend_filename_to_chunks: false, sync_files_on_connection: true, request_id: "string_example", ) p result ``` #### ⚙️ Parameters ##### domain: `String` ##### api_key: `String` ##### tags: `Object` ##### chunk_size: `Integer` ##### chunk_overlap: `Integer` ##### skip_embedding_generation: `Boolean` ##### embedding_model: [`EmbeddingGeneratorsNullable`](./lib/carbon_ruby_sdk/models/embedding_generators_nullable.rb) ##### generate_sparse_vectors: `Boolean` ##### prepend_filename_to_chunks: `Boolean` ##### sync_files_on_connection: `Boolean` ##### request_id: `String` #### 🔄 Return [GenericSuccessResponse](./lib/carbon_ruby_sdk/models/generic_success_response.rb) #### 🌐 Endpoint `/integrations/freshdesk` `POST` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `carbon.integrations.connect_gitbook` You will need an access token to connect your Gitbook account. Note that the permissions will be defined by the user generating access token so make sure you have the permission to access spaces you will be syncing. Refer this article for more details https://developer.gitbook.com/gitbook-api/authentication. Additionally, you need to specify the name of organization you will be syncing data from. #### 🛠️ Usage ```ruby result = carbon.integrations.connect_gitbook( organization: "string_example", access_token: "string_example", tags: {}, chunk_size: 1500, chunk_overlap: 20, skip_embedding_generation: false, embedding_model: "OPENAI", generate_sparse_vectors: false, prepend_filename_to_chunks: false, sync_files_on_connection: true, request_id: "string_example", ) p result ``` #### ⚙️ Parameters ##### organization: `String` ##### access_token: `String` ##### tags: `Object` ##### chunk_size: `Integer` ##### chunk_overlap: `Integer` ##### skip_embedding_generation: `Boolean` ##### embedding_model: [`EmbeddingGenerators`](./lib/carbon_ruby_sdk/models/embedding_generators.rb) ##### generate_sparse_vectors: `Boolean` ##### prepend_filename_to_chunks: `Boolean` ##### sync_files_on_connection: `Boolean` ##### request_id: `String` #### 🔄 Return [GenericSuccessResponse](./lib/carbon_ruby_sdk/models/generic_success_response.rb) #### 🌐 Endpoint `/integrations/gitbook` `POST` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `carbon.integrations.create_aws_iam_user` Create a new IAM user with permissions to:

List all buckets.
Read from the specific buckets and objects to sync with Carbon. Ensure any future buckets or objects carry the same permissions.

Once created, generate an access key for this user and share the credentials with us. We recommend testing this key beforehand. #### 🛠️ Usage ```ruby result = carbon.integrations.create_aws_iam_user( access_key: "string_example", access_key_secret: "string_example", ) p result ``` #### ⚙️ Parameters ##### access_key: `String` ##### access_key_secret: `String` #### 🔄 Return [OrganizationUserDataSourceAPI](./lib/carbon_ruby_sdk/models/organization_user_data_source_api.rb) #### 🌐 Endpoint `/integrations/s3` `POST` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `carbon.integrations.get_oauth_url` This endpoint can be used to generate the following URLs - An OAuth URL for OAuth based connectors - A file syncing URL which skips the OAuth flow if the user already has a valid access token and takes them to the success state. #### 🛠️ Usage ```ruby result = carbon.integrations.get_oauth_url( service: "GOOGLE_DRIVE", tags: None, scope: "string_example", chunk_size: 1500, chunk_overlap: 20, skip_embedding_generation: false, embedding_model: "OPENAI", zendesk_subdomain: "string_example", microsoft_tenant: "string_example", sharepoint_site_name: "string_example", confluence_subdomain: "string_example", generate_sparse_vectors: false, prepend_filename_to_chunks: false, max_items_per_chunk: 1, salesforce_domain: "string_example", sync_files_on_connection: true, set_page_as_boundary: false, data_source_id: 1, connecting_new_account: false, request_id: "76343a7e-0175-49f8-957c-e1133ae388ac", use_ocr: false, parse_pdf_tables_with_ocr: false, enable_file_picker: true, ) p result ``` #### ⚙️ Parameters ##### service: [`DataSourceType`](./lib/carbon_ruby_sdk/models/data_source_type.rb) ##### tags: `Object` ##### scope: `String` ##### chunk_size: `Integer` ##### chunk_overlap: `Integer` ##### skip_embedding_generation: `Boolean` ##### embedding_model: [`EmbeddingGeneratorsNullable`](./lib/carbon_ruby_sdk/models/embedding_generators_nullable.rb) ##### zendesk_subdomain: `String` ##### microsoft_tenant: `String` ##### sharepoint_site_name: `String` ##### confluence_subdomain: `String` ##### generate_sparse_vectors: `Boolean` ##### prepend_filename_to_chunks: `Boolean` ##### max_items_per_chunk: `Integer` Number of objects per chunk. For csv, tsv, xlsx, and json files only. ##### salesforce_domain: `String` ##### 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 ##### set_page_as_boundary: `Boolean` ##### data_source_id: `Integer` Used to specify a data source to sync from if you have multiple connected. It can be skipped if you only have one data source of that type connected or are connecting a new account. ##### connecting_new_account: `Boolean` Used to connect a new data source. If not specified, we will attempt to create a sync URL for an existing data source based on type and ID. ##### request_id: `String` This request id will be added to all files that get synced using the generated OAuth URL ##### use_ocr: `Boolean` Enable OCR for files that support it. Supported formats: pdf ##### parse_pdf_tables_with_ocr: `Boolean` ##### enable_file_picker: `Boolean` Enable integration's file picker for sources that support it. Supported sources: DROPBOX, BOX, ONEDRIVE, GOOGLE_DRIVE, SHAREPOINT #### 🔄 Return [OuthURLResponse](./lib/carbon_ruby_sdk/models/outh_url_response.rb) #### 🌐 Endpoint `/integrations/oauth_url` `POST` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `carbon.integrations.list_confluence_pages` To begin listing a user's Confluence pages, at least a `data_source_id` of a connected Confluence account must be specified. This base request returns a list of root pages for every space the user has access to in a Confluence instance. To traverse further down the user's page directory, additional requests to this endpoint can be made with the same `data_source_id` and with `parent_id` set to the id of page from a previous request. For convenience, the `has_children` property in each directory item in the response list will flag which pages will return non-empty lists of pages when set as the `parent_id`. #### 🛠️ Usage ```ruby result = carbon.integrations.list_confluence_pages( data_source_id: 1, parent_id: "string_example", ) p result ``` #### ⚙️ Parameters ##### data_source_id: `Integer` ##### parent_id: `String` #### 🔄 Return [ListResponse](./lib/carbon_ruby_sdk/models/list_response.rb) #### 🌐 Endpoint `/integrations/confluence/list` `POST` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `carbon.integrations.list_data_source_items` List Data Source Items #### 🛠️ Usage ```ruby result = carbon.integrations.list_data_source_items( data_source_id: 1, parent_id: "string_example", filters: { }, pagination: { "limit" => 10, "offset" => 0, }, ) p result ``` #### ⚙️ Parameters ##### data_source_id: `Integer` ##### parent_id: `String` ##### filters: [`ListItemsFiltersNullable`](./lib/carbon_ruby_sdk/models/list_items_filters_nullable.rb) ##### pagination: [`Pagination`](./lib/carbon_ruby_sdk/models/pagination.rb) #### 🔄 Return [ListDataSourceItemsResponse](./lib/carbon_ruby_sdk/models/list_data_source_items_response.rb) #### 🌐 Endpoint `/integrations/items/list` `POST` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `carbon.integrations.list_folders` After connecting your Outlook account, you can use this endpoint to list all of your folders on outlook. This includes both system folders like "inbox" and user created folders. #### 🛠️ Usage ```ruby result = carbon.integrations.list_folders( data_source_id: 1, ) p result ``` #### ⚙️ Parameters ##### data_source_id: `Integer` #### 🌐 Endpoint `/integrations/outlook/user_folders` `GET` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `carbon.integrations.list_gitbook_spaces` After connecting your Gitbook account, you can use this endpoint to list all of your spaces under current organization. #### 🛠️ Usage ```ruby result = carbon.integrations.list_gitbook_spaces( data_source_id: 1, ) p result ``` #### ⚙️ Parameters ##### data_source_id: `Integer` #### 🌐 Endpoint `/integrations/gitbook/spaces` `GET` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `carbon.integrations.list_labels` After connecting your Gmail account, you can use this endpoint to list all of your labels. User created labels will have the type "user" and Gmail's default labels will have the type "system" #### 🛠️ Usage ```ruby result = carbon.integrations.list_labels( data_source_id: 1, ) p result ``` #### ⚙️ Parameters ##### data_source_id: `Integer` #### 🌐 Endpoint `/integrations/gmail/user_labels` `GET` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `carbon.integrations.list_outlook_categories` After connecting your Outlook account, you can use this endpoint to list all of your categories on outlook. We currently support listing up to 250 categories. #### 🛠️ Usage ```ruby result = carbon.integrations.list_outlook_categories( data_source_id: 1, ) p result ``` #### ⚙️ Parameters ##### data_source_id: `Integer` #### 🌐 Endpoint `/integrations/outlook/user_categories` `GET` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `carbon.integrations.sync_confluence` After listing pages in a user's Confluence account, the set of selected page `ids` and the connected account's `data_source_id` can be passed into this endpoint to sync them into Carbon. Additional parameters listed below can be used to associate data to the selected pages or alter the behavior of the sync. #### 🛠️ Usage ```ruby result = carbon.integrations.sync_confluence( data_source_id: 1, ids: [ "string_example" ], tags: {}, 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: 1, set_page_as_boundary: false, request_id: "74c95466-42b2-4213-ae36-bfafbaecfcf5", use_ocr: false, parse_pdf_tables_with_ocr: false, ) p result ``` #### ⚙️ Parameters ##### data_source_id: `Integer` ##### ids: [`IdsProperty`](./lib/carbon_ruby_sdk/models/ids_property.rb) ##### tags: `Object` ##### chunk_size: `Integer` ##### chunk_overlap: `Integer` ##### skip_embedding_generation: `Boolean` ##### embedding_model: [`EmbeddingGeneratorsNullable`](./lib/carbon_ruby_sdk/models/embedding_generators_nullable.rb) ##### generate_sparse_vectors: `Boolean` ##### prepend_filename_to_chunks: `Boolean` ##### max_items_per_chunk: `Integer` Number of objects per chunk. For csv, tsv, xlsx, and json files only. ##### set_page_as_boundary: `Boolean` ##### request_id: `String` ##### use_ocr: `Boolean` ##### parse_pdf_tables_with_ocr: `Boolean` #### 🔄 Return [GenericSuccessResponse](./lib/carbon_ruby_sdk/models/generic_success_response.rb) #### 🌐 Endpoint `/integrations/confluence/sync` `POST` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `carbon.integrations.sync_data_source_items` Sync Data Source Items #### 🛠️ Usage ```ruby result = carbon.integrations.sync_data_source_items( data_source_id: 1, ) p result ``` #### ⚙️ Parameters ##### data_source_id: `Integer` #### 🔄 Return [OrganizationUserDataSourceAPI](./lib/carbon_ruby_sdk/models/organization_user_data_source_api.rb) #### 🌐 Endpoint `/integrations/items/sync` `POST` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `carbon.integrations.sync_files` After listing files and folders via /integrations/items/sync and integrations/items/list, use the selected items' external ids as the ids in this endpoint to sync them into Carbon. Sharepoint items take an additional parameter root_id, which identifies the drive the file or folder is in and is stored in root_external_id. That additional paramter is optional and excluding it will tell the sync to assume the item is stored in the default Documents drive. #### 🛠️ Usage ```ruby result = carbon.integrations.sync_files( data_source_id: 1, ids: [ "string_example" ], tags: {}, 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: 1, set_page_as_boundary: false, request_id: "74c95466-42b2-4213-ae36-bfafbaecfcf5", use_ocr: false, parse_pdf_tables_with_ocr: false, ) p result ``` #### ⚙️ Parameters ##### data_source_id: `Integer` ##### ids: [`IdsProperty`](./lib/carbon_ruby_sdk/models/ids_property.rb) ##### tags: `Object` ##### chunk_size: `Integer` ##### chunk_overlap: `Integer` ##### skip_embedding_generation: `Boolean` ##### embedding_model: [`EmbeddingGeneratorsNullable`](./lib/carbon_ruby_sdk/models/embedding_generators_nullable.rb) ##### generate_sparse_vectors: `Boolean` ##### prepend_filename_to_chunks: `Boolean` ##### max_items_per_chunk: `Integer` Number of objects per chunk. For csv, tsv, xlsx, and json files only. ##### set_page_as_boundary: `Boolean` ##### request_id: `String` ##### use_ocr: `Boolean` ##### parse_pdf_tables_with_ocr: `Boolean` #### 🔄 Return [GenericSuccessResponse](./lib/carbon_ruby_sdk/models/generic_success_response.rb) #### 🌐 Endpoint `/integrations/files/sync` `POST` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `carbon.integrations.sync_git_hub` Refer this article to obtain an access token https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens. Make sure that your access token has the permission to read content from your desired repos. Note that if your access token expires you will need to manually update it through this endpoint. #### 🛠️ Usage ```ruby result = carbon.integrations.sync_git_hub( username: "string_example", access_token: "string_example", ) p result ``` #### ⚙️ Parameters ##### username: `String` ##### access_token: `String` #### 🔄 Return [GenericSuccessResponse](./lib/carbon_ruby_sdk/models/generic_success_response.rb) #### 🌐 Endpoint `/integrations/github` `POST` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `carbon.integrations.sync_gitbook` You can sync upto 20 Gitbook spaces at a time using this endpoint. Additional parameters below can be used to associate data with the synced pages or modify the sync behavior. #### 🛠️ Usage ```ruby result = carbon.integrations.sync_gitbook( space_ids: [ "string_example" ], data_source_id: 1, tags: {}, chunk_size: 1500, chunk_overlap: 20, skip_embedding_generation: false, embedding_model: "OPENAI", generate_sparse_vectors: false, prepend_filename_to_chunks: false, request_id: "string_example", ) p result ``` #### ⚙️ Parameters ##### space_ids: Array<`String`> ##### data_source_id: `Integer` ##### tags: `Object` ##### chunk_size: `Integer` ##### chunk_overlap: `Integer` ##### skip_embedding_generation: `Boolean` ##### embedding_model: [`EmbeddingGenerators`](./lib/carbon_ruby_sdk/models/embedding_generators.rb) ##### generate_sparse_vectors: `Boolean` ##### prepend_filename_to_chunks: `Boolean` ##### request_id: `String` #### 🌐 Endpoint `/integrations/gitbook/sync` `POST` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `carbon.integrations.sync_gmail` Once you have successfully connected your gmail account, you can choose which emails to sync with us using the filters parameter. Filters is a JSON object with key value pairs. It also supports AND and OR operations. For now, we support a limited set of keys listed below. label: Inbuilt Gmail labels, for example "Important" or a custom label you created. after or before: A date in YYYY/mm/dd format (example 2023/12/31). Gets emails after/before a certain date. You can also use them in combination to get emails from a certain period. is: Can have the following values - starred, important, snoozed, and unread Using keys or values outside of the specified values can lead to unexpected behaviour. An example of a basic query with filters can be ```json { "filters": { "key": "label", "value": "Test" } } ``` Which will list all emails that have the label "Test". You can use AND and OR operation in the following way: ```json { "filters": { "AND": [ { "key": "after", "value": "2024/01/07" }, { "OR": [ { "key": "label", "value": "Personal" }, { "key": "is", "value": "starred" } ] } ] } } ``` This will return emails after 7th of Jan that are either starred or have the label "Personal". Note that this is the highest level of nesting we support, i.e. you can't add more AND/OR filters within the OR filter in the above example. #### 🛠️ Usage ```ruby result = carbon.integrations.sync_gmail( filters: {}, tags: {}, chunk_size: 1500, chunk_overlap: 20, skip_embedding_generation: false, embedding_model: "OPENAI", generate_sparse_vectors: false, prepend_filename_to_chunks: false, data_source_id: 1, request_id: "string_example", sync_attachments: false, ) p result ``` #### ⚙️ Parameters ##### filters: `Object` ##### tags: `Object` ##### chunk_size: `Integer` ##### chunk_overlap: `Integer` ##### skip_embedding_generation: `Boolean` ##### embedding_model: [`EmbeddingGenerators`](./lib/carbon_ruby_sdk/models/embedding_generators.rb) ##### generate_sparse_vectors: `Boolean` ##### prepend_filename_to_chunks: `Boolean` ##### data_source_id: `Integer` ##### request_id: `String` ##### sync_attachments: `Boolean` #### 🔄 Return [GenericSuccessResponse](./lib/carbon_ruby_sdk/models/generic_success_response.rb) #### 🌐 Endpoint `/integrations/gmail/sync` `POST` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `carbon.integrations.sync_outlook` Once you have successfully connected your Outlook account, you can choose which emails to sync with us using the filters and folder parameter. "folder" should be the folder you want to sync from Outlook. By default we get messages from your inbox folder. Filters is a JSON object with key value pairs. It also supports AND and OR operations. For now, we support a limited set of keys listed below. category: Custom categories that you created in Outlook. after or before: A date in YYYY/mm/dd format (example 2023/12/31). Gets emails after/before a certain date. You can also use them in combination to get emails from a certain period. is: Can have the following values: flagged An example of a basic query with filters can be ```json { "filters": { "key": "category", "value": "Test" } } ``` Which will list all emails that have the category "Test". Specifying a custom folder in the same query ```json { "folder": "Folder Name", "filters": { "key": "category", "value": "Test" } } ``` You can use AND and OR operation in the following way: ```json { "filters": { "AND": [ { "key": "after", "value": "2024/01/07" }, { "OR": [ { "key": "category", "value": "Personal" }, { "key": "category", "value": "Test" }, ] } ] } } ``` This will return emails after 7th of Jan that have either Personal or Test as category. Note that this is the highest level of nesting we support, i.e. you can't add more AND/OR filters within the OR filter in the above example. #### 🛠️ Usage ```ruby result = carbon.integrations.sync_outlook( filters: {}, tags: {}, folder: "Inbox", chunk_size: 1500, chunk_overlap: 20, skip_embedding_generation: false, embedding_model: "OPENAI", generate_sparse_vectors: false, prepend_filename_to_chunks: false, data_source_id: 1, request_id: "string_example", sync_attachments: false, ) p result ``` #### ⚙️ Parameters ##### filters: `Object` ##### tags: `Object` ##### folder: `String` ##### chunk_size: `Integer` ##### chunk_overlap: `Integer` ##### skip_embedding_generation: `Boolean` ##### embedding_model: [`EmbeddingGenerators`](./lib/carbon_ruby_sdk/models/embedding_generators.rb) ##### generate_sparse_vectors: `Boolean` ##### prepend_filename_to_chunks: `Boolean` ##### data_source_id: `Integer` ##### request_id: `String` ##### sync_attachments: `Boolean` #### 🔄 Return [GenericSuccessResponse](./lib/carbon_ruby_sdk/models/generic_success_response.rb) #### 🌐 Endpoint `/integrations/outlook/sync` `POST` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `carbon.integrations.sync_rss_feed` Rss Feed #### 🛠️ Usage ```ruby result = carbon.integrations.sync_rss_feed( url: "string_example", tags: {}, chunk_size: 1500, chunk_overlap: 20, skip_embedding_generation: false, embedding_model: "OPENAI", generate_sparse_vectors: false, prepend_filename_to_chunks: false, request_id: "string_example", ) p result ``` #### ⚙️ Parameters ##### url: `String` ##### tags: `Object` ##### chunk_size: `Integer` ##### chunk_overlap: `Integer` ##### skip_embedding_generation: `Boolean` ##### embedding_model: [`EmbeddingGenerators`](./lib/carbon_ruby_sdk/models/embedding_generators.rb) ##### generate_sparse_vectors: `Boolean` ##### prepend_filename_to_chunks: `Boolean` ##### request_id: `String` #### 🔄 Return [GenericSuccessResponse](./lib/carbon_ruby_sdk/models/generic_success_response.rb) #### 🌐 Endpoint `/integrations/rss_feed` `POST` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `carbon.integrations.sync_s3_files` After optionally loading the items via /integrations/items/sync and integrations/items/list, use the bucket name and object key as the ID in this endpoint to sync them into Carbon. Additional parameters below can associate data with the selected items or modify the sync behavior #### 🛠️ Usage ```ruby result = carbon.integrations.sync_s3_files( ids: [ { } ], tags: {}, 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: 1, set_page_as_boundary: false, data_source_id: 1, request_id: "string_example", use_ocr: false, parse_pdf_tables_with_ocr: false, ) p result ``` #### ⚙️ Parameters ##### ids: Array<[`S3GetFileInput`](./lib/carbon_ruby_sdk/models/s3_get_file_input.rb)> ##### tags: `Object` ##### chunk_size: `Integer` ##### chunk_overlap: `Integer` ##### skip_embedding_generation: `Boolean` ##### embedding_model: [`EmbeddingGenerators`](./lib/carbon_ruby_sdk/models/embedding_generators.rb) ##### generate_sparse_vectors: `Boolean` ##### prepend_filename_to_chunks: `Boolean` ##### max_items_per_chunk: `Integer` Number of objects per chunk. For csv, tsv, xlsx, and json files only. ##### set_page_as_boundary: `Boolean` ##### data_source_id: `Integer` ##### request_id: `String` ##### use_ocr: `Boolean` ##### parse_pdf_tables_with_ocr: `Boolean` #### 🔄 Return [GenericSuccessResponse](./lib/carbon_ruby_sdk/models/generic_success_response.rb) #### 🌐 Endpoint `/integrations/s3/files` `POST` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `carbon.organizations.get` Get Organization #### 🛠️ Usage ```ruby result = carbon.organizations.get p result ``` #### 🔄 Return [OrganizationResponse](./lib/carbon_ruby_sdk/models/organization_response.rb) #### 🌐 Endpoint `/organization` `GET` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `carbon.users.delete` Delete Users #### 🛠️ Usage ```ruby result = carbon.users.delete( customer_ids: [ "string_example" ], ) p result ``` #### ⚙️ Parameters ##### customer_ids: Array<`String`> #### 🔄 Return [GenericSuccessResponse](./lib/carbon_ruby_sdk/models/generic_success_response.rb) #### 🌐 Endpoint `/delete_users` `POST` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `carbon.users.get` User Endpoint #### 🛠️ Usage ```ruby result = carbon.users.get( customer_id: "string_example", ) p result ``` #### ⚙️ Parameters ##### customer_id: `String` #### 🔄 Return [UserResponse](./lib/carbon_ruby_sdk/models/user_response.rb) #### 🌐 Endpoint `/user` `POST` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `carbon.users.toggle_user_features` Toggle User Features #### 🛠️ Usage ```ruby result = carbon.users.toggle_user_features( configuration_key_name: "string_example", value: {}, ) p result ``` #### ⚙️ Parameters ##### configuration_key_name: `String` ##### value: `Object` #### 🔄 Return [GenericSuccessResponse](./lib/carbon_ruby_sdk/models/generic_success_response.rb) #### 🌐 Endpoint `/modify_user_configuration` `POST` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `carbon.users.update_users` Update Users #### 🛠️ Usage ```ruby result = carbon.users.update_users( customer_ids: [ "string_example" ], auto_sync_enabled_sources: [ "string_example" ], max_files: -1, max_files_per_upload: -1, ) p result ``` #### ⚙️ Parameters ##### customer_ids: Array<`String`> List of organization supplied user IDs ##### auto_sync_enabled_sources: [`AutoSyncEnabledSourcesProperty`](./lib/carbon_ruby_sdk/models/auto_sync_enabled_sources_property.rb) ##### max_files: `Integer` Custom file upload limit for the user over *all* user's files across all uploads. If set, then the user will not be allowed to upload more files than this limit. If not set, or if set to -1, then the user will have no limit. ##### max_files_per_upload: `Integer` Custom file upload limit for the user across a single upload. If set, then the user will not be allowed to upload more files than this limit in a single upload. If not set, or if set to -1, then the user will have no limit. #### 🔄 Return [GenericSuccessResponse](./lib/carbon_ruby_sdk/models/generic_success_response.rb) #### 🌐 Endpoint `/update_users` `POST` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `carbon.utilities.fetch_urls` Extracts all URLs from a webpage. Args: url (str): URL of the webpage Returns: FetchURLsResponse: A response object with a list of URLs extracted from the webpage and the webpage content. #### 🛠️ Usage ```ruby result = carbon.utilities.fetch_urls( url: "url_example", ) p result ``` #### ⚙️ Parameters ##### url: `String` #### 🔄 Return [FetchURLsResponse](./lib/carbon_ruby_sdk/models/fetch_urls_response.rb) #### 🌐 Endpoint `/fetch_urls` `GET` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `carbon.utilities.fetch_youtube_transcripts` Fetches english transcripts from YouTube videos. Args: id (str): The ID of the YouTube video. raw (bool): Whether to return the raw transcript or not. Defaults to False. Returns: dict: A dictionary with the transcript of the YouTube video. #### 🛠️ Usage ```ruby result = carbon.utilities.fetch_youtube_transcripts( id: "id_example", raw: false, ) p result ``` #### ⚙️ Parameters ##### id: `String` ##### raw: `Boolean` #### 🔄 Return [YoutubeTranscriptResponse](./lib/carbon_ruby_sdk/models/youtube_transcript_response.rb) #### 🌐 Endpoint `/fetch_youtube_transcript` `GET` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `carbon.utilities.process_sitemap` Retrieves all URLs from a sitemap, which can subsequently be utilized with our `web_scrape` endpoint. #### 🛠️ Usage ```ruby result = carbon.utilities.process_sitemap( url: "url_example", ) p result ``` #### ⚙️ Parameters ##### url: `String` #### 🌐 Endpoint `/process_sitemap` `GET` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `carbon.utilities.scrape_sitemap` Extracts all URLs from a sitemap and performs a web scrape on each of them. Args: sitemap_url (str): URL of the sitemap Returns: dict: A response object with the status of the scraping job message.--> #### 🛠️ Usage ```ruby result = carbon.utilities.scrape_sitemap( url: "string_example", tags: { "key": "string_example", }, max_pages_to_scrape: 1, chunk_size: 1500, chunk_overlap: 20, skip_embedding_generation: false, enable_auto_sync: false, generate_sparse_vectors: false, prepend_filename_to_chunks: false, html_tags_to_skip: [], css_classes_to_skip: [], css_selectors_to_skip: [], embedding_model: "OPENAI", ) p result ``` #### ⚙️ Parameters ##### url: `String` ##### tags: Hash ##### max_pages_to_scrape: `Integer` ##### chunk_size: `Integer` ##### chunk_overlap: `Integer` ##### skip_embedding_generation: `Boolean` ##### enable_auto_sync: `Boolean` ##### generate_sparse_vectors: `Boolean` ##### prepend_filename_to_chunks: `Boolean` ##### html_tags_to_skip: Array<`String`> ##### css_classes_to_skip: Array<`String`> ##### css_selectors_to_skip: Array<`String`> ##### embedding_model: [`EmbeddingGenerators`](./lib/carbon_ruby_sdk/models/embedding_generators.rb) #### 🌐 Endpoint `/scrape_sitemap` `POST` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `carbon.utilities.scrape_web` Conduct a web scrape on a given webpage URL. Our web scraper is fully compatible with JavaScript and supports recursion depth, enabling you to efficiently extract all content from the target website. #### 🛠️ Usage ```ruby result = carbon.utilities.scrape_web( body: [ { "url" => "url_example", "recursion_depth" => 3, "max_pages_to_scrape" => 100, "chunk_size" => 1500, "chunk_overlap" => 20, "skip_embedding_generation" => false, "enable_auto_sync" => false, "generate_sparse_vectors" => false, "prepend_filename_to_chunks" => false, "html_tags_to_skip" => [], "css_classes_to_skip" => [], "css_selectors_to_skip" => [], "embedding_model" => "OPENAI", } ], ) p result ``` #### ⚙️ body Array<[`WebscrapeRequest`](./lib/carbon_ruby_sdk/models/webscrape_request.rb)> #### 🌐 Endpoint `/web_scrape` `POST` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `carbon.utilities.search_urls` Perform a web search and obtain a list of relevant URLs. As an illustration, when you perform a search for “content related to MRNA,” you will receive a list of links such as the following: - https://tomrenz.substack.com/p/mrna-and-why-it-matters - https://www.statnews.com/2020/11/10/the-story-of-mrna-how-a-once-dismissed-idea-became-a-leading-technology-in-the-covid-vaccine-race/ - https://www.statnews.com/2022/11/16/covid-19-vaccines-were-a-success-but-mrna-still-has-a-delivery-problem/ - https://joomi.substack.com/p/were-still-being-misled-about-how Subsequently, you can submit these links to the web_scrape endpoint in order to retrieve the content of the respective web pages. Args: query (str): Query to search for Returns: FetchURLsResponse: A response object with a list of URLs for a given search query. #### 🛠️ Usage ```ruby result = carbon.utilities.search_urls( query: "query_example", ) p result ``` #### ⚙️ Parameters ##### query: `String` #### 🔄 Return [FetchURLsResponse](./lib/carbon_ruby_sdk/models/fetch_urls_response.rb) #### 🌐 Endpoint `/search_urls` `GET` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `carbon.webhooks.add_url` Add Webhook Url #### 🛠️ Usage ```ruby result = carbon.webhooks.add_url( url: "string_example", ) p result ``` #### ⚙️ Parameters ##### url: `String` #### 🔄 Return [Webhook](./lib/carbon_ruby_sdk/models/webhook.rb) #### 🌐 Endpoint `/add_webhook` `POST` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `carbon.webhooks.delete_url` Delete Webhook Url #### 🛠️ Usage ```ruby result = carbon.webhooks.delete_url( webhook_id: 1, ) p result ``` #### ⚙️ Parameters ##### webhook_id: `Integer` #### 🔄 Return [GenericSuccessResponse](./lib/carbon_ruby_sdk/models/generic_success_response.rb) #### 🌐 Endpoint `/delete_webhook/{webhook_id}` `DELETE` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `carbon.webhooks.urls` Webhook Urls #### 🛠️ Usage ```ruby result = carbon.webhooks.urls( pagination: { "limit" => 10, "offset" => 0, }, order_by: "created_at", order_dir: "desc", filters: { "ids" => [], }, ) p result ``` #### ⚙️ Parameters ##### pagination: [`Pagination`](./lib/carbon_ruby_sdk/models/pagination.rb) ##### order_by: [`WebhookOrderByColumns`](./lib/carbon_ruby_sdk/models/webhook_order_by_columns.rb) ##### order_dir: [`OrderDir`](./lib/carbon_ruby_sdk/models/order_dir.rb) ##### filters: [`WebhookFilters`](./lib/carbon_ruby_sdk/models/webhook_filters.rb) #### 🔄 Return [WebhookQueryResponse](./lib/carbon_ruby_sdk/models/webhook_query_response.rb) #### 🌐 Endpoint `/webhooks` `POST` [🔙 **Back to Table of Contents**](#table-of-contents) --- ## Author This TypeScript package is automatically generated by [Konfig](https://konfigthis.com)