mirror of
https://github.com/lancedb/lancedb.git
synced 2026-10-13 23:32:27 +00:00
Move the public website pages into `docs/web` beside the SDK, with
shared navigation and executable example sources in `docs/web-tests`.
The combined website is assembled by
[lancedb/docs#355](https://github.com/lancedb/docs/pull/355), with six
Enterprise replacements from
[lancedb/sophon#7681](https://github.com/lancedb/sophon/pull/7681).
This includes Function guidance, runnable Quickstarts, regenerated
snippets, production contact/demo fixes, the legacy SQL route, and the
LeRobot redirect. LeRobot remains attributed to Geneva; all 34 Geneva
pages remain in the docs repository until Function officially launches.
Materialized-view guidance follows the full rebuild refresh introduced
by #4373: local refresh writes the complete result, has no `full`
argument, supports `source_version`, and no longer requires stable row
IDs. Deployment SQL refresh options and stable-ID setup are qualified by
version/configuration. Function input guidance distinguishes ordinary
stored columns from computed inputs supported by newer deployments.
**Validation:** independently accepted local checks include 95 Python
tests (real Enterprise excluded), eight TypeScript tests, Rust
Quickstart, snippet parity, typos, deterministic assembly, Mint
validation and links/anchors/redirects. The combined baseline retains
all 181 production routes and 17 legacy redirects. Examples ran locally
against source-built Python SDK 0.40.0b13; existing GitHub workflows do
not run `docs/web-tests`. New main at `069b2f7d` is 0.41.0b0 and adds
computed Function inputs; that SDK was not exercised by the accepted
tests. Latest prose corrections receive focused site validation.
**Merge/rollout:** merge this and #7681 before #355's combined CI, which
reads producer `main`. This is migration infrastructure: section
overlays, source-owned skills and automatic versioned paired releases
remain follow-ups. The current manual publisher is transitional. Hosted
validation, a supported SDK/Enterprise release pair and a real
Enterprise walkthrough remain pending.
Production Mintlify watches `lancedb/docs:deploy-freeze`, directory
`docs`; preserve that source through review. The separate SDK GitHub
Pages reference workflow rebuilds on main merges.
**Updated-head CI (9a50f8db):**
[Typos](https://github.com/lancedb/lancedb/actions/runs/37654185443/job/112904990558),
[PR
title](https://github.com/lancedb/lancedb/actions/runs/37654179507/job/112904974595)
and
[Aikido](https://app.aikido.dev/featurebranch/scan/215386145?groupId=74229)
pass. Critical findings in the example lockfiles were patched: all Sharp
copies use 0.35.5, protobufjs 7.6.6, tar 7.5.22, quinn-proto 0.11.19,
zerovec 0.11.8 and zerovec-derive 0.11.6. The SDK's product dependencies
are unchanged. The revised lockfiles pass eight TypeScript examples,
HuggingFace decode/resize/crop/rescale/normalize plus AVIF roundtrip,
and Rust Quickstart. Aikido passing does not mean every advisory is
cleared; npm still reports 29 high and five moderate advisories in the
example dependency graph. No scanner bypass or suppression was added.
The Function prose correction passes combined/standalone Mint,
deterministic assembly, routes and assets. The revised 325-file site
checksum is
`175bec06864abb400dd292e667ba93448c0479b8359fd7bf6146afabf9040647`. This
PR remains open for independent review; further merges are on hold.
---------
Co-authored-by: Brendan Clement <brendan.clement@lancedb.com>
141 lines
4.7 KiB
Plaintext
141 lines
4.7 KiB
Plaintext
---
|
|
title: Superlinked
|
|
sidebarTitle: Superlinked
|
|
---
|
|
|
|
[Superlinked](https://superlinked.com) is a self-hosted inference engine (SIE) for embedding, reranking, and extraction. The `sie-lancedb` package registers SIE as a first-class embedding function in LanceDB's embeddings registry, so embeddings are computed automatically on insert and search. You need a running SIE instance - see the [Superlinked quickstart](https://superlinked.com/docs) for deployment options.
|
|
|
|
## Installation {#installation}
|
|
|
|
<CodeGroup>
|
|
```bash Python icon=Python
|
|
pip install sie-lancedb
|
|
```
|
|
|
|
```bash TypeScript icon=js
|
|
npm install @superlinked/sie-lancedb @lancedb/lancedb
|
|
```
|
|
</CodeGroup>
|
|
|
|
## Registered functions {#registered-functions}
|
|
|
|
Importing `sie_lancedb` registers two embedding functions in LanceDB's registry:
|
|
|
|
| Name | Purpose |
|
|
|---|---|
|
|
| `"sie"` | Dense text embeddings |
|
|
| `"sie-multivector"` | ColBERT-style late interaction with MaxSim scoring |
|
|
|
|
Supported parameters on `.create()`:
|
|
|
|
| Parameter | Type | Description |
|
|
|---|---|---|
|
|
| `model` | `str` | Any of 85+ SIE-supported models (e.g. `BAAI/bge-m3`, `NovaSearch/stella_en_400M_v5`, `jinaai/jina-colbert-v2`) |
|
|
| `base_url` | `str` | URL of the SIE endpoint (e.g. `http://localhost:8080`) |
|
|
|
|
## Usage {#usage}
|
|
|
|
```py Python icon=Python
|
|
import lancedb
|
|
from lancedb.embeddings import get_registry
|
|
from lancedb.pydantic import LanceModel, Vector
|
|
import sie_lancedb # registers "sie" and "sie-multivector"
|
|
|
|
sie = get_registry().get("sie").create(
|
|
model="BAAI/bge-m3",
|
|
base_url="http://localhost:8080",
|
|
)
|
|
|
|
class Documents(LanceModel):
|
|
text: str = sie.SourceField()
|
|
vector: Vector(sie.ndims()) = sie.VectorField()
|
|
|
|
db = lancedb.connect("~/.lancedb")
|
|
table = db.create_table("docs", schema=Documents, mode="overwrite")
|
|
|
|
table.add([
|
|
{"text": "Machine learning is a subset of AI."},
|
|
{"text": "Neural networks use multiple layers."},
|
|
{"text": "Python is popular for ML development."},
|
|
])
|
|
|
|
results = table.search("What is deep learning?").limit(3).to_list()
|
|
```
|
|
|
|
LanceDB handles embedding generation for both inserts and queries automatically, based on the `SourceField` / `VectorField` declarations on the schema.
|
|
|
|
## Hybrid search with reranker {#hybrid-search-with-reranker}
|
|
|
|
`SIEReranker` plugs into LanceDB's hybrid search pipeline. It uses SIE's cross-encoder `score()` to rerank combined vector + full-text search results. You need a full-text search index on the column first:
|
|
|
|
```py Python icon=Python
|
|
from sie_lancedb import SIEReranker
|
|
|
|
# Create FTS index for hybrid search
|
|
table.create_fts_index("text", replace=True)
|
|
|
|
results = (
|
|
table.search("What is deep learning?", query_type="hybrid")
|
|
.rerank(SIEReranker(model="jinaai/jina-reranker-v2-base-multilingual"))
|
|
.limit(5)
|
|
.to_list()
|
|
)
|
|
|
|
for r in results:
|
|
print(f"{r['_relevance_score']:.3f} {r['text']}")
|
|
```
|
|
|
|
The reranker also works with pure vector or pure FTS search via `.rerank()`.
|
|
|
|
## ColBERT and multivector {#colbert-and-multivector}
|
|
`SIEMultiVectorEmbeddingFunction` (registered as `"sie-multivector"`) works with LanceDB's native `MultiVector` type and MaxSim scoring for ColBERT and ColPali models:
|
|
|
|
```py Python icon=Python
|
|
from lancedb.pydantic import MultiVector
|
|
|
|
sie_colbert = get_registry().get("sie-multivector").create(
|
|
model="jinaai/jina-colbert-v2",
|
|
base_url="http://localhost:8080",
|
|
)
|
|
|
|
class ColBERTDocs(LanceModel):
|
|
text: str = sie_colbert.SourceField()
|
|
vector: MultiVector(sie_colbert.ndims()) = sie_colbert.VectorField()
|
|
|
|
table = db.create_table("colbert_docs", schema=ColBERTDocs, mode="overwrite")
|
|
table.add([{"text": "Machine learning is a subset of AI."}])
|
|
|
|
# MaxSim search - query and document multivectors compared token-by-token
|
|
results = table.search("What is ML?").limit(5).to_list()
|
|
```
|
|
|
|
## Entity extraction {#entity-extraction}
|
|
|
|
`SIEExtractor` adds entity extraction to LanceDB's data-enrichment workflows. Extract entities from a text column and merge the results back as a structured Arrow column - enabling filtered search on extracted entities:
|
|
|
|
```py Python icon=Python
|
|
from sie_lancedb import SIEExtractor
|
|
|
|
extractor = SIEExtractor(
|
|
base_url="http://localhost:8080",
|
|
model="urchade/gliner_multi-v2.1",
|
|
)
|
|
|
|
extractor.enrich_table(
|
|
table,
|
|
source_column="text",
|
|
target_column="entities",
|
|
labels=["person", "technology", "organization"],
|
|
id_column="id",
|
|
)
|
|
```
|
|
|
|
The `entities` column stores structured Arrow data (`list<struct<text, label, score, start, end, bbox>>`), so you can filter on extracted entities in queries.
|
|
|
|
## Links {#links}
|
|
|
|
- [`sie-lancedb` on PyPI](https://pypi.org/project/sie-lancedb/)
|
|
- [`@superlinked/sie-lancedb` on npm](https://www.npmjs.com/package/@superlinked/sie-lancedb)
|
|
- [Superlinked on GitHub](https://github.com/superlinked/sie)
|
|
- [Superlinked docs](https://superlinked.com/docs)
|