knowmax-quest-types 2.36.0-beta.9 → 2.36.0

package/dist/IDocumentInsight.d.ts

@@ -1,16 +1,19 @@
-import { DocumentInsightAction } from "./IDocumentInsightOptions";
 /** Response of Knowmax Quest Document Insight request. */
 export interface IDocumentInsight {
     /** Status of document insight retrieval. */
-    status: 'Ok' | 'IntelligenceModelError' | 'Error';
+    status: 'Ok' | 'IntelligenceModelError' | 'InputTooLong' | 'ContentFilter' | 'Error';
     /** Error specific for problems with intelligence model status initialization. */
     intelligenceModelStatus: 'Ok' | 'NotFound' | 'UnsupportedType';
+    /** In case status is set to error, this propety might contain technical details about the error. */
+    errorDetails?: string;
     /** Identification for this conversation. Provide with follow up messages in this conversation to maintain conversation history. */
-    conversationId: string;
+    conversationId?: string;
     /** Interpreted Quest id of document node for which document insight was requested. */
     questId: string;
-    /** Executed action */
-    action: DocumentInsightAction;
     /** Textual response. Might contain markdown formatted contents. */
-    text: string;
+    text?: string;
+    /** Maximum number of messages in conversation allowed. */
+    maxConversationDepth: number;
+    /** Current number in conversation */
+    conversationDepth: number;
 }

package/dist/IDocumentInsightOptions.d.ts

@@ -1,14 +1,13 @@
-export declare enum DocumentInsightAction {
-    Custom = "Custom",
-    Summarize = "Summarize",
-    Translate = "Translate"
-}
 export declare enum DocumentInsightChatMessageRole {
     System = "System",
     Assistant = "Assistant",
     User = "User",
     Tool = "Tool"
 }
+export declare enum DocumentInsightResponseFormat {
+    Text = "Text",
+    Json = "Json"
+}
 export interface IDocumentInsightChatMessage {
     role: DocumentInsightChatMessageRole;
     text: string;
@@ -21,8 +20,11 @@ export interface IDocumentInsightOptions {
     applicationName?: string;
     /** Set to conversation id received after first request to maintain conversation history. Set to undefined to start new conversation. */
     conversationId?: string;
-    action: DocumentInsightAction;
     chatMessages?: IDocumentInsightChatMessage[];
-    maxWords?: number;
-    language?: string;
+    /** Set to explicitly not use the contents of the document in generating answer. In that case only technical data like metadata, version data and table of contents will be used. Defaults to false. */
+    ignoreContents?: boolean;
+    /** Set to ignore conversation for this request. Na data will be read or written from or to conversation history. */
+    ignoreConversation?: boolean;
+    /** Set to requested type to instruct AI model to format results. Empty for default (text). */
+    responseFormat?: DocumentInsightResponseFormat;
 }

package/dist/IDocumentInsightOptions.js

@@ -1,9 +1,3 @@
-export var DocumentInsightAction;
-(function (DocumentInsightAction) {
-    DocumentInsightAction["Custom"] = "Custom";
-    DocumentInsightAction["Summarize"] = "Summarize";
-    DocumentInsightAction["Translate"] = "Translate";
-})(DocumentInsightAction || (DocumentInsightAction = {}));
 export var DocumentInsightChatMessageRole;
 (function (DocumentInsightChatMessageRole) {
     DocumentInsightChatMessageRole["System"] = "System";
@@ -11,3 +5,8 @@ export var DocumentInsightChatMessageRole;
     DocumentInsightChatMessageRole["User"] = "User";
     DocumentInsightChatMessageRole["Tool"] = "Tool";
 })(DocumentInsightChatMessageRole || (DocumentInsightChatMessageRole = {}));
+export var DocumentInsightResponseFormat;
+(function (DocumentInsightResponseFormat) {
+    DocumentInsightResponseFormat["Text"] = "Text";
+    DocumentInsightResponseFormat["Json"] = "Json";
+})(DocumentInsightResponseFormat || (DocumentInsightResponseFormat = {}));

package/dist/IMetadataValueSuggestion.d.ts

@@ -2,6 +2,8 @@
 export interface IMetadataValueSuggestion {
     /** Identification of metadata when requesting suggestions. Usually in format familylabel.label */
     metadataDefinition: string;
+    /** Origin of suggestion. */
+    origin: 'Collection' | 'Document' | 'Regular' | 'Octa';
     /** Suggested values for metadata. */
     values: IMetadataValueSuggestionItem[];
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "knowmax-quest-types",
-  "version": "2.36.0-beta.9",
+  "version": "2.36.0",
   "description": "Contains type definitions for communicating with Knowmax Quest.",
   "type": "module",
   "main": "./dist/index.js",