dochub-sdk 0.1.392 → 0.1.394
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/interfaces/ai.ts +48 -4
- package/package.json +1 -1
package/interfaces/ai.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { DocHubJSONSchema } from '../schemas/basetypes';
|
|
2
2
|
import { DataLakePath } from './datalake';
|
|
3
3
|
import { DocHubEditorContext } from './editors';
|
|
4
|
-
|
|
4
|
+
|
|
5
5
|
|
|
6
6
|
/**
|
|
7
7
|
* События AI
|
|
@@ -26,6 +26,40 @@ export enum DocHubAIEvents {
|
|
|
26
26
|
*/
|
|
27
27
|
export interface IDocHubAIContextPortion {}
|
|
28
28
|
|
|
29
|
+
/**
|
|
30
|
+
* Причина вывода моделью
|
|
31
|
+
*/
|
|
32
|
+
export enum DocHubAIRequestTypingReason {
|
|
33
|
+
/**
|
|
34
|
+
* Размышления модели
|
|
35
|
+
*/
|
|
36
|
+
thinking = 'thinking',
|
|
37
|
+
/**
|
|
38
|
+
* Использование инструмента
|
|
39
|
+
*/
|
|
40
|
+
command = 'command',
|
|
41
|
+
/**
|
|
42
|
+
* Использование знаний
|
|
43
|
+
*/
|
|
44
|
+
knowledge = 'knowledge',
|
|
45
|
+
/**
|
|
46
|
+
* Ответ модели
|
|
47
|
+
*/
|
|
48
|
+
response = 'response',
|
|
49
|
+
/**
|
|
50
|
+
* Сервисная информация (отладочная, лимиты и т.п.)
|
|
51
|
+
*/
|
|
52
|
+
service = 'service'
|
|
53
|
+
}
|
|
54
|
+
|
|
55
|
+
export interface IDocHubAIRequestTypingMeta {
|
|
56
|
+
//
|
|
57
|
+
reason: DocHubAIRequestTypingReason;
|
|
58
|
+
payload?: IDocHubAIComposerCommandMeta | IDocHubAIComposerKnowledgeMeta;
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
export type DocHubAIRequestTyping = (text: string, meta: IDocHubAIRequestTypingMeta) => void;
|
|
62
|
+
|
|
29
63
|
/**
|
|
30
64
|
* Интерфейс открытого запроса к AI
|
|
31
65
|
*/
|
|
@@ -41,8 +75,9 @@ export interface IDocHubAIRequest {
|
|
|
41
75
|
/**
|
|
42
76
|
* Обрабатывает ответ от AI
|
|
43
77
|
* @param answer - Ответ от AI
|
|
78
|
+
* @param meta - Метаинформация о выводе
|
|
44
79
|
*/
|
|
45
|
-
onTyping?:
|
|
80
|
+
onTyping?: DocHubAIRequestTyping;
|
|
46
81
|
/**
|
|
47
82
|
* Обрабатывает завершение ответа от AI
|
|
48
83
|
*/
|
|
@@ -56,6 +91,10 @@ export interface IDocHubAIRequest {
|
|
|
56
91
|
* Очищает накопившийся контекст
|
|
57
92
|
*/
|
|
58
93
|
clearContext(): void;
|
|
94
|
+
/**
|
|
95
|
+
* Вытягивает актуальные данные контекста из запроса во внутреннем формате (~OpenAI)
|
|
96
|
+
*/
|
|
97
|
+
pullContext(): Promise<string>;
|
|
59
98
|
/**
|
|
60
99
|
* Отменяет запрос
|
|
61
100
|
* @returns
|
|
@@ -65,7 +104,7 @@ export interface IDocHubAIRequest {
|
|
|
65
104
|
* Отправляет следующий запрос в AI
|
|
66
105
|
* @returns
|
|
67
106
|
*/
|
|
68
|
-
next(question: string): Promise<void>;
|
|
107
|
+
next(question: string, attachment?: DocHubAIAskAttachment): Promise<void>;
|
|
69
108
|
}
|
|
70
109
|
|
|
71
110
|
export type DocHubAIAskAttachmentFileContent = string;
|
|
@@ -106,12 +145,16 @@ export interface IDocHubAIAskOptions {
|
|
|
106
145
|
* Файлы прикрепляемые к запросу
|
|
107
146
|
*/
|
|
108
147
|
attachment?: DocHubAIAskAttachment;
|
|
148
|
+
/**
|
|
149
|
+
* Данные контекста во внутреннем формате (~OpenAI)
|
|
150
|
+
*/
|
|
151
|
+
context?: string;
|
|
109
152
|
}
|
|
110
153
|
|
|
111
154
|
/**
|
|
112
155
|
* Тип функции запроса к AI
|
|
113
156
|
*/
|
|
114
|
-
export type DocHubAskFunction = (question
|
|
157
|
+
export type DocHubAskFunction = (question?: string, options?: IDocHubAIAskOptions) => Promise<IDocHubAIRequest>;
|
|
115
158
|
|
|
116
159
|
/**
|
|
117
160
|
* Интерфейс драйвера AI
|
|
@@ -281,6 +324,7 @@ export interface IDocHubAICapabilities {
|
|
|
281
324
|
[DocHubAICapabilityID.temperature]?: boolean;
|
|
282
325
|
}
|
|
283
326
|
|
|
327
|
+
|
|
284
328
|
/**
|
|
285
329
|
* Интерфейс AI ассистента
|
|
286
330
|
*/
|