contentkit

Sep 28, 2026

Changes in this version

+ type CatalogPage struct

+ IDs []string

+ NextCursor string

type CatalogQuery

+ Cursor string

type ContentCatalog

+ Page func(ctx context.Context, tenant string, contentKind string, q CatalogQuery) (CatalogPage, error)

type ContentCatalogFunc

+ func (f ContentCatalogFunc) Page(ctx context.Context, tenant string, contentKind string, q CatalogQuery) (CatalogPage, error)

Sep 23, 2026

Changes in this version

type EmbeddedConfig

+ Candidates discovery.Candidates

type EmbeddedHub

+ func (h *EmbeddedHub) ForgetExposuresBefore(ctx context.Context, subject signal.Subject, before time.Time) error

type Hub

+ ForgetExposuresBefore func(ctx context.Context, subject signal.Subject, before time.Time) error

type Runtime

+ func (r *Runtime) ResyncPreferences(ctx context.Context) (content.PreferenceSyncReport, error)

+ func (r *Runtime) SyncPreferences(ctx context.Context) (content.PreferenceSyncReport, error)

Sep 19, 2026

Changes in this version

+ const PreferenceEventID

+ var ErrSignalPlaneDisabled = errors.New("contentkit: signal plane disabled (no ClickHouse configured)")

+ func Migrate(ctx context.Context, cfg MigrateConfig) error

+ func NewEvalRunner(client *Client, base SearchOptions) eval.CaseRunner

+ type CandidateTrace struct

+ Key TraceKey

+ Rank int

+ Score float32

+ type CatalogQuery struct

+ Limit int

+ type Client struct

+ func NewClient(cfg ClientConfig) (*Client, error)

+ func (c *Client) Search(ctx context.Context, userText string, opts SearchOptions) (SearchResult, error)

+ func (c *Client) SearchWithTrace(ctx context.Context, userText string, opts SearchOptions) (SearchResult, SearchTrace, error)

+ func (c *Client) Tenant() string

+ func (c *Client) Typeahead(ctx context.Context, userText string, opts TypeaheadOptions) ([]TypeaheadHit, error)

+ type ClientConfig struct

+ DefaultLanguage string

+ DefaultLimit int

+ Pool *pgxpool.Pool

+ Schema string

+ Tenant string

+ type ContentCatalog interface

+ Universe func(ctx context.Context, tenant string, contentKind string, q CatalogQuery) ([]string, error)

+ type ContentCatalogFunc func(ctx context.Context, tenant string, contentKind string, q CatalogQuery) ([]string, error)

+ func (f ContentCatalogFunc) Universe(ctx context.Context, tenant string, contentKind string, q CatalogQuery) ([]string, error)

+ type ContentKey = contentref.ContentKey

+ type ContentRef = contentref.ContentRef

+ type ContributionTrace struct

+ Contribution float32

+ SourceIndex int

+ SourceRank int

+ Weight float32

+ type DocumentKey = search.DocumentKey

+ type DocumentSink = search.DocumentSink

+ type Eligibility = search.Eligibility

+ type EmbeddedConfig struct

+ CH signal.Conn

+ CHDatabase string

+ Catalogs map[string]ContentCatalog

+ DefaultLanguage string

+ DefaultLimit int

+ DefaultRRFK int

+ PG *pgxpool.Pool

+ PGSchema string

+ Scorers map[string]signal.Scorer

+ Tenant string

+ type EmbeddedHub struct

+ func NewEmbedded(cfg EmbeddedConfig) (*EmbeddedHub, error)

+ func (h *EmbeddedHub) Attribution(ctx context.Context, opts signal.AttributionOptions) (signal.AttributionPage, error)

+ func (h *EmbeddedHub) Client() *Client

+ func (h *EmbeddedHub) Content(contentKind, contentID string) ContentRef

+ func (h *EmbeddedHub) EnforceErasures(ctx context.Context) (signal.ErasureReport, error)

+ func (h *EmbeddedHub) EraseSubjects(ctx context.Context, subjects []signal.Subject) (signal.ErasureReport, error)

+ func (h *EmbeddedHub) Forget(ctx context.Context, subject signal.Subject, contentKind, contentID string) error

+ func (h *EmbeddedHub) ForgetExposures(ctx context.Context, subject signal.Subject) error

+ func (h *EmbeddedHub) History(ctx context.Context, subject signal.Subject, opts signal.HistoryOptions) ([]signal.StateRow, error)

+ func (h *EmbeddedHub) HistoryCount(ctx context.Context, subject signal.Subject, opts signal.HistoryOptions) (int64, error)

+ func (h *EmbeddedHub) Inventory(ctx context.Context) ([]signal.InventoryRow, error)

+ func (h *EmbeddedHub) Metrics(ctx context.Context, refs []ContentRef, window signal.Window) (map[ContentKey]signal.ContentMetrics, error)

+ func (h *EmbeddedHub) Popular(ctx context.Context, contentKind string, opts signal.PopularOptions) ([]signal.PopularHit, error)

+ func (h *EmbeddedHub) PopularityFor(ctx context.Context, contentKind string, ids []string, window signal.Window) (map[string]float64, error)

+ func (h *EmbeddedHub) PurgeContentKinds(ctx context.Context, contentKinds []string) error

+ func (h *EmbeddedHub) Recommend(ctx context.Context, subject signal.Subject, opts RecommendOptions) ([]RecHit, error)

+ func (h *EmbeddedHub) RecordExposures(ctx context.Context, exposures []signal.Exposure) error

+ func (h *EmbeddedHub) RecordSignals(ctx context.Context, signals []signal.Signal) error

+ func (h *EmbeddedHub) RefreshCoEngagement(ctx context.Context, opts signal.RefreshCoEngagementOptions) error

+ func (h *EmbeddedHub) RepairProjections(ctx context.Context, opts signal.RepairOptions) (signal.RepairResult, error)

+ func (h *EmbeddedHub) Search(ctx context.Context, userText string, opts HubSearchOptions) (SearchResult, error)

+ func (h *EmbeddedHub) SeenIDs(ctx context.Context, subject signal.Subject, contentKind string) (map[string]struct{}, error)

+ func (h *EmbeddedHub) SimilarTo(ctx context.Context, ref ContentRef, opts SimilarOptions) ([]RecHit, error)

+ func (h *EmbeddedHub) States(ctx context.Context, subject signal.Subject, refs []ContentRef) (map[ContentKey]signal.State, error)

+ func (h *EmbeddedHub) Tenant() string

+ func (h *EmbeddedHub) Typeahead(ctx context.Context, userText string, opts TypeaheadOptions) ([]TypeaheadHit, error)

+ func (h *EmbeddedHub) Unseen(ctx context.Context, subject signal.Subject, opts UnseenOptions) ([]string, error)

+ type EmptyReason string

+ const EmptyReasonNoCandidates

+ const EmptyReasonNormalizedQuery

+ type Hub interface

+ Attribution func(ctx context.Context, opts signal.AttributionOptions) (signal.AttributionPage, error)

+ EnforceErasures func(ctx context.Context) (signal.ErasureReport, error)

+ EraseSubjects func(ctx context.Context, subjects []signal.Subject) (signal.ErasureReport, error)

+ Forget func(ctx context.Context, subject signal.Subject, contentKind, contentID string) error

+ ForgetExposures func(ctx context.Context, subject signal.Subject) error

+ History func(ctx context.Context, subject signal.Subject, opts signal.HistoryOptions) ([]signal.StateRow, error)

+ HistoryCount func(ctx context.Context, subject signal.Subject, opts signal.HistoryOptions) (int64, error)

+ Inventory func(ctx context.Context) ([]signal.InventoryRow, error)

+ Metrics func(ctx context.Context, refs []ContentRef, window signal.Window) (map[ContentKey]signal.ContentMetrics, error)

+ Popular func(ctx context.Context, contentKind string, opts signal.PopularOptions) ([]signal.PopularHit, error)

+ PopularityFor func(ctx context.Context, contentKind string, ids []string, window signal.Window) (map[string]float64, error)

+ PurgeContentKinds func(ctx context.Context, contentKinds []string) error

+ Recommend func(ctx context.Context, subject signal.Subject, opts RecommendOptions) ([]RecHit, error)

+ RecordExposures func(ctx context.Context, exposures []signal.Exposure) error

+ RecordSignals func(ctx context.Context, signals []signal.Signal) error

+ RefreshCoEngagement func(ctx context.Context, opts signal.RefreshCoEngagementOptions) error

+ RepairProjections func(ctx context.Context, opts signal.RepairOptions) (signal.RepairResult, error)

+ Search func(ctx context.Context, userText string, opts HubSearchOptions) (SearchResult, error)

+ SeenIDs func(ctx context.Context, subject signal.Subject, contentKind string) (map[string]struct{}, error)

+ SimilarTo func(ctx context.Context, ref ContentRef, opts SimilarOptions) ([]RecHit, error)

+ States func(ctx context.Context, subject signal.Subject, refs []ContentRef) (map[ContentKey]signal.State, error)

+ Tenant func() string

+ Typeahead func(ctx context.Context, userText string, opts TypeaheadOptions) ([]TypeaheadHit, error)

+ Unseen func(ctx context.Context, subject signal.Subject, opts UnseenOptions) ([]string, error)

+ type HubSearchOptions struct

+ Personalize *Personalization

+ type KeywordDocument = search.KeywordDocument

+ type LanguageMode string

+ const LanguageModeExact

+ const LanguageModeFallbackEnglish

+ type MigrateConfig struct

+ ClickHouse *chmigrate.Config

+ DB *sql.DB

+ LegacySearch bool

+ Schema string

+ SearchApp string

+ SearchSchema string

+ Taxonomy bool

+ type Personalization struct

+ AffinityWeight float32

+ CompletedPenalty float32

+ DemoteSeen bool

+ DislikePenalty float32

+ PopularityWeight float32

+ PopularityWindow signal.Window

+ SeenPenalty float32

+ Subject signal.Subject

+ type PublishedDocument = search.PublishedDocument

+ type RecHit struct

+ Score float32

+ type RecommendOptions struct

+ ContentKinds []string

+ IncludeSeen bool

+ Limit int

+ PopularWindow signal.Window

+ SeedContentKinds []string

+ SeedLimit int

+ type ResultTrace struct

+ Contributions []ContributionTrace

+ Key TraceKey

+ Rank int

+ Score float32

+ ScoreKind ScoreKind

+ type RetrievalBackend string

+ const BackendKeyword

+ type Runtime struct

+ Content *content.Runtime

+ func NewRuntime(ctx context.Context, cfg RuntimeConfig) (*Runtime, error)

+ func (r *Runtime) DeliverPreferences(ctx context.Context, after content.PreferenceKey, pageSize, maxRows int) (content.PreferenceDelivery, error)

+ func (r *Runtime) EraseSubjects(ctx context.Context, subjects []signal.Subject) (signal.ErasureReport, error)

+ func (r *Runtime) Handler() http.Handler

+ func (r *Runtime) ReplayPreferences(ctx context.Context, after content.PreferenceKey, pageSize, maxRows int) (content.PreferenceDelivery, error)

+ func (r *Runtime) WorkerOptions(host worker.Options) worker.Options

+ type RuntimeConfig struct

+ Content content.Options

+ type ScoreKind string

+ const ScoreKeywordMatch

+ type SearchHit struct

+ Language string

+ Score float32

+ type SearchOptions struct

+ CandidateLimit int

+ ContentKinds []string

+ Eligibility *Eligibility

+ FilterArgs map[string]any

+ FilterSQL string

+ Language string

+ LanguageMode LanguageMode

+ Limit int

+ Offset int

+ type SearchResult struct

+ HasMore bool

+ Hits []SearchHit

+ Truncated bool

+ type SearchTrace struct

+ CandidateLimit int

+ EmptyReason EmptyReason

+ ErrorCategory string

+ Languages []string

+ NormalizedQuery string

+ RequestedCandidateLimit int

+ RequestedLanguage string

+ RequestedLanguageMode LanguageMode

+ RequestedResultLimit int

+ ResultLimit int

+ Results []ResultTrace

+ Sources []SourceTrace

+ type SimilarOptions struct

+ ContentKinds []string

+ ExcludeSeenFor *signal.Subject

+ Limit int

+ Window signal.Window

+ type SourceStatus string

+ const SourceStatusFailed

+ const SourceStatusSucceeded

+ type SourceTrace struct

+ Backend RetrievalBackend

+ Candidates []CandidateTrace

+ ErrorCategory string

+ Language string

+ Limit int

+ ScoreKind ScoreKind

+ Status SourceStatus

+ type TaxonomyID = contentref.TaxonomyID

+ type TraceKey struct

+ Language string

+ type TypeaheadHit struct

+ Language string

+ Score float32

+ type TypeaheadOptions struct

+ ContentKinds []string

+ Eligibility *Eligibility

+ FilterArgs map[string]any

+ FilterSQL string

+ Language string

+ LanguageMode LanguageMode

+ Limit int

+ MinSimilarity float32

+ type UnseenOptions struct

+ CatalogLimit int

+ ContentKind string

+ Limit int