dochub-sdk 0.1.311 → 0.1.314

package/index.ts

@@ -19,7 +19,7 @@ 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';

package/interfaces/ai.ts

@@ -0,0 +1,78 @@
+/**
+ * Интерфейс открытого запроса к AI
+ */
+export interface IDocHubAIRequest {
+    /**
+     * Обрабатывает ответ от AI
+     * @param answer    - Ответ от AI
+     */
+    onTyping: (answer: string) => void;
+    /**
+     * Обрабатывает завершение ответа от AI
+     */
+    onFinish?: () => void;
+    /**
+     * Отменяет запрос
+     * @returns 
+     */
+    cancel();
+}
+
+/**
+ * Тип функции запроса к AI
+ */
+export type DocHubAskFunction = (question: string, model?: string) => Promise<IDocHubAIRequest>;
+
+/**
+ * Интерфейс драйвера AI
+ */
+export interface IDocHubAIDriver {
+    /**
+     * 
+     */
+    isAvailable(): boolean;
+    /**
+     * Задает вопрос AI
+     * @param question    - Вопрос
+     * @param model       - Модель AI
+     * @returns           - Запрос к AI
+    */
+    ask: DocHubAskFunction;
+}
+
+/**
+ * Интерфейс AI ассистента
+ */
+export interface IDocHubAI {
+    /**
+     * Ожидает готовности AI к запросам
+     * @param immediately    - Если true, то функция не ожидает готовности AI к запросам, а генерирует ошибку
+     */
+    whenReady(immediately?:boolean): Promise<void>;
+    /**
+     * Задает вопрос AI
+     * @param question    - Вопрос
+     * @param model       - Модель AI
+     * @returns           - Запрос к AI
+    */
+    ask: DocHubAskFunction;
+    /**
+     * Регистрирует драйвер AI
+     * @param alias     - Алиас драйвера
+     * @param driver    - Драйвер AI
+     */
+    registerDriver(model: string, driver: IDocHubAIDriver): void;
+    /**
+     * Возвращает список доступных моделей AI
+     */
+    getModels(): string[];
+    /**
+     * Возвращает дефолтную модель AI
+     */
+    getDefaultModel(): string;
+    /**
+     * Устанавливает дефолтную модель AI
+     * @param model    - Модель AI
+     */
+    setDefaultModel(model: string): void;
+}

package/interfaces/core.ts

@@ -14,11 +14,16 @@ import { DocHubEditMode, IDocHubEditors } from './editors';
 import { IDocHubPresentations } from './presentations';
 import { IDocHubTools } from './tools';
 import { IDocHubLang } from './lang';
+import { IDocHubAI } from './ai';
 
 /**
  * Интерфейс ядра
  */
 export interface IDocHubCore {
+    /**
+     * Интерфейс работы с AI
+     */
+    ai: IDocHubAI;
     /**
      * Интерфейс управления языковыми пакетами
      */

package/package.json

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