@relevanceai/sdk 1.0.0 → 1.5.0

package/README.md

@@ -11,15 +11,14 @@ npm i @relevanceai/sdk
 # Getting started
 Get started in seconds with a demo dataset of popular movies.
 ```javascript
-import {DiscoveryClient} from "@relevanceai/sdk";
+import {DiscoveryClient,QueryBuilder} from "@relevanceai/sdk";
 
 const discovery = new DiscoveryClient({
   project:'dummy-collections',
   api_key:'UzdYRktIY0JxNmlvb1NpOFNsenU6VGdTU0s4UjhUR0NsaDdnQTVwUkpKZw',
-  dataset_id:'1000-movies'
 });
-const {body} = await discovery.SimpleSearchPost( {query:'Las Vegas'} });
-console.log(body.results);
+const dataset = discovery.dataset('1000-movies');
+const {results} = await dataset.search(QueryBuilder().text('Las Vegas'));
 ```
 ## Set up your credentials
 ### Option 1 - Use environment variables
@@ -57,18 +56,27 @@ import {QueryBuilder,DiscoveryClient,BulkInsertOutput} from "@relevanceai/sdk";
 ```javascript
 const discovery = new DiscoveryClient({ });
 const dataset = discovery.dataset('tshirts-prod');
-// Here we create some demo data. Replace this with your real data
+ // 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 < 100000; i++) {
-    tshirtsData.push({_id:`tshirt-${i}1`,color:'red',price:i/1000});
-    tshirtsData.push({_id:`tshirt-${i}2`,color:'blue',price:i/1000});
-    tshirtsData.push({_id:`tshirt-${i}3`,color:'orange',price:i/1000});
+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}2`,color:'blue',price:i/1000});
+  tshirtsData.push({_id:`tshirt-${i}3`,color:'orange',price:i/1000});
 }
-const res = await dataset.insertDocuments(tshirtsData,{batchSize:50000});
+const res = await dataset.insertDocuments(tshirtsData,{batchSize:10000});
 ```
 ### insertDocuments will output:
 ```javascript
-{"inserted":300000,"failed_documents":[]}
+{"inserted":30000,"failed_documents":[]}
+```
+## Text Search and Vector Search
+```javascript
+const builder = QueryBuilder();
+builder.query('red').text().vector('title_text@1-0_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);
 ```
 ## Filter and retrieve items
 ```javascript
@@ -89,7 +97,7 @@ const filteredItems = await dataset.search(filters);
     }
     ...
   ],
-  resultsSize: 102000,
+  resultsSize: 10200,
   aggregations: {},
   aggregates: {},
   aggregateStats: {}
@@ -106,21 +114,21 @@ const aggregatesResult = await dataset.search(aggregates);
 {
   aggregates:{
     color: {
-      results: { blue: 100000, orange: 100000, red: 100000 },
+      results: { blue: 10000, orange: 10000, red: 10000 },
       aggregates: {}
     },
     price: {
       results: {
-        '0': 30000,
-        '10': 30000,
-        '20': 30000,
-        '30': 30000,
-        '40': 30000,
-        '50': 30000,
-        '60': 30000,
-        '70': 30000,
-        '80': 30000,
-        '90': 30000
+        '0': 0000,
+        '10': 3000,
+        '20': 3000,
+        '30': 3000,
+        '40': 3000,
+        '50': 3000,
+        '60': 3000,
+        '70': 3000,
+        '80': 3000,
+        '90': 3000
       },
       aggregates: {}
     }

package/dist-cjs/generated/VectorApi.js

@@ -302,6 +302,30 @@ class VectorApiClient extends BaseClient_1._GenericClient {
             options
         });
     }
+    async encodebymodelapidatasetsdatasetidvectorizepost(input, options) {
+        return this.SendRequest({
+            input,
+            method: 'post',
+            path: '/datasets/{dataset_id}/vectorize',
+            options
+        });
+    }
+    async taskstatusbymodelapidatasetsdatasetidtaskstatusget(input, options) {
+        return this.SendRequest({
+            input,
+            method: 'get',
+            path: '/datasets/{dataset_id}/task_status',
+            options
+        });
+    }
+    async listtasksapidatasetsdatasetidtasksget(input, options) {
+        return this.SendRequest({
+            input,
+            method: 'get',
+            path: '/datasets/{dataset_id}/tasks',
+            options
+        });
+    }
     async vectorsearchapiservicessearchvectorpost(input, options) {
         return this.SendRequest({
             input,
@@ -406,6 +430,14 @@ class VectorApiClient extends BaseClient_1._GenericClient {
             options
         });
     }
+    async clustercentroidsapiv2servicesclustercentroidslistpost(input, options) {
+        return this.SendRequest({
+            input,
+            method: 'post',
+            path: '/services/cluster/centroids/list',
+            options
+        });
+    }
     async clustercentroidsgetapiservicesclustercentroidsgetget(input, options) {
         return this.SendRequest({
             input,
@@ -414,7 +446,15 @@ class VectorApiClient extends BaseClient_1._GenericClient {
             options
         });
     }
-    async insertclustercentroidsapiservicesclustercentroidsinsertpost(input, options) {
+    async clustercentroidsgetapiservicesclustercentroidsgetpost(input, options) {
+        return this.SendRequest({
+            input,
+            method: 'post',
+            path: '/services/cluster/centroids/get',
+            options
+        });
+    }
+    async insertclustercentroids2apiservicesclustercentroidsinsertpost(input, options) {
         return this.SendRequest({
             input,
             method: 'post',
@@ -422,6 +462,38 @@ class VectorApiClient extends BaseClient_1._GenericClient {
             options
         });
     }
+    async updatecentroidsapiv2servicesclustercentroidsupdatepost(input, options) {
+        return this.SendRequest({
+            input,
+            method: 'post',
+            path: '/services/cluster/centroids/update',
+            options
+        });
+    }
+    async deletecentroidsapiservicesclustercentroidscentroididdeleteget(input, options) {
+        return this.SendRequest({
+            input,
+            method: 'get',
+            path: '/services/cluster/centroids/{centroid_id}/delete',
+            options
+        });
+    }
+    async deletecentroidsapiservicesclustercentroidscentroididdeletepost(input, options) {
+        return this.SendRequest({
+            input,
+            method: 'post',
+            path: '/services/cluster/centroids/{centroid_id}/delete',
+            options
+        });
+    }
+    async clustercentroidsdeleteapiservicesclustercentroidsdeletepost(input, options) {
+        return this.SendRequest({
+            input,
+            method: 'post',
+            path: '/services/cluster/centroids/delete',
+            options
+        });
+    }
     async clustercentroidsgetapiservicesclustercentroidsdocumentspost(input, options) {
         return this.SendRequest({
             input,
@@ -430,7 +502,39 @@ class VectorApiClient extends BaseClient_1._GenericClient {
             options
         });
     }
-    async clusteraggregateapiservicesclusteraggregatepost(input, options) {
+    async centroidsmetadatagetapiservicesclustercentroidsmetadataget(input, options) {
+        return this.SendRequest({
+            input,
+            method: 'get',
+            path: '/services/cluster/centroids/metadata',
+            options
+        });
+    }
+    async centroidsmetadatapostapiv2servicesclustercentroidsmetadatapost(input, options) {
+        return this.SendRequest({
+            input,
+            method: 'post',
+            path: '/services/cluster/centroids/metadata',
+            options
+        });
+    }
+    async centroidslistclosesttocenterv2servicesclustercentroidslistclosesttocenterpost(input, options) {
+        return this.SendRequest({
+            input,
+            method: 'post',
+            path: '/services/cluster/centroids/list_closest_to_center',
+            options
+        });
+    }
+    async centroidslistfurthestfromcenterv2servicesclustercentroidslistfurthestfromcenterpost(input, options) {
+        return this.SendRequest({
+            input,
+            method: 'post',
+            path: '/services/cluster/centroids/list_furthest_from_center',
+            options
+        });
+    }
+    async clusteraggregateapiv2servicesclusteraggregatepost(input, options) {
         return this.SendRequest({
             input,
             method: 'post',
@@ -438,7 +542,7 @@ class VectorApiClient extends BaseClient_1._GenericClient {
             options
         });
     }
-    async clusterfacetsapiservicesclusterfacetsget(input, options) {
+    async advancedclusterfacetsapiservicesclusterfacetsget(input, options) {
         return this.SendRequest({
             input,
             method: 'get',
@@ -446,6 +550,22 @@ class VectorApiClient extends BaseClient_1._GenericClient {
             options
         });
     }
+    async clusterlistservicesclusterlistget(input, options) {
+        return this.SendRequest({
+            input,
+            method: 'get',
+            path: '/services/cluster/list',
+            options
+        });
+    }
+    async clusterlistmultiservicesclusterlistpost(input, options) {
+        return this.SendRequest({
+            input,
+            method: 'post',
+            path: '/services/cluster/list',
+            options
+        });
+    }
     async tagapiservicestaggertagpost(input, options) {
         return this.SendRequest({
             input,

package/dist-cjs/services/discovery/Dataset.js

@@ -27,8 +27,11 @@ class Dataset {
             if (arg instanceof _1._QueryBuilder) {
                 payload = { ...payload, ...arg.build() };
             }
-            else
+            else {
                 options = arg;
+                if (options.rawPayload)
+                    payload = { ...payload, ...options.rawPayload };
+            }
         }
         const reqCallback = async () => await this.client.apiClient.SimpleSearchPost(payload, { dataset_id: this.name });
         if (options.debounce && this.debounceTimer) {
@@ -67,7 +70,9 @@ class Dataset {
                     results.push(res);
                     break;
                 }
-                catch (e) { }
+                catch (e) {
+                    console.error(`Bulk operation failed with error, retrying - ${e}`);
+                }
             }
         }
         return results;
@@ -90,7 +95,7 @@ class Dataset {
         return finalResults;
     }
     async updateDocumentsWhere(filters, partialUpdates) {
-        return (await this.client.apiClient.UpdateWhere({ filters: filters.body.filters, updates: partialUpdates })).body;
+        return (await this.client.apiClient.UpdateWhere({ filters: filters.build().filters, updates: partialUpdates })).body;
     }
     async getDocument(documentId) {
         return (await this.client.apiClient.GetDocument({ document_id: documentId })).body;
@@ -101,11 +106,11 @@ class Dataset {
     async deleteDocuments(documentIds) {
         var _a;
         const filters = (0, _1.QueryBuilder)().match('_id', documentIds);
-        return (await this.client.apiClient.DeleteWhere({ filters: (_a = filters.body.filters) !== null && _a !== void 0 ? _a : [] })).body;
+        return (await this.client.apiClient.DeleteWhere({ filters: (_a = filters.build().filters) !== null && _a !== void 0 ? _a : [] })).body;
     }
     async deleteDocumentsWhere(filters) {
         var _a;
-        return (await this.client.apiClient.DeleteWhere({ filters: (_a = filters.body.filters) !== null && _a !== void 0 ? _a : [] })).body;
+        return (await this.client.apiClient.DeleteWhere({ filters: (_a = filters.build().filters) !== null && _a !== void 0 ? _a : [] })).body;
     }
 }
 exports.Dataset = Dataset;

package/dist-cjs/services/discovery/index.js

@@ -1,74 +1,22 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DiscoveryClient = exports._QueryBuilder = exports.QueryBuilder = void 0;
+exports.DiscoveryClient = exports._QueryBuilder = exports._FilterBuilder = exports.FilterBuilder = exports.QueryBuilder = void 0;
 const __1 = require("../../");
 const Dataset_1 = require("./Dataset");
 function QueryBuilder() {
     return new _QueryBuilder();
 }
 exports.QueryBuilder = QueryBuilder;
-class _QueryBuilder {
+function FilterBuilder() {
+    return new _FilterBuilder();
+}
+exports.FilterBuilder = FilterBuilder;
+class _FilterBuilder {
     constructor() {
         this.body = { filters: [], fieldsToAggregate: [], fieldsToAggregateStats: [] };
     }
-    build() {
-        return this.body;
-    }
-    text(query, ...args) {
-        this.body.query = query;
-        for (const arg of args) {
-            if (Array.isArray(arg))
-                this.body.fieldsToSearch = arg;
-            else
-                this.body.queryConfig = arg;
-        }
-        return this;
-    }
-    vector(field, model, ...args) {
-        var _a, _b;
-        if (!Array.isArray(this.body.vectorSearchQuery))
-            this.body.vectorSearchQuery = [];
-        if (!((_b = (_a = this === null || this === void 0 ? void 0 : this.body) === null || _a === void 0 ? void 0 : _a.vectorSearchQuery) === null || _b === void 0 ? void 0 : _b.length))
-            this.body.vectorSearchQuery = [];
-        let payload = { field, model };
-        for (const arg of args) {
-            if (typeof arg === 'number')
-                payload.weight = arg;
-            else
-                payload = { ...payload, ...arg };
-        }
-        this.body.vectorSearchQuery.push(payload);
-        return this;
-    }
-    sort(field, direction) {
-        var _a, _b;
-        if (!((_b = (_a = this === null || this === void 0 ? void 0 : this.body) === null || _a === void 0 ? void 0 : _a.sort) === null || _b === void 0 ? void 0 : _b.length))
-            this.body.sort = {};
-        this.body.sort[field] = direction;
-        return this;
-    }
-    textSort(field, direction) {
-        var _a, _b;
-        if (!((_b = (_a = this === null || this === void 0 ? void 0 : this.body) === null || _a === void 0 ? void 0 : _a.textSort) === null || _b === void 0 ? void 0 : _b.length))
-            this.body.textSort = {};
-        this.body.textSort[field] = direction;
-        return this;
-    }
-    rawOption(key, value) {
-        this.body[key] = value;
-        return this;
-    }
-    minimumRelevance(value) {
-        this.body.minimumRelevance = value;
-        return this;
-    }
-    page(value) {
-        this.body.page = value;
-        return this;
-    }
-    pageSize(value) {
-        this.body.pageSize = value;
-        return this;
+    buildFilters() {
+        return this.body.filters;
     }
     rawFilter(filter) {
         var _a;
@@ -116,6 +64,98 @@ class _QueryBuilder {
         (_a = this.body.filters) === null || _a === void 0 ? void 0 : _a.push({ not: (_c = (_b = filter.body) === null || _b === void 0 ? void 0 : _b.filters) !== null && _c !== void 0 ? _c : [] });
         return this;
     }
+}
+exports._FilterBuilder = _FilterBuilder;
+class _QueryBuilder extends _FilterBuilder {
+    constructor() {
+        super();
+        this.shouldPerformTextQuery = false;
+    }
+    build() {
+        if (!this.shouldPerformTextQuery)
+            return this.body;
+        if (!this.defaultQueryValue)
+            throw new Error("Please set the search query by calling .query('my search query') before performing a text search.");
+        this.body.query = this.defaultQueryValue;
+        return this.body;
+    }
+    query(query, fieldsToSearch) {
+        this.defaultQueryValue = query;
+        if (fieldsToSearch)
+            this.body.fieldsToSearch = fieldsToSearch;
+        return this;
+    }
+    queryConfig(weight, options) {
+        this.body.queryConfig = { weight, ...(options !== null && options !== void 0 ? options : {}) };
+        return this;
+    }
+    text(field, weight) {
+        this.shouldPerformTextQuery = true;
+        if (!field)
+            return this; // support searching all fields
+        if (!this.body.fieldsToSearch)
+            this.body.fieldsToSearch = [];
+        if (!weight)
+            this.body.fieldsToSearch.push(field);
+        else
+            this.body.fieldsToSearch.push({ key: field, weight });
+        return this;
+    }
+    vector(field, ...args) {
+        if (!Array.isArray(this.body.vectorSearchQuery))
+            this.body.vectorSearchQuery = [];
+        let payload = { field };
+        const inferredModelMatch = field.match(/_(.*)_.*vector_/); // title_text@1-0_vector_ -> text@1-0
+        if (inferredModelMatch && inferredModelMatch[1])
+            payload.model = inferredModelMatch[1]; // this can be overridden
+        for (const arg of args) {
+            if (typeof arg === 'number')
+                payload.weight = arg; // weight
+            else
+                payload = { ...payload, ...arg }; // options
+        }
+        this.body.vectorSearchQuery.push(payload);
+        return this;
+    }
+    sort(field, direction) {
+        var _a, _b;
+        if (!((_b = (_a = this === null || this === void 0 ? void 0 : this.body) === null || _a === void 0 ? void 0 : _a.sort) === null || _b === void 0 ? void 0 : _b.length))
+            this.body.sort = {};
+        this.body.sort[field] = direction;
+        return this;
+    }
+    textSort(field, direction) {
+        var _a, _b;
+        if (!((_b = (_a = this === null || this === void 0 ? void 0 : this.body) === null || _a === void 0 ? void 0 : _a.textSort) === null || _b === void 0 ? void 0 : _b.length))
+            this.body.textSort = {};
+        this.body.textSort[field] = direction;
+        return this;
+    }
+    rawOption(key, value) {
+        this.body[key] = value;
+        return this;
+    }
+    minimumRelevance(value) {
+        this.body.minimumRelevance = value;
+        return this;
+    }
+    page(value) {
+        this.body.page = value;
+        return this;
+    }
+    pageSize(value) {
+        this.body.pageSize = value;
+        return this;
+    }
+    includeFields(fields) {
+        this.body.includeFields = fields;
+    }
+    excludeFields(fields) {
+        this.body.excludeFields = fields;
+    }
+    includeVectors(whetherToInclude) {
+        this.body.includeVectors = whetherToInclude;
+    }
     aggregate(field, options) {
         var _a, _b, _c;
         (_a = this.body.fieldsToAggregate) === null || _a === void 0 ? void 0 : _a.push({ key: field, ...options, fieldsToAggregate: (_c = (_b = options === null || options === void 0 ? void 0 : options.aggregates) === null || _b === void 0 ? void 0 : _b.body.fieldsToAggregate) !== null && _c !== void 0 ? _c : [] });