VoltAgent/voltagent @voltagent/resumable-streams@2.0.2

on GitHub

Patch Changes

• 99680b1 Thanks @omeraplak! - feat: add runtime memory envelope (options.memory) and deprecate legacy top-level memory fields

  What's New

  • Added a preferred per-call memory envelope:
    • options.memory.conversationId for conversation-scoped memory
    • options.memory.userId for user-scoped memory
    • options.memory.options for memory behavior overrides (contextLimit, semanticMemory, conversationPersistence)
  • Kept legacy top-level fields for backward compatibility:
    • options.conversationId, options.userId, options.contextLimit, options.semanticMemory, options.conversationPersistence
  • Legacy fields are now marked deprecated in type/docs, and envelope values are preferred when both are provided.

  Usage Examples

  Legacy (still supported, deprecated):

  await agent.generateText("Hello", {
    userId: "user-123",
    conversationId: "conv-123",
    contextLimit: 20,
    semanticMemory: {
      enabled: true,
      semanticLimit: 5,
    },
    conversationPersistence: {
      mode: "step",
      debounceMs: 150,
    },
  });

  Preferred (new memory envelope):

  await agent.generateText("Hello", {
    memory: {
      userId: "user-123",
      conversationId: "conv-123",
      options: {
        contextLimit: 20,
        semanticMemory: {
          enabled: true,
          semanticLimit: 5,
        },
        conversationPersistence: {
          mode: "step",
          debounceMs: 150,
        },
      },
    },
  });

  Server and Resumable Stream Alignment

  • @voltagent/server-core now accepts/documents the options.memory envelope in request schemas.
  • Resumable stream identity resolution now reads conversationId/userId from options.memory first and falls back to legacy fields.
  • Added tests for:
    • parsing options.memory in server schemas
    • resolving resumable stream keys from options.memory

• Updated dependencies [99680b1]:

  • @voltagent/core@2.6.6