ragit

package module

Go to main page

Versions in this module

v0

v0.3.0

Aug 28, 2026

Changes in this version

+ const MigrationsTable

+ var ErrRLSNotEnforced = errors.New("ragit: row-level security is not enforced for this connection")

+ func GrantAppRole(ctx context.Context, pool *pgxpool.Pool, role string) error

+ func ResumeChunks(ctx context.Context, db sqlb.Executor, tenantID, documentID uuid.UUID, ...) ([]bool, error)

+ func VerifyRLS(ctx context.Context, pool *pgxpool.Pool) error

type Document

+ EmbeddingFingerprint *string

type DocumentUpdate

+ func (u *DocumentUpdate) SetEmbeddingFingerprint(v *string) *DocumentUpdate

+ type MigrateOption func(*migrateConfig)

+ func FromFS(fsys fs.FS) MigrateOption

+ type PreparedChunk struct

+ Content string

+ Embedding embed.Vector

+ HeadingPath []string

+ Metadata json.RawMessage

+ type PreparedDocument struct

+ Chunks []PreparedChunk

+ Metadata json.RawMessage

+ Space embed.Space

+ Text string

type Processor

+ func (p *Processor) IngestPrepared(ctx context.Context, documentID, tenantID uuid.UUID, prepared PreparedDocument) error

type SearchOptions

+ RequireAllTerms bool

v0.2.0

Aug 26, 2026

Changes in this version

+ const DefaultListLimit

+ const DefaultTopK

+ const DeleteExpiredBatchSize

+ const MaintenanceGUC

+ const StatusError

+ const StatusPending

+ const StatusProcessing

+ const StatusReady

+ const StatusSkippedTooLarge

+ const TenantGUC

+ var ChunkCols = chunkColumns

+ var DocumentCols = documentColumns

+ var ErrNotFound = errors.New("ragit: document not found")

+ var ErrUnscoped = errors.New("ragit: query has no tenant scope")

+ func Migrate(ctx context.Context, pool *pgxpool.Pool) error

+ func MigrateDown(ctx context.Context, pool *pgxpool.Pool) error

+ func NewPool(ctx context.Context, dsn string) (*pgxpool.Pool, error)

+ func WithMaintenance(ctx context.Context, pool *pgxpool.Pool, fn func(sqlb.Executor) error) error

+ func WithTenant(ctx context.Context, pool *pgxpool.Pool, tenantID uuid.UUID, ...) error

+ type Attributes map[string]string

+ func DocumentAttributes(doc *Document) (Attributes, error)

+ type Chunk struct

+ Attributes json.RawMessage

+ ChunkIndex int32

+ Content string

+ CreatedAt time.Time

+ DocumentID uuid.UUID

+ Embedding *sqlb.Vector

+ EmbeddingFingerprint *string

+ ExpiresAt *time.Time

+ HeadingPath []string

+ ID uuid.UUID

+ Metadata json.RawMessage

+ ScopeAID *uuid.UUID

+ ScopeBID *uuid.UUID

+ SessionID *uuid.UUID

+ TenantID uuid.UUID

+ func (Chunk) TableName() string

+ type ChunkUpdate struct

+ func UpdateChunk() *ChunkUpdate

+ func (u *ChunkUpdate) SetAttributes(v json.RawMessage) *ChunkUpdate

+ func (u *ChunkUpdate) SetChunkIndex(v int32) *ChunkUpdate

+ func (u *ChunkUpdate) SetContent(v string) *ChunkUpdate

+ func (u *ChunkUpdate) SetCreatedAt(v time.Time) *ChunkUpdate

+ func (u *ChunkUpdate) SetDocumentID(v uuid.UUID) *ChunkUpdate

+ func (u *ChunkUpdate) SetEmbedding(v *sqlb.Vector) *ChunkUpdate

+ func (u *ChunkUpdate) SetEmbeddingFingerprint(v *string) *ChunkUpdate

+ func (u *ChunkUpdate) SetExpiresAt(v *time.Time) *ChunkUpdate

+ func (u *ChunkUpdate) SetHeadingPath(v []string) *ChunkUpdate

+ func (u *ChunkUpdate) SetMetadata(v json.RawMessage) *ChunkUpdate

+ func (u *ChunkUpdate) SetScopeAID(v *uuid.UUID) *ChunkUpdate

+ func (u *ChunkUpdate) SetScopeBID(v *uuid.UUID) *ChunkUpdate

+ func (u *ChunkUpdate) SetSessionID(v *uuid.UUID) *ChunkUpdate

+ func (u *ChunkUpdate) SetTenantID(v uuid.UUID) *ChunkUpdate

+ func (u *ChunkUpdate) Stmt() *sqlb.Update[Chunk]

+ func (u *ChunkUpdate) Where(preds ...sqlb.Pred) *ChunkUpdate

+ type Document struct

+ Attributes json.RawMessage

+ ChunkCount *int32

+ CreatedAt time.Time

+ EmbeddingModel *string

+ Error *string

+ ExpiresAt *time.Time

+ Filename string

+ ID uuid.UUID

+ Metadata json.RawMessage

+ MimeType string

+ ProcessedAt *time.Time

+ ScopeAID *uuid.UUID

+ ScopeBID *uuid.UUID

+ SessionID *uuid.UUID

+ SourceURI *string

+ Status string

+ TenantID uuid.UUID

+ TextContent *string

+ UpdatedAt time.Time

+ func (Document) TableName() string

+ type DocumentInput struct

+ Attributes Attributes

+ Data []byte

+ ExpiresAt *time.Time

+ Filename string

+ MimeType string

+ ScopeA *uuid.UUID

+ ScopeB *uuid.UUID

+ SessionID *uuid.UUID

+ TenantID uuid.UUID

+ type DocumentUpdate struct

+ func UpdateDocument() *DocumentUpdate

+ func (u *DocumentUpdate) SetAttributes(v json.RawMessage) *DocumentUpdate

+ func (u *DocumentUpdate) SetChunkCount(v *int32) *DocumentUpdate

+ func (u *DocumentUpdate) SetCreatedAt(v time.Time) *DocumentUpdate

+ func (u *DocumentUpdate) SetEmbeddingModel(v *string) *DocumentUpdate

+ func (u *DocumentUpdate) SetError(v *string) *DocumentUpdate

+ func (u *DocumentUpdate) SetExpiresAt(v *time.Time) *DocumentUpdate

+ func (u *DocumentUpdate) SetFilename(v string) *DocumentUpdate

+ func (u *DocumentUpdate) SetMetadata(v json.RawMessage) *DocumentUpdate

+ func (u *DocumentUpdate) SetMimeType(v string) *DocumentUpdate

+ func (u *DocumentUpdate) SetProcessedAt(v *time.Time) *DocumentUpdate

+ func (u *DocumentUpdate) SetScopeAID(v *uuid.UUID) *DocumentUpdate

+ func (u *DocumentUpdate) SetScopeBID(v *uuid.UUID) *DocumentUpdate

+ func (u *DocumentUpdate) SetSessionID(v *uuid.UUID) *DocumentUpdate

+ func (u *DocumentUpdate) SetSourceURI(v *string) *DocumentUpdate

+ func (u *DocumentUpdate) SetStatus(v string) *DocumentUpdate

+ func (u *DocumentUpdate) SetTenantID(v uuid.UUID) *DocumentUpdate

+ func (u *DocumentUpdate) SetTextContent(v *string) *DocumentUpdate

+ func (u *DocumentUpdate) SetUpdatedAt(v time.Time) *DocumentUpdate

+ func (u *DocumentUpdate) Stmt() *sqlb.Update[Document]

+ func (u *DocumentUpdate) Where(preds ...sqlb.Pred) *DocumentUpdate

+ type Event struct

+ At time.Time

+ ChunkCount int

+ DocumentID uuid.UUID

+ Error string

+ Filename string

+ ScopeA *uuid.UUID

+ ScopeB *uuid.UUID

+ SessionID *uuid.UUID

+ Status string

+ TenantID uuid.UUID

+ func (e Event) Succeeded() bool

+ type EventSink interface

+ DocumentProcessed func(ctx context.Context, event Event)

+ type EventSinkFunc func(ctx context.Context, event Event)

+ func (f EventSinkFunc) DocumentProcessed(ctx context.Context, event Event)

+ type ListFilter struct

+ Attributes Attributes

+ Limit int

+ Offset int

+ Status []string

+ type Processor struct

+ func New(pool *pgxpool.Pool, extractor extract.Extractor, chunker *chunk.Chunker, ...) *Processor

+ func (p *Processor) CountDocuments(ctx context.Context, scope Scope, filter ListFilter) (int64, error)

+ func (p *Processor) CountMisalignedChunks(ctx context.Context, scope Scope) (int64, error)

+ func (p *Processor) CreateDocument(ctx context.Context, in DocumentInput) (uuid.UUID, error)

+ func (p *Processor) DeleteDocument(ctx context.Context, tenantID, documentID uuid.UUID) error

+ func (p *Processor) DeleteExpired(ctx context.Context) (*RetentionResult, error)

+ func (p *Processor) FullTextSearch(ctx context.Context, scope Scope, query string, opts SearchOptions) ([]SearchResult, error)

+ func (p *Processor) GetDocument(ctx context.Context, scope Scope, documentID uuid.UUID) (*Document, error)

+ func (p *Processor) Ingest(ctx context.Context, in DocumentInput) (*Document, error)

+ func (p *Processor) ListChunks(ctx context.Context, scope Scope, documentID uuid.UUID) ([]Chunk, error)

+ func (p *Processor) ListDocuments(ctx context.Context, scope Scope, filter ListFilter) ([]Document, error)

+ func (p *Processor) MoveDocumentScope(ctx context.Context, tenantID, documentID uuid.UUID, ...) error

+ func (p *Processor) ProcessDocument(ctx context.Context, documentID, tenantID uuid.UUID) error

+ func (p *Processor) SetDocumentAttributes(ctx context.Context, tenantID, documentID uuid.UUID, attrs Attributes) error

+ func (p *Processor) VectorSearch(ctx context.Context, scope Scope, query string, opts SearchOptions) ([]SearchResult, error)

+ func (p *Processor) WithEventSink(sink EventSink) *Processor

+ func (p *Processor) WithMaxChunksPerDocument(n int) *Processor

+ type RetentionResult struct

+ Chunks int

+ Documents int

+ ObjectErrors []error

+ type Scope struct

+ func Tenant(tenantID uuid.UUID) Scope

+ func (s Scope) A(ids ...uuid.UUID) Scope

+ func (s Scope) AnyA() Scope

+ func (s Scope) AnyB() Scope

+ func (s Scope) B(ids ...uuid.UUID) Scope

+ func (s Scope) Session(id uuid.UUID) Scope

+ func (s Scope) TenantID() uuid.UUID

+ func (s Scope) Validate() error

+ type SearchOptions struct

+ Attributes Attributes

+ MinScore float64

+ TopK int

+ type SearchResult struct

+ ChunkID uuid.UUID

+ ChunkIndex int32

+ Content string

+ DocumentID uuid.UUID

+ Filename string

+ HeadingPath []string

+ Metadata json.RawMessage

+ Score float64

v0.1.0

Aug 25, 2026

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