Skip to content

Latest commit

 

History

History
250 lines (228 loc) · 15.5 KB

README.md

File metadata and controls

250 lines (228 loc) · 15.5 KB
Raw

Visit Carbon

Carbon

Connect external data to LLMs, no matter the source.

Go Reference

Installation

Add to your project:

go get github.com/Carbon-for-Developers/carbon-sdks/go

Getting Started

package main

import (
	"fmt"

	carbon "github.com/Carbon-for-Developers/carbon-sdks/go"
)

func main() {
	// 1) Get an access token
	configuration := carbon.NewConfiguration()
	configuration.SetApiKey("API_KEY")
	configuration.SetCustomerId("CUSTOMER_ID")
	client := carbon.NewAPIClient(configuration)
	accessTokenRequest := client.AuthApi.GetAccessToken()
	accessTokenResponse, _, _ := accessTokenRequest.Execute()
	accessToken := accessTokenResponse.GetAccessToken()

	// 2) Use the access token to make requests
	configuration = carbon.NewConfiguration()
	configuration.SetAccessToken(accessToken)
	client = carbon.NewAPIClient(configuration)

	whiteLabelingRequest := client.AuthApi.GetWhiteLabeling()
	whiteLabelingResponse, _, _ := whiteLabelingRequest.Execute()
	integrations := whiteLabelingResponse.GetIntegrations()
	fmt.Println(integrations)
}

Documentation for API Endpoints

All URIs are relative to https://api.carbon.ai

Class Method HTTP request Description
AuthApi GetAccessToken Get /auth/v1/access_token Get Access Token
AuthApi GetWhiteLabeling Get /auth/v1/white_labeling Get White Labeling
DataSourcesApi QueryUserDataSources Post /user_data_sources User Data Sources
DataSourcesApi RevokeAccessToken Post /revoke_access_token Revoke Access Token
EmbeddingsApi GetDocuments Post /embeddings Embeddings
EmbeddingsApi GetEmbeddingsAndChunks Post /text_chunks Retrieve Embeddings And Content
EmbeddingsApi UploadChunksAndEmbeddings Post /upload_chunks_and_embeddings Upload Chunks And Embeddings
FilesApi CreateUserFileTags Post /create_user_file_tags Create File Tags
FilesApi Delete Delete /deletefile/{file_id} Delete File Endpoint
FilesApi DeleteFileTags Post /delete_user_file_tags Delete File Tags
FilesApi DeleteMany Post /delete_files Delete Files Endpoint
FilesApi DeleteV2 Post /delete_files_v2 Delete Files V2 Endpoint
FilesApi GetParsedFile Get /parsed_file/{file_id} Parsed File
FilesApi GetRawFile Get /raw_file/{file_id} Raw File
FilesApi QueryUserFiles Post /user_files_v2 User Files V2
FilesApi QueryUserFilesDeprecated Post /user_files User Files
FilesApi Resync Post /resync_file Resync File
FilesApi Upload Post /uploadfile Create Upload File
FilesApi UploadFromUrl Post /upload_file_from_url Create Upload File From Url
FilesApi UploadText Post /upload_text Create Raw Text
HealthApi Check Get /health Health
IntegrationsApi ConnectDataSource Post /integrations/connect Connect Data Source
IntegrationsApi ConnectFreshdesk Post /integrations/freshdesk Freshdesk Connect
IntegrationsApi ConnectGitbook Post /integrations/gitbook Gitbook Connect
IntegrationsApi CreateAwsIamUser Post /integrations/s3 S3 Auth
IntegrationsApi GetOauthUrl Post /integrations/oauth_url Get Oauth Url
IntegrationsApi ListConfluencePages Post /integrations/confluence/list Confluence List
IntegrationsApi ListDataSourceItems Post /integrations/items/list List Data Source Items
IntegrationsApi ListFolders Get /integrations/outlook/user_folders Outlook Folders
IntegrationsApi ListGitbookSpaces Get /integrations/gitbook/spaces Gitbook Spaces
IntegrationsApi ListLabels Get /integrations/gmail/user_labels Gmail Labels
IntegrationsApi ListOutlookCategories Get /integrations/outlook/user_categories Outlook Categories
IntegrationsApi ListRepos Get /integrations/github/repos Github List Repos
IntegrationsApi SyncConfluence Post /integrations/confluence/sync Confluence Sync
IntegrationsApi SyncDataSourceItems Post /integrations/items/sync Sync Data Source Items
IntegrationsApi SyncFiles Post /integrations/files/sync Sync Files
IntegrationsApi SyncGitHub Post /integrations/github Github Connect
IntegrationsApi SyncGitbook Post /integrations/gitbook/sync Gitbook Sync
IntegrationsApi SyncGmail Post /integrations/gmail/sync Gmail Sync
IntegrationsApi SyncOutlook Post /integrations/outlook/sync Outlook Sync
IntegrationsApi SyncRepos Post /integrations/github/sync_repos Github Sync Repos
IntegrationsApi SyncRssFeed Post /integrations/rss_feed Rss Feed
IntegrationsApi SyncS3Files Post /integrations/s3/files S3 Files
OrganizationsApi Get Get /organization Get Organization
OrganizationsApi Update Post /organization/update Update Organization
UsersApi Delete Post /delete_users Delete Users
UsersApi Get Post /user User Endpoint
UsersApi ToggleUserFeatures Post /modify_user_configuration Toggle User Features
UsersApi UpdateUsers Post /update_users Update Users
UtilitiesApi FetchUrls Get /fetch_urls Fetch Urls
UtilitiesApi FetchYoutubeTranscripts Get /fetch_youtube_transcript Fetch Youtube Transcripts
UtilitiesApi ProcessSitemap Get /process_sitemap Sitemap
UtilitiesApi ScrapeSitemap Post /scrape_sitemap Scrape Sitemap
UtilitiesApi ScrapeWeb Post /web_scrape Web Scrape
UtilitiesApi SearchUrls Get /search_urls Search Urls
WebhooksApi AddUrl Post /add_webhook Add Webhook Url
WebhooksApi DeleteUrl Delete /delete_webhook/{webhook_id} Delete Webhook Url
WebhooksApi Urls Post /webhooks Webhook Urls

Documentation For Models