search

type Candidate ¶

type Candidate struct {
	contentref.ContentRef
	Language string
	Score    float32
}

Candidate is one document proposed by another retrieval source.

type DirtyMark ¶

type DirtyMark struct {
	DocumentKey
	Deleted bool
	Reason  string
}

DirtyMark asks the worker to rebuild (or delete) one document.

type DocumentKey ¶

type DocumentKey struct {
	contentref.ContentRef
	Language string
}

DocumentKey identifies one keyword document: a content reference in one language. The language is metadata of the document, never of the content.

type Eligibility ¶

type Eligibility struct {
	SQL  string
	Args map[string]any
}

Eligibility is ContentKit's own SQL (the discovery routes' rendering of the visibility rule) joined laterally to every candidate document (alias sd: tenant_id, content_kind, content_id, content_version_id, language). It returns no row when the document is not eligible for this request, or one row with the column priority (integer: preferred document among a content item's equal matches, lower first). Ownership, access, publication and every requested version trait must hold on that one row; sibling documents never make each other eligible.

type Executor ¶

type Executor interface {
	Exec(context.Context, string, ...any) (pgconn.CommandTag, error)
}

Executor lets a pool or a transaction own document and queue writes.

type Hit ¶

type Hit struct {
	contentref.ContentRef
	Language string
	// Priority orders same-item documents at equal match; lower is preferred.
	Priority int32
	Score    float32
}

Hit is one matched document.

func Eligible(ctx context.Context, pool *pgxpool.Pool, opts Options, candidates []Candidate) ([]Hit, error)

type IndexRetirement ¶ added in v0.104.0

type IndexRetirement struct {
	Validated []string
	Dropped   []string
	Absent    []string
}

IndexRetirement reports one retirement pass: the replacement indexes it validated and the superseded objects it dropped or found already gone.

func RetireLegacyIndexes(ctx context.Context, pool *pgxpool.Pool, schema string, legacyWritersStopped bool) (IndexRetirement, error)

type KeywordDocument ¶

type KeywordDocument struct {
	DocumentKey
	Title    string
	Aliases  []string
	Keywords []string
}

KeywordDocument is the search input for one document, built by ContentKit from its own records. Derived search text belongs to ContentKit; callers never write it. An empty Title deletes the document. Aliases are alternate names; Keywords are contextual terms (for example trusted tags), not descriptions.

func (d KeywordDocument) Validate() error

type NameSource ¶ added in v0.104.0

type NameSource uint8

NameSource is a trusted indexed source, never a request-supplied relation.

const (
	PublishedNames NameSource = iota
	CurrentContentNames
	CurrentEntityNames
)

type Options ¶

type Options struct {
	Schema   string
	Tenant   string
	Language string
	// ContentKinds limits the kinds searched; empty means every kind.
	ContentKinds []string
	Limit        int

	// Eligibility binds pgx '@name' placeholders other than the reserved
	// tenant, language, q, prefix, contains, limit, kinds and candidates.
	Eligibility *Eligibility
}

Options selects one tenant, language and window of a keyword request.

type RRFContribution ¶

type RRFContribution struct {
	ListIndex    int     `json:"list_index"` // zero-based source-list index
	Rank         int     `json:"rank"`       // one-based rank within the source list
	Weight       float32 `json:"weight"`
	Contribution float32 `json:"contribution"`
}

type RRFHit ¶

type RRFHit struct {
	RRFKey
	Score float32
}

func FuseRRF(lists [][]RRFKey, opts RRFOptions) []RRFHit

type RRFKey ¶

type RRFKey struct {
	contentref.ContentKey
	Language string
}

RRFKey identifies one document across fused lists.

type RRFOptions ¶

type RRFOptions struct {
	// K is the stabilizer constant; higher K flattens rank differences.
	// Defaults to 60 when <= 0.
	K int
	// Finite weights apply to each list; missing weights default to 1.
	// Zero excludes a list. Negative weights subtract its contributions.
	Weights []float32
}

RRF (Reciprocal Rank Fusion) combines ranked lists without relying on raw score calibration: score(doc) = Σ weight_i / (k + rank_i), rank 1-based.

type RRFTraceHit ¶

type RRFTraceHit struct {
	Hit           RRFHit            `json:"-"`
	Key           RRFTraceKey       `json:"key"`
	Score         float32           `json:"score"`
	Contributions []RRFContribution `json:"contributions"`
}

func FuseRRFWithTrace(lists [][]RRFKey, opts RRFOptions) ([]RRFTraceHit, error)

type RRFTraceKey ¶

type RRFTraceKey struct {
	TenantID         string `json:"tenant_id"`
	ContentKind      string `json:"content_kind"`
	ContentID        string `json:"content_id"`
	ContentVersionID string `json:"content_version_id,omitempty"`
	Language         string `json:"language"`
}

type Result ¶

type Result struct {
	// Hits are documents ordered by score, content kind, content id and version.
	Hits []Hit
	// Truncated reports that a route filled its SQL window or that more scored
	// documents existed than Limit: documents beyond the window were never ranked.
	Truncated bool
}

Result is one language's scored document window.

func KeywordSearch(ctx context.Context, pool *pgxpool.Pool, query string, opts Options) (Result, error)

func NameSearch(ctx context.Context, pool *pgxpool.Pool, query string, opts Options) (Result, error)

func NameSearchFrom(ctx context.Context, pool *pgxpool.Pool, query string, opts Options, source NameSource) (Result, error)