@relevanceai/sdk 1.10.0 → 1.13.0

package/dist-types/generated/index.d.ts

@@ -1,2 +1 @@
 export * from "./DiscoveryApi";
-export * from "./VectorApi";

package/dist-types/index.d.ts

@@ -1,2 +1 @@
 export * from './generated';
-export * from './services';

package/dist-types/services/discovery/Dataset.d.ts

@@ -1,50 +0,0 @@
-/// <reference types="node" />
-import { DiscoveryClient, _QueryBuilder } from ".";
-import { DeleteDocumentOutput, DeleteWhereOutput, GetDocumentOutput, SimpleSearchPostOutput, BulkInsertOutput, UpdateWhereOutput, BulkUpdateOutput } from "../..";
-import { _GenericMethodOptions } from "../../shared/BaseClient";
-interface searchOptions {
-    debounce?: number;
-    rawPayload?: any;
-}
-export declare class Dataset {
-    client: DiscoveryClient;
-    name: string;
-    config: any;
-    debounceTimer?: NodeJS.Timeout;
-    constructor(client: DiscoveryClient, name: string, options: any);
-    get datasetName(): string;
-    insertDocument(document: any, options?: _GenericMethodOptions): Promise<unknown>;
-    search(): Promise<SimpleSearchPostOutput>;
-    search(query?: _QueryBuilder): Promise<SimpleSearchPostOutput>;
-    search(options?: searchOptions): Promise<SimpleSearchPostOutput>;
-    search(query?: _QueryBuilder, options?: searchOptions): Promise<SimpleSearchPostOutput>;
-    insertDocuments(documents: any, options?: _GenericMethodOptions & {
-        batchSize?: number;
-        retryCount?: number;
-        progressCallback?: (progress: BulkInsertOutput[]) => any;
-    }): Promise<BulkInsertOutput>;
-    _GenericBulkOperation<InputItem, OutputItem>({ data, batchSize, fn, retryCount }: {
-        data: InputItem[];
-        fn: (data: InputItem[]) => Promise<OutputItem>;
-        batchSize?: number;
-        retryCount?: number;
-        progressCallback?: (progress: OutputItem[]) => any;
-    }): Promise<OutputItem[]>;
-    updateDocument(documentId: string, partialUpdates: any): Promise<{
-        status: string;
-        message: string;
-    }>;
-    updateDocuments(updates: any, options?: _GenericMethodOptions & {
-        batchSize?: number;
-        retryCount?: number;
-        progressCallback?: (progress: BulkUpdateOutput[]) => any;
-    }): Promise<BulkUpdateOutput>;
-    updateDocumentsWhere(filters: _QueryBuilder, partialUpdates: {
-        [id: string]: any;
-    }): Promise<UpdateWhereOutput>;
-    getDocument(documentId: string): Promise<GetDocumentOutput>;
-    deleteDocument(documentId: string): Promise<DeleteDocumentOutput>;
-    deleteDocuments(documentIds: [string]): Promise<DeleteWhereOutput>;
-    deleteDocumentsWhere(filters: _QueryBuilder): Promise<DeleteWhereOutput>;
-}
-export {};

package/dist-types/services/discovery/index.d.ts

@@ -1,366 +0,0 @@
-import { DiscoveryApiClient } from '../../';
-import { _ClientInput } from '../../shared/BaseClient';
-import { operations, components } from '../../generated/_DiscoveryApiSchemaTypes';
-import { Dataset } from './Dataset';
-declare type bodyType = operations['SimpleSearchPost']['requestBody']['content']['application/json'];
-export declare function QueryBuilder(): _QueryBuilder;
-export declare function FilterBuilder(): _FilterBuilder;
-export declare class _FilterBuilder {
-    body: bodyType;
-    constructor();
-    buildFilters(): {
-        match?: {
-            key: string;
-            value: string | number | boolean | unknown[];
-        } | undefined;
-        range?: {
-            key: string;
-            greaterThan?: unknown;
-            lessThan?: unknown;
-        } | undefined;
-        wildcard?: {
-            key: string;
-            value: string | string[];
-        } | undefined;
-        fieldExists?: {
-            key: string;
-        } | undefined;
-        selfreference?: {
-            a: string;
-            b: string;
-            operation: "<=" | ">=" | "<" | ">" | "==" | "!=";
-        } | undefined;
-        or?: (any | any[])[] | undefined;
-        not?: any | any[] | undefined;
-        chunk?: {
-            path: string;
-            filters: any[];
-        } | undefined;
-    }[] | undefined;
-    rawFilter(filter: components['schemas']['filterListItem']): this;
-    filter(type: string, key: string, value: string, ...options: any): this;
-    match(field: string, value: any): this;
-    wildcard(field: string, value: any): this;
-    selfreference(fielda: string, fieldb: string, operation: "<=" | ">=" | "<" | ">" | "==" | "!="): this;
-    range(field: string, options: Omit<components['schemas']['filterListItem']['range'], 'key'>): this;
-    or(filters: _FilterBuilder[]): this;
-    not(filter: _FilterBuilder): this;
-}
-export declare class _QueryBuilder extends _FilterBuilder {
-    defaultQueryValue?: string;
-    shouldPerformTextQuery: boolean;
-    constructor();
-    build(): {
-        query?: string | undefined;
-        queryConfig?: {
-            weight?: number | undefined;
-        } | undefined;
-        vectorSearchQuery?: {
-            field: string;
-            query?: string | undefined;
-            model?: string | undefined;
-            model_url?: string | undefined;
-            weight?: number | undefined;
-            chunkConfig?: {
-                chunkField: string;
-                page?: number | undefined;
-                pageSize?: number | undefined;
-            } | undefined;
-        } | {
-            field: string;
-            query?: string | undefined;
-            model?: string | undefined;
-            model_url?: string | undefined;
-            weight?: number | undefined;
-            chunkConfig?: {
-                chunkField: string;
-                page?: number | undefined;
-                pageSize?: number | undefined;
-            } | undefined;
-        }[] | undefined;
-        fieldsToSearch?: (string | {
-            key: string;
-            weight?: number | undefined;
-        })[] | undefined;
-        page?: number | undefined;
-        pageSize?: number | undefined;
-        minimumRelevance?: number | undefined;
-        cleanPayloadUsingSchema?: boolean | undefined;
-        sort?: {
-            [key: string]: "asc" | "desc";
-        } | undefined;
-        includeFields?: string[] | undefined;
-        excludeFields?: string[] | undefined;
-        includeVectors?: boolean | undefined;
-        textSort?: {
-            [key: string]: "asc" | "desc";
-        } | undefined;
-        fieldsToAggregate?: (string | {
-            key: string;
-            outputKey?: string | undefined;
-            resultsSize?: number | undefined;
-            fieldsToAggregate?: (string | any)[] | undefined;
-            chunkAggregate?: {
-                chunkFieldName: string;
-                filters?: {
-                    match?: {
-                        key: string;
-                        value: string | number | boolean | unknown[];
-                    } | undefined;
-                    range?: {
-                        key: string;
-                        greaterThan?: unknown;
-                        lessThan?: unknown;
-                    } | undefined;
-                    wildcard?: {
-                        key: string;
-                        value: string | string[];
-                    } | undefined;
-                    fieldExists?: {
-                        key: string;
-                    } | undefined;
-                    selfreference?: {
-                        a: string;
-                        b: string;
-                        operation: "<=" | ">=" | "<" | ">" | "==" | "!=";
-                    } | undefined;
-                    or?: (any | any[])[] | undefined;
-                    not?: any | any[] | undefined;
-                    chunk?: {
-                        path: string;
-                        filters: any[];
-                    } | undefined;
-                }[] | undefined;
-            } | undefined;
-        })[] | undefined;
-        fieldsToAggregateStats?: (string | {
-            key: string;
-            interval?: number | undefined;
-        })[] | undefined;
-        filters?: {
-            match?: {
-                key: string;
-                value: string | number | boolean | unknown[];
-            } | undefined;
-            range?: {
-                key: string;
-                greaterThan?: unknown;
-                lessThan?: unknown;
-            } | undefined;
-            wildcard?: {
-                key: string;
-                value: string | string[];
-            } | undefined;
-            fieldExists?: {
-                key: string;
-            } | undefined;
-            selfreference?: {
-                a: string;
-                b: string;
-                operation: "<=" | ">=" | "<" | ">" | "==" | "!=";
-            } | undefined;
-            or?: (any | any[])[] | undefined;
-            not?: any | any[] | undefined;
-            chunk?: {
-                path: string;
-                filters: any[];
-            } | undefined;
-        }[] | undefined;
-        relevanceBoosters?: {
-            match?: {
-                key: string;
-                value: string | number | boolean | unknown[];
-            } | undefined;
-            range?: {
-                key: string;
-                greaterThan?: unknown;
-                lessThan?: unknown;
-            } | undefined;
-            wildcard?: {
-                key: string;
-                value: string | string[];
-            } | undefined;
-            fieldExists?: {
-                key: string;
-            } | undefined;
-            selfreference?: {
-                a: string;
-                b: string;
-                operation: "<=" | ">=" | "<" | ">" | "==" | "!=";
-            } | undefined;
-            or?: ({
-                match?: {
-                    key: string;
-                    value: string | number | boolean | unknown[];
-                } | undefined;
-                range?: {
-                    key: string;
-                    greaterThan?: unknown;
-                    lessThan?: unknown;
-                } | undefined;
-                wildcard?: {
-                    key: string;
-                    value: string | string[];
-                } | undefined;
-                fieldExists?: {
-                    key: string;
-                } | undefined;
-                selfreference?: {
-                    a: string;
-                    b: string;
-                    operation: "<=" | ">=" | "<" | ">" | "==" | "!=";
-                } | undefined;
-                or?: (any | any[])[] | undefined;
-                not?: any | any[] | undefined;
-                chunk?: {
-                    path: string;
-                    filters: any[];
-                } | undefined;
-            } | {
-                match?: {
-                    key: string;
-                    value: string | number | boolean | unknown[];
-                } | undefined;
-                range?: {
-                    key: string;
-                    greaterThan?: unknown;
-                    lessThan?: unknown;
-                } | undefined;
-                wildcard?: {
-                    key: string;
-                    value: string | string[];
-                } | undefined;
-                fieldExists?: {
-                    key: string;
-                } | undefined;
-                selfreference?: {
-                    a: string;
-                    b: string;
-                    operation: "<=" | ">=" | "<" | ">" | "==" | "!=";
-                } | undefined;
-                or?: (any | any[])[] | undefined;
-                not?: any | any[] | undefined;
-                chunk?: {
-                    path: string;
-                    filters: any[];
-                } | undefined;
-            }[])[] | undefined;
-            not?: {
-                match?: {
-                    key: string;
-                    value: string | number | boolean | unknown[];
-                } | undefined;
-                range?: {
-                    key: string;
-                    greaterThan?: unknown;
-                    lessThan?: unknown;
-                } | undefined;
-                wildcard?: {
-                    key: string;
-                    value: string | string[];
-                } | undefined;
-                fieldExists?: {
-                    key: string;
-                } | undefined;
-                selfreference?: {
-                    a: string;
-                    b: string;
-                    operation: "<=" | ">=" | "<" | ">" | "==" | "!=";
-                } | undefined;
-                or?: (any | any[])[] | undefined;
-                not?: any | any[] | undefined;
-                chunk?: {
-                    path: string;
-                    filters: any[];
-                } | undefined;
-            } | {
-                match?: {
-                    key: string;
-                    value: string | number | boolean | unknown[];
-                } | undefined;
-                range?: {
-                    key: string;
-                    greaterThan?: unknown;
-                    lessThan?: unknown;
-                } | undefined;
-                wildcard?: {
-                    key: string;
-                    value: string | string[];
-                } | undefined;
-                fieldExists?: {
-                    key: string;
-                } | undefined;
-                selfreference?: {
-                    a: string;
-                    b: string;
-                    operation: "<=" | ">=" | "<" | ">" | "==" | "!=";
-                } | undefined;
-                or?: (any | any[])[] | undefined;
-                not?: any | any[] | undefined;
-                chunk?: {
-                    path: string;
-                    filters: any[];
-                } | undefined;
-            }[] | undefined;
-            chunk?: {
-                path: string;
-                filters: {
-                    match?: {
-                        key: string;
-                        value: string | number | boolean | unknown[];
-                    } | undefined;
-                    range?: {
-                        key: string;
-                        greaterThan?: unknown;
-                        lessThan?: unknown;
-                    } | undefined;
-                    wildcard?: {
-                        key: string;
-                        value: string | string[];
-                    } | undefined;
-                    fieldExists?: {
-                        key: string;
-                    } | undefined;
-                    selfreference?: {
-                        a: string;
-                        b: string;
-                        operation: "<=" | ">=" | "<" | ">" | "==" | "!=";
-                    } | undefined;
-                    or?: (any | any[])[] | undefined;
-                    not?: any | any[] | undefined;
-                    chunk?: {
-                        path: string;
-                        filters: any[];
-                    } | undefined;
-                }[];
-            } | undefined;
-            weight?: number | undefined;
-        }[] | undefined;
-    };
-    query(query: string, fieldsToSearch?: bodyType['fieldsToSearch']): this;
-    queryConfig(weight: number, options?: bodyType['queryConfig']): this;
-    text(field?: string): _QueryBuilder;
-    vector(field: string, weight?: number): _QueryBuilder;
-    vector(field: string, options?: components['schemas']['vectorSearchQuery']): _QueryBuilder;
-    vector(field: string, weight?: number, options?: components['schemas']['vectorSearchQuery']): _QueryBuilder;
-    sort(field: string, direction: 'asc' | 'desc'): this;
-    textSort(field: string, direction: 'asc' | 'desc'): this;
-    rawOption(key: string, value: any): this;
-    minimumRelevance(value: bodyType['minimumRelevance']): this;
-    page(value: bodyType['page']): this;
-    pageSize(value: bodyType['pageSize']): this;
-    includeFields(fields: bodyType['includeFields']): void;
-    excludeFields(fields: bodyType['excludeFields']): void;
-    includeVectors(whetherToInclude: bodyType['includeVectors']): void;
-    aggregate(field: string, options?: {
-        options?: any;
-        aggregates?: _QueryBuilder;
-    }): this;
-    aggregateStats(field: string, interval?: number): this;
-}
-export declare class DiscoveryClient {
-    apiClient: DiscoveryApiClient;
-    constructor(config?: _ClientInput);
-    dataset(name: string, options?: any): Dataset;
-}
-export {};

package/dist-types/services/index.d.ts

@@ -1 +0,0 @@
-export * from './discovery';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@relevanceai/sdk",
-  "version": "1.10.0",
+  "version": "1.13.0",
   "description": "Javascript client for RelevanceAI APIs. Browser, Node.js and typescript support.",
   "main": "./dist-cjs/index.js",
   "types": "./dist-types/index.d.ts",
@@ -12,7 +12,7 @@
     "build": "tsc -p tsconfig.json && tsc -p tsconfig.es.json && tsc -p tsconfig.types.json",
     "generate": "ts-node ./src/shared/generate.ts",
     "test": "jest",
-    "prepare": "npm run test && npm run build"
+    "prepare": "npm run build"
   },
   "repository": {
     "type": "git",