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

Schema Object

Classes

Blob(name: str, schema_obj: SchemaObjectT, nullable: bool) : Field of a schema that represents a local/remote file path or an utf-8 encoded bytes string.

e.g.: `ImageSpace` expects a blob field as an input.

### Ancestors (in MRO)

* superlinked.framework.common.schema.schema_object.SchemaField
* superlinked.framework.common.interface.comparison_operand.ComparisonOperand
* abc.ABC
* typing.Generic

### Instance variables

`supported_comparison_operation_types: Sequence[ComparisonOperationType]`
:

### Methods

`as_type(self, value: Any) ‑> superlinked.framework.common.schema.blob_information.BlobInformation`
:

DescribedBlob(blob: Blob, description: String) : DescribedBlob(blob: 'Blob', description: 'String')

### Instance variables

`blob: superlinked.framework.common.schema.schema_object.Blob`
:

`description: superlinked.framework.common.schema.schema_object.String`
:

Float(name: str, schema_obj: SchemaObjectT, nullable: bool) : Field of a schema that represents a float.

### Ancestors (in MRO)

* superlinked.framework.common.schema.schema_object.Number
* superlinked.framework.common.schema.schema_object.SchemaField
* superlinked.framework.common.interface.comparison_operand.ComparisonOperand
* abc.ABC
* typing.Generic

### Instance variables

`supported_comparison_operation_types: Sequence[ComparisonOperationType]`
:

FloatList(name: str, schema_obj: SchemaObjectT, nullable: bool) : Field of a schema that represents a vector.

### Ancestors (in MRO)

* superlinked.framework.common.schema.schema_object.SchemaField
* superlinked.framework.common.interface.comparison_operand.ComparisonOperand
* abc.ABC
* typing.Generic

### Instance variables

`supported_comparison_operation_types: Sequence[ComparisonOperationType]`
:

### Methods

`as_type(self, value: Any) ‑> list[float]`
:

`parse(self, value: list[float]) ‑> list[float]`
:

Integer(name: str, schema_obj: SchemaObjectT, nullable: bool) : Field of a schema that represents an integer.

### Ancestors (in MRO)

* superlinked.framework.common.schema.schema_object.Number
* superlinked.framework.common.schema.schema_object.SchemaField
* superlinked.framework.common.interface.comparison_operand.ComparisonOperand
* abc.ABC
* typing.Generic

### Instance variables

`supported_comparison_operation_types: Sequence[ComparisonOperationType]`
:

Number(name: str, schema_obj: SchemaObjectT, type_: type[SFT], nullable: bool) : Field of a schema that represents a union of Float and Integer.

e.g.: `NumberSpace` expects a Number field as an input.

### Ancestors (in MRO)

* superlinked.framework.common.schema.schema_object.SchemaField
* superlinked.framework.common.interface.comparison_operand.ComparisonOperand
* abc.ABC
* typing.Generic

### Descendants

* superlinked.framework.common.schema.schema_object.Float
* superlinked.framework.common.schema.schema_object.Integer

SchemaField(name: str, schema_obj: SchemaObjectT, type_: type[SFT], nullable: bool) : A SchemaField is a generic field of your @schema decorated class.

`SchemaField`s are the basic building block for inputs that will be referenced in an embedding space.
Sub-types of a `SchemaField` are typed data representations that you can use to transform and load data
to feed the vector embedding process.

### Ancestors (in MRO)

* superlinked.framework.common.interface.comparison_operand.ComparisonOperand
* abc.ABC
* typing.Generic

### Descendants

* superlinked.framework.common.schema.event_schema_object.CreatedAtField
* superlinked.framework.common.schema.event_schema_object.SchemaReference
* superlinked.framework.common.schema.id_field.IdField
* superlinked.framework.common.schema.schema_object.Blob
* superlinked.framework.common.schema.schema_object.FloatList
* superlinked.framework.common.schema.schema_object.Number
* superlinked.framework.common.schema.schema_object.String
* superlinked.framework.common.schema.schema_object.StringList
* superlinked.framework.common.schema.schema_object.Timestamp

### Instance variables

`supported_comparison_operation_types: Sequence[ComparisonOperationType]`
:

### Methods

`as_type(self, value: Any) ‑> ~SFT`
:

`parse(self, value: SFT) ‑> ~SFT`
:

SchemaObject(base_cls: type) : @schema decorated class that has multiple SchemaFields.

Use it to represent your structured data to reference during the vector embedding process.

### Descendants

* superlinked.framework.common.schema.id_schema_object.IdSchemaObject

### Instance variables

`schema_fields: Sequence[SchemaField]`
:

String(name: str, schema_obj: SchemaObjectT, nullable: bool) : Field of a schema that represents a string value.

e.g.: `TextEmbeddingSpace` expects a String field as an input.

### Ancestors (in MRO)

* superlinked.framework.common.schema.schema_object.SchemaField
* superlinked.framework.common.interface.comparison_operand.ComparisonOperand
* abc.ABC
* typing.Generic

### Instance variables

`supported_comparison_operation_types: Sequence[ComparisonOperationType]`
:

StringList(name: str, schema_obj: SchemaObjectT, nullable: bool) : Field of a schema that represents a list of strings.

### Ancestors (in MRO)

* superlinked.framework.common.schema.schema_object.SchemaField
* superlinked.framework.common.interface.comparison_operand.ComparisonOperand
* abc.ABC
* typing.Generic

### Instance variables

`supported_comparison_operation_types: Sequence[ComparisonOperationType]`
:

### Methods

`as_type(self, value: Any) ‑> list[str]`
:

`parse(self, value: list[str]) ‑> list[str]`
:

Timestamp(name: str, schema_obj: SchemaObjectT, nullable: bool) : Field of a schema that represents a unix timestamp.

e.g.: `RecencySpace` expects a Timestamp field as an input.

### Ancestors (in MRO)

* superlinked.framework.common.schema.schema_object.SchemaField
* superlinked.framework.common.interface.comparison_operand.ComparisonOperand
* abc.ABC
* typing.Generic

### Instance variables

`supported_comparison_operation_types: Sequence[ComparisonOperationType]`
:

### Methods

`as_type(self, value: Any) ‑> int`
:
PreviousEvent Schema ObjectNextSchema

Last updated 1 month ago

Was this helpful?