knowmax-quest-types 2.36.0 → 2.37.0-beta.1

package/dist/IDocumentInsight.d.ts

@@ -4,7 +4,7 @@ export interface IDocumentInsight {
     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. */
+    /** In case status is set to error, this property 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;

package/dist/IDocumentInsightOptions.d.ts

@@ -1,17 +1,8 @@
-export declare enum DocumentInsightChatMessageRole {
-    System = "System",
-    Assistant = "Assistant",
-    User = "User",
-    Tool = "Tool"
-}
+import type { IIntelligenceChatMessage } from '.';
 export declare enum DocumentInsightResponseFormat {
     Text = "Text",
     Json = "Json"
 }
-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. */
@@ -20,7 +11,7 @@ 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;
-    chatMessages?: IDocumentInsightChatMessage[];
+    chatMessages?: IIntelligenceChatMessage[];
     /** 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. */

package/dist/IDocumentInsightOptions.js

@@ -1,10 +1,3 @@
-export var DocumentInsightChatMessageRole;
-(function (DocumentInsightChatMessageRole) {
-    DocumentInsightChatMessageRole["System"] = "System";
-    DocumentInsightChatMessageRole["Assistant"] = "Assistant";
-    DocumentInsightChatMessageRole["User"] = "User";
-    DocumentInsightChatMessageRole["Tool"] = "Tool";
-})(DocumentInsightChatMessageRole || (DocumentInsightChatMessageRole = {}));
 export var DocumentInsightResponseFormat;
 (function (DocumentInsightResponseFormat) {
     DocumentInsightResponseFormat["Text"] = "Text";

package/dist/IIndexResearch.d.ts

@@ -1,7 +1,19 @@
 export interface IIndexResearch {
-    conversationId: string;
-    text: string;
+    /** Status of index research request. */
+    status: 'Ok' | 'IndexError' | 'IntelligenceModelError' | 'ContentFilter' | 'Error';
+    /** Error specific for problems with intelligence model status initialization. */
+    intelligenceModelStatus: 'Ok' | 'NotFound' | 'UnsupportedType';
+    /** In case status is set to error, this property 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;
+    text?: string;
+    /** List of citations possible referenced from text. */
     citations?: IIndexResearchCitation[];
+    /** Maximum number of messages in conversation allowed. */
+    maxConversationDepth: number;
+    /** Current number in conversation */
+    conversationDepth: number;
 }
 export interface IIndexResearchCitation {
     questId: string;

package/dist/IIndexResearchOptions.d.ts

@@ -1,7 +1,15 @@
+import type { IIntelligenceChatMessage } from '.';
 export interface IIndexResearchOptions {
-    applicationName?: string;
+    /**  The label of the intelligence model to use. If not provided, applicationName must be provided to determine intelligence model. */
+    intelligenceModelLabel?: string;
+    /** Name of index definition to use. If not provided, applicationName must be provided to determine index definition. */
     indexDefinitionName?: string;
+    /** Used to determine intelligence model for application if intelligenceModelLabel is not provided.  */
+    applicationName?: string;
     conversationId?: string;
-    query: string;
+    chatMessages?: IIntelligenceChatMessage[];
+    /** Filter to use for query. */
     filter?: string;
+    /** Set to ignore conversation for this request. Na data will be read or written from or to conversation history. */
+    ignoreConversation?: boolean;
 }

package/dist/IIntelligenceChatMessage.d.ts

@@ -0,0 +1,10 @@
+export declare enum IntelligenceChatMessageRole {
+    System = "System",
+    Assistant = "Assistant",
+    User = "User",
+    Tool = "Tool"
+}
+export interface IIntelligenceChatMessage {
+    role: IntelligenceChatMessageRole;
+    text: string;
+}

package/dist/IIntelligenceChatMessage.js

@@ -0,0 +1,7 @@
+export var IntelligenceChatMessageRole;
+(function (IntelligenceChatMessageRole) {
+    IntelligenceChatMessageRole["System"] = "System";
+    IntelligenceChatMessageRole["Assistant"] = "Assistant";
+    IntelligenceChatMessageRole["User"] = "User";
+    IntelligenceChatMessageRole["Tool"] = "Tool";
+})(IntelligenceChatMessageRole || (IntelligenceChatMessageRole = {}));

package/dist/index.d.ts

@@ -35,3 +35,4 @@ export * from './IDocumentInsightOptions';
 export * from './IDocumentInsight';
 export * from './IIndexResearchOptions';
 export * from './IIndexResearch';
+export * from './IIntelligenceChatMessage';

package/dist/index.js

@@ -35,3 +35,4 @@ export * from './IDocumentInsightOptions';
 export * from './IDocumentInsight';
 export * from './IIndexResearchOptions';
 export * from './IIndexResearch';
+export * from './IIntelligenceChatMessage';

package/package.json

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