frankensearch-core 0.1.1

Core traits, types, and error types for frankensearch
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137

//! Core traits, types, and error types for the frankensearch hybrid search library.
//!
//! This crate defines the shared interfaces (`Embedder`, `Reranker`, `LexicalSearch`),
//! result types (`ScoredResult`, `VectorHit`, `FusedHit`), error types (`SearchError`),
//! text canonicalization, and query classification used across all frankensearch crates.
//!
//! It has minimal external dependencies and is intended to be depended on by every
//! other crate in the workspace.

pub mod activation;
pub mod cache;
pub mod canonicalize;
pub mod collectors;
pub mod commit_replay;
pub mod config;
pub mod contract_sanity;
pub mod decision_plane;
pub mod distributed_observability;
pub mod e2e_artifact;
pub mod error;
pub mod explanation;
pub mod filter;
pub mod fingerprint;
pub mod generation;
pub mod graph;
pub mod host_adapter;
pub mod metrics_eval;
pub mod observability_lint;
pub mod parsed_query;
pub mod query_class;
pub mod repair;
pub mod time_travel;
pub mod tracing_config;
pub mod traits;
pub mod types;

pub use activation::{
    ActiveGeneration, ArtifactVerification, ArtifactVerifier, GenerationController, InvariantCheck,
    check_invariants,
};
pub use cache::{CachePolicy, NoCache, S3FifoCache, S3FifoConfig};
pub use canonicalize::{Canonicalizer, DefaultCanonicalizer};
pub use collectors::{
    CollectorConfig, CollectorSnapshot, DEFAULT_COLLECTION_INTERVAL_MS,
    DEFAULT_SEARCH_STREAM_CAPACITY, EmbedderTier, EmbeddingCollectorSample, EmbeddingStage,
    EmbeddingStatus, IndexCollectorSample, IndexInventory, IndexOperation, IndexStatus,
    LifecycleSeverity, LifecycleState, LiveSearchFrame, LiveSearchStreamEmitter,
    MIN_COLLECTION_INTERVAL_MS, PressureProfile, QuantizationMode, ResourceCollectorSample,
    RuntimeMetricsCollector, SearchCollectorSample, SearchEventPhase, SearchStreamConfig,
    SearchStreamHealth, SearchStreamMode, SearchStreamPublishOutcome, TELEMETRY_SCHEMA_VERSION,
    TelemetryCorrelation, TelemetryEmbedderInfo, TelemetryEmbeddingJob, TelemetryEnvelope,
    TelemetryEvent, TelemetryInstance, TelemetryQueryClass, TelemetryResourceSample,
    TelemetrySearchMetrics, TelemetrySearchQuery, TelemetrySearchResults,
};
pub use commit_replay::{
    CommitEntry, CommitOutcome, CommitReplayEngine, DocumentOp, ReplayConsumer, ReplayPolicy,
    ReplayWatermark, SkipReason,
};
pub use config::{TwoTierConfig, TwoTierMetrics};
pub use contract_sanity::{
    AdapterContractResult, CompatibilityStatus, ContractSanityChecker, ContractSanityReport,
    ContractViolationDiagnostic, MAX_SCHEMA_VERSION_LAG, ViolationSeverity, classify_version,
    classify_version_against, replay_command_for_reason,
};
pub use decision_plane::{
    CalibrationFallbackReason, CalibrationStatus, CalibrationThresholds, DecisionContext,
    DecisionOutcome, EvidenceEventType, EvidenceRecord, ExhaustionPolicy, LossVector, LossWeights,
    PipelineAction, PipelineState, ReasonCode, ResourceBudget, ResourceUsage, Severity,
};
pub use distributed_observability::{
    DistributedEvent, DistributedMetrics, emit_event, service_state_label,
};
pub use e2e_artifact::{
    ArtifactEmissionInput, ArtifactEntry, ClockMode, Correlation, DeterminismTier, DiffEntry,
    E2E_ARTIFACT_ARTIFACTS_INDEX_JSON, E2E_ARTIFACT_ENV_JSON, E2E_ARTIFACT_MANIFEST_JSON,
    E2E_ARTIFACT_REPLAY_COMMAND_TXT, E2E_ARTIFACT_REPRO_LOCK, E2E_ARTIFACT_STRUCTURED_EVENTS_JSONL,
    E2E_ARTIFACT_TERMINAL_TRANSCRIPT_TXT, E2E_SCHEMA_EVENT, E2E_SCHEMA_MANIFEST,
    E2E_SCHEMA_ORACLE_REPORT, E2E_SCHEMA_REPLAY, E2E_SCHEMA_SNAPSHOT_DIFF, E2E_SCHEMA_VERSION,
    E2eArtifactEmitterError, E2eArtifactValidationError, E2eEnvelope, E2eEventType, E2eOutcome,
    E2eSeverity, EventBody, ExitStatus, LaneReport, ManifestBody, ModelVersion, OracleReportBody,
    OracleVerdictRecord, Platform, ReplayBody, ReplayEventType, ReportTotals, SnapshotDiffBody,
    Suite, build_artifact_entries, build_core_manifest_artifacts, normalize_artifact_file_name,
    normalize_replay_command, render_artifacts_index, sha256_checksum, validate_envelope,
    validate_event_body, validate_event_envelope, validate_manifest_body,
    validate_manifest_envelope,
};
pub use error::{SearchError, SearchResult};
pub use explanation::{
    ExplainedSource, ExplanationPhase, HitExplanation, RankMovement, ScoreComponent,
};
pub use filter::{
    BitsetFilter, DateRangeFilter, DocTypeFilter, FilterChain, FilterMode, PredicateFilter,
    SearchFilter, fnv1a_hash,
};
pub use fingerprint::{
    DEFAULT_SEMANTIC_CHANGE_THRESHOLD, DocumentFingerprint, SIGNIFICANT_CHAR_COUNT_CHANGE_THRESHOLD,
};
pub use generation::{
    ActivationInvariant, CommitRange, EmbedderRevision, EmbedderTierTag, GenerationManifest,
    InvariantKind, LexicalArtifact, MANIFEST_SCHEMA_VERSION, QuantizationFormat, RepairDescriptor,
    ValidationFinding, ValidationResult, VectorArtifact, compute_manifest_hash, require_valid,
    validate_manifest,
};
pub use graph::{DocumentGraph, EdgeType, GraphDocId, GraphEdge};
pub use host_adapter::{
    AdapterIdentity, AdapterLifecycleEvent, AdapterSink, CanonicalHostProject, ConformanceConfig,
    ConformanceHarness, ConformanceReport, ConformanceViolation,
    DEFAULT_REDACTION_FORBIDDEN_PATTERNS, ForwardingHostAdapter, HostAdapter, NoopAdapterSink,
};
pub use metrics_eval::{
    BootstrapCi, BootstrapComparison, QualityComparison, QualityMetric, QualityMetricComparison,
    QualityMetricSamples, RunStabilityVerdict, bootstrap_ci, bootstrap_compare,
    coefficient_of_variation, detect_outliers_iqr, map_at_k, mrr, ndcg_at_k, quality_comparison,
    recall_at_k, trim_outliers, verify_run_stability,
};
pub use observability_lint::{
    LintFinding, LintReport, LintRuleId, LintSeverity, lint_component_coverage, lint_record,
    lint_stream,
};
pub use parsed_query::ParsedQuery;
pub use repair::{
    CorruptionEvent, CorruptionPolicy, DegradedReason, DetectionMethod, RepairAttempt,
    RepairOrchestrator, RepairOutcome, RepairProvider, ServiceState,
};
pub use time_travel::{GenerationHistory, RetainedGeneration, RetentionPolicy, TimeTravelResult};

pub use asupersync::Cx;
pub use query_class::QueryClass;
pub use traits::{
    Embedder, LexicalSearch, MetricsExporter, ModelCategory, ModelInfo, ModelTier,
    NoOpMetricsExporter, RerankDocument, RerankScore, Reranker, SearchFuture,
    SharedMetricsExporter, cosine_similarity, l2_normalize, truncate_embedding,
};
pub use types::{
    EmbeddingMetrics, FusedHit, IndexMetrics, IndexableDocument, PhaseMetrics, RankChanges,
    ScoreSource, ScoredResult, SearchMetrics, SearchMode, SearchPhase, VectorHit,
};