@relevanceai/sdk 2.0.0 → 2.0.1

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

@@ -0,0 +1 @@
+export * from "./VecDBApi";

package/dist-types/index.d.ts

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

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

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

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

@@ -0,0 +1,52 @@
+/// <reference types="node" />
+import { VecDBClient, _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: VecDBClient;
+    name: string;
+    config: any;
+    debounceTimer?: NodeJS.Timeout;
+    constructor(client: VecDBClient, name: string, options: any);
+    get datasetName(): string;
+    createIfNotExist(): Promise<boolean>;
+    recreateIfExists(): Promise<boolean>;
+    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, encoders?: 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/vecdb/index.d.ts

@@ -0,0 +1,44 @@
+import { VecDBApiClient } from '../../';
+import { _ClientInput } from '../../shared/BaseClient';
+import { components } from '../../generated/_VecDBApiSchemaTypes';
+import { Dataset } from './Dataset';
+declare type bodyType = any;
+export declare function QueryBuilder(): _QueryBuilder;
+export declare function FilterBuilder(): _FilterBuilder;
+export declare class _FilterBuilder {
+    body: bodyType;
+    constructor();
+    buildFilters(): any;
+    rawFilter(filter: components['schemas']['simpleSearchAndFlatFilterItem']): this;
+    filter(type: string, key: string, value: string, ...options: any): this;
+    match(field: string, value: any): this;
+    wildcard(field: string, value: any): this;
+    range(field: string, options: Omit<components['schemas']['simpleSearchAndFlatFilterItem']['range'], 'field'>): this;
+    or(filters: _FilterBuilder[]): this;
+}
+export declare class _QueryBuilder extends _FilterBuilder {
+    defaultQueryValue?: string;
+    shouldPerformTextQuery: boolean;
+    constructor();
+    build(): any;
+    vector(field: string, weight?: number): _QueryBuilder;
+    vector(field: string, options?: any): _QueryBuilder;
+    vector(field: string, weight?: number, options?: any): _QueryBuilder;
+    sort(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']): this;
+    ask(query: string, field: string, options: {
+        preset?: any;
+        titleReferenceField?: string;
+        urlReferenceField?: string;
+    }): this;
+}
+export declare class VecDBClient {
+    apiClient: VecDBApiClient;
+    constructor(config?: _ClientInput);
+    dataset(name: string, options?: any): Dataset;
+}
+export {};

package/dist-types/shared/BaseClient.d.ts

@@ -0,0 +1,28 @@
+import { serviceConfig } from './serviceConfigs';
+export declare type CommandInput<A> = A;
+export interface CommandOutput<output> {
+    body: output;
+}
+export interface _ClientInput {
+    endpoint?: string;
+    api_key?: string;
+    project?: string;
+    dataset_id?: string;
+}
+export declare type _GenericClientInput = _ClientInput & {
+    service_name: string;
+};
+export interface _GenericMethodOptions {
+    dataset_id?: string;
+}
+export declare class _GenericClient {
+    config: _GenericClientInput;
+    serviceConfig: serviceConfig;
+    constructor(config: _GenericClientInput);
+    SendRequest({ input, path, method, options }: {
+        input: any;
+        path: string;
+        method: string;
+        options?: _GenericMethodOptions;
+    }): Promise<CommandOutput<any>>;
+}

package/dist-types/shared/generate.d.ts

@@ -0,0 +1 @@
+export {};

package/dist-types/shared/serviceConfigs.d.ts

@@ -0,0 +1,8 @@
+export interface serviceConfig {
+    schema_url: string;
+    endpoint: string;
+    name: string;
+}
+export declare const serviceConfigs: {
+    [id: string]: serviceConfig;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@relevanceai/sdk",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "description": "Javascript client for RelevanceAI APIs. Browser, Node.js and typescript support.",
   "main": "./dist-cjs/index.js",
   "types": "./dist-types/index.d.ts",