tandem-memory 0.6.0

Memory storage and embedding utilities for Tandem
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
use serde::{Deserialize, Serialize};
use tandem_enterprise_contract::DataClass;

/// Governance-facing tier model for scoped memory access.
///
/// Note: `team` and `curated` are included for policy/capability contracts
/// before storage-layer migrations complete.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum GovernedMemoryTier {
    Session,
    Project,
    Team,
    Curated,
}

impl std::fmt::Display for GovernedMemoryTier {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Self::Session => write!(f, "session"),
            Self::Project => write!(f, "project"),
            Self::Team => write!(f, "team"),
            Self::Curated => write!(f, "curated"),
        }
    }
}

/// Hard partition for memory operations in corporate/LAN environments.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct MemoryPartition {
    pub org_id: String,
    pub workspace_id: String,
    pub project_id: String,
    pub tier: GovernedMemoryTier,
}

impl MemoryPartition {
    pub fn key(&self) -> String {
        format!(
            "{}/{}/{}/{}",
            self.org_id, self.workspace_id, self.project_id, self.tier
        )
    }
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum MemoryClassification {
    Internal,
    Restricted,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum MemoryAuthorityOperation {
    Read,
    Write,
    Promote,
    Export,
    Decrypt,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct MemoryAuthorityJobContext {
    pub org_id: String,
    pub workspace_id: String,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub deployment_id: Option<String>,
    pub project_id: String,
    pub actor_id: String,
    pub run_id: String,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub node_id: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub task_id: Option<String>,
    pub purpose: String,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub source_binding_id: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub data_class: Option<DataClass>,
    pub classification: MemoryClassification,
    pub operation: MemoryAuthorityOperation,
    #[serde(default)]
    pub source_memory_ids: Vec<String>,
    #[serde(default)]
    pub artifact_refs: Vec<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub policy_decision_id: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub grant_decision_id: Option<String>,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum MemoryAuthorityJobContextError {
    Missing,
    TenantMismatch,
    ProjectMismatch,
    ActorMissing,
    ActorMismatch,
    RunMismatch,
    PurposeMissing,
    OperationMismatch,
    ClassificationMismatch,
    SourceMemoryMismatch,
}

impl MemoryAuthorityJobContextError {
    pub fn as_str(self) -> &'static str {
        match self {
            Self::Missing => "memory authority job context missing",
            Self::TenantMismatch => "memory authority job tenant mismatch",
            Self::ProjectMismatch => "memory authority job project mismatch",
            Self::ActorMissing => "memory authority job actor missing",
            Self::ActorMismatch => "memory authority job actor mismatch",
            Self::RunMismatch => "memory authority job run mismatch",
            Self::PurposeMissing => "memory authority job purpose missing",
            Self::OperationMismatch => "memory authority job operation mismatch",
            Self::ClassificationMismatch => "memory authority job classification mismatch",
            Self::SourceMemoryMismatch => "memory authority job source memory mismatch",
        }
    }
}

#[derive(Debug, Clone, Copy)]
pub struct MemoryAuthorityJobValidation<'a> {
    pub context: Option<&'a MemoryAuthorityJobContext>,
    pub require_context: bool,
    pub org_id: &'a str,
    pub workspace_id: &'a str,
    pub deployment_id: Option<&'a str>,
    pub actor_id: Option<&'a str>,
    pub run_id: &'a str,
    pub partition: &'a MemoryPartition,
    pub operation: MemoryAuthorityOperation,
    pub classification: Option<MemoryClassification>,
    pub source_memory_id: Option<&'a str>,
}

pub fn validate_memory_authority_job_context(
    validation: MemoryAuthorityJobValidation<'_>,
) -> Result<(), MemoryAuthorityJobContextError> {
    let MemoryAuthorityJobValidation {
        context,
        require_context,
        org_id,
        workspace_id,
        deployment_id,
        actor_id,
        run_id,
        partition,
        operation,
        classification,
        source_memory_id,
    } = validation;
    let Some(context) = context else {
        return if require_context {
            Err(MemoryAuthorityJobContextError::Missing)
        } else {
            Ok(())
        };
    };

    if context.org_id != org_id
        || context.workspace_id != workspace_id
        || context.org_id != partition.org_id
        || context.workspace_id != partition.workspace_id
        || context.deployment_id.as_deref() != deployment_id
    {
        return Err(MemoryAuthorityJobContextError::TenantMismatch);
    }
    if context.project_id != partition.project_id {
        return Err(MemoryAuthorityJobContextError::ProjectMismatch);
    }
    if context.actor_id.trim().is_empty() {
        return Err(MemoryAuthorityJobContextError::ActorMissing);
    }
    if actor_id.is_some_and(|expected| context.actor_id != expected) {
        return Err(MemoryAuthorityJobContextError::ActorMismatch);
    }
    if context.run_id != run_id {
        return Err(MemoryAuthorityJobContextError::RunMismatch);
    }
    if context.purpose.trim().is_empty() {
        return Err(MemoryAuthorityJobContextError::PurposeMissing);
    }
    if context.operation != operation {
        return Err(MemoryAuthorityJobContextError::OperationMismatch);
    }
    if classification.is_some_and(|expected| context.classification != expected) {
        return Err(MemoryAuthorityJobContextError::ClassificationMismatch);
    }
    if let Some(source_memory_id) = source_memory_id {
        if !context
            .source_memory_ids
            .iter()
            .any(|candidate| candidate == source_memory_id)
        {
            return Err(MemoryAuthorityJobContextError::SourceMemoryMismatch);
        }
    }

    Ok(())
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct MemoryCapabilities {
    #[serde(default)]
    pub read_tiers: Vec<GovernedMemoryTier>,
    #[serde(default)]
    pub write_tiers: Vec<GovernedMemoryTier>,
    #[serde(default)]
    pub promote_targets: Vec<GovernedMemoryTier>,
    #[serde(default = "default_require_review_for_promote")]
    pub require_review_for_promote: bool,
    #[serde(default)]
    pub allow_auto_use_tiers: Vec<GovernedMemoryTier>,
}

fn default_require_review_for_promote() -> bool {
    true
}

impl Default for MemoryCapabilities {
    fn default() -> Self {
        Self {
            read_tiers: vec![GovernedMemoryTier::Session, GovernedMemoryTier::Project],
            write_tiers: vec![GovernedMemoryTier::Session],
            promote_targets: Vec::new(),
            require_review_for_promote: true,
            allow_auto_use_tiers: vec![GovernedMemoryTier::Curated],
        }
    }
}

/// Run-scoped capability token claims for memory access.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct MemoryCapabilityToken {
    pub run_id: String,
    pub subject: String,
    pub org_id: String,
    pub workspace_id: String,
    pub project_id: String,
    pub memory: MemoryCapabilities,
    pub expires_at: u64,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, Default)]
pub struct MemoryRetrievalBudgets {
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub max_queries_per_window: Option<u32>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub window_ms: Option<u64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub max_top_k: Option<usize>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub max_tokens: Option<i64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub max_chars: Option<usize>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub max_results_per_window: Option<u32>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub max_tokens_per_window: Option<i64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub max_chars_per_window: Option<usize>,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct MemoryRetrievalGrant {
    pub grant_id: String,
    pub subject: String,
    pub org_id: String,
    pub workspace_id: String,
    #[serde(default)]
    pub project_ids: Vec<String>,
    #[serde(default)]
    pub source_binding_ids: Vec<String>,
    #[serde(default)]
    pub source_object_ids: Vec<String>,
    #[serde(default)]
    pub data_classes: Vec<DataClass>,
    #[serde(default)]
    pub budgets: MemoryRetrievalBudgets,
    #[serde(default)]
    pub revoked: bool,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub expires_at: Option<u64>,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct MemoryRetrievalGatewayRequest {
    pub grant: MemoryRetrievalGrant,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub session_id: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub channel: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub user_id: Option<String>,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct MemoryRetrievalBudgetWindow {
    pub started_at_ms: u64,
    pub query_count: u32,
    pub result_count: u32,
    pub token_count: i64,
    pub char_count: usize,
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum MemoryContentKind {
    SolutionCapsule,
    Note,
    Fact,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum MemoryTrustLabel {
    ExternalUserSupplied,
    ConnectorSourced,
    Verified,
    HumanApproved,
    SystemGenerated,
}

impl MemoryTrustLabel {
    pub fn as_str(self) -> &'static str {
        match self {
            Self::ExternalUserSupplied => "external_user_supplied",
            Self::ConnectorSourced => "connector_sourced",
            Self::Verified => "verified",
            Self::HumanApproved => "human_approved",
            Self::SystemGenerated => "system_generated",
        }
    }

    pub fn is_trusted_for_promotion(self) -> bool {
        matches!(
            self,
            Self::Verified | Self::HumanApproved | Self::SystemGenerated
        )
    }
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct MemoryPutRequest {
    pub run_id: String,
    pub partition: MemoryPartition,
    pub kind: MemoryContentKind,
    pub content: String,
    #[serde(default)]
    pub artifact_refs: Vec<String>,
    pub classification: MemoryClassification,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub authority_job_context: Option<MemoryAuthorityJobContext>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub metadata: Option<serde_json::Value>,
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct MemoryPutResponse {
    pub id: String,
    pub stored: bool,
    pub tier: GovernedMemoryTier,
    pub partition_key: String,
    pub audit_id: String,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct PromotionReview {
    pub required: bool,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub reviewer_id: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub approval_id: Option<String>,
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, Default)]
pub struct PromotionSourceOutcome {
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub status: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub approved: Option<bool>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub source_run_id: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub approval_id: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub policy_decision_id: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub audit_id: Option<String>,
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct MemoryPromoteRequest {
    pub run_id: String,
    pub source_memory_id: String,
    pub from_tier: GovernedMemoryTier,
    pub to_tier: GovernedMemoryTier,
    pub partition: MemoryPartition,
    pub reason: String,
    pub review: PromotionReview,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub authority_job_context: Option<MemoryAuthorityJobContext>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub source_outcome: Option<PromotionSourceOutcome>,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum ScrubStatus {
    Passed,
    Redacted,
    Blocked,
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct ScrubReport {
    pub status: ScrubStatus,
    pub redactions: u32,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub block_reason: Option<String>,
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct MemoryPromoteResponse {
    pub promoted: bool,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub new_memory_id: Option<String>,
    pub to_tier: GovernedMemoryTier,
    pub scrub_report: ScrubReport,
    pub audit_id: String,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub policy_decision_id: Option<String>,
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct MemorySearchRequest {
    pub run_id: String,
    pub query: String,
    #[serde(default)]
    pub read_scopes: Vec<GovernedMemoryTier>,
    pub partition: MemoryPartition,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub limit: Option<i64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub authority_job_context: Option<MemoryAuthorityJobContext>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub retrieval_gateway: Option<MemoryRetrievalGatewayRequest>,
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct MemorySearchResponse {
    #[serde(default)]
    pub results: Vec<serde_json::Value>,
    #[serde(default)]
    pub scopes_used: Vec<GovernedMemoryTier>,
    #[serde(default)]
    pub blocked_scopes: Vec<GovernedMemoryTier>,
    pub audit_id: String,
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn default_capabilities_are_fail_safe() {
        let caps = MemoryCapabilities::default();
        assert_eq!(
            caps.read_tiers,
            vec![GovernedMemoryTier::Session, GovernedMemoryTier::Project]
        );
        assert_eq!(caps.write_tiers, vec![GovernedMemoryTier::Session]);
        assert!(caps.promote_targets.is_empty());
        assert!(caps.require_review_for_promote);
        assert_eq!(caps.allow_auto_use_tiers, vec![GovernedMemoryTier::Curated]);
    }

    #[test]
    fn partition_key_is_stable() {
        let partition = MemoryPartition {
            org_id: "org_acme".to_string(),
            workspace_id: "ws_tandem".to_string(),
            project_id: "proj_engine".to_string(),
            tier: GovernedMemoryTier::Project,
        };
        assert_eq!(
            partition.key(),
            "org_acme/ws_tandem/proj_engine/project".to_string()
        );
    }

    fn authority_context() -> (MemoryPartition, MemoryAuthorityJobContext) {
        let partition = MemoryPartition {
            org_id: "org-1".to_string(),
            workspace_id: "ws-1".to_string(),
            project_id: "proj-1".to_string(),
            tier: GovernedMemoryTier::Project,
        };
        let context = MemoryAuthorityJobContext {
            org_id: partition.org_id.clone(),
            workspace_id: partition.workspace_id.clone(),
            deployment_id: Some("deploy-1".to_string()),
            project_id: partition.project_id.clone(),
            actor_id: "reviewer-1".to_string(),
            run_id: "run-1".to_string(),
            node_id: Some("node-1".to_string()),
            task_id: Some("task-1".to_string()),
            purpose: "promote approved memory".to_string(),
            source_binding_id: Some("workflow:wf-1".to_string()),
            data_class: Some(DataClass::Internal),
            classification: MemoryClassification::Internal,
            operation: MemoryAuthorityOperation::Promote,
            source_memory_ids: vec!["mem-1".to_string()],
            artifact_refs: vec!["artifact://run-1/task-1".to_string()],
            policy_decision_id: Some("policy-1".to_string()),
            grant_decision_id: Some("grant-1".to_string()),
        };
        (partition, context)
    }

    #[test]
    fn authority_context_revalidates_execution_scope() {
        let (partition, context) = authority_context();

        let result = validate_memory_authority_job_context(MemoryAuthorityJobValidation {
            context: Some(&context),
            require_context: true,
            org_id: "org-1",
            workspace_id: "ws-1",
            deployment_id: Some("deploy-1"),
            actor_id: Some("reviewer-1"),
            run_id: "run-1",
            partition: &partition,
            operation: MemoryAuthorityOperation::Promote,
            classification: Some(MemoryClassification::Internal),
            source_memory_id: Some("mem-1"),
        });

        assert_eq!(result, Ok(()));
    }

    #[test]
    fn authority_context_fails_closed_for_tampered_scope() {
        let (partition, mut context) = authority_context();
        context.operation = MemoryAuthorityOperation::Write;

        let result = validate_memory_authority_job_context(MemoryAuthorityJobValidation {
            context: Some(&context),
            require_context: true,
            org_id: "org-1",
            workspace_id: "ws-1",
            deployment_id: Some("deploy-1"),
            actor_id: Some("reviewer-1"),
            run_id: "run-1",
            partition: &partition,
            operation: MemoryAuthorityOperation::Promote,
            classification: Some(MemoryClassification::Internal),
            source_memory_id: Some("mem-1"),
        });

        assert_eq!(
            result,
            Err(MemoryAuthorityJobContextError::OperationMismatch)
        );
        assert_eq!(
            MemoryAuthorityJobContextError::OperationMismatch.as_str(),
            "memory authority job operation mismatch"
        );
    }

    #[test]
    fn missing_authority_context_can_be_required() {
        let (partition, _) = authority_context();

        let result = validate_memory_authority_job_context(MemoryAuthorityJobValidation {
            context: None,
            require_context: true,
            org_id: "org-1",
            workspace_id: "ws-1",
            deployment_id: Some("deploy-1"),
            actor_id: Some("reviewer-1"),
            run_id: "run-1",
            partition: &partition,
            operation: MemoryAuthorityOperation::Promote,
            classification: None,
            source_memory_id: None,
        });

        assert_eq!(result, Err(MemoryAuthorityJobContextError::Missing));
    }
}