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
      • Parser
        • Dataframe Parser
        • Data Parser
        • Json Parser
      • Schema
        • Event Schema Object
        • Event Schema
        • Schema Object
        • Schema
        • Id Schema Object
      • Executor
        • Executor
        • Exception
        • Interactive
          • Interactive Executor
        • Query
          • Query Executor
        • In Memory
          • In Memory Executor
        • Rest
          • Rest Configuration
          • Rest Descriptor
          • Rest Executor
          • Rest Handler
      • Source
        • Types
        • Rest Source
        • Data Loader Source
        • In Memory Source
        • Source
        • Interactive Source
      • App
        • App
        • Interactive
          • Interactive App
        • Online
          • Online App
        • In Memory
          • In Memory App
        • Rest
          • Rest App
      • Registry
        • Superlinked Registry
        • Exception
      • Index
        • Index
        • Effect
        • Util
          • Aggregation Effect Group
          • Aggregation Node Util
          • Effect With Referenced Schema Object
          • Event Aggregation Node Util
          • Event Aggregation Effect Group
      • Query
        • Query Descriptor
        • Typed Param
        • Query Clause
        • Query Filter Validator
        • Query Param Information
        • Query Mixin
        • Nlq Pydantic Model Builder
        • Param
        • Query Filters
        • Result
        • Query Filter Information
        • Query Param Value Setter
        • Query Vector Factory
        • Query Weighting
        • Clause Params
        • Nlq Param Evaluator
        • Natural Language Query Param Handler
        • Query
        • Param Evaluator
        • Space Weight Param Info
        • Predicate
          • Query Predicate
          • Binary Predicate
          • Binary Op
        • Nlq
          • Nlq Compatible Clause Handler
          • Nlq Clause Collector
          • Exception
          • Nlq Handler
          • Param Filler
            • Query Param Prompt Builder
            • Query Param Model Validator Info
            • Query Param Model Builder
            • Query Param Model Validator
            • Nlq Annotation
            • Templates
          • Suggestion
            • Query Suggestion Model
            • Query Suggestions Prompt Builder
        • Query Result Converter
          • Serializable Query Result Converter
          • Default Query Result Converter
          • Query Result Converter
        • Query Clause
          • Limit Clause
          • Radius Clause
          • Query Clause
          • Single Value Param Query Clause
          • Weight By Space Clause
          • Similar Filter Clause
          • Overriden Now Clause
          • Looks Like Filter Clause
          • Hard Filter Clause
          • Select Clause
          • Looks Like Filter Clause Weights By Space
          • Space Weight Map
          • Base Looks Like Filter Clause
          • Nlq Clause
          • Nlq System Prompt Clause
      • Space
        • Text Similarity Space
        • Image Space
        • Input Aggregation Mode
        • Categorical Similarity Space
        • Exception
        • Space
        • Number Space
        • Has Space Field Set
        • Recency Space
        • Image Space Field Set
        • Space Field Set
        • Custom Space
      • Storage
        • Mongo Db Vector Database
        • Redis Vector Database
        • Vector Database
        • Qdrant Vector Database
        • In Memory Vector Database
  • 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`
:
PreviousOnlineNextIn Memory

Last updated 4 months ago

Was this helpful?