carbon_ruby_sdk 0.1.0

data/spec/api/organizations_api_spec.rb

@@ -0,0 +1,39 @@
+=begin
+#Carbon
+
+#Connect external data to LLMs, no matter the source.
+
+The version of the OpenAPI document: 1.0.0
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Carbon::OrganizationsApi
+describe 'OrganizationsApi' do
+  before do
+    # run before each test
+    @api_instance = Carbon::OrganizationsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of OrganizationsApi' do
+    it 'should create an instance of OrganizationsApi' do
+      expect(@api_instance).to be_instance_of(Carbon::OrganizationsApi)
+    end
+  end
+
+  # unit tests for get
+  # Get Organization
+  # @param [Hash] opts the optional parameters
+  # @return [OrganizationResponse]
+  describe 'get test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/users_api_spec.rb

@@ -0,0 +1,51 @@
+=begin
+#Carbon
+
+#Connect external data to LLMs, no matter the source.
+
+The version of the OpenAPI document: 1.0.0
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Carbon::UsersApi
+describe 'UsersApi' do
+  before do
+    # run before each test
+    @api_instance = Carbon::UsersApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of UsersApi' do
+    it 'should create an instance of UsersApi' do
+      expect(@api_instance).to be_instance_of(Carbon::UsersApi)
+    end
+  end
+
+  # unit tests for get
+  # User Endpoint
+  # @param user_request_content 
+  # @param [Hash] opts the optional parameters
+  # @return [UserResponse]
+  describe 'get test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for toggle_user_features
+  # Toggle User Features
+  # @param modify_user_configuration_input 
+  # @param [Hash] opts the optional parameters
+  # @return [GenericSuccessResponse]
+  describe 'toggle_user_features test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/utilities_api_spec.rb

@@ -0,0 +1,102 @@
+=begin
+#Carbon
+
+#Connect external data to LLMs, no matter the source.
+
+The version of the OpenAPI document: 1.0.0
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Carbon::UtilitiesApi
+describe 'UtilitiesApi' do
+  before do
+    # run before each test
+    @api_instance = Carbon::UtilitiesApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of UtilitiesApi' do
+    it 'should create an instance of UtilitiesApi' do
+      expect(@api_instance).to be_instance_of(Carbon::UtilitiesApi)
+    end
+  end
+
+  # unit tests for fetch_urls
+  # 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.
+  # @param url 
+  # @param [Hash] opts the optional parameters
+  # @return [FetchURLsResponse]
+  describe 'fetch_urls test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for fetch_youtube_transcripts
+  # 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.
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @option opts [Boolean] :raw 
+  # @return [YoutubeTranscriptResponse]
+  describe 'fetch_youtube_transcripts test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for process_sitemap
+  # Sitemap
+  # Retrieves all URLs from a sitemap, which can subsequently be utilized with our `web_scrape` endpoint.  <!--Args:     url (str): URL of the sitemap  Returns:     dict: A dictionary with a list of URLs extracted from the sitemap.-->
+  # @param url 
+  # @param [Hash] opts the optional parameters
+  # @return [Object]
+  describe 'process_sitemap test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for scrape_sitemap
+  # 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.-->
+  # @param sitemap_scrape_request 
+  # @param [Hash] opts the optional parameters
+  # @return [Object]
+  describe 'scrape_sitemap test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for scrape_web
+  # Web Scrape
+  # 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.  <!--Args:     scraping_requests (List[WebscrapeRequest]): A list of WebscrapeRequest objects.       Returns:     dict: A response object with the status of the scraping job message.-->
+  # @param webscrape_request 
+  # @param [Hash] opts the optional parameters
+  # @return [Object]
+  describe 'scrape_web test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for search_urls
+  # 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.
+  # @param query 
+  # @param [Hash] opts the optional parameters
+  # @return [FetchURLsResponse]
+  describe 'search_urls test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/webhooks_api_spec.rb

@@ -0,0 +1,62 @@
+=begin
+#Carbon
+
+#Connect external data to LLMs, no matter the source.
+
+The version of the OpenAPI document: 1.0.0
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Carbon::WebhooksApi
+describe 'WebhooksApi' do
+  before do
+    # run before each test
+    @api_instance = Carbon::WebhooksApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of WebhooksApi' do
+    it 'should create an instance of WebhooksApi' do
+      expect(@api_instance).to be_instance_of(Carbon::WebhooksApi)
+    end
+  end
+
+  # unit tests for add_url
+  # Add Webhook Url
+  # @param add_webhook_props 
+  # @param [Hash] opts the optional parameters
+  # @return [Webhook]
+  describe 'add_url test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for delete_url
+  # Delete Webhook Url
+  # @param webhook_id 
+  # @param [Hash] opts the optional parameters
+  # @return [GenericSuccessResponse]
+  describe 'delete_url test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for urls
+  # Webhook Urls
+  # @param webhook_query_input 
+  # @param [Hash] opts the optional parameters
+  # @return [WebhookQueryResponse]
+  describe 'urls test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api_client_spec.rb

@@ -0,0 +1,191 @@
+=begin
+#Carbon
+
+#Connect external data to LLMs, no matter the source.
+
+The version of the OpenAPI document: 1.0.0
+=end
+
+require 'spec_helper'
+
+describe Carbon::ApiClient do
+  context 'initialization' do
+    context 'URL stuff' do
+      context 'host' do
+        it 'removes http from host' do
+
+          configuration = Carbon::Configuration.new
+          configuration.host = 'http://example.com'
+          expect(configuration.host).to eq('example.com')
+        end
+
+        it 'removes https from host' do
+          configuration = Carbon::Configuration.new
+          configuration.host = 'https://wookiee.com'
+          expect(configuration.host).to eq('wookiee.com')
+        end
+
+        it 'removes trailing path from host' do
+          configuration = Carbon::Configuration.new
+          configuration.host = 'hello.com/v4'
+          expect(configuration.host).to eq('hello.com')
+        end
+      end
+
+      context 'base_path' do
+        it "prepends a slash to base_path" do
+          configuration = Carbon::Configuration.new
+          configuration.base_path = 'v4/dog'
+          expect(configuration.base_path).to eq('/v4/dog')
+        end
+
+        it "doesn't prepend a slash if one is already there" do
+          configuration = Carbon::Configuration.new
+          configuration.base_path = '/v4/dog'
+          expect(configuration.base_path).to eq('/v4/dog')
+        end
+
+        it "ends up as a blank string if nil" do
+          configuration = Carbon::Configuration.new
+          configuration.base_path = nil
+          expect(configuration.base_path).to eq('')
+        end
+      end
+    end
+  end
+
+  describe '#deserialize' do
+    it "handles Array<Integer>" do
+      api_client = Carbon::ApiClient.new
+      headers = { 'Content-Type' => 'application/json' }
+      response = double('response', headers: headers, body: '[12, 34]')
+      data = api_client.deserialize(response, 'Array<Integer>')
+      expect(data).to be_instance_of(Array)
+      expect(data).to eq([12, 34])
+    end
+
+    it 'handles Array<Array<Integer>>' do
+      api_client = Carbon::ApiClient.new
+      headers = { 'Content-Type' => 'application/json' }
+      response = double('response', headers: headers, body: '[[12, 34], [56]]')
+      data = api_client.deserialize(response, 'Array<Array<Integer>>')
+      expect(data).to be_instance_of(Array)
+      expect(data).to eq([[12, 34], [56]])
+    end
+
+    it 'handles Hash<String, String>' do
+      api_client = Carbon::ApiClient.new
+      headers = { 'Content-Type' => 'application/json' }
+      response = double('response', headers: headers, body: '{"message": "Hello"}')
+      data = api_client.deserialize(response, 'Hash<String, String>')
+      expect(data).to be_instance_of(Hash)
+      expect(data).to eq(:message => 'Hello')
+    end
+  end
+
+  describe "#object_to_hash" do
+    it 'ignores nils and includes empty arrays' do
+      # uncomment below to test object_to_hash for model
+      # api_client = Carbon::ApiClient.new
+      # _model = Carbon::ModelName.new
+      # update the model attribute below
+      # _model.id = 1
+      # update the expected value (hash) below
+      # expected = {id: 1, name: '', tags: []}
+      # expect(api_client.object_to_hash(_model)).to eq(expected)
+    end
+  end
+
+  describe '#build_collection_param' do
+    let(:param) { ['aa', 'bb', 'cc'] }
+    let(:api_client) { Carbon::ApiClient.new }
+
+    it 'works for csv' do
+      expect(api_client.build_collection_param(param, :csv)).to eq('aa,bb,cc')
+    end
+
+    it 'works for ssv' do
+      expect(api_client.build_collection_param(param, :ssv)).to eq('aa bb cc')
+    end
+
+    it 'works for tsv' do
+      expect(api_client.build_collection_param(param, :tsv)).to eq("aa\tbb\tcc")
+    end
+
+    it 'works for pipes' do
+      expect(api_client.build_collection_param(param, :pipes)).to eq('aa|bb|cc')
+    end
+
+    it 'works for multi' do
+      expect(api_client.build_collection_param(param, :multi)).to eq(['aa', 'bb', 'cc'])
+    end
+
+    it 'fails for invalid collection format' do
+      expect { api_client.build_collection_param(param, :INVALID) }.to raise_error(RuntimeError, 'unknown collection format: :INVALID')
+    end
+  end
+
+  describe '#json_mime?' do
+    let(:api_client) { Carbon::ApiClient.new }
+
+    it 'works' do
+      expect(api_client.json_mime?(nil)).to eq false
+      expect(api_client.json_mime?('')).to eq false
+
+      expect(api_client.json_mime?('application/json')).to eq true
+      expect(api_client.json_mime?('application/json; charset=UTF8')).to eq true
+      expect(api_client.json_mime?('APPLICATION/JSON')).to eq true
+
+      expect(api_client.json_mime?('application/xml')).to eq false
+      expect(api_client.json_mime?('text/plain')).to eq false
+      expect(api_client.json_mime?('application/jsonp')).to eq false
+    end
+  end
+
+  describe '#select_header_accept' do
+    let(:api_client) { Carbon::ApiClient.new }
+
+    it 'works' do
+      expect(api_client.select_header_accept(nil)).to be_nil
+      expect(api_client.select_header_accept([])).to be_nil
+
+      expect(api_client.select_header_accept(['application/json'])).to eq('application/json')
+      expect(api_client.select_header_accept(['application/xml', 'application/json; charset=UTF8'])).to eq('application/json; charset=UTF8')
+      expect(api_client.select_header_accept(['APPLICATION/JSON', 'text/html'])).to eq('APPLICATION/JSON')
+
+      expect(api_client.select_header_accept(['application/xml'])).to eq('application/xml')
+      expect(api_client.select_header_accept(['text/html', 'application/xml'])).to eq('text/html,application/xml')
+    end
+  end
+
+  describe '#select_header_content_type' do
+    let(:api_client) { Carbon::ApiClient.new }
+
+    it 'works' do
+      expect(api_client.select_header_content_type(nil)).to be_nil
+      expect(api_client.select_header_content_type([])).to be_nil
+
+      expect(api_client.select_header_content_type(['application/json'])).to eq('application/json')
+      expect(api_client.select_header_content_type(['application/xml', 'application/json; charset=UTF8'])).to eq('application/json; charset=UTF8')
+      expect(api_client.select_header_content_type(['APPLICATION/JSON', 'text/html'])).to eq('APPLICATION/JSON')
+      expect(api_client.select_header_content_type(['application/xml'])).to eq('application/xml')
+      expect(api_client.select_header_content_type(['text/plain', 'application/xml'])).to eq('text/plain')
+    end
+  end
+
+  describe '#sanitize_filename' do
+    let(:api_client) { Carbon::ApiClient.new }
+
+    it 'works' do
+      expect(api_client.sanitize_filename('sun')).to eq('sun')
+      expect(api_client.sanitize_filename('sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('../sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('/var/tmp/sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('./sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('..\sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('\var\tmp\sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('c:\var\tmp\sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('.\sun.gif')).to eq('sun.gif')
+    end
+  end
+end

data/spec/configuration_spec.rb

@@ -0,0 +1,38 @@
+=begin
+#Carbon
+
+#Connect external data to LLMs, no matter the source.
+
+The version of the OpenAPI document: 1.0.0
+=end
+
+require 'spec_helper'
+
+describe Carbon::Configuration do
+  let(:config) { Carbon::Configuration.default }
+
+  before(:each) do
+    # uncomment below to setup host and base_path
+    # require 'URI'
+    # uri = URI.parse("https://api.carbon.ai")
+    # Carbon.configure do |c|
+    #   c.host = uri.host
+    #   c.base_path = uri.path
+    # end
+  end
+
+  describe '#base_url' do
+    it 'should have the default value' do
+      # uncomment below to test default value of the base path
+      # expect(config.base_url).to eq("https://api.carbon.ai")
+    end
+
+    it 'should remove trailing slashes' do
+      [nil, '', '/', '//'].each do |base_path|
+        config.base_path = base_path
+        # uncomment below to test trailing slashes
+        # expect(config.base_url).to eq("https://api.carbon.ai")
+      end
+    end
+  end
+end

data/spec/getting_started_spec.rb

@@ -0,0 +1,196 @@
+require 'spec_helper'
+require 'json'
+require 'securerandom'
+require 'debug'
+
+describe 'GettingStarted' do
+  before do
+    Carbon.access_token = "YOUR API KEY"
+    Carbon.api_key = "YOUR API KEY"
+    Carbon.customer_id = "YOUR API KEY"
+    Carbon.host = "http://127.0.0.1:4010"
+  end
+
+  after do
+  end
+
+  it 'Utilities.scrape_web' do
+    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",
+            }
+        ],
+    )
+    expect(result).to_not be_nil
+  end
+
+  it 'data_sources.query_user_data_sources' do
+    configuration = Carbon::Configuration.new
+    configuration.access_token = 'YOUR API KEY'
+    configuration.api_key = 'YOUR API KEY'
+    configuration.customer_id = 'YOUR API KEY'
+    configuration.host = 'http://127.0.0.1:4010'
+    carbon = Carbon::Client.new(configuration)
+    pagination = {
+        "limit" => 10,
+        "offset" => 0,
+    }
+    order_by = "created_at"
+    order_dir = "desc"
+    filters = {
+            "source" => "GOOGLE_DRIVE",
+        }
+    result = carbon.data_sources.query_user_data_sources(
+      pagination: pagination,
+      order_by: order_by,
+      order_dir: order_dir,
+      filters: filters,
+    )
+    p result
+  end
+
+  it 'data_sources.query_user_data_sources static pattern' do
+      result = Carbon::DataSources.query_user_data_sources(
+        pagination: {
+          "limit" => 10,
+          "offset" => 0,
+        },
+        order_by: "created_at",
+        order_dir: "desc",
+        filters: {
+          "source" => "GOOGLE_DRIVE",
+        },
+      )
+
+      # assert result is not nil
+      expect(result).to_not be_nil
+  end
+
+  it 'integrations.sync_gitbook' do
+    result = Carbon::Integrations.sync_gitbook_with_http_info(
+      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,
+    )
+    expect(result).to_not be_nil
+    expect(result.data).to_not be_nil
+    expect(result.status_code).to eq(200)
+    expect(result.headers).to_not be_nil
+    expect(result.response).to_not be_nil
+  end
+
+  it 'embedding.get_documents' do
+    configuration = Carbon::Configuration.new
+    configuration.access_token = 'YOUR API KEY'
+    configuration.api_key = 'YOUR API KEY'
+    configuration.customer_id = 'YOUR API KEY'
+    configuration.host = 'http://127.0.0.1:4010'
+    carbon = Carbon::Client.new(configuration)
+    result = carbon.embeddings.get_documents(
+      query: "a",
+      k: 1,
+      tags: {
+            "key": "string_example",
+        },
+      query_vector: [
+            3.14
+        ],
+      file_ids: [
+            1
+        ],
+      parent_file_ids: [
+            1
+        ],
+      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",
+    )
+    expect(result).to_not be_nil
+  end
+
+  it 'Webhooks.urls' do
+    result = Carbon::Webhooks.urls(
+      pagination: {
+            "limit" => 10,
+            "offset" => 0,
+        },
+      order_by: "created_at",
+      order_dir: "desc",
+      filters: {
+            "ids" => [],
+        },
+    )
+    expect(result).to_not be_nil
+  end
+
+  it 'Embeddings.upload_chunks_and_embeddings' do
+    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",
+                        "embedding" => [
+                            3.14
+                        ],
+                    }
+                ],
+            }
+        ],
+      overwrite_existing: false,
+    )
+    expect(result).to_not be_nil
+  end
+
+  it 'files.upload' do
+    # read from directory of this file ../README.md to file
+    file = File.open(File.join(File.dirname(__FILE__), "../README.md"), "rb")
+
+    result = Carbon::Files.upload(
+      file: file,
+      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,
+    )
+    expect(result).to_not be_nil
+  end
+end