Reference
Components
Complete reference documentation for all Superlinked framework components
This section provides comprehensive API documentation for all components in the Superlinked framework. Each component is documented with detailed parameter descriptions, usage examples, and best practices.
Common Module
Core utilities for data processing and schema management.Data Processing
DAG Components
DAG Components
- PeriodTime - Time-based filtering and decay parameters
Data Parsers
Data Parsers
- DataParser - Base data parsing functionality - DataFrameParser - Pandas DataFrame processing - JsonParser - JSON data handling
Schema Components
Schema Components
- Schema - Main schema definition
- SchemaObject - Individual schema objects
- EventSchema - Event-based schema definitions
- EventSchemaObject - Event schema objects
- IdSchemaObject - ID-based schema objects
DSL Module
Domain-specific language for vector computation and search.Application Framework
App Components
App Components
- App - Base application class
- InMemoryApp - In-memory execution
- InteractiveApp - Interactive development
- OnlineApp - Production deployment
- RestApp - REST API interface
Executor Components
Executor Components
- Executor - Base execution engine
- InMemoryExecutor - Memory-based execution
- InteractiveExecutor - Interactive execution
- QueryExecutor - Query processing
- RestExecutor - REST API execution
- RestConfiguration - REST configuration
- RestDescriptor - REST API descriptions
- RestHandler - REST request handling
Vector Operations
Index Components
Index Components
- Index - Vector index management
- Effect - Conditional vector modifications
- Utilities: AggregationEffectGroup, EventAggregationNodeUtil
Space Components
Space Components
- Space - Base vector space
- TextSimilaritySpace - Text embeddings
- CategoricalSimilaritySpace - Categorical encodings
- NumberSpace - Numerical transformations
- RecencySpace - Time-based decay
- ImageSpace - Image embeddings
- CustomSpace - Custom transformations
Query System
Query Components
Query Components
- Query - Main query interface
- QueryDescriptor - Query configuration
- QueryFilters - Filtering capabilities
- Result - Query results handling
Natural Language Querying
Natural Language Querying
- NLQHandler - Natural language processing - NLQClauseCollector - Query clause extraction - QuerySuggestionModel
- Query suggestions
Query Clauses
Query Clauses
- HardFilterClause - Exact filtering
- LooksLikeFilterClause - Similarity filtering
- LimitClause - Result limiting
- SelectClause - Field selection
Data Sources & Storage
Source Components
Source Components
- Source - Base data source
- InMemorySource - Memory-based sources
- InteractiveSource - Interactive data input
- RestSource - REST API sources
- DataLoaderSource - Batch data loading
Storage Components
Storage Components
- VectorDatabase - Base vector database
- InMemoryVectorDatabase - Memory storage
- QdrantVectorDatabase - Qdrant integration
- RedisVectorDatabase - Redis integration
- MongoDbVectorDatabase - MongoDB integration
- TopKVectorDatabase - Top-K optimization
Registry System
Registry Components
Registry Components
- SuperlinkedRegistry - Component registration - Exception - Registry error handling
Navigation Tips
Use the search functionality to quickly find specific components or methods
you’re looking for.
Each component page includes detailed parameter documentation, usage examples,
and integration guidance.