@relevanceai/sdk 1.149.0 → 2.0.1

package/README.md

@@ -5,20 +5,26 @@ npm i @relevanceai/sdk
 ```
 ## Features
 - Node and Browser support
-- Typescript definitions for almost all [relevance.ai](https://relevance.ai/) apis
+- Typescript definitions for almost all [relevanceai.com](https://relevanceai.com/) apis
 - Insert millions of documents with one function call
 - Our SearchBuilder makes searching, filtering, and aggregating your data simple
 # Getting started
-Get started in seconds with a demo dataset of popular movies.
+Get started by creating an account in [cloud.relevanceai.com](https://cloud.relevanceai.com) - select the Vector Database onboarding option. Once set up you can fetch your API key and use the below snippet.
+
 ```javascript
-import {DiscoveryClient,QueryBuilder} from "@relevanceai/sdk";
+import {VecDBClient,QueryBuilder} from "@relevanceai/sdk";
 
-const discovery = new DiscoveryClient({
-  project:'dummy-collections',
-  api_key:'UzdYRktIY0JxNmlvb1NpOFNsenU6VGdTU0s4UjhUR0NsaDdnQTVwUkpKZw',
+const discovery = new VecDBClient({
+  project: '',
+  api_key: '',
+  endpoint: ''
 });
 const dataset = discovery.dataset('1000-movies');
-const {results} = await dataset.search(QueryBuilder().text('Las Vegas'));
+
+const movies = [{ title: 'Lord of the Rings: The Fellowship of the Ring', grenre: 'action', budget: 100 }, ...]
+await dataset.insertDocuments(movies, [{ model_name: 'text-embedding-ada-002', field: 'title' }]);
+
+const {results} = await dataset.search(QueryBuilder().vector('title_vector_', { query: 'LOTR', model: 'text-embeddings-ada-002' }));
 ```
 ## Set up your credentials
 ### Option 1 - Use environment variables
@@ -27,7 +33,7 @@ First, set environment variables in your shell before you run your code.
 set RELEVANCE_PROJECT to your project name.
 
 set RELEVANCE_API_KEY to your api key.
-for more information, view the docs here: [Authorization docs](https://discovery.relevance.ai/reference/api-usage)
+for more information, view the docs here: [Authorization docs](https://discovery.relevanceai.com/reference/api-usage)
 
 Heres a template to copy and paste in for linux environments:
 ```bash
@@ -36,13 +42,13 @@ export RELEVANCE_API_KEY=#########
 ```
 The SDK will use these variables when making api calls. You can then initialise your client like this:
 ```javascript
-import {DiscoveryClient} from "@relevanceai/sdk";
-const discovery = new DiscoveryClient({});
+import {VecDBClient} from "@relevanceai/sdk";
+const client = new VecDBClient({});
 ```
 ### Option 2 - Passing them in code.
 ```javascript
-import {DiscoveryClient} from "@relevanceai/sdk";
-const discovery = new DiscoveryClient({
+import {VecDBClient} from "@relevanceai/sdk";
+const client = new VecDBClient({
   project:'########',
   api_key:'########',
 });
@@ -50,18 +56,18 @@ const discovery = new DiscoveryClient({
 # Examples
 ### You can import builders and type definitions like this
 ```javascript
-import {QueryBuilder,DiscoveryClient,BulkInsertOutput} from "@relevanceai/sdk";
+import {QueryBuilder,VecDBClient,BulkInsertOutput} from "@relevanceai/sdk";
 ```
 ## Insert millions of items with one function call
 ```javascript
-const discovery = new DiscoveryClient({ });
+const discovery = new VecDBClient({ ... });
 const dataset = discovery.dataset('tshirts-prod');
  // Here we create some demo data. Replace this with your real data
 const fakeVector = [];
 for (let i = 0; i < 768; i++) fakeVector.push(1);
 const tshirtsData = [];
 for (let i = 0; i < 10000; i++) {
-  tshirtsData.push({_id:`tshirt-${i}1`,color:'red',price:i/1000,'title_text@1-0_vector_':fakeVector});
+  tshirtsData.push({_id:`tshirt-${i}1`,color:'red',price:i/1000,'title-fake_vector_':fakeVector});
   tshirtsData.push({_id:`tshirt-${i}2`,color:'blue',price:i/1000});
   tshirtsData.push({_id:`tshirt-${i}3`,color:'orange',price:i/1000});
 }
@@ -74,7 +80,7 @@ const res = await dataset.insertDocuments(tshirtsData,{batchSize:10000});
 ## Text Search and Vector Search
 ```javascript
 const builder = QueryBuilder();
-builder.query('red').text().vector('title_text@1-0_vector_',0.5).minimumRelevance(0.1);
+builder.query('red').text().vector('title-fake_vector_',0.5).minimumRelevance(0.1);
 // .text() searches all fields. alternatively, use .text(field1).text(field2)... to search specific fields
 const searchResults = await dataset.search(builder);
 ```
@@ -103,41 +109,13 @@ const filteredItems = await dataset.search(filters);
   aggregateStats: {}
 }
 ```
-## Summarise your data using aggregations
-```javascript
-const aggregates = QueryBuilder();
-aggregates.aggregate('color').aggregateStats('price',10);
-const aggregatesResult = await dataset.search(aggregates);
-```
-### aggregates will output:
-```javascript
-{
-  aggregates:{
-    color: {
-      results: { blue: 10000, orange: 10000, red: 10000 },
-      aggregates: {}
-    },
-    price: {
-      results: {
-        '0': 0000,
-        '10': 3000,
-        '20': 3000,
-        '30': 3000,
-        '40': 3000,
-        '50': 3000,
-        '60': 3000,
-        '70': 3000,
-        '80': 3000,
-        '90': 3000
-      },
-      aggregates: {}
-    }
-  }
-}
+
+
 ```
 ## Call raw api methods directly
 ```javascript
-const rawClient = new DiscoveryApiClient({dataset_id:'tshirts-prod'});
-const {body} = await rawClient.FastSearch({filters:[{match:{key:'_id',value:`tshirt-01`}}]});
+const discovery = new VecDBClient({ ... });
+const dataset = discovery.dataset('tshirts-prod');
+const {body} = await dataset.apiClient.FastSearch({filters:[{match:{key:'_id',value:`tshirt-01`}}]});
 expect((body.results[0] as any).color).toBe('red')
 ```

package/dist-cjs/generated/{DiscoveryApi.js → VecDBApi.js}

@@ -1,10 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DiscoveryApiClient = void 0;
+exports.VecDBApiClient = void 0;
 const BaseClient_1 = require("../shared/BaseClient");
-class DiscoveryApiClient extends BaseClient_1._GenericClient {
+class VecDBApiClient extends BaseClient_1._GenericClient {
     constructor(config) {
-        super({ ...config, service_name: 'DiscoveryApi' });
+        super({ ...config, service_name: 'VecDBApi' });
     }
     async CreateDeployable(input, options) {
         return this.SendRequest({
@@ -166,6 +166,46 @@ class DiscoveryApiClient extends BaseClient_1._GenericClient {
             options
         });
     }
+    async GetProjectsOrgInfo(input, options) {
+        return this.SendRequest({
+            input,
+            method: 'get',
+            path: '/projects/organization_info',
+            options
+        });
+    }
+    async ListProjectKeys(input, options) {
+        return this.SendRequest({
+            input,
+            method: 'get',
+            path: '/projects/keys/list',
+            options
+        });
+    }
+    async GetProjectKey(input, options) {
+        return this.SendRequest({
+            input,
+            method: 'post',
+            path: '/projects/keys/get',
+            options
+        });
+    }
+    async SetProjectKey(input, options) {
+        return this.SendRequest({
+            input,
+            method: 'post',
+            path: '/projects/keys/set',
+            options
+        });
+    }
+    async DeleteProjectKey(input, options) {
+        return this.SendRequest({
+            input,
+            method: 'post',
+            path: '/projects/keys/delete',
+            options
+        });
+    }
     async CreateUser(input, options) {
         return this.SendRequest({
             input,
@@ -430,6 +470,22 @@ class DiscoveryApiClient extends BaseClient_1._GenericClient {
             options
         });
     }
+    async EditOneToManyClusters(input, options) {
+        return this.SendRequest({
+            input,
+            method: 'post',
+            path: '/datasets/{dataset_id}/cluster/one_to_many/edit',
+            options
+        });
+    }
+    async EditListInDocuments(input, options) {
+        return this.SendRequest({
+            input,
+            method: 'post',
+            path: '/datasets/{dataset_id}/documents/edit_list',
+            options
+        });
+    }
     async CreateOrganization(input, options) {
         return this.SendRequest({
             input,
@@ -510,6 +566,38 @@ class DiscoveryApiClient extends BaseClient_1._GenericClient {
             options
         });
     }
+    async ListBillingEvents(input, options) {
+        return this.SendRequest({
+            input,
+            method: 'post',
+            path: '/organizations/{organization_id}/billing/events/list',
+            options
+        });
+    }
+    async CreateBillingEventAdmin(input, options) {
+        return this.SendRequest({
+            input,
+            method: 'post',
+            path: '/admin/organizations/{organization_id}/billing/events/create',
+            options
+        });
+    }
+    async GetBillingFrontendLink(input, options) {
+        return this.SendRequest({
+            input,
+            method: 'get',
+            path: '/organizations/{organization_id}/billing/get_billing_frontend_link',
+            options
+        });
+    }
+    async UpdateOrganizationBilling(input, options) {
+        return this.SendRequest({
+            input,
+            method: 'post',
+            path: '/organizations/{organization_id}/billing/update',
+            options
+        });
+    }
     async CreateConnector(input, options) {
         return this.SendRequest({
             input,
@@ -622,6 +710,14 @@ class DiscoveryApiClient extends BaseClient_1._GenericClient {
             options
         });
     }
+    async GetWorkflowConfig(input, options) {
+        return this.SendRequest({
+            input,
+            method: 'post',
+            path: '/workflows/{workflow_id}/config',
+            options
+        });
+    }
     async DeleteWorkflowStatus(input, options) {
         return this.SendRequest({
             input,
@@ -670,6 +766,54 @@ class DiscoveryApiClient extends BaseClient_1._GenericClient {
             options
         });
     }
+    async SearchWorkflowTypes(input, options) {
+        return this.SendRequest({
+            input,
+            method: 'post',
+            path: '/workflows/types/search',
+            options
+        });
+    }
+    async GetWorkflowTypesAsOpenAPI(input, options) {
+        return this.SendRequest({
+            input,
+            method: 'get',
+            path: '/workflows/types/openapi',
+            options
+        });
+    }
+    async AggregateWorkflowTypes(input, options) {
+        return this.SendRequest({
+            input,
+            method: 'post',
+            path: '/workflows/types/aggregate',
+            options
+        });
+    }
+    async BulkUpdateWorkflowTypesAdmin(input, options) {
+        return this.SendRequest({
+            input,
+            method: 'post',
+            path: '/workflows/types/bulk_update',
+            options
+        });
+    }
+    async UpdateWorkflowTypesVersionAliasesAdmin(input, options) {
+        return this.SendRequest({
+            input,
+            method: 'post',
+            path: '/workflows/types/version_aliases/update',
+            options
+        });
+    }
+    async GetWorkflowTypesVersionAliases(input, options) {
+        return this.SendRequest({
+            input,
+            method: 'post',
+            path: '/workflows/types/version_aliases/get',
+            options
+        });
+    }
     async GetWorkflowType(input, options) {
         return this.SendRequest({
             input,
@@ -710,6 +854,14 @@ class DiscoveryApiClient extends BaseClient_1._GenericClient {
             options
         });
     }
+    async GetTemporaryFileUploadUrl(input, options) {
+        return this.SendRequest({
+            input,
+            method: 'post',
+            path: '/services/get_temporary_file_upload_url',
+            options
+        });
+    }
     async ListFileUploadsForDataset(input, options) {
         return this.SendRequest({
             input,
@@ -742,6 +894,14 @@ class DiscoveryApiClient extends BaseClient_1._GenericClient {
             options
         });
     }
+    async GenerateOnboarding(input, options) {
+        return this.SendRequest({
+            input,
+            method: 'post',
+            path: '/onboard/generate',
+            options
+        });
+    }
     async DeleteDataset(input, options) {
         return this.SendRequest({
             input,
@@ -814,14 +974,6 @@ class DiscoveryApiClient extends BaseClient_1._GenericClient {
             options
         });
     }
-    async GetDatasetUsage(input, options) {
-        return this.SendRequest({
-            input,
-            method: 'post',
-            path: '/datasets/{dataset_id}/monitor/usage',
-            options
-        });
-    }
     async GetVectorMappings(input, options) {
         return this.SendRequest({
             input,
@@ -1102,11 +1254,19 @@ class DiscoveryApiClient extends BaseClient_1._GenericClient {
             options
         });
     }
-    async CreateImageFromPrompt(input, options) {
+    async ListDatasetWorkflowsByFields(input, options) {
         return this.SendRequest({
             input,
-            method: 'post',
-            path: '/services/prompt_to_image/create',
+            method: 'get',
+            path: '/datasets/{dataset_id}/workflows_by_fields',
+            options
+        });
+    }
+    async GetAPIHealth(input, options) {
+        return this.SendRequest({
+            input,
+            method: 'get',
+            path: '/health',
             options
         });
     }
@@ -1254,43 +1414,43 @@ class DiscoveryApiClient extends BaseClient_1._GenericClient {
             options
         });
     }
-    async ListDatasetEditorConfigurations(input, options) {
+    async ListEditorConfigurations(input, options) {
         return this.SendRequest({
             input,
             method: 'post',
-            path: '/datasets/{dataset_id}/editor/configuration/list',
+            path: '/editor/configuration/list',
             options
         });
     }
-    async CreateDatasetEditorConfiguration(input, options) {
+    async CreateEditorConfiguration(input, options) {
         return this.SendRequest({
             input,
             method: 'post',
-            path: '/datasets/{dataset_id}/editor/configuration/create',
+            path: '/editor/configuration/create',
             options
         });
     }
-    async UpdateDatasetEditorConfiguration(input, options) {
+    async UpdateEditorConfiguration(input, options) {
         return this.SendRequest({
             input,
             method: 'post',
-            path: '/datasets/{dataset_id}/editor/configuration/{dataseteditorconfiguration_id}/update',
+            path: '/editor/configuration/{editorconfiguration_id}/update',
             options
         });
     }
-    async DeleteDatasetEditorConfiguration(input, options) {
+    async DeleteEditorConfiguration(input, options) {
         return this.SendRequest({
             input,
             method: 'post',
-            path: '/datasets/{dataset_id}/editor/configuration/{dataseteditorconfiguration_id}/delete',
+            path: '/editor/configuration/{editorconfiguration_id}/delete',
             options
         });
     }
-    async GetDatasetEditorConfiguration(input, options) {
+    async GetEditorConfiguration(input, options) {
         return this.SendRequest({
             input,
             method: 'get',
-            path: '/datasets/{dataset_id}/editor/configuration/{dataseteditorconfiguration_id}/get',
+            path: '/editor/configuration/{editorconfiguration_id}/get',
             options
         });
     }
@@ -1334,6 +1494,14 @@ class DiscoveryApiClient extends BaseClient_1._GenericClient {
             options
         });
     }
+    async BulkDeleteKeyphrases(input, options) {
+        return this.SendRequest({
+            input,
+            method: 'post',
+            path: '/datasets/{dataset_id}/fields/{field}/keyphrase/bulk_delete',
+            options
+        });
+    }
     async ListTaxonomys(input, options) {
         return this.SendRequest({
             input,
@@ -1374,5 +1542,141 @@ class DiscoveryApiClient extends BaseClient_1._GenericClient {
             options
         });
     }
+    async DeleteFavouriteDataset(input, options) {
+        return this.SendRequest({
+            input,
+            method: 'post',
+            path: '/datasets/favourites/{favouritedataset_id}/delete',
+            options
+        });
+    }
+    async ListFavouriteDatasets(input, options) {
+        return this.SendRequest({
+            input,
+            method: 'post',
+            path: '/datasets/favourites/list',
+            options
+        });
+    }
+    async UpdateFavouriteDataset(input, options) {
+        return this.SendRequest({
+            input,
+            method: 'post',
+            path: '/datasets/favourites/{favouritedataset_id}/update',
+            options
+        });
+    }
+    async DeleteFavouriteDeployable(input, options) {
+        return this.SendRequest({
+            input,
+            method: 'post',
+            path: '/deployable/favourites/{favouritedeployable_id}/delete',
+            options
+        });
+    }
+    async ListFavouriteDeployables(input, options) {
+        return this.SendRequest({
+            input,
+            method: 'post',
+            path: '/deployable/favourites/list',
+            options
+        });
+    }
+    async UpdateFavouriteDeployable(input, options) {
+        return this.SendRequest({
+            input,
+            method: 'post',
+            path: '/deployable/favourites/{favouritedeployable_id}/update',
+            options
+        });
+    }
+    async DeleteUserOnboardingFlag(input, options) {
+        return this.SendRequest({
+            input,
+            method: 'post',
+            path: '/useronboardingflags/{useronboardingflag_id}/delete',
+            options
+        });
+    }
+    async ListUserOnboardingFlags(input, options) {
+        return this.SendRequest({
+            input,
+            method: 'post',
+            path: '/useronboardingflags/list',
+            options
+        });
+    }
+    async UpdateUserOnboardingFlag(input, options) {
+        return this.SendRequest({
+            input,
+            method: 'post',
+            path: '/useronboardingflags/{useronboardingflag_id}/update',
+            options
+        });
+    }
+    async GetTranscriptTagList(input, options) {
+        return this.SendRequest({
+            input,
+            method: 'get',
+            path: '/datasets/{dataset_id}/fields/{field}/transcript_tags/{transcripttaglist_id}/get',
+            options
+        });
+    }
+    async UpdateTranscriptTagList(input, options) {
+        return this.SendRequest({
+            input,
+            method: 'post',
+            path: '/datasets/{dataset_id}/fields/{field}/transcript_tags/{transcripttaglist_id}/update',
+            options
+        });
+    }
+    async ListTranscriptTagLists(input, options) {
+        return this.SendRequest({
+            input,
+            method: 'post',
+            path: '/datasets/{dataset_id}/fields/{field}/transcript_tags/list',
+            options
+        });
+    }
+    async ListTags(input, options) {
+        return this.SendRequest({
+            input,
+            method: 'post',
+            path: '/datasets/{dataset_id}/field/{tag_field}/tags/list',
+            options
+        });
+    }
+    async DeleteTag(input, options) {
+        return this.SendRequest({
+            input,
+            method: 'post',
+            path: '/datasets/{dataset_id}/field/{tag_field}/tags/{tag_id}/delete',
+            options
+        });
+    }
+    async GetTag(input, options) {
+        return this.SendRequest({
+            input,
+            method: 'get',
+            path: '/datasets/{dataset_id}/field/{tag_field}/tags/{tag_id}/get',
+            options
+        });
+    }
+    async BulkDeleteTags(input, options) {
+        return this.SendRequest({
+            input,
+            method: 'post',
+            path: '/datasets/{dataset_id}/field/{tag_field}/tags/bulk_delete',
+            options
+        });
+    }
+    async BulkUpdateTags(input, options) {
+        return this.SendRequest({
+            input,
+            method: 'post',
+            path: '/datasets/{dataset_id}/field/{tag_field}/tags/bulk_update',
+            options
+        });
+    }
 }
-exports.DiscoveryApiClient = DiscoveryApiClient;
+exports.VecDBApiClient = VecDBApiClient;

package/dist-cjs/generated/index.js

@@ -14,4 +14,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./DiscoveryApi"), exports);
+__exportStar(require("./VecDBApi"), exports);

package/dist-cjs/index.js

@@ -15,4 +15,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./generated"), exports);
-// export * from './services';
+__exportStar(require("./services"), exports);

package/dist-cjs/services/index.js

@@ -1,3 +1,18 @@
 "use strict";
-// Not interested in this right now
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
 // export * from './discovery';
+__exportStar(require("./vecdb"), exports);