provenance

Documentation

Index

• func Append(projectPath string, event Event) error
• func LastOutputEquals(projectPath, action, key string, expected any) (bool, error)
• func Note(projectPath, message, actorName string) error
• type Event
  • func Read(projectPath string) ([]Event, error)

Functions

func Append

func Append(projectPath string, event Event) error

Append records one Provenance event in the project JSONL ledger.

func LastOutputEquals

func LastOutputEquals(projectPath, action, key string, expected any) (bool, error)

LastOutputEquals reports whether the latest event with action has output key equal to expected.

func Note

func Note(projectPath, message, actorName string) error

Note appends a researcher annotation event to the project provenance log. It is the CLI-safe path for recording human observations without a full search run.

Types

type Event

type Event struct {
	SchemaVersion string         `json:"schemaVersion"`
	ID            string         `json:"id"`
	Timestamp     string         `json:"timestamp"`
	Actor         string         `json:"actor"`
	Action        string         `json:"action"`
	Target        string         `json:"target"`
	Inputs        map[string]any `json:"inputs"`
	Outputs       map[string]any `json:"outputs"`
	Warnings      []string       `json:"warnings"`
}

Event is one append-only Provenance record in a ResearchForge project.

func Read

func Read(projectPath string) ([]Event, error)

Read returns all Provenance events from the project JSONL ledger.