Merge main into sweep/update_the_docstrings_and_comments_in_sd

sdks/ts/src/managers/memory.ts

@@ -5,6 +5,19 @@ import { invariant } from "../utils/invariant";
 import { isValidUuid4 } from "../utils/isValidUuid4";
 
 export class MemoriesManager extends BaseManager {
+  /**
+   * Manages memory-related operations for agents. Inherits from BaseManager.
+   * Provides functionality to list memories associated with a given agent.
+   */
+  /**
+   * Lists memories based on the provided parameters.
+   * @param {string} agentId - The UUID of the agent whose memories are to be listed. Must be a valid UUID v4.
+   * @param {string} query - A query string to filter memories.
+   * @param {string} [userId] - The UUID of the user associated with the memories. Optional.
+   * @param {number} [limit=100] - The maximum number of memories to return. Optional.
+   * @param {number} [offset=0] - The offset for pagination. Optional.
+   * @returns {Promise<Memory[]>} A promise that resolves to an array of Memory objects.
+   */
   async list({
     agentId,
     query,
@@ -18,7 +31,9 @@ export class MemoriesManager extends BaseManager {
     limit?: number;
     offset?: number;
   }): Promise<Memory[]> {
+    // Validates that the agentId is a valid UUID v4 format.
     invariant(isValidUuid4(agentId), "agentId must be a valid UUID v4");
+    // Validates that the userId, if provided, is a valid UUID v4 format.
     userId && invariant(isValidUuid4(userId), "userId must be a valid UUID v4");
 
     const response = await this.apiClient.default.getAgentMemories({

sdks/ts/src/utils/invariant.ts

@@ -1,7 +1,13 @@
+/**
+ * Ensures that a condition is met, throwing a custom error message if not.
+ * @param condition The condition to test. If falsy, an error is thrown.
+ * @param message Optional. The error message to throw if the condition is not met. Defaults to "Invariant Violation".
+ */
 export function invariant(
   condition: any,
   message: string = "Invariant Violation",
 ): void {
+  // Throw an error with the provided message if the condition is falsy
   if (!condition) {
     throw new Error(message);
   }