knowmax-quest-types 2.36.0-beta.16 → 2.36.0-beta.18

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.
@@ -7,11 +7,11 @@ export interface IDocumentInsight {
7
7
  /** In case status is set to error, this propety might contain technical details about the error. */
8
8
  errorDetails?: string;
9
9
  /** Identification for this conversation. Provide with follow up messages in this conversation to maintain conversation history. */
10
- conversationId: string;
10
+ conversationId?: string;
11
11
  /** Interpreted Quest id of document node for which document insight was requested. */
12
12
  questId: string;
13
13
  /** Textual response. Might contain markdown formatted contents. */
14
- text: string;
14
+ text?: string;
15
15
  /** Maximum number of messages in conversation allowed. */
16
16
  maxConversationDepth: number;
17
17
  /** Current number in conversation */
@@ -4,6 +4,10 @@ export declare enum DocumentInsightChatMessageRole {
4
4
  User = "User",
5
5
  Tool = "Tool"
6
6
  }
7
+ export declare enum DocumentInsightResponseFormat {
8
+ Text = "Text",
9
+ Json = "Json"
10
+ }
7
11
  export interface IDocumentInsightChatMessage {
8
12
  role: DocumentInsightChatMessageRole;
9
13
  text: string;
@@ -21,6 +25,6 @@ export interface IDocumentInsightOptions {
21
25
  ignoreContents?: boolean;
22
26
  /** Set to ignore conversation for this request. Na data will be read or written from or to conversation history. */
23
27
  ignoreConversation?: boolean;
24
- /** Set to true to instruct AI model to format results as JSON. */
25
- responseFormatJson?: boolean;
28
+ /** Set to requested type to instruct AI model to format results. Empty for default (text). */
29
+ responseFormat?: DocumentInsightResponseFormat;
26
30
  }
@@ -5,3 +5,8 @@ export var DocumentInsightChatMessageRole;
5
5
  DocumentInsightChatMessageRole["User"] = "User";
6
6
  DocumentInsightChatMessageRole["Tool"] = "Tool";
7
7
  })(DocumentInsightChatMessageRole || (DocumentInsightChatMessageRole = {}));
8
+ export var DocumentInsightResponseFormat;
9
+ (function (DocumentInsightResponseFormat) {
10
+ DocumentInsightResponseFormat["Text"] = "Text";
11
+ DocumentInsightResponseFormat["Json"] = "Json";
12
+ })(DocumentInsightResponseFormat || (DocumentInsightResponseFormat = {}));
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "knowmax-quest-types",
3
- "version": "2.36.0-beta.16",
3
+ "version": "2.36.0-beta.18",
4
4
  "description": "Contains type definitions for communicating with Knowmax Quest.",
5
5
  "type": "module",
6
6
  "main": "./dist/index.js",