dochub-sdk 0.1.382 → 0.1.385

package/interfaces/ai.ts

@@ -3,6 +3,20 @@ import { DocHubJSONSchema } from '../schemas/basetypes';
 import { DataLakePath } from './datalake';
 import { DocHubEditorContext } from './editors';
 
+/**
+ * События AI 
+ */
+export enum DocHubAIEvents {
+    /**
+     * Глобальные события
+     */
+    setDefaultDriver = '$ai-change-default-driver',  // Драйвер AI по умолчанию изменился
+    /**
+     * Локальные события
+     */
+    registeredDriver = '#ai-registered-driver',  // Зарегистрирован драйвер AI
+};
+
 /**
  * Фрагмент контекста
  */
@@ -50,6 +64,24 @@ export interface IDocHubAIRequest {
     next(question: string): Promise<void>;
 }
 
+export type DocHubAIAskAttachmentFileContent = string;
+
+
+/**
+ * Метаданные файла
+ */
+export interface DocHubAIAskAttachmentFile {
+    url: URL;               // Ссылка на файл, либо base64 кодированный файл
+    source?: URL;           // Источник информации для задач AI при указании ссылок на источники
+    description?: string;   // Контекстное описание файла
+}
+
+/**
+ * Структура прикрепляемых файлов к запросу
+ */
+
+export type DocHubAIAskAttachment = DocHubAIAskAttachmentFile[];
+
 /**
  * Опции выполнения AI запроса
  */
@@ -66,6 +98,10 @@ export interface IDocHubAIAskOptions {
      * Признак отображения внутреннего диалога IDE и AI-агента
      */
     trace?: boolean;
+    /**
+     * Файлы прикрепляемые к запросу
+     */
+    attachment?: DocHubAIAskAttachment;
 }
 
 /**
@@ -88,6 +124,10 @@ export interface IDocHubAIDriver {
      * @returns           - Запрос к AI
     */
     ask: DocHubAskFunction;
+    /**
+     * Возвращает информацию о способностях AI
+     */
+    getCapabilities(): Promise<IDocHubAICapabilities>;
 }
 
 export interface IDocHubAITextPartition {
@@ -187,6 +227,37 @@ export interface IDocHubComposerProvider {
     fetchCommands(): Promise<IDocHubAIComposerCommand[]>;
 }
 
+export enum IDocHubAICapabilityID {
+    text = 'text',
+    attachment = 'attachment',
+    contextWindow = 'context-window'
+}
+
+export type DocHubAIAttachmentFileContentType = string;
+
+/**
+ * Метаинформация о возможностях AI-агента
+ */
+export interface IDocHubAICapabilities {
+    /**
+     * Текстовое резюме от AI
+     */
+    description?: string;
+    /**
+     * Способность обрабатывать прикрепленные файлы к сообщению
+     */
+    [IDocHubAICapabilityID.attachment]?: DocHubAIAttachmentFileContentType[];
+    /**
+     * Способность воспринимать текс в запросе
+     */
+    [IDocHubAICapabilityID.text]?: boolean;
+    /**
+     * Размер контекстного окна
+     */
+    [IDocHubAICapabilityID.contextWindow]?: number;
+}
+
+
 /**
  * Интерфейс AI ассистента
  */
@@ -254,9 +325,14 @@ export interface IDocHubAI {
      */
     registerComposerProvider(alias: string, provider: IDocHubComposerProvider): void;
     /**
-     * Возвращает список доступных моделей AI
+     * Возвращает список доступных AI драйверов
+     */
+    fetchDrivers(): string[];
+    /**
+     * Возвращает интерфейс драйвера по указанному идентификатору.
+     * Если alias пусто, то вернет интерфейс к драйверу по умолчанию.
      */
-    getDrivers(): string[];
+    getDriver(alias?: string): IDocHubAIDriver;
     /**
      * Возвращает дефолтный драйвер AI
      */

package/package.json

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