@futdevpro/nts-dynamo 1.15.155 → 1.15.156

package/build/_modules/ai/_modules/open-ai/_services/data-services/oai-vector-data.service.d.ts

@@ -1,120 +1,120 @@
-import { DyFM_DataModel_Params, DyFM_DataProperty_Params, DyFM_DBFilter, DyFM_Metadata } from '@futdevpro/fsm-dynamo';
-import { DyFM_OAI_Settings, DyFM_OAI_Model } from '@futdevpro/fsm-dynamo/ai/open-ai';
-import { DyNTS_DataService } from '../../../../../../_services/base/data.service';
-import { DyNTS_OAI_Embedding_ControlService } from '../oai-embedding.control-service';
-/**
- * Vector Data Service that is connected to the relevant DBServices
- * extends {@link DyNTS_DataService}
- *
- * For the vectorization, you need to setup the index in the DB to something like this:
- * (the path declared here must be the same as the vectorizeUseIndex in the {@link DyFM_DataProperty_Params})
- * ```json
- * {
- *   "fields": [
- *     {
- *       "type": "vector",
- *       "path": "contentVectorized",
- *       "numDimensions": 3072,
- *       "similarity": "cosine"
- *     }
- *   ]
- * }
- * ```
- *
- * @example
- * export class UserMatchStatisticsService extends DyNTS_DataService<UserMatchStatistics> {
- *   constructor(
- *     set: {
- *       data?: UserMatchStatistics,
- *       openAISettings?: DyFM_OAI_Settings,
- *       issuer: string,
- *     }
- *   ) {
- *     super(
- *       new UserMatchStatistics(set?.data),
- *       userMatchStatisticsModelParams,
- *       set?.openAISettings ?? defaultOpenAISettings,
- *       set.issuer,
- *     );
- *   }
- * }
- */
-export declare class DyNTS_OAI_VectorDataService<T extends DyFM_Metadata> extends DyNTS_DataService<T> {
-    /**
-     * OpenAI settings
-     */
-    readonly openAISettings: DyFM_OAI_Settings;
-    /**
-     * Properties that are vectorized
-     * (properties that are marked with vectorizeFrom in other properties)
-     */
-    readonly vectorizeProperties: DyFM_DataProperty_Params<any, T>[];
-    readonly vectorizedProperties: DyFM_DataProperty_Params<any, T>[];
-    debugLog: boolean;
-    swallowVectorizedProperties: boolean;
-    embedding_CS: DyNTS_OAI_Embedding_ControlService;
-    tokenSpent: number;
-    constructor(
-    /**
-     * Initial data, this will be used by functions on default
-     */
-    data: T, 
-    /**
-     * DB data prams will be used to connect to usable dbService on GlobalService
-     */
-    dataParams: DyFM_DataModel_Params<T>, 
-    /**
-     * OpenAI settings
-     */
-    openAISettings: DyFM_OAI_Settings, 
-    /**
-     * Initial set for issuer to be able to follow the issuer's activity
-     */
-    issuer: string);
-    /**
-     * Vectorizes the properties of the data
-     * IF they are not vectorized yet OR alwaysVectorize is true
-     * (That are marked with vectorizeFrom if the specific property is not defined)
-     *
-     * @example
-     * const data = await vectorizeDataProperties(data);
-     *
-     * @returns The vectorized data
-     */
-    vectorizeDataProperties(newData?: T, forceVectorize?: boolean): Promise<T>;
-    private checkAndVectorizeSingleProperty;
-    private getVectorizingDataForVectorizedProperty;
-    /**
-     * Vectorizes the input
-     *
-     * @example
-     * const vector = await vectorize(input);
-     */
-    vectorize(input: string, useModel?: DyFM_OAI_Model | string): Promise<number[]>;
-    /**
-     * Vectorizes the input and searches for the most similar data
-     * (the default limit is 3, and the default numberOfCandidates is 100)
-     *
-     * @example
-     * const result = await vectorSearch(input, searchInKey);
-     */
-    vectorSearch(set: {
-        input: string;
-        /** this should be the vectorized property key */
-        searchInKey: string;
-        limit?: number;
-        /**
-         * Number of candidates that are used to find the best match
-         */
-        numberOfCandidates?: number;
-        filterBy?: DyFM_DBFilter<T>;
-    }): Promise<any>;
-    /**
-     * VectorDataService overrides the saveData function to vectorize the data properties
-     *
-     * {@link DyNTS_DataService.saveData}
-     */
-    saveData(data?: T, dontSetToService?: boolean, forceVectorize?: boolean): Promise<T>;
-    getProvidedData(data: T): T;
-}
+import { DyFM_DataModel_Params, DyFM_DataProperty_Params, DyFM_DBFilter, DyFM_Metadata } from '@futdevpro/fsm-dynamo';
+import { DyFM_OAI_Settings, DyFM_OAI_Model } from '@futdevpro/fsm-dynamo/ai/open-ai';
+import { DyNTS_DataService } from '../../../../../../_services/base/data.service';
+import { DyNTS_OAI_Embedding_ControlService } from '../oai-embedding.control-service';
+/**
+ * Vector Data Service that is connected to the relevant DBServices
+ * extends {@link DyNTS_DataService}
+ *
+ * For the vectorization, you need to setup the index in the DB to something like this:
+ * (the path declared here must be the same as the vectorizeUseIndex in the {@link DyFM_DataProperty_Params})
+ * ```json
+ * {
+ *   "fields": [
+ *     {
+ *       "type": "vector",
+ *       "path": "contentVectorized",
+ *       "numDimensions": 3072,
+ *       "similarity": "cosine"
+ *     }
+ *   ]
+ * }
+ * ```
+ *
+ * @example
+ * export class UserMatchStatisticsService extends DyNTS_DataService<UserMatchStatistics> {
+ *   constructor(
+ *     set: {
+ *       data?: UserMatchStatistics,
+ *       openAISettings?: DyFM_OAI_Settings,
+ *       issuer: string,
+ *     }
+ *   ) {
+ *     super(
+ *       new UserMatchStatistics(set?.data),
+ *       userMatchStatisticsModelParams,
+ *       set?.openAISettings ?? defaultOpenAISettings,
+ *       set.issuer,
+ *     );
+ *   }
+ * }
+ */
+export declare class DyNTS_OAI_VectorDataService<T extends DyFM_Metadata> extends DyNTS_DataService<T> {
+    /**
+     * OpenAI settings
+     */
+    readonly openAISettings: DyFM_OAI_Settings;
+    /**
+     * Properties that are vectorized
+     * (properties that are marked with vectorizeFrom in other properties)
+     */
+    readonly vectorizeProperties: DyFM_DataProperty_Params<any, T>[];
+    readonly vectorizedProperties: DyFM_DataProperty_Params<any, T>[];
+    debugLog: boolean;
+    swallowVectorizedProperties: boolean;
+    embedding_CS: DyNTS_OAI_Embedding_ControlService;
+    tokenSpent: number;
+    constructor(
+    /**
+     * Initial data, this will be used by functions on default
+     */
+    data: T, 
+    /**
+     * DB data prams will be used to connect to usable dbService on GlobalService
+     */
+    dataParams: DyFM_DataModel_Params<T>, 
+    /**
+     * OpenAI settings
+     */
+    openAISettings: DyFM_OAI_Settings, 
+    /**
+     * Initial set for issuer to be able to follow the issuer's activity
+     */
+    issuer: string);
+    /**
+     * Vectorizes the properties of the data
+     * IF they are not vectorized yet OR alwaysVectorize is true
+     * (That are marked with vectorizeFrom if the specific property is not defined)
+     *
+     * @example
+     * const data = await vectorizeDataProperties(data);
+     *
+     * @returns The vectorized data
+     */
+    vectorizeDataProperties(newData?: T, forceVectorize?: boolean): Promise<T>;
+    private checkAndVectorizeSingleProperty;
+    private getVectorizingDataForVectorizedProperty;
+    /**
+     * Vectorizes the input
+     *
+     * @example
+     * const vector = await vectorize(input);
+     */
+    vectorize(input: string, useModel?: DyFM_OAI_Model | string): Promise<number[]>;
+    /**
+     * Vectorizes the input and searches for the most similar data
+     * (the default limit is 3, and the default numberOfCandidates is 100)
+     *
+     * @example
+     * const result = await vectorSearch(input, searchInKey);
+     */
+    vectorSearch(set: {
+        input: string;
+        /** this should be the vectorized property key */
+        searchInKey: string;
+        limit?: number;
+        /**
+         * Number of candidates that are used to find the best match
+         */
+        numberOfCandidates?: number;
+        filterBy?: DyFM_DBFilter<T>;
+    }): Promise<any>;
+    /**
+     * VectorDataService overrides the saveData function to vectorize the data properties
+     *
+     * {@link DyNTS_DataService.saveData}
+     */
+    saveData(data?: T, dontSetToService?: boolean, forceVectorize?: boolean): Promise<T>;
+    getProvidedData(data: T): T;
+}
 //# sourceMappingURL=oai-vector-data.service.d.ts.map