booths 2.0.0-1 → 2.0.0-3

package/dist/index.d.ts

@@ -585,13 +585,17 @@ export declare class ContextProviderPlugin implements BoothPlugin {
 }
 
 /**
- * The ConversationHistoryPlugin manages the conversation history between users and the booth system.
+ * A plugin for managing and summarizing conversation history in an LLM-based booth system.
  *
- * This plugin is responsible for maintaining a continuous conversation context by tracking
- * and preserving all messages exchanged between the user and the LLM. It ensures that each new
- * interaction has access to the full conversation history, enabling contextual responses.
+ * The ConversationHistoryPlugin maintains session history by appending user inputs and LLM responses.
+ * It also provides functionality to compact the history when certain thresholds or conditions are met,
+ * summarizing key points to enable effective reference for interaction progression.
  */
 export declare class ConversationHistoryPlugin implements BoothPlugin {
+    private onCompactStart;
+    private onCompactEnd;
+    private tokenCompactionThreshold;
+    private readonly compactInstructions;
     /**
      * The sessionHistory variable stores the conversation history between the user and the booth system.
      * It is initialized as an empty array and will be populated with messages exchanged during the interaction.
@@ -622,12 +626,48 @@ export declare class ConversationHistoryPlugin implements BoothPlugin {
      * @return A boolean indicating whether a booth change is present in the response.
      */
     private responseContainsBoothChange;
+    /**
+     * Checks if the conversation history should be compacted.
+     *
+     * @param response - The response from the LLM
+     * @returns True if compaction is needed, false otherwise
+     * @private
+     */
+    private shouldCompactHistory;
+    /**
+     * Summarizes a conversation session history based on a set of instructions and returns the summary text.
+     *
+     * @param {RepositoryUtilities} utilities - An object providing access to repository utilities and LLM adapter.
+     * @return {Promise<string>} A promise that resolves to the summarized text of the conversation.
+     */
+    private summerizeConversation;
+    /**
+     * Cleans out resolved function calls from the provided history and returns
+     * only the unresolved function calls.
+     *
+     * @param {ResponseInput[]} newHistory - Array of response history objects that may include function calls and their outputs.
+     * @return {ResponseInput[]} Filtered array containing only unresolved function calls.
+     */
+    private cleanOutResolvedFunctionCalls;
+    /**
+     * Rebuilds the conversation history by combining the provided function calls,
+     * summary message, and the last user message from the new history.
+     *
+     * @param {ResponseInput} newHistory - The new history containing messages to rebuild the conversation.
+     * @param {ResponseInput[]} unresolvedFunctionCalls - The array of function call messages to include in the updated history.
+     * @param {ResponseInputItem} developerSummaryMessage - A summary message to include in the updated history.
+     * @return {ResponseInput} The updated conversation history after combining the inputs.
+     */
+    private rebuildHistory;
     /**
      * Constructs a new instance with an optional session history.
      *
      * @param {ResponseInput[]} [sessionHistory=[]] - An array representing the session history. Defaults to an empty array if not provided.
+     * @param onCompactStart
+     * @param onCompactEnd
+     * @param tokenCompactionThreshold
      */
-    constructor(sessionHistory?: ResponseInput);
+    constructor(sessionHistory?: ResponseInput, onCompactStart?: () => void, onCompactEnd?: () => void, tokenCompactionThreshold?: number);
     /**
      * Retrieves the session history.
      *
@@ -765,6 +805,11 @@ export declare class CoreBooth<T> {
         sessionHistory?: ResponseInput;
         endInteractionLoopMarker?: string;
         loopLimit?: number;
+        compactOptions?: {
+            onCompactStart?: () => void;
+            onCompactEnd?: () => void;
+            tokenCompactionThreshold?: number;
+        };
     });
 }