Documentation Souvenis

{
  userId: string        // Identifiant de l'utilisateur
  content: string       // Le texte a memoriser
  metadata?: object     // Donnees supplementaires (optionnel)
}

{
  memory: {
    id: string          // Identifiant unique de la memoire
    content: string
    metadata: object
    createdAt: string   // Date de creation ISO 8601
    updatedAt: string
  }
}

import Souvenis from 'souvenis'

const memory = new Souvenis({ apiKey: process.env.SOUVENIS_API_KEY })

const result = await memory.save({
  userId: 'user-123',
  content: "L'utilisateur prefere les reponses courtes.",
  metadata: { source: 'conversation', topic: 'preferences' }
})

console.log(result.memory.id) // "550e8400-..."

{
  userId: string        // Identifiant de l'utilisateur
  limit?: number        // Nombre max de resultats (defaut: 20)
  cursor?: string       // Curseur pour la page suivante
  search?: string       // Recherche textuelle (optionnel)
  sortBy?: string       // Tri : 'created_at' | 'updated_at'
  order?: string        // Ordre : 'asc' | 'desc'
}

{
  memories: Array<{
    id: string
    content: string
    metadata: object
    createdAt: string
    updatedAt: string
  }>
  hasMore: boolean      // true s'il y a une page suivante
  cursor?: string       // Curseur pour la page suivante
}

const results = await memory.retrieve({
  userId: 'user-123',
  limit: 5
})

results.memories.forEach(m => {
  console.log(m.content)
})

// Pagination
if (results.hasMore) {
  const page2 = await memory.retrieve({
    userId: 'user-123',
    cursor: results.cursor
  })
}

{
  userId: string        // Identifiant de l'utilisateur
  maxTokens?: number    // Limite de tokens (defaut: 2000)
  limit?: number        // Nombre max de memoires (optionnel)
}

{
  context: string         // Texte formate pour injection prompt
  memoriesUsed: number    // Nombre de memoires incluses
  memoriesTotal: number   // Nombre total de memoires
  memoriesFiltered: number // Memoires exclues (injection ou erreur)
  truncated: boolean      // true si le contexte a ete tronque
  tokensEstimated: number // Estimation du nombre de tokens
}

const ctx = await memory.getContext({
  userId: 'user-123',
  maxTokens: 1500
})

// Injecter dans votre prompt LLM
const prompt = `Contexte utilisateur :
${ctx.context}

Question : ...`

{
  memoryId: string      // ID de la memoire a modifier
  content?: string      // Nouveau contenu (optionnel)
  metadata?: object     // Nouvelles metadonnees (optionnel)
}

{
  memory: {
    id: string
    content: string
    metadata: object
    updatedAt: string   // Date de mise a jour ISO 8601
  }
}

await memory.update({
  memoryId: "550e8400-...",
  content: "L'utilisateur prefere les reponses detaillees.",
  metadata: { category: 'preference', updated_reason: 'user feedback' }
})

{
  memoryId: string      // ID de la memoire a supprimer
}

// void — aucune valeur de retour (204 No Content)

await memory.delete({ memoryId: "550e8400-..." })

{
  userId: string        // Identifiant de l'utilisateur
}

{
  status: string        // "erased"
  erasureId: string     // ID de preuve de suppression
  erasedAt: string      // Date de suppression ISO 8601
  regulation: string    // "RGPD (UE) 2016/679 — Article 17"
  erasedResources: {
    memories: number    // Nombre de memoires supprimees
    consents: number    // Nombre de consentements supprimes
  }
}

// Attention : action irreversible
const result = await memory.deleteAll({ userId: 'user-123' })

console.log(result.erasureId)       // Conserver comme preuve
console.log(result.erasedResources) // { memories: 42, consents: 3 }

{
  userId: string        // Identifiant de l'utilisateur
}

{
  data: {
    exportMetadata: {
      formatVersion: string
      exportedAt: string
      regulation: string  // "RGPD (UE) 2016/679 — Article 20"
    }
    data: {
      memories: Memory[]
      consents: Consent[]
      processingHistory: ProcessingLog[]
    }
    statistics: {
      totalMemories: number
      totalConsents: number
      totalOperations: number
    }
  }
}

const result = await memory.export({ userId: 'user-123' })

console.log(result.data.statistics.totalMemories)
console.log(result.data.data.memories)   // Memoires dechiffrees
console.log(result.data.exportMetadata.regulation)

{
  userId: string        // Identifiant de l'utilisateur
}

{
  consents: Array<{
    consentType: string   // Ex: 'memory_storage', 'research', etc.
    granted: boolean
    grantedAt: string | null
    revokedAt: string | null
    createdAt: string
    updatedAt: string
  }>
}

const result = await memory.getConsent({ userId: 'user-123' })

result.consents.forEach(c => {
  console.log(`${c.consentType}: ${c.granted ? 'accorde' : 'refuse'}`)
})

{
  userId: string        // Identifiant de l'utilisateur
  consentType: string   // 'memory_storage' | 'ai_processing' | 'data_retention' | ...
  granted: boolean      // true = accorde, false = revoque
}

{
  consent: {
    consentType: string
    granted: boolean
    grantedAt: string | null
    revokedAt: string | null
    updatedAt: string
  }
}

// Accorder le consentement recherche
await memory.updateConsent({
  userId: 'user-123',
  consentType: 'ai_processing',
  granted: true
})

// Revoquer le consentement
await memory.updateConsent({
  userId: 'user-123',
  consentType: 'ai_processing',
  granted: false
})