@intelliweave/embedded 2.0.72-beta.9 → 2.1.74

package/dist/webpack/index.d.ts

@@ -65,6 +65,8 @@ declare class TokenWindowGroup<DataType> {
     recalculateTokens(): void;
     /** Add an item to the group */
     add(item: string | TokenWindowGroupItemParams<DataType>): TokenWindowGroupItem<DataType>;
+    /** Manually remove an item */
+    remove(itemId: string): boolean;
     /** Get all items as a string */
     getAllAsString(): string;
     /** Get all items. Doesn't return disabled items. */
@@ -466,6 +468,8 @@ declare class KnowledgeBase {
     allowWindowSources: boolean;
     /** If true, allows using knowledge specified in the global configuration object */
     allowGlobalConfigSources: boolean;
+    /** If true, allows the AI to search the knowledge base. If false, essentially disables RAG lookup. */
+    allowRagSearch: boolean;
     /** Constructor */
     constructor(ai: IntelliWeave);
     /** Ensures the internal knowledge is set correctly */
@@ -494,7 +498,7 @@ declare class KnowledgeBase {
     /** Create and register an external knowledge base source from a URL */
     registerSourceFromURL(url: string, id?: string): void;
     /** Clone this instance */
-    clone(): KnowledgeBase;
+    clone(newIW: IntelliWeave): KnowledgeBase;
     /** Registers an MCP server as a knowledge base source */
     registerMCPSource(config: MCPKnowledgeClient['config']): MCPKnowledgeClient;
 }
@@ -824,6 +828,8 @@ interface SubAgentConfig {
     usageInstructions?: string;
     /** If true, will remove all Persona knowledge entries */
     clearExistingKnowledge?: boolean;
+    /** Disable RAG search for subagents. If true, only KB entries with isContext=true will be used. */
+    disableRagSearch?: boolean;
     /** Extra knowledge base sources for the sub-agent */
     knowledge?: KnowledgeFetcher;
     /** Optional extra configuration for the subagent instance */
@@ -912,6 +918,13 @@ interface WebWeaverGPTConfig {
     /** Subagents */
     subagents?: SubAgentConfig[];
 }
+/** Configuration for the IntelliWeave initialization */
+interface IntelliWeaveConfig extends Partial<WebWeaverGPTConfig> {
+    /** Optionally allows you to specify a custom hub API URL. */
+    hubAPI?: string;
+    /** A unique ID to identify this user. Defaults to a generated userID if not specified. */
+    userID?: string;
+}
 /**
  * IntelliWeave interface, loads a Persona from the hub and allows you to interact with it. This is the main entry point into the IntelliWeave
  * SDK when not using the built-in UI.
@@ -983,12 +996,14 @@ declare class IntelliWeave extends EventTarget {
     /** URL of the IntelliWeave Hub API */
     hubAPI: string;
     /** Set model and load data from an API key */
-    load(apiKey: string, config?: Partial<WebWeaverGPTConfig>): Promise<IntelliWeave>;
+    load(apiKey: string, config?: IntelliWeaveConfig): Promise<IntelliWeave>;
     /** Set the current model */
     setModel(id: string): void;
     private _lastSystemMsg;
     /** Get the system message prefix, before the KB entries are added */
     getContextPrefix(): Promise<string>;
+    /** KB items added in the last run */
+    private lastKBItems;
     /** Get system message to send to the AI */
     onBeforeMessageProcessing(): Promise<void>;
     /** @private Process incoming message(s) from the AI. Can be used to respond to encoded actions in the text response. */
@@ -1204,7 +1219,7 @@ declare class IntelliWeaveTranscriptionNode extends VoiceChunkOutputNode {
     static debugExportWav: boolean;
     /** Server address for transcription */
     apiAddress: string;
-    /** OpenAI API key */
+    /** IntelliWeave API key */
     apiKey: string;
     /** WebSocket connection */
     private ws?;
@@ -1224,6 +1239,32 @@ declare class IntelliWeaveTranscriptionNode extends VoiceChunkOutputNode {
     onSocketClose(): void;
 }
 
+/**
+ * This AudioNode uses ElevenLabs to transcribe spoken speech to text.
+ *
+ * - event `transcription` - Fired when a transcription is ready. `text` contains the transcribed text.
+ */
+declare class ElevenLabsTranscriptionNode extends VoiceChunkOutputNode {
+    /** ElevenLabs API key */
+    apiKey: string;
+    /** ElevenLabs stream connection */
+    private connection?;
+    /** True if currently transcribing */
+    isTranscribing: boolean;
+    /** WebSocket shutdown timer */
+    private shutdownTimer?;
+    /** Constructor */
+    constructor(audioContext: AudioContext, apiKey: string);
+    /** Called when a voice chunk is received */
+    onVoiceChunk(buffer: Float32Array): Promise<void>;
+    /** Start reading the stream */
+    private startReading;
+    /** Called when the voice recording ends */
+    onVoiceEnd(buffers: Float32Array[]): Promise<void>;
+    /** Called when a transcription is ready */
+    onVoiceTranscription(text: string): void;
+}
+
 /**
  * Handles speech recognition from the microphone
  *
@@ -1249,7 +1290,7 @@ declare class WebWeaverSpeechRecognition extends EventTarget {
     /** Returns true if speech recognition is supported by this persona and browser */
     get isSupported(): boolean;
     /** Currently active voice detection node */
-    voiceDetection?: IntelliWeaveTranscriptionNode | OpenAITranscriptionNode;
+    voiceDetection?: IntelliWeaveTranscriptionNode | OpenAITranscriptionNode | ElevenLabsTranscriptionNode;
     /** Constructor */
     constructor(ai: IntelliWeave);
     private _skipEvents;
@@ -1344,6 +1385,29 @@ interface ElevenLabsTextToSpeechStream {
 }
 /** This creates a two-way connection to ElevenLabs that allows for realtime text upload and realtime speech download. */
 declare function createElevenLabsTextToSpeechStream(apiKey: string, voiceID: string, format?: string): ElevenLabsTextToSpeechStream;
+/** Return value of createElevenLabsSpeechToTextStream() */
+interface ElevenLabsSpeechToTextStream {
+    /** Audio data output stream */
+    stream: ReadableStream<string>;
+    /** Function to send audio to be processed */
+    sendAudio: (audio: ArrayBuffer) => void;
+    /** Function to signal speech has stopped. Only necessary if commitStrategy is 'manual' */
+    commit: () => void;
+    /** Function to close the connection */
+    close: () => void;
+    /** True if this connection is closed */
+    isClosed?: boolean;
+}
+/** This creates a two-way connection to ElevenLabs that allows for realtime speech upload and text download. */
+declare function createElevenLabsSpeechToTextStream(
+/** ElevenLabs API key */
+apiKey: string, 
+/** Format the audio data you're passing is in */
+inputAudioFormat?: string, 
+/** Input audio sample rate */
+sampleRate?: number, 
+/** Should ElevenLabs detect speech end, or will you call commit() manually */
+commitStrategy?: 'manual' | 'vad'): ElevenLabsSpeechToTextStream;
 
 /**
  * This is a utility class for dealing with the ONNX runtime and model loading.
@@ -2177,9 +2241,15 @@ declare const WebWeaverUI: (props: {
     /** Vertical position: 'top' or 'bottom' (default: 'bottom') - only used when positioningMode is 'fixed' */
     positionY?: "top" | "bottom";
 }) => React.JSX.Element | null;
-/** Global typescript definitions */
+/** Web Component ... React supports any registered Web Component with dashes in the name, but they don't get TypeScript definitions */
 declare global {
-    /** Web Component ... React supports any registered Web Component with dashes in the name, but they don't get TypeScript definitions */
+    namespace JSX {
+        interface IntrinsicElements {
+            'intelliweave-embed': any;
+        }
+    }
+}
+declare module 'react' {
     namespace JSX {
         interface IntrinsicElements {
             'intelliweave-embed': any;
@@ -2205,4 +2275,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, AnthropicChat, AudioSystem, type BaseStatisticsEvent, type BufferType, BufferedWebSocket, type BuiltInActionFlags, ChatBase, type ChatBaseConfig, type ChatBaseToolConfig, ChatGPT, type ElevenLabsTextToSpeechStream, FixedBufferStream, type InputStatisticsEvent, IntelliWeave, type IntelliWeaveGlobalConfig, type IntelliWeaveInstructConfig, IntelliWeaveMessageParser, type IntelliWeaveParameterDefinition, IntelliWeaveProvider, IntelliWeaveTranscriptionNode, KnowledgeBase, type KnowledgeBaseActionParameterSchema, type KnowledgeBaseItem, type KnowledgeBaseItemAttachment, type KnowledgeBaseSearchEvent, type KnowledgeBaseSource, type KnowledgeBaseWebhookActionResponse, type KnowledgeBaseWebhookRequest, type KnowledgeBaseWebhookSearchResponse, type KnowledgeFetcher, Logging, MCPKnowledgeClient, type MessageReceiveEvent, type MessageSendEvent, ONNXModel, type ONNXTensors, OpenAITranscriptionNode, PCMPlayerNode, PCMReceiverNode, Resampler, type SessionStartEvent, type StatisticsEvent, type StatisticsEventType, type SubAgentConfig, SubAgents, type SupportedArrayBuffers, TokenWindow, TokenWindowGroup, type TokenWindowGroupItem, type TokenWindowGroupItemParams, type TokenWindowGroupItemSection, TokenWindowGroupItemSectionType, type ToolCallEvent, type UICloseEvent, type UIOpenEvent, VoiceChunkOutputNode, VoiceDetectionNode, type VoiceEndEvent, type VoiceStartEvent, type VoiceSubmitEvent, WebWeaverEmbed, type WebWeaverGPTConfig, WebWeaverSpeechOutput, WebWeaverSpeechRecognition, WebWeaverUI, audioToWav, convertParamsToJSONSchema, createElevenLabsTextToSpeechStream, floatTo16BitPCM, floatTo64BitPCM, getDefaultUserID, int16ToFloat32BitPCM, intelliweaveConfig, intelliweaveGlobalThis, sseEvents, track, trimWhitespaceInText, useIntelliWeave, useIntelliWeaveKnowledge };
+export { AILogic, AnthropicChat, AudioSystem, type BaseStatisticsEvent, type BufferType, BufferedWebSocket, type BuiltInActionFlags, ChatBase, type ChatBaseConfig, type ChatBaseToolConfig, ChatGPT, type ElevenLabsSpeechToTextStream, type ElevenLabsTextToSpeechStream, ElevenLabsTranscriptionNode, FixedBufferStream, type InputStatisticsEvent, IntelliWeave, type IntelliWeaveConfig, type IntelliWeaveGlobalConfig, type IntelliWeaveInstructConfig, IntelliWeaveMessageParser, type IntelliWeaveParameterDefinition, IntelliWeaveProvider, IntelliWeaveTranscriptionNode, KnowledgeBase, type KnowledgeBaseActionParameterSchema, type KnowledgeBaseItem, type KnowledgeBaseItemAttachment, type KnowledgeBaseSearchEvent, type KnowledgeBaseSource, type KnowledgeBaseWebhookActionResponse, type KnowledgeBaseWebhookRequest, type KnowledgeBaseWebhookSearchResponse, type KnowledgeFetcher, Logging, MCPKnowledgeClient, type MessageReceiveEvent, type MessageSendEvent, ONNXModel, type ONNXTensors, OpenAITranscriptionNode, PCMPlayerNode, PCMReceiverNode, Resampler, type SessionStartEvent, type StatisticsEvent, type StatisticsEventType, type SubAgentConfig, SubAgents, type SupportedArrayBuffers, TokenWindow, TokenWindowGroup, type TokenWindowGroupItem, type TokenWindowGroupItemParams, type TokenWindowGroupItemSection, TokenWindowGroupItemSectionType, type ToolCallEvent, type UICloseEvent, type UIOpenEvent, VoiceChunkOutputNode, VoiceDetectionNode, type VoiceEndEvent, type VoiceStartEvent, type VoiceSubmitEvent, WebWeaverEmbed, type WebWeaverGPTConfig, WebWeaverSpeechOutput, WebWeaverSpeechRecognition, WebWeaverUI, audioToWav, convertParamsToJSONSchema, createElevenLabsSpeechToTextStream, createElevenLabsTextToSpeechStream, floatTo16BitPCM, floatTo64BitPCM, getDefaultUserID, int16ToFloat32BitPCM, intelliweaveConfig, intelliweaveGlobalThis, sseEvents, track, trimWhitespaceInText, useIntelliWeave, useIntelliWeaveKnowledge };