enrich

package

v0.167.0 Latest Latest Go to latest Published: Jul 11, 2026 License: MIT Imports: 6 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/freeeve/libcat

Links

Open Source Insights

Documentation ¶

Overview ¶

Package enrich executes enrichment sources against the deployment's grain store in one of two modes: direct (auto-approve -- assertions land in the source's enrichment:<name> graph) or queue (candidates become PIPELINE-provenance suggestions for moderation). The mode is a per-source deployment decision; the enrichers themselves are mode-blind.

Index ¶

type Mode
type Result
type Service
- func (s *Service) Names() []string
- func (s *Service) Run(ctx context.Context, name string) (Result, error)
type Source

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Mode ¶

type Mode string

Mode selects how a source's results land.

const (
	// ModeQueue routes candidates through moderation (the approval gate).
	ModeQueue Mode = "queue"
	// ModeDirect writes the source's enrichment graph outright
	// (auto-approve on import).
	ModeDirect Mode = "direct"
)

type Result ¶

type Result struct {
	Source string `json:"source"`
	Mode   Mode   `json:"mode"`
	// Works is the number of Works enriched (direct) or with candidates
	// queued (queue).
	Works int `json:"works"`
}

Result summarizes one run.

type Service ¶

type Service struct {
	Blob        blob.Store
	GrainPrefix string
	Queue       *suggest.Service
	Sources     map[string]Source
	// Summaries, when set, is the shared maintained summary source
	// (workindex, tasks/109) queue-mode runs read instead of a per-run
	// corpus walk; nil falls back to ScanSummaries.
	Summaries ingest.SummarySource
}

Service runs configured sources.

func (*Service) Names ¶

func (s *Service) Names() []string

Names lists the configured sources.

func (*Service) Run ¶

func (s *Service) Run(ctx context.Context, name string) (Result, error)

Run executes one configured source by name.

type Source ¶

type Source struct {
	Enricher ingest.Enricher
	Mode     Mode
	// Scheme keys the queued TermRefs (e.g. "lcsh"); queue mode only.
	Scheme string
}

Source pairs an enricher with its deployment mode.

Source Files ¶

View all Source files

enrich.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL