overlane memory unlearn | Overlane Docs

Unlearn a memory: remove it and every memory derived from it, and record the action

Removes the memory, every memory derived from it (for example a team copy promoted from it), their vectors and enrichment, and keeps an unlearn record without the content. This cannot be undone. Without a terminal it needs –force.

Usage

overlane memory unlearn [memory-id] [--service URL] [--team TENANT_ID] [--dry-run] [--force]

Arguments

Argument	Required	Description
`memory-id`	no	The memory to unlearn (required)

Flags

Flag	Type	Required	Description
`--service`	string	no	The service address (default: OVERLANE_SERVICE_URL, then the project’s binding, then the hosted service)
`--team`	string	no	The team (tenant) to act on (default: the one your token belongs to)
`--dry-run`	boolean	no	Print the requests and file changes this command would make, then stop. Needs no credentials.
`--force`	boolean	no	Confirm a destructive action when there is no terminal to ask on. Without it, exit 2.

Examples

overlane memory unlearn mem_ab12 --force
overlane memory unlearn mem_ab12 --dry-run

Behavior

Effect: destructive (deletes or reverts; needs --force without a terminal).
Needs credentials: yes. Uses the network: yes.
Supports --dry-run: yes. Accepts --force: yes.
Machine-readable description: overlane schema memory unlearn.

Result

With --json (the default when stdout is not a terminal) the command prints this JSON Schema’s shape on stdout.

{
  "anyOf": [
    {
      "type": "object",
      "properties": {
        "tenantId": {
          "type": "string",
          "minLength": 1,
          "maxLength": 128,
          "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]*$",
          "description": "tenant identifier"
        },
        "id": {
          "type": "string",
          "minLength": 1,
          "maxLength": 64,
          "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]*$"
        },
        "rootId": {
          "type": "string",
          "minLength": 1,
          "maxLength": 64,
          "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]*$"
        },
        "removedIds": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1,
            "maxLength": 64,
            "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]*$"
          }
        },
        "vectorsRemoved": {
          "type": "integer",
          "minimum": 0,
          "maximum": 9007199254740991
        },
        "by": {
          "type": "string",
          "minLength": 1,
          "maxLength": 160
        },
        "at": {
          "type": "string",
          "format": "date-time",
          "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
        }
      },
      "required": [
        "tenantId",
        "id",
        "rootId",
        "removedIds",
        "vectorsRemoved",
        "by",
        "at"
      ],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "dryRun": {
          "type": "boolean",
          "const": true
        },
        "service": {
          "type": "string"
        },
        "requests": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "method": {
                "type": "string"
              },
              "path": {
                "type": "string"
              },
              "body": {},
              "note": {
                "type": "string"
              }
            },
            "required": [
              "method",
              "path"
            ],
            "additionalProperties": false
          }
        },
        "commands": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "writes": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "path": {
                "type": "string"
              },
              "action": {
                "type": "string",
                "enum": [
                  "write",
                  "append",
                  "delete"
                ]
              },
              "description": {
                "type": "string"
              }
            },
            "required": [
              "path",
              "action",
              "description"
            ],
            "additionalProperties": false
          }
        },
        "notes": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "required": [
        "dryRun",
        "requests",
        "commands",
        "writes",
        "notes"
      ],
      "additionalProperties": false
    }
  ]
}

See exit codes for the status the process returns.