dochub-sdk 0.1.393 → 0.1.395

package/interfaces/ai.ts

@@ -45,10 +45,15 @@ export enum DocHubAIRequestTypingReason {
     /**
      * Ответ модели
      */
-    response = 'response'
+    response = 'response',
+    /**
+     * Сервисная информация (отладочная, лимиты и т.п.)
+     */
+    service = 'service'
 }
 
 export interface IDocHubAIRequestTypingMeta {
+    // 
     reason: DocHubAIRequestTypingReason;
     payload?: IDocHubAIComposerCommandMeta | IDocHubAIComposerKnowledgeMeta;
 }
@@ -86,6 +91,15 @@ export interface IDocHubAIRequest {
      * Очищает накопившийся контекст
      */
     clearContext(): void;
+    /**
+     * Вытягивает актуальные данные контекста из запроса во внутреннем формате (~OpenAI)
+     */
+    pullContext(): Promise<string>;
+    /**
+     * Добавляет к текущему контексту сегмент (мерджит)
+     * @param context 
+     */
+    appendContext(context: string): Promise<void>;
     /**
      * Отменяет запрос
      * @returns 
@@ -95,7 +109,7 @@ export interface IDocHubAIRequest {
      * Отправляет следующий запрос в AI
      * @returns 
      */
-    next(question: string): Promise<void>;
+    next(question: string, attachment?: DocHubAIAskAttachment): Promise<void>;
 }
 
 export type DocHubAIAskAttachmentFileContent = string;
@@ -136,12 +150,16 @@ export interface IDocHubAIAskOptions {
      * Файлы прикрепляемые к запросу
      */
     attachment?: DocHubAIAskAttachment;
+    /**
+     * Данные контекста во внутреннем формате (~OpenAI)
+     */
+    context?: string;
 }
 
 /**
  * Тип функции запроса к AI
  */
-export type DocHubAskFunction = (question: string, options?: IDocHubAIAskOptions) => Promise<IDocHubAIRequest>;
+export type DocHubAskFunction = (question?: string, options?: IDocHubAIAskOptions) => Promise<IDocHubAIRequest>;
 
 /**
  * Интерфейс драйвера AI
@@ -217,6 +235,8 @@ export interface IDocHubKnowledgeProvider {
 
 export type IDocHubAIComposerCommandPayload = any;
 
+export type IDocHubAIComposerCommandPullSchema = () => Promise<DocHubJSONSchema>;
+
 export interface IDocHubAIComposerCommandMeta {
     /**
      * Уникальный идентификатор команды
@@ -225,7 +245,7 @@ export interface IDocHubAIComposerCommandMeta {
     /**
      * Схема определяющая payload команды
      */
-    schema: DocHubJSONSchema;
+    schema: DocHubJSONSchema | IDocHubAIComposerCommandPullSchema;
 }
 
 /**
@@ -242,6 +262,23 @@ export interface IDocHubAIComposerKnowledgeMeta {
     description: string;
 }
 
+export type DocHubAIComposerCommandStatus = (payload: any) => void;
+
+/**
+ * Метаданные исполнения команды
+ */
+export interface IDocHubAIComposerCommandOptions {
+    /**
+     * Тэг операции. Если он определен, то результат операции должен быть помечен данным тэгом.
+     * Например, созданные или измененные файлы должны иметь тэги данной операции.
+     */
+    tag?: string;
+    /**
+     * Обработчик внутренних событий команды для отражения статуса ее выполнения
+     */
+    onStatus?: DocHubAIComposerCommandStatus;
+}
+
 /**
  * Интерфейс декларирующий доступную команду для AI
  */
@@ -251,7 +288,7 @@ export interface IDocHubAIComposerCommand extends IDocHubAIComposerCommandMeta {
      * @param payload   - Данны для выполнения команды
      * @returns         - Результат выполнения команды для включения в контекст
      */
-    execute(payload: IDocHubAIComposerCommandPayload): Promise<string>;
+    execute(payload: IDocHubAIComposerCommandPayload, options?: IDocHubAIComposerCommandOptions): Promise<string>;
 }
 
 /**

package/interfaces/datalake.ts

@@ -1,8 +1,6 @@
 import { IProtocolResponseOptions, IDocHubProtocolResponse, IDocHubResourceVersion } from './protocols';
-import { DocHubDataSetProfileSource, DocHubJSONataQuery, IDocHubDataSetProfile } from './jsonata';
+import { DocHubDataSetProfileSource, IDocHubDataSetProfile } from './jsonata';
 import { DocHubUITargetWindow } from './ui';
-import { DocHubJSONSchema } from '../schemas/basetypes';
-import { DocHubJSONSchemaFormat, DocHubJSONSchemaFormatCollection, DocHubJSONSchemaFormatController } from '../schemas/fields/suggester';
 import { IDocHubDataLakeSchema } from '../schemas/schema';
 
 export enum DataLakeChange {
@@ -183,6 +181,10 @@ export interface IDocHubTransaction {
      * @param uids              - массив идентификаторов изменений
      */
     deleteFileVersions(uids: string[]): Promise<void>;
+    /**
+     * Ожидает готовности транзакции к взаимодействию 
+     */
+    whenReady(): Promise<void>
 }
 
 /**

package/package.json

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