Welcome to ef’s documentation!
Contents:
- ef
ArtifactGraphArtifactIdBaseEmbedderBaseSegmenterBatchHandleBatchedSegmenterCachedEmbedderChangeDetectingCorpusChangeEventConfigIdCorpusDiffCorpusInfoEfServiceEmbedderEmbedderErrorExploreResultFunctionEmbedderFunctionSegmenterHashingEmbedderIndexedSourceMultiEmbedderNormalizingEmbedderOpKeyPipelineSpecProducerSpecRagEvalReportRagSampleRecursiveCharacterSegmenterRefreshPlanRefreshReportRerankerRetrievalEvalReportRetryPolicyRetryingEmbedderSearchHitSearchableCorpusSegmentSegmentRecordSegmenterSourceManagerStalenessReportTransformSpecapprox_token_count()artifact_id()as_corpus()as_embedder()as_ragas_dataset()as_segment()as_segmenter()average_precision()cache_key()cluster()cohere_embedder()config_id()content_hash()context_precision()context_recall()cross_encoder_reranker()dcg_at_k()diagnose()embed_length_sorted()evaluate_rag()evaluate_retrieval()exact_match()explore()full_kwargs()gemini_embedder()hierarchical()hits_to_segments()http_embedder()imbed_segmenter()ingest()label_clusters()line_segmenter()make_segment()materialise()ndcg_at_k()openai_embedder()plan_refresh()precision_at_k()producer_spec()project()read_beir()ready_handle()recall_at_k()reciprocal_rank()refresh_on_change()rerank()segment_id()segment_record()sentence_transformers_embedder()step_params()token_f1()voyage_embedder()with_overlap()with_reranker()write_beir()
- ef.artifact_graph
- ef.config
- ef.corpus
- ef.diagnostics
- ef.embedder_adapters
- ef.embedder_wrappers
- ef.embedders
- ef.evaluation
QrelsRETRIEVAL_METRICSRagEvalReportRagSampleRetrievalEvalReportas_ragas_dataset()average_precision()context_precision()context_recall()dcg_at_k()evaluate_rag()evaluate_retrieval()exact_match()ndcg_at_k()precision_at_k()read_beir()recall_at_k()reciprocal_rank()token_f1()write_beir()
- ef.exploration
- ef.hashing
- ef.ops
- ef.refresh
- ef.reranking
- ef.segmenter_adapters
- ef.segmenters
- ef.segments
- ef.service
- ef.source_manager
Indices and tables
Release: 0.1.21
Last change: Jun 21, 2026