@intelliweave/embedded 1.6.55 → 1.7.57

package/dist/webpack/index.d.ts

@@ -1,7 +1,86 @@
+import { Optional } from 'utility-types';
 import * as onnxruntime_web from 'onnxruntime-web';
 import { InferenceSession, Tensor } from 'onnxruntime-web';
 import React from 'react';
 
+/**
+ * This class helps organize groups of tokenized text along with removing items when the window is full.
+ */
+declare class TokenWindow {
+    /** Token window size */
+    size: number;
+    /** Token groups */
+    groups: TokenWindowGroup<any>[];
+    /** Create a new group */
+    createGroup(id: string): TokenWindowGroup<unknown>;
+    /** Get a group */
+    group<CustomDataType>(id: string): TokenWindowGroup<CustomDataType> | undefined;
+    /** Calculate current tokens in all groups */
+    countTokens(): number;
+    /** Remove overflow from all groups. */
+    removeOverflow(): void;
+    /** Remove one overflow item. Returns null if no items were able to be removed. */
+    private removeOneItem;
+}
+/** A token group. */
+declare class TokenWindowGroup<CustomDataType> {
+    /** Group ID */
+    id: string;
+    /** List of items */
+    items: TokenWindowGroupItem<CustomDataType>[];
+    /**
+     * Weight controls how many items from this group should be kept in relation to the entire window. For example if all
+     * groups have a weight of 1, each group remove items equally if full. If one has a weight of 2 while the rest are 1,
+     * that group will be allowed to keep double the amount of items.
+     */
+    weight: number;
+    /** Current total token count, computed automatically. Don't update this value manually. */
+    tokenCount: number;
+    /** Group item separator */
+    separator: string;
+    /** Token count padding added to each item. */
+    private itemPadding;
+    /** Sets the token count padding added to each item. Useful if you don't know exactly what will be added by the LLM host. */
+    setItemPadding(padding: number): this;
+    /** Sort function */
+    private sortFunction;
+    /** Set sort function */
+    sortBy(sortFunction: (a: TokenWindowGroupItem<CustomDataType>, b: TokenWindowGroupItem<CustomDataType>) => number): this;
+    /** Set separator */
+    setSeparator(separator: string): this;
+    /** Set weight */
+    setWeight(weight: number): this;
+    /** Recalculate all tokens. Note this may take a while. */
+    recalculateTokens(): void;
+    /** Add an item to the group */
+    add(item: string | Omit<Optional<TokenWindowGroupItem<CustomDataType>, 'id' | 'dateAdded' | 'sortOrder'>, 'tokenCount'>): TokenWindowGroupItem<CustomDataType>;
+    /** Get all items as a string */
+    getAllAsString(): string;
+    /** Get all items. Doesn't return disabled items. */
+    getAll(): TokenWindowGroupItem<CustomDataType>[];
+    /** Remove all items from this group */
+    empty(): void;
+}
+/** Token group item */
+interface TokenWindowGroupItem<CustomDataType> {
+    /** Each item must have a unique ID. */
+    id: string;
+    /** The string content of the item */
+    content: string;
+    /** True if this item should never be removed */
+    cannotRemove?: boolean;
+    /** Sorting order. If not specified, uses dateAdded instead. */
+    sortOrder: number;
+    /** Date this item was added */
+    dateAdded: number;
+    /** Token count in the content */
+    tokenCount: number;
+    /** Anything to attach to this item */
+    customData?: CustomDataType;
+    /** If disabled, this item will not be included and will not add tot he token count. */
+    disabled?: boolean;
+}
+
 /** ChatGPT config options */
 interface ChatGPTConfig {
     /** API key */
@@ -43,9 +122,22 @@ interface ChatGPTToolConfig {
     callback: (params: any) => any;
     /** If true, this tool call will be removed from the message history after it is executed. */
     removeFromMessageHistory?: boolean;
+    /** If true, this item can be removed if there's not enough context available. */
+    canRemove?: boolean;
     /** Misc app context */
     [key: string]: any;
 }
+/** ChatGPT message */
+interface ChatGPTMessage {
+    /** Role of the message */
+    role: 'user' | 'assistant' | 'system' | 'tool';
+    /** Content of the message */
+    content: string;
+    /** Tool call ID */
+    tool_call_id?: string;
+    /** Tool calls made by the AI */
+    tool_calls?: any[];
+}
 /**
  * API for interacting with ChatGPT APIs.
  */
@@ -56,22 +148,33 @@ declare class ChatGPT {
     metadata: any;
     /** Config */
     config: ChatGPTConfig;
-    /** List of messages in the chat history */
-    messages: any[];
-    /** List of available tools */
-    tools: ChatGPTToolConfig[];
     /** The maximum tool calls in sequence the AI can make before an error is thrown. */
     maxToolCallsPerMessage: number;
-    private _hasRemovedToolCallHistorySinceLastMessage;
     /** Statistics */
     stats: {
         /** Total tokens used this session */
         tokensUsed: number;
     };
+    /** Token window management */
+    tokenWindow: TokenWindow;
+    /** Token window group used for the context message */
+    get contextGroup(): TokenWindowGroup<any>;
+    /** Token window group used for tools / actions */
+    get toolGroup(): TokenWindowGroup<ChatGPTToolConfig>;
+    /** Token window group used for messages */
+    get messageGroup(): TokenWindowGroup<ChatGPTMessage>;
     /** Constructor */
     constructor(config: ChatGPTConfig);
     /** Send a message, and get the response */
     sendMessage(message: string): Promise<string>;
+    /** Insert a message as if the assistant has written it */
+    addAssistantMessage(message: string): void;
+    /** Insert a message sent from a user. Note that doing this instead of using `sendMessage()` means you'll need to manually call `await processMessages()` and then `getLatestMessage()` to get the response. */
+    addUserMessage(message: string): void;
+    /** Get all messages */
+    getMessages(): ChatGPTMessage[];
+    /** Get latest message */
+    getLatestMessage(): ChatGPTMessage | undefined;
     /** @private Process messages in the chat history */
     processMessages(): Promise<void>;
     /** Trim message list */
@@ -397,11 +500,11 @@ declare class IntelliWeave extends EventTarget {
     exportState(): {
         type: string;
         conversationID: string;
-        messages: any[] | undefined;
+        messages: (ChatGPTMessage | undefined)[] | undefined;
     };
     /** Import conversation state from JSON */
     importState(state: any): void;
-    /** Clone this instance */
+    /** Clone this instance without any message history */
     clone(): IntelliWeave;
 }
 
@@ -1317,4 +1420,4 @@ declare function useIntelliWeave(): IntelliWeave | undefined;
 /** React hook to add an external KB search hook. This can provide static KB entries, or perform an async search and return dynamic entries. */
 declare function useIntelliWeaveKnowledge(query: KnowledgeBaseSource['query'], dependencies?: any[]): void;
 
-export { AILogic, AudioSystem, type BufferType, BufferedWebSocket, ChatGPT, type ChatGPTConfig, type ChatGPTToolConfig, FixedBufferStream, IntelliWeave, IntelliWeaveProvider, IntelliWeaveStream, type IntelliWeaveStreamErrorEvent, type IntelliWeaveStreamEvent, type IntelliWeaveStreamTextOutputEvent, IntelliWeaveTranscriptionNode, KnowledgeBase, type KnowledgeBaseItem, type KnowledgeBaseSource, type KnowledgeBaseWebhookActionResponse, type KnowledgeBaseWebhookRequest, type KnowledgeBaseWebhookSearchResponse, Logging, ONNXModel, type ONNXTensors, OpenAITranscriptionNode, PCMPlayerNode, PCMReceiverNode, Resampler, type SupportedArrayBuffers, VoiceChunkOutputNode, VoiceDetectionNode, WebWeaverEmbed, type WebWeaverGPTConfig, WebWeaverSpeechOutput, WebWeaverSpeechRecognition, WebWeaverUI, audioToWav, floatTo16BitPCM, floatTo64BitPCM, getDefaultUserID, int16ToFloat32BitPCM, intelliweaveConfig, intelliweaveGlobalThis, sseEvents, trimWhitespaceInText, useIntelliWeave, useIntelliWeaveKnowledge };
+export { AILogic, AudioSystem, type BufferType, BufferedWebSocket, ChatGPT, type ChatGPTConfig, type ChatGPTMessage, type ChatGPTToolConfig, FixedBufferStream, IntelliWeave, IntelliWeaveProvider, IntelliWeaveStream, type IntelliWeaveStreamErrorEvent, type IntelliWeaveStreamEvent, type IntelliWeaveStreamTextOutputEvent, IntelliWeaveTranscriptionNode, KnowledgeBase, type KnowledgeBaseItem, type KnowledgeBaseSource, type KnowledgeBaseWebhookActionResponse, type KnowledgeBaseWebhookRequest, type KnowledgeBaseWebhookSearchResponse, Logging, ONNXModel, type ONNXTensors, OpenAITranscriptionNode, PCMPlayerNode, PCMReceiverNode, Resampler, type SupportedArrayBuffers, TokenWindow, TokenWindowGroup, type TokenWindowGroupItem, VoiceChunkOutputNode, VoiceDetectionNode, WebWeaverEmbed, type WebWeaverGPTConfig, WebWeaverSpeechOutput, WebWeaverSpeechRecognition, WebWeaverUI, audioToWav, floatTo16BitPCM, floatTo64BitPCM, getDefaultUserID, int16ToFloat32BitPCM, intelliweaveConfig, intelliweaveGlobalThis, sseEvents, trimWhitespaceInText, useIntelliWeave, useIntelliWeaveKnowledge };