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. Query

Clause Params

Classes

KNNSearchClauseParams(limit: int | None = None, filters: Sequence[ComparisonOperation[SchemaField]] = <factory>, schema_fields_to_return: Sequence[SchemaField] = <factory>, radius: float | None = None, should_return_index_vector: bool = False) : KNNSearchClauseParams(limit: 'int | None' = None, filters: 'Sequence[ComparisonOperation[SchemaField]]' = , schema_fields_to_return: 'Sequence[SchemaField]' = , radius: 'float | None' = None, should_return_index_vector: 'bool' = False)

### Instance variables

`filters: Sequence[superlinked.framework.common.interface.comparison_operand.ComparisonOperation[superlinked.framework.common.schema.schema_object.SchemaField]]`
:

`limit: int | None`
:

`radius: float | None`
:

`schema_fields_to_return: Sequence[superlinked.framework.common.schema.schema_object.SchemaField]`
:

`should_return_index_vector: bool`
:

### Methods

`set_params(self, **params: Any) ‑> superlinked.framework.dsl.query.clause_params.KNNSearchClauseParams`
:

MetadataExtractionClauseParams(vector_part_ids: Sequence[str] = <factory>) : MetadataExtractionClauseParams(vector_part_ids: 'Sequence[str]' = )

### Instance variables

`vector_part_ids: Sequence[str]`
:

NLQClauseParams(client_config: OpenAIClientConfig | None = None, natural_query: str | None = None, system_prompt: str | None = None) : NLQClauseParams(client_config: 'OpenAIClientConfig | None' = None, natural_query: 'str | None' = None, system_prompt: 'str | None' = None)

### Instance variables

`client_config: superlinked.framework.common.nlq.open_ai.OpenAIClientConfig | None`
:

`natural_query: str | None`
:

`system_prompt: str | None`
:

QueryVectorClauseParams(weight_by_space: Mapping[Space, float] = <factory>, context_time: int | None = None, query_node_inputs_by_node_id: Mapping[str, list[QueryNodeInput]] = <factory>) : QueryVectorClauseParams(weight_by_space: 'Mapping[Space, float]' = , context_time: 'int | None' = None, query_node_inputs_by_node_id: 'Mapping[str, list[QueryNodeInput]]' = )

### Instance variables

`context_time: int | None`
:

`query_node_inputs_by_node_id: Mapping[str, list[superlinked.framework.query.query_node_input.QueryNodeInput]]`
:

`weight_by_space: Mapping[superlinked.framework.dsl.space.space.Space, float]`
:

### Methods

`set_params(self, **params: Any) ‑> superlinked.framework.dsl.query.clause_params.QueryVectorClauseParams`
:
PreviousQuery WeightingNextNlq Param Evaluator

Last updated 2 months ago

Was this helpful?