LogoLogo
👋 Get in touch⭐️ GitHub
  • Welcome
  • Getting Started
    • Why Superlinked?
    • Setup Superlinked
    • Basic Building Blocks
  • Run in Production
    • Overview
    • Setup Superlinked Server
      • Configuring your app
      • Interacting with app via API
    • Supported Vector Databases
      • Redis
      • Mongo DB
      • Qdrant
  • Concepts
    • Overview
    • Combining Multiple Embeddings for Better Retrieval Outcomes
    • Dynamic Parameters/Query Time weights
  • Reference
    • Overview
    • Changelog
    • Components
      • Dag
        • Period Time
      • Schema
        • Schema Object
        • Event Schema
        • Schema
        • Id Schema Object
        • Event Schema Object
      • Parser
        • Json Parser
        • Dataframe Parser
        • Data Parser
      • App
        • App
        • In Memory
          • In Memory App
        • Rest
          • Rest App
        • Online
          • Online App
        • Interactive
          • Interactive App
      • Executor
        • Exception
        • Executor
        • In Memory
          • In Memory Executor
        • Rest
          • Rest Executor
          • Rest Descriptor
          • Rest Handler
          • Rest Configuration
        • Query
          • Query Executor
        • Interactive
          • Interactive Executor
      • Source
        • Interactive Source
        • Types
        • Source
        • In Memory Source
        • Data Loader Source
        • Rest Source
      • Registry
        • Exception
        • Superlinked Registry
      • Space
        • Has Space Field Set
        • Image Space Field Set
        • Text Similarity Space
        • Number Space
        • Space
        • Image Space
        • Exception
        • Input Aggregation Mode
        • Custom Space
        • Categorical Similarity Space
        • Recency Space
        • Space Field Set
      • Query
        • Query Filter Validator
        • Param
        • Query Filters
        • Typed Param
        • Query Param Information
        • Natural Language Query Param Handler
        • Param Evaluator
        • Query Filter Information
        • Query Vector Factory
        • Query
        • Query Param Value Setter
        • Nlq Param Evaluator
        • Query Clause
        • Query Weighting
        • Clause Params
        • Nlq Pydantic Model Builder
        • Query User Config
        • Result
        • Query Mixin
        • Space Weight Param Info
        • Query Descriptor
        • Nlq
          • Nlq Compatible Clause Handler
          • Nlq Handler
          • Exception
          • Nlq Clause Collector
          • Param Filler
            • Query Param Prompt Builder
            • Query Param Model Builder
            • Query Param Model Validator Info
            • Nlq Annotation
            • Query Param Model Validator
            • Templates
          • Suggestion
            • Query Suggestion Model
            • Query Suggestions Prompt Builder
        • Predicate
          • Binary Predicate
          • Query Predicate
          • Binary Op
        • Query Clause
          • Looks Like Filter Clause
          • Select Clause
          • Similar Filter Clause
          • Looks Like Filter Clause Weights By Space
          • Space Weight Map
          • Single Value Param Query Clause
          • Nlq System Prompt Clause
          • Query Clause
          • Limit Clause
          • Base Looks Like Filter Clause
          • Nlq Clause
          • Weight By Space Clause
          • Radius Clause
          • Hard Filter Clause
          • Overriden Now Clause
        • Query Result Converter
          • Serializable Query Result Converter
          • Default Query Result Converter
          • Query Result Converter
      • Storage
        • Qdrant Vector Database
        • In Memory Vector Database
        • Redis Vector Database
        • Mongo Db Vector Database
        • Vector Database
      • Index
        • Effect
        • Index
        • Util
          • Effect With Referenced Schema Object
          • Event Aggregation Node Util
          • Aggregation Node Util
          • Aggregation Effect Group
          • Event Aggregation Effect Group
  • Recipes
    • Overview
    • Multi-Modal Semantic Search
      • Hotel Search
    • Recommendation System
      • E-Commerce RecSys
  • Tutorials
    • Overview
    • Semantic Search - News
    • Semantic Search - Movies
    • Semantic Search - Product Images & Descriptions
    • RecSys - Ecommerce
    • RAG - HR
    • Analytics - User Acquisition
    • Analytics - Keyword Expansion
  • Help & FAQ
    • Logging
    • Support
    • Discussion
  • Policies
    • Terms of Use
    • Privacy Policy
Powered by GitBook
On this page

Was this helpful?

Edit on GitHub
  1. Reference
  2. Components
  3. App
  4. Online

Online App

Classes

OnlineApp(sources: Sequence[~OnlineSourceT], indices: Sequence[superlinked.framework.dsl.index.index.Index], vector_database: superlinked.framework.dsl.storage.vector_database.VectorDatabase, context: superlinked.framework.common.dag.context.ExecutionContext, init_search_indices: bool, queue: superlinked.framework.queue.interface.queue.Queue | None = None, blob_handler: superlinked.framework.blob.blob_handler.BlobHandler | None = None, query_result_converter: superlinked.framework.dsl.query.query_result_converter.query_result_converter.QueryResultConverter | None = None) : Manages the execution environment for online sources and indices.

This class extends the base App class and incorporates the QueryMixin to handle
query execution. It is designed to work with online sources and indices, providing
the necessary setup and management for efficient data processing and querying.

Initialize the OnlineApp with the given sources, indices, vector database, and execution context.

Args:
    sources (Sequence[OnlineSourceT]): A sequence of data sources to be used by the application.
    indices (Sequence[Index]): A sequence of indices for data retrieval and storage.
    vector_database (VectorDatabase): The vector database instance for managing vector data.
    context (ExecutionContext): The execution context providing necessary runtime information.
    source_to_queue_map (dict[OnlineSourceT, Queue] | None): a mapping from sources
        to messaging queues persisting the ingested data on the given source; defaults to None.

### Ancestors (in MRO)

* superlinked.framework.dsl.app.app.App
* abc.ABC
* typing.Generic
* superlinked.framework.dsl.query.query_mixin.QueryMixin

### Descendants

* superlinked.framework.dsl.app.interactive.interactive_app.InteractiveApp
* superlinked.framework.dsl.app.rest.rest_app.RestApp

### Class variables

`INGEST_MESSAGE_TYPE`
:
PreviousOnlineNextInteractive

Last updated 4 months ago

Was this helpful?