knowmax-quest-types 2.35.3 → 2.36.0-beta.10

package/dist/IDocumentInsight.d.ts

@@ -1,6 +1,20 @@
 import { DocumentInsightAction } from "./IDocumentInsightOptions";
+/** Response of Knowmax Quest Document Insight request. */
 export interface IDocumentInsight {
+    /** Status of document insight retrieval. */
+    status: 'Ok' | 'IntelligenceModelError' | 'Error';
+    /** Error specific for problems with intelligence model status initialization. */
+    intelligenceModelStatus: 'Ok' | 'NotFound' | 'UnsupportedType';
+    /** Identification for this conversation. Provide with follow up messages in this conversation to maintain conversation history. */
+    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;
+    /** Maximum number of messages in conversation allowed. */
+    maxConversationDepth: number;
+    /** Current number in conversation */
+    conversationDepth: number;
 }

package/dist/IDocumentInsightOptions.d.ts

@@ -3,9 +3,26 @@ export declare enum DocumentInsightAction {
     Summarize = "Summarize",
     Translate = "Translate"
 }
+export declare enum DocumentInsightChatMessageRole {
+    System = "System",
+    Assistant = "Assistant",
+    User = "User",
+    Tool = "Tool"
+}
+export interface IDocumentInsightChatMessage {
+    role: DocumentInsightChatMessageRole;
+    text: string;
+}
+/** Describes Knowmax Quest Document Insight request. */
 export interface IDocumentInsightOptions {
+    /**  The label of the intelligence model to use. If not provided, applicationName must be provided to determine intelligence model. */
+    intelligenceModelLabel?: string;
+    /** Used to determine intelligence model for application if intelligenceModelLabel is not provided.  */
+    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;
-    prompts?: string[];
+    chatMessages?: IDocumentInsightChatMessage[];
     maxWords?: number;
     language?: string;
 }

package/dist/IDocumentInsightOptions.js

@@ -4,3 +4,10 @@ export var DocumentInsightAction;
     DocumentInsightAction["Summarize"] = "Summarize";
     DocumentInsightAction["Translate"] = "Translate";
 })(DocumentInsightAction || (DocumentInsightAction = {}));
+export var DocumentInsightChatMessageRole;
+(function (DocumentInsightChatMessageRole) {
+    DocumentInsightChatMessageRole["System"] = "System";
+    DocumentInsightChatMessageRole["Assistant"] = "Assistant";
+    DocumentInsightChatMessageRole["User"] = "User";
+    DocumentInsightChatMessageRole["Tool"] = "Tool";
+})(DocumentInsightChatMessageRole || (DocumentInsightChatMessageRole = {}));

package/dist/IIndexResearch.d.ts

@@ -0,0 +1,10 @@
+export interface IIndexResearch {
+    conversationId: string;
+    text: string;
+    citations?: IIndexResearchCitation[];
+}
+export interface IIndexResearchCitation {
+    questId: string;
+    title: string;
+    contents: string;
+}

package/dist/IIndexResearch.js

@@ -0,0 +1 @@
+export {};

package/dist/IIndexResearchOptions.d.ts

@@ -0,0 +1,7 @@
+export interface IIndexResearchOptions {
+    applicationName?: string;
+    indexDefinitionName?: string;
+    conversationId?: string;
+    query: string;
+    filter?: string;
+}

package/dist/IIndexResearchOptions.js

@@ -0,0 +1 @@
+export {};

package/dist/index.d.ts

@@ -33,3 +33,5 @@ export * from './IListRequest';
 export * from './ISecurityLabels';
 export * from './IDocumentInsightOptions';
 export * from './IDocumentInsight';
+export * from './IIndexResearchOptions';
+export * from './IIndexResearch';

package/dist/index.js

@@ -33,3 +33,5 @@ export * from './IListRequest';
 export * from './ISecurityLabels';
 export * from './IDocumentInsightOptions';
 export * from './IDocumentInsight';
+export * from './IIndexResearchOptions';
+export * from './IIndexResearch';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "knowmax-quest-types",
-  "version": "2.35.3",
+  "version": "2.36.0-beta.10",
   "description": "Contains type definitions for communicating with Knowmax Quest.",
   "type": "module",
   "main": "./dist/index.js",
@@ -27,6 +27,6 @@
     "rimraf": "6.0.1",
     "ts-jest": "^29.2.5",
     "ts-node": "^10.9.2",
-    "typescript": "5.7.2"
+    "typescript": "5.7.3"
   }
 }