@intelliweave/embedded 1.7.58 → 1.8.60

package/dist/react/react.d.ts

@@ -205,6 +205,14 @@ declare class WebWeaverSpeechOutput extends EventTarget {
     /** Current player vars */
     private currentPlayerVolume?;
     private currentPlayer?;
+    /** The audio analyser node */
+    private analyserNode?;
+    /** The audio analyser buffer */
+    private analyserBuffer?;
+    /** @private Maximum volume heard this session */
+    private maxVolumeHeard;
+    /** Get current (realtime) audio output volume level, from 0 to 1 */
+    get volumeLevel(): number;
     /** Speak the text */
     speak(text: string): Promise<void>;
     private _speakWithLock;
@@ -382,9 +390,9 @@ declare class WebWeaverSpeechRecognition extends EventTarget {
     /** True if recognition is running */
     isRunning: boolean;
     /** The audio analyser node */
-    analyserNode?: AnalyserNode;
+    private analyserNode?;
     /** The audio analyser buffer */
-    analyserBuffer?: Float32Array;
+    private analyserBuffer?;
     /** The microphone stream */
     micStream?: MediaStream;
     /** Returns true if speech recognition is supported by this persona and browser */
@@ -443,49 +451,53 @@ declare class AILogic {
     /** Constructor */
     constructor(ai: IntelliWeave);
     /** Ask the AI a yes/no question associated with the specified data. Data must be JSON-serializable, or a string of any kind of data. */
-    boolean(question: string, data: any): Promise<boolean>;
+    boolean(config: IntelliWeaveInstructConfig): Promise<boolean>;
+    /** Ask the AI to select a choice from a list of options. */
+    choose(config: IntelliWeaveInstructConfig & {
+        /** List of choices the AI can pick from. */
+        options: string[];
+    }): Promise<string | undefined>;
     /**
-        Ask the AI to select a choice from a list of options. The AI will return the selected choice.
-        @param question The question to ask the AI.
-        @param data The data to provide to the AI. This can be a string or a JSON-serializable object.
-        @param options The list of options to choose from.
+     * Ask the AI to extract data from input data. The AI will return the extracted data. Possibly an array of multiple extractions.
      */
-    choose(question: string, data: any, options: string[]): Promise<string | undefined>;
+    extract<T = any>(config: IntelliWeaveInstructConfig & {
+        /** Allow multiple items to be returned. If true, returns an array instead of an object. */
+        allowMultiple?: boolean;
+        /** Fields to extract in each object. */
+        extractions: {
+            /** Field name */
+            name: string;
+            /** Field data type */
+            type: 'string' | 'number' | 'boolean' | 'date' | 'email' | 'phone' | 'address';
+            /** Describe to the AI what data to put in this field. */
+            description?: string;
+        }[];
+    }): Promise<T[]>;
     /**
-     * Ask the AI to extract data from a text. The AI will return the extracted data. Possibly an array of multiple extractions.
-     *   Example: extract(myData, true, [
-     *   { name: "id", type: "string", description: "The user's ID number." },
-     *   { name: "firstName", type: "string", description: "The user's first name" },
-     *   ])
-     * @param question The question to ask the AI.
-     * @param data The data to provide to the AI. This can be a string or a JSON-serializable object.
-     * @param allowMultiple Whether to allow multiple extractions or not.
-     * @param extractions The list of extractions to perform. Each extraction is an object with the following properties:
-     * - name: The name of the extraction. This will be the key in the returned object.
-     * - type: The type of the extraction. This can be "string", "number", "boolean", "date", "email", "url", "phone", "address", "name", "organization", "person", "location", "time", "duration", "money", "percentage", "quantity", "custom".
-     * - description: A description of the extraction. This is optional.
-     */
-    extract(question: string, data: any, allowMultiple: boolean, extractions: {
-        name: string;
-        type: string;
-        description?: string;
-    }[]): Promise<any>;
-    /**
-     * Generate a Markdown document based on the input query from the user.
+     * Generate a Markdown document based on the data from the user.
      *
      * @param query The query to generate the document from.
-     * @param callback The callback that will be called when streaming the response. Each call will contain the full text that has been generated so far.
+     * @param config Instruct config.
      */
-    generateMarkdown(query: string, callback: (txt: string) => void): Promise<string | null>;
+    generateMarkdown(config: Omit<IntelliWeaveInstructConfig, 'instruction'>): Promise<string>;
     /**
      * Perform an instruction.
      *
-     * @param instruction Describe the action to perform.
-     * @param query The user query to pass to the AI.
-     * @param callback The callback that will be called when streaming the response. Each call will contain the full text that has been generated so far.
+     * @param config Instruct config.
      * @returns The final response from the AI.
      */
-    instruct(instruction: string, query: string, callback: (txt: string) => void): Promise<string | null>;
+    instruct(config: IntelliWeaveInstructConfig): Promise<string>;
+}
+/** Config for any instruct call */
+interface IntelliWeaveInstructConfig {
+    /** Instruction */
+    instruction: string;
+    /** Input data or query to process */
+    data: any;
+    /** Whether to allow the AI to use the knowledge base or not. If false, the AI will not use the knowledge base. */
+    allowKB?: boolean;
+    /** Callback that will be called when streaming the response. Each call will contain the full text that has been generated so far. */
+    callback?: (txt: string) => void;
 }
 
 /** Persona config received from the hub */
@@ -593,7 +605,7 @@ declare class IntelliWeave extends EventTarget {
     setModel(id: string): void;
     private _lastSystemMsg;
     /** Get the system message prefix, before the KB entries are added */
-    getContextPrefix(): Promise<any>;
+    getContextPrefix(): Promise<string>;
     /** Get system message to send to the AI */
     onBeforeMessageProcessing(): Promise<void>;
     private _lastOutput?;