apogee-ai-search¶
Hybrid retrieval (BM25 + dense + reranker) over
apogee-coreindex abstractions.
Esta página está sendo ampliada
As tabelas abaixo são geradas do código-fonte do pacote, portanto estão corretas. Guias narrativos e exemplos comentados estão sendo escritos módulo a módulo.
API pública¶
Tudo abaixo é exportado pela raiz do pacote, então from apogee_ai_search import X funciona para cada nome.
| Camada | Símbolos |
|---|---|
| Application · DTOs | BenchDTO, IndexDTO, QueryDTO |
| Application · Use cases | BenchSearchUseCase, BulkIndexUseCase, IndexDocumentsUseCase, SearchUseCase |
| Domain | SearchDocument, SearchHit, SearchQuery, SearchResult |
| Domain · Enums | IndexKind, SearcherKind |
| Domain · Exceptions | IndexNotReadyError, SearchError |
| Domain · Protocols (ports) | IIndex, ISearcher |
| Infrastructure | BM25Searcher, HybridSearcher, InMemoryInvertedIndex, InMemoryVectorIndex, VectorSearcher, cosine, tokenize |
Instalação¶
A instalação base não tem dependência externa obrigatória. Cada extra habilita um adapter.
| Extra | Traz |
|---|---|
elasticsearch |
elasticsearch>=8.13 |
opensearch |
opensearch-py>=2.5 |
CLI¶
Instalado como console script e registrado como plugin do apogee, então os mesmos subcomandos funcionam sob o binário global.
Leia a seguir¶
- Instalação
- Referência — todo símbolo público, gerado do código-fonte
- Apogee Framework — como os pacotes se encaixam