@squidcloud/client
    Preparing search index...

    Interface AiAgentMemoryOptions

    Options for AI agent memory management.

    interface AiAgentMemoryOptions {
        expirationMinutes?: number;
        memoryId?: string;
        memoryMode: "none" | "read-only" | "read-write";
    }
    Index

    Properties

    expirationMinutes? memoryId? memoryMode

    Properties

    expirationMinutes?: number

    Overrides the expiration for the whole chat history. If not provided, the expiration will not be changed.

    Default: the last provided expiration by user or 1 day if the user didn't provide any expiration.

    memoryId?: string

    A unique ID to store the chat memory.

    The full chat memory key is constructed as a combination of 'appId', 'agentId', and 'memoryId'. If not provided the Squid client instance ID used as a memoryId.

    Important: the memory ID should be treated with the same security measures as Access Token because it unblocks direct access to the agent chat history. A good practice is to use a non-trivial and a unique value.

    memoryMode: "none" | "read-only" | "read-write"

    The memory mode:

    • 'none': No memory is used, the agent does not remember past interactions.
    • 'read-only': The agent can read from memory but cannot write to it.
    • 'read-write': The agent can both read from and write to memory.

    Settings

    Member Visibility

    On This Page

    Properties