dochub-sdk 0.1.317 → 0.1.319

package/index.ts

@@ -19,10 +19,10 @@ export * from './interfaces/settings';
 export * from './interfaces/ui';
 export * from './interfaces/tools';
 export * from './interfaces/lang';
-export * from './interfaces/ai';
 export * from './interfaces/datasets';
-
 export * from './metamodel/index';
+export * from './interfaces/ai';
+export * from './interfaces/explainer';
 
 export * from './schemas/basetypes';
 export * from './schemas/dochub-yaml';

package/interfaces/ai.ts

@@ -29,14 +29,14 @@ export interface IDocHubAIRequest {
 /**
  * Тип функции запроса к AI
  */
-export type DocHubAskFunction = (question: string, model?: string) => Promise<IDocHubAIRequest>;
+export type DocHubAskFunction = (question: string, driver?: string, model?: string) => Promise<IDocHubAIRequest>;
 
 /**
  * Интерфейс драйвера AI
  */
 export interface IDocHubAIDriver {
     /**
-     * 
+     * Возвращает признак активности драйвера
      */
     isActive(): boolean;
     /**
@@ -69,18 +69,18 @@ export interface IDocHubAI {
      * @param alias     - Алиас драйвера
      * @param driver    - Драйвер AI
      */
-    registerDriver(model: string, driver: IDocHubAIDriver): void;
+    registerDriver(alias: string, driver: IDocHubAIDriver): void;
     /**
      * Возвращает список доступных моделей AI
      */
-    getModels(): string[];
+    getDrivers(): string[];
     /**
-     * Возвращает дефолтную модель AI
+     * Возвращает дефолтный драйвер AI
      */
-    getDefaultModel(): string;
+    getDefaultDriver(): string;
     /**
-     * Устанавливает дефолтную модель AI
-     * @param model    - Модель AI
+     * Устанавливает дефолтный драйвер AI
+     * @param driver    - Драйвер AI
      */
-    setDefaultModel(model: string): void;
+    setDefaultDriver(alias: string): void;
 }

package/interfaces/core.ts

@@ -15,7 +15,7 @@ import { IDocHubPresentations } from './presentations';
 import { IDocHubTools } from './tools';
 import { IDocHubLang } from './lang';
 import { IDocHubAI } from './ai';
-
+import { IDocHubExplainer } from './explainer';
 /**
  * Интерфейс ядра
  */
@@ -24,6 +24,10 @@ export interface IDocHubCore {
      * Интерфейс работы с AI
      */
     ai: IDocHubAI;
+    /**
+     * Интерфейс подсистемы объяснения
+     */
+    explainer: IDocHubExplainer;
     /**
      * Интерфейс управления языковыми пакетами
      */

package/interfaces/explainer.ts

@@ -0,0 +1,79 @@
+
+/**
+ * Интерфейс драйвера объяснения
+ */
+export interface IDocHubExplainerDriver {
+    /**
+     * Возвращает признак активности драйвера
+     */
+    isActive(): boolean;
+    /**
+     * Объясняет файл
+     * @param uri               - URI файла
+     * @returns                 - Результат выполнения запроса
+     */
+    explainFile(uri: string): Promise<string>;
+    /**
+     * Объясняет метаданные
+     * @param path              - Путь который требуется объяснить
+     * @returns                 - Результат выполнения запроса
+     */
+    explainMeta(path: string): Promise<string>;
+    /**
+     * Объясняет данные
+     * @param data              - Данные
+     * @returns                 - Результат выполнения запроса
+     */
+    explainData(data: any): Promise<string>;
+}
+
+/**
+ * Интерфейс подсистемы объяснения
+ */
+export interface IDocHubExplainer {
+    /**
+     * Ожидает готовности к запросам в подсистему объяснения
+     * @param immediately    - Если true, то функция не ожидает готовности запросам, а генерирует ошибку
+     */
+    whenReady(immediately?:boolean): Promise<void>;    
+    /**
+     * Регистрирует драйвер
+     * @param driver            - Драйвер
+     */
+    registerDriver(alias: string, driver: IDocHubExplainerDriver): void;
+    /**
+     * Возвращает список доступных драйверов
+     * @returns                 - Список доступных драйверов
+     */
+    getDrivers(): string[];
+    /**
+     * Объясняет файл
+     * @param uri               - URI файла
+     * @param driver            - Драйвер
+     * @returns                 - Результат выполнения запроса
+     */
+    explainFile(uri: string, driver?: string): Promise<string>;
+    /**
+     * Объясняет метаданные
+     * @param path              - Путь который требуется объяснить
+     * @param driver            - Драйвер
+     * @returns                 - Результат выполнения запроса
+     */
+    explainMeta(path: string, driver?: string): Promise<string>;
+    /**
+     * Объясняет данные
+     * @param data              - Данные
+     * @param driver            - Драйвер
+     * @returns                 - Результат выполнения запроса
+     */
+    explainData(data: any, driver?: string): Promise<string>;
+    /**
+     * Возвращает дефолтный драйвер
+     */
+    getDefaultDriver(): string;
+    /**
+     * Устанавливает дефолтный драйвер
+     * @param driver    - Драйвер
+     */
+    setDefaultDriver(alias: string): void;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dochub-sdk",
-  "version": "0.1.317",
+  "version": "0.1.319",
   "description": "The DocHub System Development Kit.",
   "private": false,
   "main": "index.ts",