knowmax-quest-types 2.37.0-beta.2 → 2.37.0-beta.5

package/dist/IDocumentInsight.d.ts

@@ -1,19 +1,6 @@
+import type { IIntelligenceBase } from '.';
 /** Response of Knowmax Quest Document Insight request. */
-export interface IDocumentInsight {
-    /** Status of document insight retrieval. */
-    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 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;
+export interface IDocumentInsight extends IIntelligenceBase {
     /** Interpreted Quest id of document node for which document insight was requested. */
     questId: string;
-    /** 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

@@ -1,21 +1,12 @@
-import type { IIntelligenceChatMessage } from '.';
+import type { IIntelligenceBaseOptions } from '.';
 export declare enum DocumentInsightResponseFormat {
     Text = "Text",
     Json = "Json"
 }
 /** 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;
-    chatMessages?: IIntelligenceChatMessage[];
+export interface IDocumentInsightOptions extends IIntelligenceBaseOptions {
     /** 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/IIndexResearch.d.ts

@@ -1,22 +1,3 @@
-export interface IIndexResearch {
-    /** 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;
-    title: string;
-    contents: string;
+import type { IIntelligenceBase } from '.';
+export interface IIndexResearch extends IIntelligenceBase {
 }

package/dist/IIndexResearchOptions.d.ts

@@ -1,15 +1,5 @@
-import type { IIntelligenceChatMessage } from '.';
-export interface IIndexResearchOptions {
-    /**  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;
-    chatMessages?: IIntelligenceChatMessage[];
-    /** Filter to use for query. */
+import type { IIntelligenceBaseOptions } from '.';
+export interface IIndexResearchOptions extends IIntelligenceBaseOptions {
+    /** Azure AI Search 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/IIntelligenceBase.d.ts

@@ -0,0 +1,19 @@
+import type { IIntelligenceCitation } from ".";
+export interface IIntelligenceBase {
+    /** Status of document insight retrieval. */
+    status: 'Ok' | 'IndexError' | '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 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;
+    /** Textual response. Might contain markdown formatted contents. */
+    text?: string;
+    /** List of citations possible referenced from text. */
+    citations?: IIntelligenceCitation[];
+    /** Maximum number of messages in conversation allowed. */
+    maxConversationDepth: number;
+    /** Current number in conversation */
+    conversationDepth: number;
+}

package/dist/IIntelligenceBase.js

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

package/dist/IIntelligenceBaseOptions.d.ts

@@ -0,0 +1,15 @@
+import type { IIntelligenceChatMessage } from '.';
+export interface IIntelligenceBaseOptions {
+    /**  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;
+    /** Optional conversation id to maintain context across multiple requests. */
+    conversationId?: string;
+    /** Array of chat messages to use for this request.  */
+    chatMessages: IIntelligenceChatMessage[];
+    /** Set to ignore conversation for this request. Na data will be read or written from or to conversation history. */
+    ignoreConversation?: boolean;
+}

package/dist/IIntelligenceBaseOptions.js

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

package/dist/IIntelligenceCitation.d.ts

@@ -1,4 +1,5 @@
 export interface IIntelligenceCitation {
+    bookTitle?: string;
     questId: string;
     title: string;
     contents: string;

package/dist/index.d.ts

@@ -31,6 +31,8 @@ export * from './IDocumentPredecessor';
 export * from './metadata';
 export * from './IListRequest';
 export * from './ISecurityLabels';
+export * from './IIntelligenceBaseOptions';
+export * from './IIntelligenceBase';
 export * from './IDocumentInsightOptions';
 export * from './IDocumentInsight';
 export * from './IIndexResearchOptions';

package/dist/index.js

@@ -31,6 +31,8 @@ export * from './IDocumentPredecessor';
 export * from './metadata';
 export * from './IListRequest';
 export * from './ISecurityLabels';
+export * from './IIntelligenceBaseOptions';
+export * from './IIntelligenceBase';
 export * from './IDocumentInsightOptions';
 export * from './IDocumentInsight';
 export * from './IIndexResearchOptions';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "knowmax-quest-types",
-  "version": "2.37.0-beta.2",
+  "version": "2.37.0-beta.5",
   "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.6",
     "ts-node": "^10.9.2",
-    "typescript": "5.7.3"
+    "typescript": "5.8.2"
   }
 }