memory

Documentation

Overview

Package memory defines the agent core's long-term memory contract.

Index

• type Fact
• type Message
• type Scope
• type Store

Types

type Fact

type Fact struct {
	ID        string
	Text      string
	Hash      string
	Score     float32
	CreatedAt time.Time
	Scope     Scope
}

Fact is a durable statement returned by a Store.

type Message

type Message struct {
	Role    string `json:"role"`
	Content string `json:"content"`
	Name    string `json:"name,omitempty"`
}

Message is a conversational turn supplied to Store.Add.

type Scope

type Scope struct {
	UserID  string `json:"user_id,omitempty"`
	AgentID string `json:"agent_id,omitempty"`
	RunID   string `json:"run_id,omitempty"`
}

Scope is the namespace a memory belongs to.

type Store

type Store interface {
	Add(ctx context.Context, msgs []Message, scope Scope) ([]Fact, error)
	Search(ctx context.Context, query string, scope Scope, k int) ([]Fact, error)
	Close() error
}

Store is the long-term memory functionality used by the agent and its lifecycle.