@relevanceai/sdk 1.149.0 → 2.0.0

package/dist-cjs/generated/_DiscoveryApiSchemaTypes.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-;

package/dist-cjs/generated/index.js

@@ -1,17 +0,0 @@
-"use strict";
-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 });
-__exportStar(require("./DiscoveryApi"), exports);

package/dist-cjs/index.js

@@ -1,18 +0,0 @@
-"use strict";
-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 });
-__exportStar(require("./generated"), exports);
-// export * from './services';

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

@@ -1,126 +0,0 @@
-"use strict";
-// import { QueryBuilder, DiscoveryClient, _QueryBuilder } from ".";
-// import { DeleteDocumentOutput, DeleteWhereOutput, GetDocumentOutput, SimpleSearchPostOutput, BulkInsertOutput,UpdateWhereOutput,BulkUpdateOutput } from "../..";
-// import { _GenericMethodOptions } from "../../shared/BaseClient";
-// interface searchOptions {
-//  debounce?:number;   
-//  rawPayload?:any;
-// }
-// export class Dataset {
-//     client: DiscoveryClient;
-//     name: string;
-//     config: any;
-//     debounceTimer?:NodeJS.Timeout;
-//     constructor(client: DiscoveryClient, name: string, options: any) {
-//         // TODO validate name
-//         this.client = client;
-//         this.name = name;
-//         this.config = options;
-//     }
-//     get datasetName(): string {
-//         return this.name;
-//     };
-//     async insertDocument(document: any, options?: _GenericMethodOptions) {
-//         const response = await this.client.apiClient.Insert({
-//             document,
-//             ...options
-//         }, { dataset_id: this.name });
-//         return response.body;
-//     }
-//     // without options
-//     async search(): Promise<SimpleSearchPostOutput>;
-//     async search(query?: _QueryBuilder): Promise<SimpleSearchPostOutput>;
-//     async search(options?:searchOptions): Promise<SimpleSearchPostOutput>;
-//     async search(query?: _QueryBuilder,options?:searchOptions): Promise<SimpleSearchPostOutput>;
-//     async search(...args:any[]) {
-//         let payload: any = {};
-//         let options:searchOptions = {};
-//         for (const arg of args) {
-//             if (arg instanceof _QueryBuilder) {
-//                 payload = {...payload,...arg.build()};
-//             }
-//             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) {
-//             clearTimeout(this.debounceTimer);
-//             return new Promise((resolve) => {
-//                 this.debounceTimer = setTimeout(async () => {const res = await reqCallback();resolve(res)},options.debounce);
-//             });
-//         } else {
-//             const response = await reqCallback();
-//             return response.body;
-//         }
-//     }
-//     async insertDocuments(documents: any, options?: _GenericMethodOptions & { batchSize?: number,retryCount?:number, progressCallback?: (progress:BulkInsertOutput[]) => any }):Promise<BulkInsertOutput> {
-//         const results = await this._GenericBulkOperation<any,BulkInsertOutput>({
-//             data:documents??[],
-//             ...options,
-//             fn:async (documentsSlice) => (await this.client.apiClient.BulkInsert({ documents:documentsSlice }, { dataset_id: this.name })).body
-//         });
-//         const finalResults = results.reduce((prev,cur) => {
-//             prev.failed_documents = prev.failed_documents.concat(cur.failed_documents);
-//             prev.inserted += cur.inserted
-//             return prev;
-//         },{inserted:0,failed_documents:[]});
-//         return finalResults;
-//     }
-//     // TODO - ChunkSearch, insert, insertAndVectorize?, vectorize, 
-//     async _GenericBulkOperation<InputItem,OutputItem>({data,batchSize,fn,retryCount}:{
-//         data:InputItem[],
-//         fn:(data:InputItem[]) => Promise<OutputItem>,
-//         batchSize?:number,
-//         retryCount?:number,
-//         progressCallback?:(progress:OutputItem[]) => any
-//     }):Promise<OutputItem[]> {
-//         batchSize = batchSize ?? 10000;
-//         retryCount = retryCount ?? 1;
-//         const results:OutputItem[] = [];
-//         for (let i = 0; i < data?.length; i += batchSize) {
-//             for (let retrysSoFar = 0; retrysSoFar < retryCount; retrysSoFar++) {
-//                 try {
-//                     const res = await fn(data.slice(i, i + batchSize));
-//                     results.push(res);
-//                     break;
-//                 } catch (e) { console.error(`Bulk operation failed with error, retrying - ${e}`) }
-//             }
-//         }
-//         return results;
-//     }
-//     async updateDocument(documentId: string, partialUpdates: any) {
-//         const response = await this.client.apiClient.Update({ id: documentId, updates: partialUpdates });
-//         return response.body;
-//     }
-//     async updateDocuments(updates: any, options?: _GenericMethodOptions & { batchSize?: number,retryCount?:number, progressCallback?: (progress:BulkUpdateOutput[]) => any }):Promise<BulkUpdateOutput> {
-//         const results = await this._GenericBulkOperation<any,BulkUpdateOutput>({
-//             data:updates??[],
-//             ...options,
-//             fn:async (updatesSlice) => (await this.client.apiClient.BulkUpdate({ updates:updatesSlice }, { dataset_id: this.name })).body
-//         });
-//         const finalResults = results.reduce((prev,cur) => {
-//             prev.failed_documents = prev.failed_documents.concat(cur.failed_documents);
-//             prev.inserted += cur.inserted
-//             return prev;
-//         },{inserted:0,failed_documents:[]});
-//         return finalResults;
-//     }
-//     async updateDocumentsWhere(filters: _QueryBuilder, partialUpdates: {[id:string]:any}):Promise<UpdateWhereOutput> {
-//         return (await this.client.apiClient.UpdateWhere({ filters: filters.build().filters, updates: partialUpdates })).body;
-//     }
-//     async getDocument(documentId: string):Promise<GetDocumentOutput> {
-//         return (await this.client.apiClient.GetDocument({document_id:documentId})).body;
-//     }
-//     async deleteDocument(documentId: string):Promise<DeleteDocumentOutput> {
-//         return (await this.client.apiClient.DeleteDocument({id:documentId})).body;
-//     }
-//     async deleteDocuments(documentIds: [string]):Promise<DeleteWhereOutput> {
-//         const filters = QueryBuilder().match('_id',documentIds);
-//         return (await this.client.apiClient.DeleteWhere({ filters: filters.build().filters??[] })).body;
-//     } 
-//     async deleteDocumentsWhere(filters: _QueryBuilder):Promise<DeleteWhereOutput> {
-//         return (await this.client.apiClient.DeleteWhere({ filters: filters.build().filters??[]})).body;
-//     }
-// }

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

@@ -1,159 +0,0 @@
-"use strict";
-// import { DiscoveryApiClient, BulkInsertInput, BulkInsertOutput } from '../../';
-// import { _ClientInput, CommandInput, CommandOutput, _GenericMethodOptions } from '../../shared/BaseClient';
-// import { operations, components } from '../../generated/_DiscoveryApiSchemaTypes';
-// import { Dataset } from './Dataset';
-// type bodyType = operations['SimpleSearchPost']['requestBody']['content']['application/json'];
-// export function QueryBuilder():_QueryBuilder{
-//     return new _QueryBuilder();
-// }
-// export function FilterBuilder():_FilterBuilder{
-//     return new _FilterBuilder();
-// }
-// export class _FilterBuilder {
-//     body: bodyType;
-//     constructor() {
-//         this.body = {filters:[],fieldsToAggregate:[],fieldsToAggregateStats:[]};
-//     }
-//     buildFilters() {
-//         return this.body.filters;
-//     }
-//     rawFilter(filter: components['schemas']['filterListItem']) {
-//         this.body.filters?.push(filter);
-//         return this;
-//     }
-//     filter(type: string, key: string, value: string, ...options: any) {
-//         this.body.filters?.push({
-//             [type]: {
-//                 key,
-//                 value,
-//                 ...options
-//             }
-//         });
-//         return this;
-//     }
-//     match(field: string, value: any) {
-//         this.body.filters?.push({ match: { key: field, value } });
-//         return this;
-//     }
-//     wildcard(field: string, value: any) {
-//         this.body.filters?.push({ wildcard: { key: field, value } });
-//         return this;
-//     }
-//     selfreference(fielda: string, fieldb: string, operation: "<=" | ">=" | "<" | ">" | "==" | "!=") {
-//         this.body.filters?.push({ selfreference: { a: fielda, b: fieldb, operation } });
-//         return this;
-//     }
-//     range(field: string, options: Omit<components['schemas']['filterListItem']['range'],'key'>) {
-//         this.body.filters?.push({ range: { key: field, ...options } });
-//         return this;
-//     }
-//     or(filters: _FilterBuilder[]) {
-//         this.body.filters?.push({ or: filters.map(f => f.body.filters ?? []) });
-//         return this;
-//     }
-//     not(filter: _FilterBuilder) {
-//         this.body.filters?.push({ not: filter.body?.filters ?? [] });
-//         return this;
-//     }
-// } 
-// export class _QueryBuilder extends _FilterBuilder {
-//     defaultQueryValue?: string;
-//     shouldPerformTextQuery:boolean;
-//     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:string,fieldsToSearch?: bodyType['fieldsToSearch']) {
-//         this.defaultQueryValue = query;
-//         if (fieldsToSearch) this.body.fieldsToSearch = fieldsToSearch;
-//         return this;
-//     }
-//     queryConfig(weight:number,options?:bodyType['queryConfig']) {
-//         this.body.queryConfig = {weight,...(options??{})};
-//         return this;
-//     }
-//     text(field?:string): _QueryBuilder;
-//     text(field?:string,weight?:number):_QueryBuilder{
-//         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({field,weight});
-//         return this;
-//     }
-//     vector(field: string, weight?: number): _QueryBuilder;
-//     vector(field: string, options?: components['schemas']['vectorSearchQuery']): _QueryBuilder;
-//     vector(field: string, weight?: number, options?: components['schemas']['vectorSearchQuery']): _QueryBuilder;
-//     vector(field: string, ...args:any[]) {
-//         if (!Array.isArray(this.body.vectorSearchQuery)) this.body.vectorSearchQuery = [];
-//         let payload:components['schemas']['vectorSearchQuery'] = {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: string, direction: 'asc' | 'desc') {
-//         if (!this?.body?.sort?.length) this.body.sort = {};
-//         this.body.sort[field] = direction;
-//         return this;
-//     }
-//     textSort(field: string, direction: 'asc' | 'desc') {
-//         if (!this?.body?.textSort?.length) this.body.textSort = {};
-//         this.body.textSort[field] = direction;
-//         return this;
-//     }
-//     rawOption(key: string, value: any) {
-//         (this.body as any)[key] = value;
-//         return this;
-//     }
-//     minimumRelevance(value: bodyType['minimumRelevance']) {
-//         this.body.minimumRelevance = value;
-//         return this;
-//     }
-//     page(value: bodyType['page']) {
-//         this.body.page = value;
-//         return this;
-//     }
-//     pageSize(value: bodyType['pageSize']) {
-//         this.body.pageSize = value;
-//         return this;
-//     }
-//     includeFields(fields:bodyType['includeFields']) {
-//         this.body.includeFields = fields;
-//     }
-//     excludeFields(fields:bodyType['excludeFields']) {
-//         this.body.excludeFields = fields;
-//     }
-//     includeVectors(whetherToInclude:bodyType['includeVectors']){
-//         this.body.includeVectors = whetherToInclude;
-//     }
-//     aggregate(field: string, options?: { options?: any, aggregates?: _QueryBuilder }) {
-//         this.body.fieldsToAggregate?.push({  field, ...options, fieldsToAggregate: options?.aggregates?.body.fieldsToAggregate ?? [] });
-//         return this;
-//     }
-//     aggregateStats(field: string, interval?: number) {
-//         this.body.fieldsToAggregateStats?.push({  field, interval });
-//         return this;
-//     }
-// }
-// export class DiscoveryClient {
-//     apiClient:DiscoveryApiClient;
-//     constructor(config?: _ClientInput) {
-//         this.apiClient = new DiscoveryApiClient(config ?? {});
-//     }
-//     dataset(name: string, options?: any) {
-//         let dataset = new Dataset(this, name, options);
-//         return dataset;
-//     }
-// }

package/dist-cjs/services/index.js

@@ -1,3 +0,0 @@
-"use strict";
-// Not interested in this right now
-// export * from './discovery';

package/dist-cjs/shared/BaseClient.js

@@ -1,35 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-var _a, _b;
-Object.defineProperty(exports, "__esModule", { value: true });
-exports._GenericClient = void 0;
-const cross_fetch_1 = __importDefault(require("cross-fetch"));
-const serviceConfigs_1 = require("./serviceConfigs");
-const envVars = {
-    project: (_a = process === null || process === void 0 ? void 0 : process.env) === null || _a === void 0 ? void 0 : _a.RELEVANCE_PROJECT,
-    api_key: (_b = process === null || process === void 0 ? void 0 : process.env) === null || _b === void 0 ? void 0 : _b.RELEVANCE_API_KEY,
-};
-class _GenericClient {
-    constructor(config) {
-        this.config = config;
-        this.serviceConfig = serviceConfigs_1.serviceConfigs[config.service_name];
-    }
-    async SendRequest({ input, path, method, options }) {
-        var _a, _b, _c, _d, _e;
-        const settings = {
-            method,
-            headers: { authorization: `${(_a = this.config.project) !== null && _a !== void 0 ? _a : envVars.project}:${(_b = this.config.api_key) !== null && _b !== void 0 ? _b : envVars.api_key}` },
-        };
-        if (method.toLowerCase() !== 'get')
-            settings.body = JSON.stringify(input);
-        const final_dataset_id = (_d = (_c = options === null || options === void 0 ? void 0 : options.dataset_id) !== null && _c !== void 0 ? _c : this.config.dataset_id) !== null && _d !== void 0 ? _d : "";
-        const res = await (0, cross_fetch_1.default)(`${(_e = this.config.endpoint) !== null && _e !== void 0 ? _e : this.serviceConfig.endpoint}/latest${path.replace('{dataset_id}', final_dataset_id)}`, settings);
-        if (!res.ok)
-            throw new Error(`${path} ${method} failed with status ${res.status}: ${(await res.text())}`);
-        const body = await res.json();
-        return { body };
-    }
-}
-exports._GenericClient = _GenericClient;

package/dist-cjs/shared/generate.js

@@ -1,90 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const cross_fetch_1 = __importDefault(require("cross-fetch"));
-const fs_1 = require("fs");
-const openapi_typescript_1 = __importDefault(require("openapi-typescript"));
-const serviceConfigs_1 = require("./serviceConfigs");
-// download schema using cross-fetch
-// convert to sdk with typescript, can supply middleware methods that will be run ???
-function GetFlattenedSchema(schema) {
-    var _a, _b, _c;
-    if (!schema.paths)
-        throw new Error('No paths in schema ${config.schema_url}');
-    const final = [];
-    for (const [path, methods] of Object.entries(schema.paths)) {
-        for (const [method, pathData] of Object.entries(methods)) {
-            const operation = pathData; // object.entries didnt work here
-            const operationSummaryName = (_c = ((_b = (_a = operation === null || operation === void 0 ? void 0 : operation.operationId) !== null && _a !== void 0 ? _a : operation === null || operation === void 0 ? void 0 : operation.summary) !== null && _b !== void 0 ? _b : `${path}-${method}`)) === null || _c === void 0 ? void 0 : _c.replace(/[^A-Za-z0-9]/g, "");
-            final.push({ path, method, operation, operationSummaryName });
-        }
-    }
-    return final;
-}
-async function GenerateSDKFromOpenAPISchema({ config }) {
-    const openapiSchema = await (await (0, cross_fetch_1.default)(config.schema_url)).json();
-    const typescriptOutput = 'interface definitions {[id:string]:any};\n' + (await (0, openapi_typescript_1.default)(openapiSchema));
-    let sdkText = '';
-    const pipeline = [
-        () => {
-            sdkText += `import {CommandInput,_GenericClient,CommandOutput,_ClientInput,_GenericMethodOptions} from '../shared/BaseClient';
-      import {operations} from './_${config.name}SchemaTypes';
-`;
-        },
-        () => {
-            for (const { path, method, operation, operationSummaryName } of GetFlattenedSchema(openapiSchema)) {
-                if (method.toLowerCase() !== 'get' && operation.requestBody) {
-                    sdkText += `
-  export type ${operationSummaryName}Input = operations['${operation.operationId}']['requestBody']['content']['application/json']`;
-                }
-                else {
-                    sdkText += `
-  export type ${operationSummaryName}Input = {}`;
-                }
-                sdkText += `
-export type ${operationSummaryName}Output = operations['${operation.operationId}']['responses']['200']['content']['application/json']`;
-            }
-        },
-        () => {
-            sdkText += `
-export class ${config.name}Client  extends _GenericClient {
-  constructor(config:_ClientInput){
-    super({...config,service_name:'${config.name}'});
-  }`;
-        },
-        () => {
-            for (const { path, method, operationSummaryName } of GetFlattenedSchema(openapiSchema)) {
-                sdkText += `
-  public async ${operationSummaryName}(
-    input: CommandInput<${operationSummaryName}Input>,
-    options?: _GenericMethodOptions
-  ):Promise<CommandOutput<${operationSummaryName}Output>> {
-    return this.SendRequest({
-      input,
-      method:'${method}',
-      path:'${path}',
-      options
-    });
-  }`;
-            }
-        },
-        () => {
-            sdkText += '}';
-        }
-    ];
-    for (const fn of pipeline)
-        fn();
-    await fs_1.promises.writeFile(`./src/generated/${config.name}.ts`, sdkText);
-    await fs_1.promises.writeFile(`./src/generated/_${config.name}SchemaTypes.ts`, typescriptOutput);
-}
-async function GenerateSDKS() {
-    let indexFileContent = '';
-    for (const config of Object.values(serviceConfigs_1.serviceConfigs)) {
-        GenerateSDKFromOpenAPISchema({ config });
-        indexFileContent += `export * from "./${config.name}";\n`;
-    }
-    await fs_1.promises.writeFile(`./src/generated/index.ts`, indexFileContent);
-}
-GenerateSDKS();

package/dist-cjs/shared/serviceConfigs.js

@@ -1,10 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.serviceConfigs = void 0;
-exports.serviceConfigs = {
-    DiscoveryApi: {
-        schema_url: 'https://api.ap-southeast-2.relevance.ai/latest/openapi_schema.json',
-        endpoint: 'https://api.ap-southeast-2.relevance.ai',
-        name: 'DiscoveryApi',
-    },
-};