superlinked

superlinked

Superlinked is a Python framework for AI Engineers building high-performance search & recommendation applications that combine structured and unstructured data.

Stars: 852

Visit
 screenshot

Superlinked is a compute framework for information retrieval and feature engineering systems, focusing on converting complex data into vector embeddings for RAG, Search, RecSys, and Analytics stack integration. It enables custom model performance in machine learning with pre-trained model convenience. The tool allows users to build multimodal vectors, define weights at query time, and avoid postprocessing & rerank requirements. Users can explore the computational model through simple scripts and python notebooks, with a future release planned for production usage with built-in data infra and vector database integrations.

README:

 

Documentation PyPI Last commit License

Superlinked is a Python framework for AI Engineers building high-performance search & recommendation applications that combine structured and unstructured data. Check documentation to get started.

Table of Contents

Overview

  • WHY: Improve your vector search relevance by encoding metadata togehter with your unstructured data into vectors.
  • WHAT: A framework and a self-hostable REST API server that connects your data, vector database and backend services.
  • HOW: Construct custom data & query embedding models from pre-trained encoders from sentence-transformers, open-clip and custom encoders for numbers, timestamps and categorical data. See the feature and use-case notebooks below for examples.

If you like what we do, give us a star! ⭐


Features

You can check a full list of our features and concepts.

Use-cases

Dive deeper with our notebooks into how each use-case benefits from the Superlinked framework.

You can check a full list of examples here.

Experiment in a notebook

Let's build an e-commerce product search that understands product descriptions and ratings:

Install the superlinked library

%pip install superlinked

Run the example:

First run will take a minute to download the embedding model.

import json
import os

from superlinked import framework as sl


class Product(sl.Schema):
    id: sl.IdField
    description: sl.String
    rating: sl.Integer


product = Product()

description_space = sl.TextSimilaritySpace(
    text=product.description, model="Alibaba-NLP/gte-large-en-v1.5"
)
rating_space = sl.NumberSpace(
    number=product.rating, min_value=1, max_value=5, mode=sl.Mode.MAXIMUM
)
index = sl.Index([description_space, rating_space], fields=[product.rating])


# Define your query and parameters to set them directly at query-time
# or let an LLM fill them in for you using the `natural_language_query` param.
# Don't forget to set your OpenAI API key to unlock this feature.
query = (
    sl.Query(
        index,
        weights={
            description_space: sl.Param("description_weight"),
            rating_space: sl.Param("rating_weight"),
        },
    )
    .find(product)
    .similar(
        description_space,
        sl.Param(
            "description_query",
            description="The text in the user's query that refers to product descriptions.",
        ),
    )
    .limit(sl.Param("limit"))
    .with_natural_query(
        sl.Param("natural_language_query"),
        sl.OpenAIClientConfig(api_key=os.environ["OPEN_AI_API_KEY"], model="gpt-4o")
    )
)

# Run the app in-memory (server & Apache Spark executors available too!).
source = sl.InMemorySource(product)
executor = sl.InMemoryExecutor(sources=[source], indices=[index])
app = executor.run()


# Ingest data into the system - index updates and other processing happens automatically.
source.put([
    {
        "id": 1,
        "description": "Budget toothbrush in black color. Just what you need.",
        "rating": 1,
    },
    {
        "id": 2,
        "description": "High-end toothbrush created with no compromises.",
        "rating": 5,
    },
    {
        "id": 3,
        "description": "A toothbrush created for the smart 21st century man.",
        "rating": 3,
    },
])

result = app.query(query, natural_query="best toothbrushes", limit=1)

# Examine the extracted parameters from your query
print(json.dumps(result.knn_params, indent=2))

# The result is the 5-star rated product.
result.to_pandas()

Run in production

With a single command you can run Superlinked as a REST API Server locally or in your cloud with Superlinked Server. Get data ingestion and query APIs, embedding model inference and deep vector database integrations for free!

Unify your evaluation, ingestion and serving stacks with a single declarative python codebase. Superlinked enables this by letting you define your data schema, vector indexes and the compute DAG that links them all at once and then chose the right executor for the task - in-memory or server.

If your are interested in learning more about running at scale, Book a demo for an early access to our managed cloud.

Supported Vector Databases

Superlinked stores your vectors in your vector database, with deep integrations for:

Curious about vector database pros & cons in general? Our community compared 44 Vector Databases on 30+ features.

Logging

The Superlinked framework logs include contextual information, such as the process ID and package scope. Personally Identifiable Information (PII) is filtered out by default but can be exposed with the SUPERLINKED_EXPOSE_PII environment variable to true.

Resources

  • Vector DB Comparison: Open-source collaborative comparison of vector databases by Superlinked.
  • VectorHub: VectorHub is a free and open-sourced learning hub for people interested in adding vector retrieval to their ML stack

Support

Need help? We're here to support you:

  • Report a bug by creating an issue
  • Request a new feature here
  • Start a discussion about your ideas or questions

Please create separate issues/discussions for each topic to help us better address your feedback. Thank you for contributing!

For Tasks:

Click tags to check more tools for each tasks

For Jobs:

Alternative AI tools for superlinked

Similar Open Source Tools

For similar tasks

For similar jobs