mirror of
https://github.com/lancedb/lancedb.git
synced 2025-12-23 21:39:57 +00:00
Compare commits
2 Commits
python-v0.
...
docs/quick
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
9e278fc5a6 | ||
|
|
09fed1f286 |
@@ -1,5 +1,5 @@
|
|||||||
[tool.bumpversion]
|
[tool.bumpversion]
|
||||||
current_version = "0.21.2-beta.0"
|
current_version = "0.19.1-beta.1"
|
||||||
parse = """(?x)
|
parse = """(?x)
|
||||||
(?P<major>0|[1-9]\\d*)\\.
|
(?P<major>0|[1-9]\\d*)\\.
|
||||||
(?P<minor>0|[1-9]\\d*)\\.
|
(?P<minor>0|[1-9]\\d*)\\.
|
||||||
|
|||||||
7
.github/workflows/java.yml
vendored
7
.github/workflows/java.yml
vendored
@@ -35,9 +35,6 @@ jobs:
|
|||||||
- uses: Swatinem/rust-cache@v2
|
- uses: Swatinem/rust-cache@v2
|
||||||
with:
|
with:
|
||||||
workspaces: java/core/lancedb-jni
|
workspaces: java/core/lancedb-jni
|
||||||
- uses: actions-rust-lang/setup-rust-toolchain@v1
|
|
||||||
with:
|
|
||||||
components: rustfmt
|
|
||||||
- name: Run cargo fmt
|
- name: Run cargo fmt
|
||||||
run: cargo fmt --check
|
run: cargo fmt --check
|
||||||
working-directory: ./java/core/lancedb-jni
|
working-directory: ./java/core/lancedb-jni
|
||||||
@@ -71,9 +68,6 @@ jobs:
|
|||||||
- uses: Swatinem/rust-cache@v2
|
- uses: Swatinem/rust-cache@v2
|
||||||
with:
|
with:
|
||||||
workspaces: java/core/lancedb-jni
|
workspaces: java/core/lancedb-jni
|
||||||
- uses: actions-rust-lang/setup-rust-toolchain@v1
|
|
||||||
with:
|
|
||||||
components: rustfmt
|
|
||||||
- name: Run cargo fmt
|
- name: Run cargo fmt
|
||||||
run: cargo fmt --check
|
run: cargo fmt --check
|
||||||
working-directory: ./java/core/lancedb-jni
|
working-directory: ./java/core/lancedb-jni
|
||||||
@@ -116,3 +110,4 @@ jobs:
|
|||||||
-Djdk.reflect.useDirectMethodHandle=false \
|
-Djdk.reflect.useDirectMethodHandle=false \
|
||||||
-Dio.netty.tryReflectionSetAccessible=true"
|
-Dio.netty.tryReflectionSetAccessible=true"
|
||||||
JAVA_HOME=$JAVA_17 mvn clean test
|
JAVA_HOME=$JAVA_17 mvn clean test
|
||||||
|
|
||||||
|
|||||||
9
.github/workflows/make-release-commit.yml
vendored
9
.github/workflows/make-release-commit.yml
vendored
@@ -84,7 +84,6 @@ jobs:
|
|||||||
run: |
|
run: |
|
||||||
pip install bump-my-version PyGithub packaging
|
pip install bump-my-version PyGithub packaging
|
||||||
bash ci/bump_version.sh ${{ inputs.type }} ${{ inputs.bump-minor }} v $COMMIT_BEFORE_BUMP
|
bash ci/bump_version.sh ${{ inputs.type }} ${{ inputs.bump-minor }} v $COMMIT_BEFORE_BUMP
|
||||||
bash ci/update_lockfiles.sh --amend
|
|
||||||
- name: Push new version tag
|
- name: Push new version tag
|
||||||
if: ${{ !inputs.dry_run }}
|
if: ${{ !inputs.dry_run }}
|
||||||
uses: ad-m/github-push-action@master
|
uses: ad-m/github-push-action@master
|
||||||
@@ -93,3 +92,11 @@ jobs:
|
|||||||
github_token: ${{ secrets.LANCEDB_RELEASE_TOKEN }}
|
github_token: ${{ secrets.LANCEDB_RELEASE_TOKEN }}
|
||||||
branch: ${{ github.ref }}
|
branch: ${{ github.ref }}
|
||||||
tags: true
|
tags: true
|
||||||
|
- uses: ./.github/workflows/update_package_lock
|
||||||
|
if: ${{ !inputs.dry_run && inputs.other }}
|
||||||
|
with:
|
||||||
|
github_token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
- uses: ./.github/workflows/update_package_lock_nodejs
|
||||||
|
if: ${{ !inputs.dry_run && inputs.other }}
|
||||||
|
with:
|
||||||
|
github_token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
|||||||
5
.github/workflows/nodejs.yml
vendored
5
.github/workflows/nodejs.yml
vendored
@@ -47,9 +47,6 @@ jobs:
|
|||||||
run: |
|
run: |
|
||||||
sudo apt update
|
sudo apt update
|
||||||
sudo apt install -y protobuf-compiler libssl-dev
|
sudo apt install -y protobuf-compiler libssl-dev
|
||||||
- uses: actions-rust-lang/setup-rust-toolchain@v1
|
|
||||||
with:
|
|
||||||
components: rustfmt, clippy
|
|
||||||
- name: Lint
|
- name: Lint
|
||||||
run: |
|
run: |
|
||||||
cargo fmt --all -- --check
|
cargo fmt --all -- --check
|
||||||
@@ -116,7 +113,7 @@ jobs:
|
|||||||
set -e
|
set -e
|
||||||
npm ci
|
npm ci
|
||||||
npm run docs
|
npm run docs
|
||||||
if ! git diff --exit-code -- . ':(exclude)Cargo.lock'; then
|
if ! git diff --exit-code; then
|
||||||
echo "Docs need to be updated"
|
echo "Docs need to be updated"
|
||||||
echo "Run 'npm run docs', fix any warnings, and commit the changes."
|
echo "Run 'npm run docs', fix any warnings, and commit the changes."
|
||||||
exit 1
|
exit 1
|
||||||
|
|||||||
34
.github/workflows/npm-publish.yml
vendored
34
.github/workflows/npm-publish.yml
vendored
@@ -505,8 +505,6 @@ jobs:
|
|||||||
name: vectordb NPM Publish
|
name: vectordb NPM Publish
|
||||||
needs: [node, node-macos, node-linux-gnu, node-windows]
|
needs: [node, node-macos, node-linux-gnu, node-windows]
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
permissions:
|
|
||||||
contents: write
|
|
||||||
# Only runs on tags that matches the make-release action
|
# Only runs on tags that matches the make-release action
|
||||||
if: startsWith(github.ref, 'refs/tags/v')
|
if: startsWith(github.ref, 'refs/tags/v')
|
||||||
steps:
|
steps:
|
||||||
@@ -539,20 +537,6 @@ jobs:
|
|||||||
# We need to deprecate the old package to avoid confusion.
|
# We need to deprecate the old package to avoid confusion.
|
||||||
# Each time we publish a new version, it gets undeprecated.
|
# Each time we publish a new version, it gets undeprecated.
|
||||||
run: npm deprecate vectordb "Use @lancedb/lancedb instead."
|
run: npm deprecate vectordb "Use @lancedb/lancedb instead."
|
||||||
- name: Checkout
|
|
||||||
uses: actions/checkout@v4
|
|
||||||
with:
|
|
||||||
ref: main
|
|
||||||
- name: Update package-lock.json
|
|
||||||
run: |
|
|
||||||
git config user.name 'Lance Release'
|
|
||||||
git config user.email 'lance-dev@lancedb.com'
|
|
||||||
bash ci/update_lockfiles.sh
|
|
||||||
- name: Push new commit
|
|
||||||
uses: ad-m/github-push-action@master
|
|
||||||
with:
|
|
||||||
github_token: ${{ secrets.LANCEDB_RELEASE_TOKEN }}
|
|
||||||
branch: main
|
|
||||||
- name: Notify Slack Action
|
- name: Notify Slack Action
|
||||||
uses: ravsamhq/notify-slack-action@2.3.0
|
uses: ravsamhq/notify-slack-action@2.3.0
|
||||||
if: ${{ always() }}
|
if: ${{ always() }}
|
||||||
@@ -562,3 +546,21 @@ jobs:
|
|||||||
notification_title: "{workflow} is failing"
|
notification_title: "{workflow} is failing"
|
||||||
env:
|
env:
|
||||||
SLACK_WEBHOOK_URL: ${{ secrets.ACTION_MONITORING_SLACK }}
|
SLACK_WEBHOOK_URL: ${{ secrets.ACTION_MONITORING_SLACK }}
|
||||||
|
|
||||||
|
update-package-lock:
|
||||||
|
if: startsWith(github.ref, 'refs/tags/v')
|
||||||
|
needs: [release]
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
permissions:
|
||||||
|
contents: write
|
||||||
|
steps:
|
||||||
|
- name: Checkout
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
with:
|
||||||
|
ref: main
|
||||||
|
token: ${{ secrets.LANCEDB_RELEASE_TOKEN }}
|
||||||
|
fetch-depth: 0
|
||||||
|
lfs: true
|
||||||
|
- uses: ./.github/workflows/update_package_lock
|
||||||
|
with:
|
||||||
|
github_token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
|||||||
4
.github/workflows/run_tests/action.yml
vendored
4
.github/workflows/run_tests/action.yml
vendored
@@ -24,8 +24,8 @@ runs:
|
|||||||
- name: pytest (with integration)
|
- name: pytest (with integration)
|
||||||
shell: bash
|
shell: bash
|
||||||
if: ${{ inputs.integration == 'true' }}
|
if: ${{ inputs.integration == 'true' }}
|
||||||
run: pytest -m "not slow" -vv --durations=30 python/python/tests
|
run: pytest -m "not slow" -x -v --durations=30 python/python/tests
|
||||||
- name: pytest (no integration tests)
|
- name: pytest (no integration tests)
|
||||||
shell: bash
|
shell: bash
|
||||||
if: ${{ inputs.integration != 'true' }}
|
if: ${{ inputs.integration != 'true' }}
|
||||||
run: pytest -m "not slow and not s3_test" -vv --durations=30 python/python/tests
|
run: pytest -m "not slow and not s3_test" -x -v --durations=30 python/python/tests
|
||||||
|
|||||||
3
.github/workflows/rust.yml
vendored
3
.github/workflows/rust.yml
vendored
@@ -40,9 +40,6 @@ jobs:
|
|||||||
with:
|
with:
|
||||||
fetch-depth: 0
|
fetch-depth: 0
|
||||||
lfs: true
|
lfs: true
|
||||||
- uses: actions-rust-lang/setup-rust-toolchain@v1
|
|
||||||
with:
|
|
||||||
components: rustfmt, clippy
|
|
||||||
- uses: Swatinem/rust-cache@v2
|
- uses: Swatinem/rust-cache@v2
|
||||||
with:
|
with:
|
||||||
workspaces: rust
|
workspaces: rust
|
||||||
|
|||||||
33
.github/workflows/update_package_lock/action.yml
vendored
Normal file
33
.github/workflows/update_package_lock/action.yml
vendored
Normal file
@@ -0,0 +1,33 @@
|
|||||||
|
name: update_package_lock
|
||||||
|
description: "Update node's package.lock"
|
||||||
|
|
||||||
|
inputs:
|
||||||
|
github_token:
|
||||||
|
required: true
|
||||||
|
description: "github token for the repo"
|
||||||
|
|
||||||
|
runs:
|
||||||
|
using: "composite"
|
||||||
|
steps:
|
||||||
|
- uses: actions/setup-node@v3
|
||||||
|
with:
|
||||||
|
node-version: 20
|
||||||
|
- name: Set git configs
|
||||||
|
shell: bash
|
||||||
|
run: |
|
||||||
|
git config user.name 'Lance Release'
|
||||||
|
git config user.email 'lance-dev@lancedb.com'
|
||||||
|
- name: Update package-lock.json file
|
||||||
|
working-directory: ./node
|
||||||
|
run: |
|
||||||
|
npm install
|
||||||
|
git add package-lock.json
|
||||||
|
git commit -m "Updating package-lock.json"
|
||||||
|
shell: bash
|
||||||
|
- name: Push changes
|
||||||
|
if: ${{ inputs.dry_run }} == "false"
|
||||||
|
uses: ad-m/github-push-action@master
|
||||||
|
with:
|
||||||
|
github_token: ${{ inputs.github_token }}
|
||||||
|
branch: main
|
||||||
|
tags: true
|
||||||
33
.github/workflows/update_package_lock_nodejs/action.yml
vendored
Normal file
33
.github/workflows/update_package_lock_nodejs/action.yml
vendored
Normal file
@@ -0,0 +1,33 @@
|
|||||||
|
name: update_package_lock_nodejs
|
||||||
|
description: "Update nodejs's package.lock"
|
||||||
|
|
||||||
|
inputs:
|
||||||
|
github_token:
|
||||||
|
required: true
|
||||||
|
description: "github token for the repo"
|
||||||
|
|
||||||
|
runs:
|
||||||
|
using: "composite"
|
||||||
|
steps:
|
||||||
|
- uses: actions/setup-node@v3
|
||||||
|
with:
|
||||||
|
node-version: 20
|
||||||
|
- name: Set git configs
|
||||||
|
shell: bash
|
||||||
|
run: |
|
||||||
|
git config user.name 'Lance Release'
|
||||||
|
git config user.email 'lance-dev@lancedb.com'
|
||||||
|
- name: Update package-lock.json file
|
||||||
|
working-directory: ./nodejs
|
||||||
|
run: |
|
||||||
|
npm install
|
||||||
|
git add package-lock.json
|
||||||
|
git commit -m "Updating package-lock.json"
|
||||||
|
shell: bash
|
||||||
|
- name: Push changes
|
||||||
|
if: ${{ inputs.dry_run }} == "false"
|
||||||
|
uses: ad-m/github-push-action@master
|
||||||
|
with:
|
||||||
|
github_token: ${{ inputs.github_token }}
|
||||||
|
branch: main
|
||||||
|
tags: true
|
||||||
2037
Cargo.lock
generated
2037
Cargo.lock
generated
File diff suppressed because it is too large
Load Diff
57
Cargo.toml
57
Cargo.toml
@@ -21,54 +21,55 @@ categories = ["database-implementations"]
|
|||||||
rust-version = "1.78.0"
|
rust-version = "1.78.0"
|
||||||
|
|
||||||
[workspace.dependencies]
|
[workspace.dependencies]
|
||||||
lance = { "version" = "=0.31.2", "features" = [
|
lance = { "version" = "=0.27.0", "features" = ["dynamodb"], tag = "v0.27.0-beta.2", git="https://github.com/lancedb/lance.git" }
|
||||||
"dynamodb",
|
lance-io = { version = "=0.27.0", tag = "v0.27.0-beta.2", git="https://github.com/lancedb/lance.git" }
|
||||||
], "tag" = "v0.31.2-beta.3", "git" = "https://github.com/lancedb/lance.git" }
|
lance-index = { version = "=0.27.0", tag = "v0.27.0-beta.2", git="https://github.com/lancedb/lance.git" }
|
||||||
lance-io = { "version" = "=0.31.2", "tag" = "v0.31.2-beta.3", "git" = "https://github.com/lancedb/lance.git" }
|
lance-linalg = { version = "=0.27.0", tag = "v0.27.0-beta.2", git="https://github.com/lancedb/lance.git" }
|
||||||
lance-index = { "version" = "=0.31.2", "tag" = "v0.31.2-beta.3", "git" = "https://github.com/lancedb/lance.git" }
|
lance-table = { version = "=0.27.0", tag = "v0.27.0-beta.2", git="https://github.com/lancedb/lance.git" }
|
||||||
lance-linalg = { "version" = "=0.31.2", "tag" = "v0.31.2-beta.3", "git" = "https://github.com/lancedb/lance.git" }
|
lance-testing = { version = "=0.27.0", tag = "v0.27.0-beta.2", git="https://github.com/lancedb/lance.git" }
|
||||||
lance-table = { "version" = "=0.31.2", "tag" = "v0.31.2-beta.3", "git" = "https://github.com/lancedb/lance.git" }
|
lance-datafusion = { version = "=0.27.0", tag = "v0.27.0-beta.2", git="https://github.com/lancedb/lance.git" }
|
||||||
lance-testing = { "version" = "=0.31.2", "tag" = "v0.31.2-beta.3", "git" = "https://github.com/lancedb/lance.git" }
|
lance-encoding = { version = "=0.27.0", tag = "v0.27.0-beta.2", git="https://github.com/lancedb/lance.git" }
|
||||||
lance-datafusion = { "version" = "=0.31.2", "tag" = "v0.31.2-beta.3", "git" = "https://github.com/lancedb/lance.git" }
|
|
||||||
lance-encoding = { "version" = "=0.31.2", "tag" = "v0.31.2-beta.3", "git" = "https://github.com/lancedb/lance.git" }
|
|
||||||
# Note that this one does not include pyarrow
|
# Note that this one does not include pyarrow
|
||||||
arrow = { version = "55.1", optional = false }
|
arrow = { version = "54.1", optional = false }
|
||||||
arrow-array = "55.1"
|
arrow-array = "54.1"
|
||||||
arrow-data = "55.1"
|
arrow-data = "54.1"
|
||||||
arrow-ipc = "55.1"
|
arrow-ipc = "54.1"
|
||||||
arrow-ord = "55.1"
|
arrow-ord = "54.1"
|
||||||
arrow-schema = "55.1"
|
arrow-schema = "54.1"
|
||||||
arrow-arith = "55.1"
|
arrow-arith = "54.1"
|
||||||
arrow-cast = "55.1"
|
arrow-cast = "54.1"
|
||||||
async-trait = "0"
|
async-trait = "0"
|
||||||
datafusion = { version = "48.0", default-features = false }
|
datafusion = { version = "46.0", default-features = false }
|
||||||
datafusion-catalog = "48.0"
|
datafusion-catalog = "46.0"
|
||||||
datafusion-common = { version = "48.0", default-features = false }
|
datafusion-common = { version = "46.0", default-features = false }
|
||||||
datafusion-execution = "48.0"
|
datafusion-execution = "46.0"
|
||||||
datafusion-expr = "48.0"
|
datafusion-expr = "46.0"
|
||||||
datafusion-physical-plan = "48.0"
|
datafusion-physical-plan = "46.0"
|
||||||
env_logger = "0.11"
|
env_logger = "0.11"
|
||||||
half = { "version" = "2.6.0", default-features = false, features = [
|
half = { "version" = "=2.4.1", default-features = false, features = [
|
||||||
"num-traits",
|
"num-traits",
|
||||||
] }
|
] }
|
||||||
futures = "0"
|
futures = "0"
|
||||||
log = "0.4"
|
log = "0.4"
|
||||||
moka = { version = "0.12", features = ["future"] }
|
moka = { version = "0.12", features = ["future"] }
|
||||||
object_store = "0.12.0"
|
object_store = "0.11.0"
|
||||||
pin-project = "1.0.7"
|
pin-project = "1.0.7"
|
||||||
snafu = "0.8"
|
snafu = "0.8"
|
||||||
url = "2"
|
url = "2"
|
||||||
num-traits = "0.2"
|
num-traits = "0.2"
|
||||||
rand = "0.9"
|
rand = "0.8"
|
||||||
regex = "1.10"
|
regex = "1.10"
|
||||||
lazy_static = "1"
|
lazy_static = "1"
|
||||||
semver = "1.0.25"
|
semver = "1.0.25"
|
||||||
|
|
||||||
# Temporary pins to work around downstream issues
|
# Temporary pins to work around downstream issues
|
||||||
# https://github.com/apache/arrow-rs/commit/2fddf85afcd20110ce783ed5b4cdeb82293da30b
|
# https://github.com/apache/arrow-rs/commit/2fddf85afcd20110ce783ed5b4cdeb82293da30b
|
||||||
chrono = "=0.4.41"
|
chrono = "=0.4.39"
|
||||||
# https://github.com/RustCrypto/formats/issues/1684
|
# https://github.com/RustCrypto/formats/issues/1684
|
||||||
base64ct = "=1.6.0"
|
base64ct = "=1.6.0"
|
||||||
|
|
||||||
# Workaround for: https://github.com/eira-fransham/crunchy/issues/13
|
# Workaround for: https://github.com/eira-fransham/crunchy/issues/13
|
||||||
crunchy = "=0.2.2"
|
crunchy = "=0.2.2"
|
||||||
|
|
||||||
# Workaround for: https://github.com/Lokathor/bytemuck/issues/306
|
# Workaround for: https://github.com/Lokathor/bytemuck/issues/306
|
||||||
bytemuck_derive = ">=1.8.1, <1.9.0"
|
bytemuck_derive = ">=1.8.1, <1.9.0"
|
||||||
|
|||||||
167
README.md
167
README.md
@@ -1,97 +1,94 @@
|
|||||||
<a href="https://cloud.lancedb.com" target="_blank">
|
<a href="https://cloud.lancedb.com" target="_blank">
|
||||||
<img src="https://github.com/user-attachments/assets/92dad0a2-2a37-4ce1-b783-0d1b4f30a00c" alt="LanceDB Cloud Public Beta" width="100%" style="max-width: 100%;">
|
<img src="https://github.com/user-attachments/assets/92dad0a2-2a37-4ce1-b783-0d1b4f30a00c" alt="LanceDB Cloud Public Beta" width="100%" style="max-width: 100%;">
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
<div align="center">
|
<div align="center">
|
||||||
|
<p align="center">
|
||||||
|
|
||||||
[](https://lancedb.com)
|
<picture>
|
||||||
[](https://lancedb.com/)
|
<source media="(prefers-color-scheme: dark)" srcset="https://github.com/user-attachments/assets/ac270358-333e-4bea-a132-acefaa94040e">
|
||||||
[](https://blog.lancedb.com/)
|
<source media="(prefers-color-scheme: light)" srcset="https://github.com/user-attachments/assets/b864d814-0d29-4784-8fd9-807297c758c0">
|
||||||
[](https://discord.gg/zMM32dvNtd)
|
<img alt="LanceDB Logo" src="https://github.com/user-attachments/assets/b864d814-0d29-4784-8fd9-807297c758c0" width=300>
|
||||||
[](https://twitter.com/lancedb)
|
</picture>
|
||||||
[](https://www.linkedin.com/company/lancedb/)
|
|
||||||
|
|
||||||
|
**Search More, Manage Less**
|
||||||
|
|
||||||
<img src="docs/src/assets/lancedb.png" alt="LanceDB" width="50%">
|
<a href='https://github.com/lancedb/vectordb-recipes/tree/main' target="_blank"><img alt='LanceDB' src='https://img.shields.io/badge/VectorDB_Recipes-100000?style=for-the-badge&logo=LanceDB&logoColor=white&labelColor=645cfb&color=645cfb'/></a>
|
||||||
|
<a href='https://lancedb.github.io/lancedb/' target="_blank"><img alt='lancdb' src='https://img.shields.io/badge/DOCS-100000?style=for-the-badge&logo=lancdb&logoColor=white&labelColor=645cfb&color=645cfb'/></a>
|
||||||
|
[](https://blog.lancedb.com/)
|
||||||
|
[](https://discord.gg/zMM32dvNtd)
|
||||||
|
[](https://twitter.com/lancedb)
|
||||||
|
[](https://gurubase.io/g/lancedb)
|
||||||
|
|
||||||
# **The Multimodal AI Lakehouse**
|
</p>
|
||||||
|
|
||||||
[**How to Install** ](#how-to-install) ✦ [**Detailed Documentation**](https://lancedb.github.io/lancedb/) ✦ [**Tutorials and Recipes**](https://github.com/lancedb/vectordb-recipes/tree/main) ✦ [**Contributors**](#contributors)
|
|
||||||
|
|
||||||
**The ultimate multimodal data platform for AI/ML applications.**
|
|
||||||
|
|
||||||
LanceDB is designed for fast, scalable, and production-ready vector search. It is built on top of the Lance columnar format. You can store, index, and search over petabytes of multimodal data and vectors with ease.
|
|
||||||
LanceDB is a central location where developers can build, train and analyze their AI workloads.
|
|
||||||
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<br>
|
|
||||||
|
|
||||||
## **Demo: Multimodal Search by Keyword, Vector or with SQL**
|
|
||||||
<img max-width="750px" alt="LanceDB Multimodal Search" src="https://github.com/lancedb/lancedb/assets/917119/09c5afc5-7816-4687-bae4-f2ca194426ec">
|
<img max-width="750px" alt="LanceDB Multimodal Search" src="https://github.com/lancedb/lancedb/assets/917119/09c5afc5-7816-4687-bae4-f2ca194426ec">
|
||||||
|
|
||||||
## **Star LanceDB to get updates!**
|
</p>
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>⭐ Click here ⭐ to see how fast we're growing!</summary>
|
|
||||||
<picture>
|
|
||||||
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=lancedb/lancedb&theme=dark&type=Date">
|
|
||||||
<img width="100%" src="https://api.star-history.com/svg?repos=lancedb/lancedb&theme=dark&type=Date">
|
|
||||||
</picture>
|
|
||||||
</details>
|
|
||||||
|
|
||||||
## **Key Features**:
|
|
||||||
|
|
||||||
- **Fast Vector Search**: Search billions of vectors in milliseconds with state-of-the-art indexing.
|
|
||||||
- **Comprehensive Search**: Support for vector similarity search, full-text search and SQL.
|
|
||||||
- **Multimodal Support**: Store, query and filter vectors, metadata and multimodal data (text, images, videos, point clouds, and more).
|
|
||||||
- **Advanced Features**: Zero-copy, automatic versioning, manage versions of your data without needing extra infrastructure. GPU support in building vector index.
|
|
||||||
|
|
||||||
### **Products**:
|
|
||||||
- **Open Source & Local**: 100% open source, runs locally or in your cloud. No vendor lock-in.
|
|
||||||
- **Cloud and Enterprise**: Production-scale vector search with no servers to manage. Complete data sovereignty and security.
|
|
||||||
|
|
||||||
### **Ecosystem**:
|
|
||||||
- **Columnar Storage**: Built on the Lance columnar format for efficient storage and analytics.
|
|
||||||
- **Seamless Integration**: Python, Node.js, Rust, and REST APIs for easy integration. Native Python and Javascript/Typescript support.
|
|
||||||
- **Rich Ecosystem**: Integrations with [**LangChain** 🦜️🔗](https://python.langchain.com/docs/integrations/vectorstores/lancedb/), [**LlamaIndex** 🦙](https://gpt-index.readthedocs.io/en/latest/examples/vector_stores/LanceDBIndexDemo.html), Apache-Arrow, Pandas, Polars, DuckDB and more on the way.
|
|
||||||
|
|
||||||
## **How to Install**:
|
|
||||||
|
|
||||||
Follow the [Quickstart](https://lancedb.github.io/lancedb/basic/) doc to set up LanceDB locally.
|
|
||||||
|
|
||||||
**API & SDK:** We also support Python, Typescript and Rust SDKs
|
|
||||||
|
|
||||||
| Interface | Documentation |
|
|
||||||
|-----------|---------------|
|
|
||||||
| Python SDK | https://lancedb.github.io/lancedb/python/python/ |
|
|
||||||
| Typescript SDK | https://lancedb.github.io/lancedb/js/globals/ |
|
|
||||||
| Rust SDK | https://docs.rs/lancedb/latest/lancedb/index.html |
|
|
||||||
| REST API | https://docs.lancedb.com/api-reference/introduction |
|
|
||||||
|
|
||||||
## **Join Us and Contribute**
|
|
||||||
|
|
||||||
We welcome contributions from everyone! Whether you're a developer, researcher, or just someone who wants to help out.
|
|
||||||
|
|
||||||
If you have any suggestions or feature requests, please feel free to open an issue on GitHub or discuss it on our [**Discord**](https://discord.gg/G5DcmnZWKB) server.
|
|
||||||
|
|
||||||
[**Check out the GitHub Issues**](https://github.com/lancedb/lancedb/issues) if you would like to work on the features that are planned for the future. If you have any suggestions or feature requests, please feel free to open an issue on GitHub.
|
|
||||||
|
|
||||||
## **Contributors**
|
|
||||||
|
|
||||||
<a href="https://github.com/lancedb/lancedb/graphs/contributors">
|
|
||||||
<img src="https://contrib.rocks/image?repo=lancedb/lancedb" />
|
|
||||||
</a>
|
|
||||||
|
|
||||||
|
|
||||||
## **Stay in Touch With Us**
|
|
||||||
<div align="center">
|
|
||||||
|
|
||||||
</br>
|
|
||||||
|
|
||||||
[](https://lancedb.com/)
|
|
||||||
[](https://blog.lancedb.com/)
|
|
||||||
[](https://discord.gg/zMM32dvNtd)
|
|
||||||
[](https://twitter.com/lancedb)
|
|
||||||
[](https://www.linkedin.com/company/lancedb/)
|
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
<hr />
|
||||||
|
|
||||||
|
LanceDB is an open-source database for vector-search built with persistent storage, which greatly simplifies retrieval, filtering and management of embeddings.
|
||||||
|
|
||||||
|
The key features of LanceDB include:
|
||||||
|
|
||||||
|
* Production-scale vector search with no servers to manage.
|
||||||
|
|
||||||
|
* Store, query and filter vectors, metadata and multi-modal data (text, images, videos, point clouds, and more).
|
||||||
|
|
||||||
|
* Support for vector similarity search, full-text search and SQL.
|
||||||
|
|
||||||
|
* Native Python and Javascript/Typescript support.
|
||||||
|
|
||||||
|
* Zero-copy, automatic versioning, manage versions of your data without needing extra infrastructure.
|
||||||
|
|
||||||
|
* GPU support in building vector index(*).
|
||||||
|
|
||||||
|
* Ecosystem integrations with [LangChain 🦜️🔗](https://python.langchain.com/docs/integrations/vectorstores/lancedb/), [LlamaIndex 🦙](https://gpt-index.readthedocs.io/en/latest/examples/vector_stores/LanceDBIndexDemo.html), Apache-Arrow, Pandas, Polars, DuckDB and more on the way.
|
||||||
|
|
||||||
|
LanceDB's core is written in Rust 🦀 and is built using <a href="https://github.com/lancedb/lance">Lance</a>, an open-source columnar format designed for performant ML workloads.
|
||||||
|
|
||||||
|
## Quick Start
|
||||||
|
|
||||||
|
**Javascript**
|
||||||
|
```shell
|
||||||
|
npm install @lancedb/lancedb
|
||||||
|
```
|
||||||
|
|
||||||
|
```javascript
|
||||||
|
import * as lancedb from "@lancedb/lancedb";
|
||||||
|
|
||||||
|
const db = await lancedb.connect("data/sample-lancedb");
|
||||||
|
const table = await db.createTable("vectors", [
|
||||||
|
{ id: 1, vector: [0.1, 0.2], item: "foo", price: 10 },
|
||||||
|
{ id: 2, vector: [1.1, 1.2], item: "bar", price: 50 },
|
||||||
|
], {mode: 'overwrite'});
|
||||||
|
|
||||||
|
|
||||||
|
const query = table.vectorSearch([0.1, 0.3]).limit(2);
|
||||||
|
const results = await query.toArray();
|
||||||
|
|
||||||
|
// You can also search for rows by specific criteria without involving a vector search.
|
||||||
|
const rowsByCriteria = await table.query().where("price >= 10").toArray();
|
||||||
|
```
|
||||||
|
|
||||||
|
**Python**
|
||||||
|
```shell
|
||||||
|
pip install lancedb
|
||||||
|
```
|
||||||
|
|
||||||
|
```python
|
||||||
|
import lancedb
|
||||||
|
|
||||||
|
uri = "data/sample-lancedb"
|
||||||
|
db = lancedb.connect(uri)
|
||||||
|
table = db.create_table("my_table",
|
||||||
|
data=[{"vector": [3.1, 4.1], "item": "foo", "price": 10.0},
|
||||||
|
{"vector": [5.9, 26.5], "item": "bar", "price": 20.0}])
|
||||||
|
result = table.search([100, 100]).limit(2).to_pandas()
|
||||||
|
```
|
||||||
|
|
||||||
|
## Blogs, Tutorials & Videos
|
||||||
|
* 📈 <a href="https://blog.lancedb.com/benchmarking-random-access-in-lance/">2000x better performance with Lance over Parquet</a>
|
||||||
|
* 🤖 <a href="https://github.com/lancedb/vectordb-recipes/tree/main/examples/Youtube-Search-QA-Bot">Build a question and answer bot with LanceDB</a>
|
||||||
|
|||||||
@@ -1,188 +0,0 @@
|
|||||||
import argparse
|
|
||||||
import sys
|
|
||||||
import json
|
|
||||||
|
|
||||||
|
|
||||||
def run_command(command: str) -> str:
|
|
||||||
"""
|
|
||||||
Run a shell command and return stdout as a string.
|
|
||||||
If exit code is not 0, raise an exception with the stderr output.
|
|
||||||
"""
|
|
||||||
import subprocess
|
|
||||||
|
|
||||||
result = subprocess.run(command, shell=True, capture_output=True, text=True)
|
|
||||||
if result.returncode != 0:
|
|
||||||
raise Exception(f"Command failed with error: {result.stderr.strip()}")
|
|
||||||
return result.stdout.strip()
|
|
||||||
|
|
||||||
|
|
||||||
def get_latest_stable_version() -> str:
|
|
||||||
version_line = run_command("cargo info lance | grep '^version:'")
|
|
||||||
version = version_line.split(" ")[1].strip()
|
|
||||||
return version
|
|
||||||
|
|
||||||
|
|
||||||
def get_latest_preview_version() -> str:
|
|
||||||
lance_tags = run_command(
|
|
||||||
"git ls-remote --tags https://github.com/lancedb/lance.git | grep 'refs/tags/v[0-9beta.-]\\+$'"
|
|
||||||
).splitlines()
|
|
||||||
lance_tags = (
|
|
||||||
tag.split("refs/tags/")[1]
|
|
||||||
for tag in lance_tags
|
|
||||||
if "refs/tags/" in tag and "beta" in tag
|
|
||||||
)
|
|
||||||
from packaging.version import Version
|
|
||||||
|
|
||||||
latest = max(
|
|
||||||
(tag[1:] for tag in lance_tags if tag.startswith("v")), key=lambda t: Version(t)
|
|
||||||
)
|
|
||||||
return str(latest)
|
|
||||||
|
|
||||||
|
|
||||||
def extract_features(line: str) -> list:
|
|
||||||
"""
|
|
||||||
Extracts the features from a line in Cargo.toml.
|
|
||||||
Example: 'lance = { "version" = "=0.29.0", "features" = ["dynamodb"] }'
|
|
||||||
Returns: ['dynamodb']
|
|
||||||
"""
|
|
||||||
import re
|
|
||||||
|
|
||||||
match = re.search(r'"features"\s*=\s*\[\s*(.*?)\s*\]', line, re.DOTALL)
|
|
||||||
if match:
|
|
||||||
features_str = match.group(1)
|
|
||||||
return [f.strip('"') for f in features_str.split(",") if len(f) > 0]
|
|
||||||
return []
|
|
||||||
|
|
||||||
|
|
||||||
def update_cargo_toml(line_updater):
|
|
||||||
"""
|
|
||||||
Updates the Cargo.toml file by applying the line_updater function to each line.
|
|
||||||
The line_updater function should take a line as input and return the updated line.
|
|
||||||
"""
|
|
||||||
with open("Cargo.toml", "r") as f:
|
|
||||||
lines = f.readlines()
|
|
||||||
|
|
||||||
new_lines = []
|
|
||||||
lance_line = ""
|
|
||||||
is_parsing_lance_line = False
|
|
||||||
for line in lines:
|
|
||||||
if line.startswith("lance"):
|
|
||||||
# Update the line using the provided function
|
|
||||||
if line.strip().endswith("}"):
|
|
||||||
new_lines.append(line_updater(line))
|
|
||||||
else:
|
|
||||||
lance_line = line
|
|
||||||
is_parsing_lance_line = True
|
|
||||||
elif is_parsing_lance_line:
|
|
||||||
lance_line += line
|
|
||||||
if line.strip().endswith("}"):
|
|
||||||
new_lines.append(line_updater(lance_line))
|
|
||||||
lance_line = ""
|
|
||||||
is_parsing_lance_line = False
|
|
||||||
else:
|
|
||||||
print("doesn't end with }:", line)
|
|
||||||
else:
|
|
||||||
# Keep the line unchanged
|
|
||||||
new_lines.append(line)
|
|
||||||
|
|
||||||
with open("Cargo.toml", "w") as f:
|
|
||||||
f.writelines(new_lines)
|
|
||||||
|
|
||||||
|
|
||||||
def set_stable_version(version: str):
|
|
||||||
"""
|
|
||||||
Sets lines to
|
|
||||||
lance = { "version" = "=0.29.0", "features" = ["dynamodb"] }
|
|
||||||
lance-io = "=0.29.0"
|
|
||||||
...
|
|
||||||
"""
|
|
||||||
|
|
||||||
def line_updater(line: str) -> str:
|
|
||||||
package_name = line.split("=", maxsplit=1)[0].strip()
|
|
||||||
features = extract_features(line)
|
|
||||||
if features:
|
|
||||||
return f'{package_name} = {{ "version" = "={version}", "features" = {json.dumps(features)} }}\n'
|
|
||||||
else:
|
|
||||||
return f'{package_name} = "={version}"\n'
|
|
||||||
|
|
||||||
update_cargo_toml(line_updater)
|
|
||||||
|
|
||||||
|
|
||||||
def set_preview_version(version: str):
|
|
||||||
"""
|
|
||||||
Sets lines to
|
|
||||||
lance = { "version" = "=0.29.0", "features" = ["dynamodb"], tag = "v0.29.0-beta.2", git="https://github.com/lancedb/lance.git" }
|
|
||||||
lance-io = { version = "=0.29.0", tag = "v0.29.0-beta.2", git="https://github.com/lancedb/lance.git" }
|
|
||||||
...
|
|
||||||
"""
|
|
||||||
|
|
||||||
def line_updater(line: str) -> str:
|
|
||||||
package_name = line.split("=", maxsplit=1)[0].strip()
|
|
||||||
features = extract_features(line)
|
|
||||||
base_version = version.split("-")[0] # Get the base version without beta suffix
|
|
||||||
if features:
|
|
||||||
return f'{package_name} = {{ "version" = "={base_version}", "features" = {json.dumps(features)}, "tag" = "v{version}", "git" = "https://github.com/lancedb/lance.git" }}\n'
|
|
||||||
else:
|
|
||||||
return f'{package_name} = {{ "version" = "={base_version}", "tag" = "v{version}", "git" = "https://github.com/lancedb/lance.git" }}\n'
|
|
||||||
|
|
||||||
update_cargo_toml(line_updater)
|
|
||||||
|
|
||||||
|
|
||||||
def set_local_version():
|
|
||||||
"""
|
|
||||||
Sets lines to
|
|
||||||
lance = { path = "../lance/rust/lance", features = ["dynamodb"] }
|
|
||||||
lance-io = { path = "../lance/rust/lance-io" }
|
|
||||||
...
|
|
||||||
"""
|
|
||||||
|
|
||||||
def line_updater(line: str) -> str:
|
|
||||||
package_name = line.split("=", maxsplit=1)[0].strip()
|
|
||||||
features = extract_features(line)
|
|
||||||
if features:
|
|
||||||
return f'{package_name} = {{ "path" = "../lance/rust/{package_name}", "features" = {json.dumps(features)} }}\n'
|
|
||||||
else:
|
|
||||||
return f'{package_name} = {{ "path" = "../lance/rust/{package_name}" }}\n'
|
|
||||||
|
|
||||||
update_cargo_toml(line_updater)
|
|
||||||
|
|
||||||
|
|
||||||
parser = argparse.ArgumentParser(description="Set the version of the Lance package.")
|
|
||||||
parser.add_argument(
|
|
||||||
"version",
|
|
||||||
type=str,
|
|
||||||
help="The version to set for the Lance package. Use 'stable' for the latest stable version, 'preview' for latest preview version, or a specific version number (e.g., '0.1.0'). You can also specify 'local' to use a local path.",
|
|
||||||
)
|
|
||||||
args = parser.parse_args()
|
|
||||||
|
|
||||||
if args.version == "stable":
|
|
||||||
latest_stable_version = get_latest_stable_version()
|
|
||||||
print(
|
|
||||||
f"Found latest stable version: \033[1mv{latest_stable_version}\033[0m",
|
|
||||||
file=sys.stderr,
|
|
||||||
)
|
|
||||||
set_stable_version(latest_stable_version)
|
|
||||||
elif args.version == "preview":
|
|
||||||
latest_preview_version = get_latest_preview_version()
|
|
||||||
print(
|
|
||||||
f"Found latest preview version: \033[1mv{latest_preview_version}\033[0m",
|
|
||||||
file=sys.stderr,
|
|
||||||
)
|
|
||||||
set_preview_version(latest_preview_version)
|
|
||||||
elif args.version == "local":
|
|
||||||
set_local_version()
|
|
||||||
else:
|
|
||||||
# Parse the version number.
|
|
||||||
version = args.version
|
|
||||||
# Ignore initial v if present.
|
|
||||||
if version.startswith("v"):
|
|
||||||
version = version[1:]
|
|
||||||
|
|
||||||
if "beta" in version:
|
|
||||||
set_preview_version(version)
|
|
||||||
else:
|
|
||||||
set_stable_version(version)
|
|
||||||
|
|
||||||
print("Updating lockfiles...", file=sys.stderr, end="")
|
|
||||||
run_command("cargo metadata > /dev/null")
|
|
||||||
print(" done.", file=sys.stderr)
|
|
||||||
@@ -1,30 +0,0 @@
|
|||||||
#!/usr/bin/env bash
|
|
||||||
set -euo pipefail
|
|
||||||
|
|
||||||
AMEND=false
|
|
||||||
|
|
||||||
for arg in "$@"; do
|
|
||||||
if [[ "$arg" == "--amend" ]]; then
|
|
||||||
AMEND=true
|
|
||||||
fi
|
|
||||||
done
|
|
||||||
|
|
||||||
# This updates the lockfile without building
|
|
||||||
cargo metadata --quiet > /dev/null
|
|
||||||
|
|
||||||
pushd nodejs || exit 1
|
|
||||||
npm install --package-lock-only --silent
|
|
||||||
popd
|
|
||||||
pushd node || exit 1
|
|
||||||
npm install --package-lock-only --silent
|
|
||||||
popd
|
|
||||||
|
|
||||||
if git diff --quiet --exit-code; then
|
|
||||||
echo "No lockfile changes to commit; skipping amend."
|
|
||||||
elif $AMEND; then
|
|
||||||
git add Cargo.lock nodejs/package-lock.json node/package-lock.json
|
|
||||||
git commit --amend --no-edit
|
|
||||||
else
|
|
||||||
git add Cargo.lock nodejs/package-lock.json node/package-lock.json
|
|
||||||
git commit -m "Update lockfiles"
|
|
||||||
fi
|
|
||||||
@@ -105,7 +105,8 @@ markdown_extensions:
|
|||||||
nav:
|
nav:
|
||||||
- Home:
|
- Home:
|
||||||
- LanceDB: index.md
|
- LanceDB: index.md
|
||||||
- 🏃🏼♂️ Quick start: basic.md
|
- 👉 Quickstart: quickstart.md
|
||||||
|
- 🏃🏼♂️ Basic Usage: basic.md
|
||||||
- 📚 Concepts:
|
- 📚 Concepts:
|
||||||
- Vector search: concepts/vector_search.md
|
- Vector search: concepts/vector_search.md
|
||||||
- Indexing:
|
- Indexing:
|
||||||
@@ -193,7 +194,6 @@ nav:
|
|||||||
- Pandas and PyArrow: python/pandas_and_pyarrow.md
|
- Pandas and PyArrow: python/pandas_and_pyarrow.md
|
||||||
- Polars: python/polars_arrow.md
|
- Polars: python/polars_arrow.md
|
||||||
- DuckDB: python/duckdb.md
|
- DuckDB: python/duckdb.md
|
||||||
- Datafusion: python/datafusion.md
|
|
||||||
- LangChain:
|
- LangChain:
|
||||||
- LangChain 🔗: integrations/langchain.md
|
- LangChain 🔗: integrations/langchain.md
|
||||||
- LangChain demo: notebooks/langchain_demo.ipynb
|
- LangChain demo: notebooks/langchain_demo.ipynb
|
||||||
@@ -206,7 +206,6 @@ nav:
|
|||||||
- PromptTools: integrations/prompttools.md
|
- PromptTools: integrations/prompttools.md
|
||||||
- dlt: integrations/dlt.md
|
- dlt: integrations/dlt.md
|
||||||
- phidata: integrations/phidata.md
|
- phidata: integrations/phidata.md
|
||||||
- Genkit: integrations/genkit.md
|
|
||||||
- 🎯 Examples:
|
- 🎯 Examples:
|
||||||
- Overview: examples/index.md
|
- Overview: examples/index.md
|
||||||
- 🐍 Python:
|
- 🐍 Python:
|
||||||
@@ -239,7 +238,9 @@ nav:
|
|||||||
- 👾 JavaScript (lancedb): js/globals.md
|
- 👾 JavaScript (lancedb): js/globals.md
|
||||||
- 🦀 Rust: https://docs.rs/lancedb/latest/lancedb/
|
- 🦀 Rust: https://docs.rs/lancedb/latest/lancedb/
|
||||||
|
|
||||||
- Quick start: basic.md
|
- Getting Started:
|
||||||
|
- Quickstart: quickstart.md
|
||||||
|
- Basic Usage: basic.md
|
||||||
- Concepts:
|
- Concepts:
|
||||||
- Vector search: concepts/vector_search.md
|
- Vector search: concepts/vector_search.md
|
||||||
- Indexing:
|
- Indexing:
|
||||||
@@ -249,7 +250,6 @@ nav:
|
|||||||
- Data management: concepts/data_management.md
|
- Data management: concepts/data_management.md
|
||||||
- Guides:
|
- Guides:
|
||||||
- Working with tables: guides/tables.md
|
- Working with tables: guides/tables.md
|
||||||
- Working with SQL: guides/sql_querying.md
|
|
||||||
- Building an ANN index: ann_indexes.md
|
- Building an ANN index: ann_indexes.md
|
||||||
- Vector Search: search.md
|
- Vector Search: search.md
|
||||||
- Full-text search (native): fts.md
|
- Full-text search (native): fts.md
|
||||||
@@ -326,7 +326,6 @@ nav:
|
|||||||
- Pandas and PyArrow: python/pandas_and_pyarrow.md
|
- Pandas and PyArrow: python/pandas_and_pyarrow.md
|
||||||
- Polars: python/polars_arrow.md
|
- Polars: python/polars_arrow.md
|
||||||
- DuckDB: python/duckdb.md
|
- DuckDB: python/duckdb.md
|
||||||
- Datafusion: python/datafusion.md
|
|
||||||
- LangChain 🦜️🔗↗: integrations/langchain.md
|
- LangChain 🦜️🔗↗: integrations/langchain.md
|
||||||
- LangChain.js 🦜️🔗↗: https://js.langchain.com/docs/integrations/vectorstores/lancedb
|
- LangChain.js 🦜️🔗↗: https://js.langchain.com/docs/integrations/vectorstores/lancedb
|
||||||
- LlamaIndex 🦙↗: integrations/llamaIndex.md
|
- LlamaIndex 🦙↗: integrations/llamaIndex.md
|
||||||
@@ -335,7 +334,6 @@ nav:
|
|||||||
- PromptTools: integrations/prompttools.md
|
- PromptTools: integrations/prompttools.md
|
||||||
- dlt: integrations/dlt.md
|
- dlt: integrations/dlt.md
|
||||||
- phidata: integrations/phidata.md
|
- phidata: integrations/phidata.md
|
||||||
- Genkit: integrations/genkit.md
|
|
||||||
- Examples:
|
- Examples:
|
||||||
- examples/index.md
|
- examples/index.md
|
||||||
- 🐍 Python:
|
- 🐍 Python:
|
||||||
|
|||||||
@@ -1,5 +0,0 @@
|
|||||||
{% extends "base.html" %}
|
|
||||||
|
|
||||||
{% block announce %}
|
|
||||||
📚 Starting June 1st, 2025, please use <a href="https://lancedb.github.io/documentation" target="_blank" rel="noopener noreferrer">lancedb.github.io/documentation</a> for the latest docs.
|
|
||||||
{% endblock %}
|
|
||||||
12
docs/package-lock.json
generated
12
docs/package-lock.json
generated
@@ -19,7 +19,7 @@
|
|||||||
},
|
},
|
||||||
"../node": {
|
"../node": {
|
||||||
"name": "vectordb",
|
"name": "vectordb",
|
||||||
"version": "0.21.2-beta.0",
|
"version": "0.12.0",
|
||||||
"cpu": [
|
"cpu": [
|
||||||
"x64",
|
"x64",
|
||||||
"arm64"
|
"arm64"
|
||||||
@@ -65,11 +65,11 @@
|
|||||||
"uuid": "^9.0.0"
|
"uuid": "^9.0.0"
|
||||||
},
|
},
|
||||||
"optionalDependencies": {
|
"optionalDependencies": {
|
||||||
"@lancedb/vectordb-darwin-arm64": "0.21.2-beta.0",
|
"@lancedb/vectordb-darwin-arm64": "0.12.0",
|
||||||
"@lancedb/vectordb-darwin-x64": "0.21.2-beta.0",
|
"@lancedb/vectordb-darwin-x64": "0.12.0",
|
||||||
"@lancedb/vectordb-linux-arm64-gnu": "0.21.2-beta.0",
|
"@lancedb/vectordb-linux-arm64-gnu": "0.12.0",
|
||||||
"@lancedb/vectordb-linux-x64-gnu": "0.21.2-beta.0",
|
"@lancedb/vectordb-linux-x64-gnu": "0.12.0",
|
||||||
"@lancedb/vectordb-win32-x64-msvc": "0.21.2-beta.0"
|
"@lancedb/vectordb-win32-x64-msvc": "0.12.0"
|
||||||
},
|
},
|
||||||
"peerDependencies": {
|
"peerDependencies": {
|
||||||
"@apache-arrow/ts": "^14.0.2",
|
"@apache-arrow/ts": "^14.0.2",
|
||||||
|
|||||||
@@ -291,7 +291,7 @@ Product quantization can lead to approximately `16 * sizeof(float32) / 1 = 64` t
|
|||||||
|
|
||||||
`num_partitions` is used to decide how many partitions the first level `IVF` index uses.
|
`num_partitions` is used to decide how many partitions the first level `IVF` index uses.
|
||||||
Higher number of partitions could lead to more efficient I/O during queries and better accuracy, but it takes much more time to train.
|
Higher number of partitions could lead to more efficient I/O during queries and better accuracy, but it takes much more time to train.
|
||||||
On `SIFT-1M` dataset, our benchmark shows that keeping each partition 4K-8K rows lead to a good latency / recall.
|
On `SIFT-1M` dataset, our benchmark shows that keeping each partition 1K-4K rows lead to a good latency / recall.
|
||||||
|
|
||||||
`num_sub_vectors` specifies how many Product Quantization (PQ) short codes to generate on each vector. The number should be a factor of the vector dimension. Because
|
`num_sub_vectors` specifies how many Product Quantization (PQ) short codes to generate on each vector. The number should be a factor of the vector dimension. Because
|
||||||
PQ is a lossy compression of the original vector, a higher `num_sub_vectors` usually results in
|
PQ is a lossy compression of the original vector, a higher `num_sub_vectors` usually results in
|
||||||
|
|||||||
Binary file not shown.
|
Before Width: | Height: | Size: 1.7 MiB |
Binary file not shown.
|
Before Width: | Height: | Size: 40 KiB |
@@ -1,4 +1,4 @@
|
|||||||
# Quick start
|
# Basic Usage
|
||||||
|
|
||||||
!!! info "LanceDB can be run in a number of ways:"
|
!!! info "LanceDB can be run in a number of ways:"
|
||||||
|
|
||||||
|
|||||||
@@ -1,60 +0,0 @@
|
|||||||
# SQL Querying
|
|
||||||
|
|
||||||
You can use DuckDB and Apache Datafusion to query your LanceDB tables using SQL.
|
|
||||||
This guide will show how to query Lance tables them using both.
|
|
||||||
|
|
||||||
We will re-use the dataset [created previously](./tables.md):
|
|
||||||
|
|
||||||
```python
|
|
||||||
import lancedb
|
|
||||||
|
|
||||||
db = lancedb.connect("data/sample-lancedb")
|
|
||||||
data = [
|
|
||||||
{"vector": [3.1, 4.1], "item": "foo", "price": 10.0},
|
|
||||||
{"vector": [5.9, 26.5], "item": "bar", "price": 20.0}
|
|
||||||
]
|
|
||||||
table = db.create_table("pd_table", data=data)
|
|
||||||
```
|
|
||||||
|
|
||||||
## Querying a LanceDB Table with DuckDb
|
|
||||||
|
|
||||||
The `to_lance` method converts the LanceDB table to a `LanceDataset`, which is accessible to DuckDB through the Arrow compatibility layer.
|
|
||||||
To query the resulting Lance dataset in DuckDB, all you need to do is reference the dataset by the same name in your SQL query.
|
|
||||||
|
|
||||||
```python
|
|
||||||
import duckdb
|
|
||||||
|
|
||||||
arrow_table = table.to_lance()
|
|
||||||
|
|
||||||
duckdb.query("SELECT * FROM arrow_table")
|
|
||||||
```
|
|
||||||
|
|
||||||
| vector | item | price |
|
|
||||||
| ----------- | ---- | ----- |
|
|
||||||
| [3.1, 4.1] | foo | 10.0 |
|
|
||||||
| [5.9, 26.5] | bar | 20.0 |
|
|
||||||
|
|
||||||
## Querying a LanceDB Table with Apache Datafusion
|
|
||||||
|
|
||||||
Have the required imports before doing any querying.
|
|
||||||
|
|
||||||
=== "Python"
|
|
||||||
|
|
||||||
```python
|
|
||||||
--8<-- "python/python/tests/docs/test_guide_tables.py:import-lancedb"
|
|
||||||
--8<-- "python/python/tests/docs/test_guide_tables.py:import-session-context"
|
|
||||||
--8<-- "python/python/tests/docs/test_guide_tables.py:import-ffi-dataset"
|
|
||||||
```
|
|
||||||
|
|
||||||
Register the table created with the Datafusion session context.
|
|
||||||
|
|
||||||
=== "Python"
|
|
||||||
|
|
||||||
```python
|
|
||||||
--8<-- "python/python/tests/docs/test_guide_tables.py:lance_sql_basic"
|
|
||||||
```
|
|
||||||
|
|
||||||
| vector | item | price |
|
|
||||||
| ----------- | ---- | ----- |
|
|
||||||
| [3.1, 4.1] | foo | 10.0 |
|
|
||||||
| [5.9, 26.5] | bar | 20.0 |
|
|
||||||
@@ -1,183 +0,0 @@
|
|||||||
### genkitx-lancedb
|
|
||||||
This is a lancedb plugin for genkit framework. It allows you to use LanceDB for ingesting and rereiving data using genkit framework.
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
### Installation
|
|
||||||
```bash
|
|
||||||
pnpm install genkitx-lancedb
|
|
||||||
```
|
|
||||||
|
|
||||||
### Usage
|
|
||||||
|
|
||||||
Adding LanceDB plugin to your genkit instance.
|
|
||||||
|
|
||||||
```ts
|
|
||||||
import { lancedbIndexerRef, lancedb, lancedbRetrieverRef, WriteMode } from 'genkitx-lancedb';
|
|
||||||
import { textEmbedding004, vertexAI } from '@genkit-ai/vertexai';
|
|
||||||
import { gemini } from '@genkit-ai/vertexai';
|
|
||||||
import { z, genkit } from 'genkit';
|
|
||||||
import { Document } from 'genkit/retriever';
|
|
||||||
import { chunk } from 'llm-chunk';
|
|
||||||
import { readFile } from 'fs/promises';
|
|
||||||
import path from 'path';
|
|
||||||
import pdf from 'pdf-parse/lib/pdf-parse';
|
|
||||||
|
|
||||||
const ai = genkit({
|
|
||||||
plugins: [
|
|
||||||
// vertexAI provides the textEmbedding004 embedder
|
|
||||||
vertexAI(),
|
|
||||||
|
|
||||||
// the local vector store requires an embedder to translate from text to vector
|
|
||||||
lancedb([
|
|
||||||
{
|
|
||||||
dbUri: '.db', // optional lancedb uri, default to .db
|
|
||||||
tableName: 'table', // optional table name, default to table
|
|
||||||
embedder: textEmbedding004,
|
|
||||||
},
|
|
||||||
]),
|
|
||||||
],
|
|
||||||
});
|
|
||||||
```
|
|
||||||
|
|
||||||
You can run this app with the following command:
|
|
||||||
```bash
|
|
||||||
genkit start -- tsx --watch src/index.ts
|
|
||||||
```
|
|
||||||
|
|
||||||
This'll add LanceDB as a retriever and indexer to the genkit instance. You can see it in the GUI view
|
|
||||||
<img width="1710" alt="Screenshot 2025-05-11 at 7 21 05 PM" src="https://github.com/user-attachments/assets/e752f7f4-785b-4797-a11e-72ab06a531b7" />
|
|
||||||
|
|
||||||
**Testing retrieval on a sample table**
|
|
||||||
Let's see the raw retrieval results
|
|
||||||
|
|
||||||
<img width="1710" alt="Screenshot 2025-05-11 at 7 21 05 PM" src="https://github.com/user-attachments/assets/b8d356ed-8421-4790-8fc0-d6af563b9657" />
|
|
||||||
On running this query, you'll 5 results fetched from the lancedb table, where each result looks something like this:
|
|
||||||
<img width="1417" alt="Screenshot 2025-05-11 at 7 21 18 PM" src="https://github.com/user-attachments/assets/77429525-36e2-4da6-a694-e58c1cf9eb83" />
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Creating a custom RAG flow
|
|
||||||
|
|
||||||
Now that we've seen how you can use LanceDB for in a genkit pipeline, let's refine the flow and create a RAG. A RAG flow will consist of an index and a retreiver with its outputs postprocessed an fed into an LLM for final response
|
|
||||||
|
|
||||||
### Creating custom indexer flows
|
|
||||||
You can also create custom indexer flows, utilizing more options and features provided by LanceDB.
|
|
||||||
|
|
||||||
```ts
|
|
||||||
export const menuPdfIndexer = lancedbIndexerRef({
|
|
||||||
// Using all defaults, for dbUri, tableName, and embedder, etc
|
|
||||||
});
|
|
||||||
|
|
||||||
const chunkingConfig = {
|
|
||||||
minLength: 1000,
|
|
||||||
maxLength: 2000,
|
|
||||||
splitter: 'sentence',
|
|
||||||
overlap: 100,
|
|
||||||
delimiters: '',
|
|
||||||
} as any;
|
|
||||||
|
|
||||||
|
|
||||||
async function extractTextFromPdf(filePath: string) {
|
|
||||||
const pdfFile = path.resolve(filePath);
|
|
||||||
const dataBuffer = await readFile(pdfFile);
|
|
||||||
const data = await pdf(dataBuffer);
|
|
||||||
return data.text;
|
|
||||||
}
|
|
||||||
|
|
||||||
export const indexMenu = ai.defineFlow(
|
|
||||||
{
|
|
||||||
name: 'indexMenu',
|
|
||||||
inputSchema: z.string().describe('PDF file path'),
|
|
||||||
outputSchema: z.void(),
|
|
||||||
},
|
|
||||||
async (filePath: string) => {
|
|
||||||
filePath = path.resolve(filePath);
|
|
||||||
|
|
||||||
// Read the pdf.
|
|
||||||
const pdfTxt = await ai.run('extract-text', () =>
|
|
||||||
extractTextFromPdf(filePath)
|
|
||||||
);
|
|
||||||
|
|
||||||
// Divide the pdf text into segments.
|
|
||||||
const chunks = await ai.run('chunk-it', async () =>
|
|
||||||
chunk(pdfTxt, chunkingConfig)
|
|
||||||
);
|
|
||||||
|
|
||||||
// Convert chunks of text into documents to store in the index.
|
|
||||||
const documents = chunks.map((text) => {
|
|
||||||
return Document.fromText(text, { filePath });
|
|
||||||
});
|
|
||||||
|
|
||||||
// Add documents to the index.
|
|
||||||
await ai.index({
|
|
||||||
indexer: menuPdfIndexer,
|
|
||||||
documents,
|
|
||||||
options: {
|
|
||||||
writeMode: WriteMode.Overwrite,
|
|
||||||
} as any
|
|
||||||
});
|
|
||||||
}
|
|
||||||
);
|
|
||||||
```
|
|
||||||
|
|
||||||
<img width="1316" alt="Screenshot 2025-05-11 at 8 35 56 PM" src="https://github.com/user-attachments/assets/e2a20ce4-d1d0-4fa2-9a84-f2cc26e3a29f" />
|
|
||||||
|
|
||||||
In your console, you can see the logs
|
|
||||||
|
|
||||||
<img width="511" alt="Screenshot 2025-05-11 at 7 19 14 PM" src="https://github.com/user-attachments/assets/243f26c5-ed38-40b6-b661-002f40f0423a" />
|
|
||||||
|
|
||||||
### Creating custom retriever flows
|
|
||||||
You can also create custom retriever flows, utilizing more options and features provided by LanceDB.
|
|
||||||
```ts
|
|
||||||
export const menuRetriever = lancedbRetrieverRef({
|
|
||||||
tableName: "table", // Use the same table name as the indexer.
|
|
||||||
displayName: "Menu", // Use a custom display name.
|
|
||||||
|
|
||||||
export const menuQAFlow = ai.defineFlow(
|
|
||||||
{ name: "Menu", inputSchema: z.string(), outputSchema: z.string() },
|
|
||||||
async (input: string) => {
|
|
||||||
// retrieve relevant documents
|
|
||||||
const docs = await ai.retrieve({
|
|
||||||
retriever: menuRetriever,
|
|
||||||
query: input,
|
|
||||||
options: {
|
|
||||||
k: 3,
|
|
||||||
},
|
|
||||||
});
|
|
||||||
|
|
||||||
const extractedContent = docs.map(doc => {
|
|
||||||
if (doc.content && Array.isArray(doc.content) && doc.content.length > 0) {
|
|
||||||
if (doc.content[0].media && doc.content[0].media.url) {
|
|
||||||
return doc.content[0].media.url;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return "No content found";
|
|
||||||
});
|
|
||||||
|
|
||||||
console.log("Extracted content:", extractedContent);
|
|
||||||
|
|
||||||
const { text } = await ai.generate({
|
|
||||||
model: gemini('gemini-2.0-flash'),
|
|
||||||
prompt: `
|
|
||||||
You are acting as a helpful AI assistant that can answer
|
|
||||||
questions about the food available on the menu at Genkit Grub Pub.
|
|
||||||
|
|
||||||
Use only the context provided to answer the question.
|
|
||||||
If you don't know, do not make up an answer.
|
|
||||||
Do not add or change items on the menu.
|
|
||||||
|
|
||||||
Context:
|
|
||||||
${extractedContent.join('\n\n')}
|
|
||||||
|
|
||||||
Question: ${input}`,
|
|
||||||
docs,
|
|
||||||
});
|
|
||||||
|
|
||||||
return text;
|
|
||||||
}
|
|
||||||
);
|
|
||||||
```
|
|
||||||
Now using our retrieval flow, we can ask question about the ingsted PDF
|
|
||||||
<img width="1306" alt="Screenshot 2025-05-11 at 7 18 45 PM" src="https://github.com/user-attachments/assets/86c66b13-7c12-4d5f-9d81-ae36bfb1c346" />
|
|
||||||
|
|
||||||
@@ -1,53 +0,0 @@
|
|||||||
[**@lancedb/lancedb**](../README.md) • **Docs**
|
|
||||||
|
|
||||||
***
|
|
||||||
|
|
||||||
[@lancedb/lancedb](../globals.md) / BooleanQuery
|
|
||||||
|
|
||||||
# Class: BooleanQuery
|
|
||||||
|
|
||||||
Represents a full-text query interface.
|
|
||||||
This interface defines the structure and behavior for full-text queries,
|
|
||||||
including methods to retrieve the query type and convert the query to a dictionary format.
|
|
||||||
|
|
||||||
## Implements
|
|
||||||
|
|
||||||
- [`FullTextQuery`](../interfaces/FullTextQuery.md)
|
|
||||||
|
|
||||||
## Constructors
|
|
||||||
|
|
||||||
### new BooleanQuery()
|
|
||||||
|
|
||||||
```ts
|
|
||||||
new BooleanQuery(queries): BooleanQuery
|
|
||||||
```
|
|
||||||
|
|
||||||
Creates an instance of BooleanQuery.
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
|
|
||||||
* **queries**: [[`Occur`](../enumerations/Occur.md), [`FullTextQuery`](../interfaces/FullTextQuery.md)][]
|
|
||||||
An array of (Occur, FullTextQuery objects) to combine.
|
|
||||||
Occur specifies whether the query must match, or should match.
|
|
||||||
|
|
||||||
#### Returns
|
|
||||||
|
|
||||||
[`BooleanQuery`](BooleanQuery.md)
|
|
||||||
|
|
||||||
## Methods
|
|
||||||
|
|
||||||
### queryType()
|
|
||||||
|
|
||||||
```ts
|
|
||||||
queryType(): FullTextQueryType
|
|
||||||
```
|
|
||||||
|
|
||||||
The type of the full-text query.
|
|
||||||
|
|
||||||
#### Returns
|
|
||||||
|
|
||||||
[`FullTextQueryType`](../enumerations/FullTextQueryType.md)
|
|
||||||
|
|
||||||
#### Implementation of
|
|
||||||
|
|
||||||
[`FullTextQuery`](../interfaces/FullTextQuery.md).[`queryType`](../interfaces/FullTextQuery.md#querytype)
|
|
||||||
@@ -40,8 +40,6 @@ Creates an instance of MatchQuery.
|
|||||||
- `boost`: The boost factor for the query (default is 1.0).
|
- `boost`: The boost factor for the query (default is 1.0).
|
||||||
- `fuzziness`: The fuzziness level for the query (default is 0).
|
- `fuzziness`: The fuzziness level for the query (default is 0).
|
||||||
- `maxExpansions`: The maximum number of terms to consider for fuzzy matching (default is 50).
|
- `maxExpansions`: The maximum number of terms to consider for fuzzy matching (default is 50).
|
||||||
- `operator`: The logical operator to use for combining terms in the query (default is "OR").
|
|
||||||
- `prefixLength`: The number of beginning characters being unchanged for fuzzy matching.
|
|
||||||
|
|
||||||
* **options.boost?**: `number`
|
* **options.boost?**: `number`
|
||||||
|
|
||||||
@@ -49,10 +47,6 @@ Creates an instance of MatchQuery.
|
|||||||
|
|
||||||
* **options.maxExpansions?**: `number`
|
* **options.maxExpansions?**: `number`
|
||||||
|
|
||||||
* **options.operator?**: [`Operator`](../enumerations/Operator.md)
|
|
||||||
|
|
||||||
* **options.prefixLength?**: `number`
|
|
||||||
|
|
||||||
#### Returns
|
#### Returns
|
||||||
|
|
||||||
[`MatchQuery`](MatchQuery.md)
|
[`MatchQuery`](MatchQuery.md)
|
||||||
|
|||||||
@@ -33,7 +33,7 @@ Construct a MergeInsertBuilder. __Internal use only.__
|
|||||||
### execute()
|
### execute()
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
execute(data, execOptions?): Promise<MergeResult>
|
execute(data): Promise<MergeStats>
|
||||||
```
|
```
|
||||||
|
|
||||||
Executes the merge insert operation
|
Executes the merge insert operation
|
||||||
@@ -42,13 +42,11 @@ Executes the merge insert operation
|
|||||||
|
|
||||||
* **data**: [`Data`](../type-aliases/Data.md)
|
* **data**: [`Data`](../type-aliases/Data.md)
|
||||||
|
|
||||||
* **execOptions?**: `Partial`<[`WriteExecutionOptions`](../interfaces/WriteExecutionOptions.md)>
|
|
||||||
|
|
||||||
#### Returns
|
#### Returns
|
||||||
|
|
||||||
`Promise`<[`MergeResult`](../interfaces/MergeResult.md)>
|
`Promise`<[`MergeStats`](../interfaces/MergeStats.md)>
|
||||||
|
|
||||||
the merge result
|
Statistics about the merge operation: counts of inserted, updated, and deleted rows
|
||||||
|
|
||||||
***
|
***
|
||||||
|
|
||||||
|
|||||||
@@ -38,12 +38,9 @@ Creates an instance of MultiMatchQuery.
|
|||||||
* **options?**
|
* **options?**
|
||||||
Optional parameters for the multi-match query.
|
Optional parameters for the multi-match query.
|
||||||
- `boosts`: An array of boost factors for each column (default is 1.0 for all).
|
- `boosts`: An array of boost factors for each column (default is 1.0 for all).
|
||||||
- `operator`: The logical operator to use for combining terms in the query (default is "OR").
|
|
||||||
|
|
||||||
* **options.boosts?**: `number`[]
|
* **options.boosts?**: `number`[]
|
||||||
|
|
||||||
* **options.operator?**: [`Operator`](../enumerations/Operator.md)
|
|
||||||
|
|
||||||
#### Returns
|
#### Returns
|
||||||
|
|
||||||
[`MultiMatchQuery`](MultiMatchQuery.md)
|
[`MultiMatchQuery`](MultiMatchQuery.md)
|
||||||
|
|||||||
@@ -19,10 +19,7 @@ including methods to retrieve the query type and convert the query to a dictiona
|
|||||||
### new PhraseQuery()
|
### new PhraseQuery()
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
new PhraseQuery(
|
new PhraseQuery(query, column): PhraseQuery
|
||||||
query,
|
|
||||||
column,
|
|
||||||
options?): PhraseQuery
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Creates an instance of `PhraseQuery`.
|
Creates an instance of `PhraseQuery`.
|
||||||
@@ -35,12 +32,6 @@ Creates an instance of `PhraseQuery`.
|
|||||||
* **column**: `string`
|
* **column**: `string`
|
||||||
The name of the column to search within.
|
The name of the column to search within.
|
||||||
|
|
||||||
* **options?**
|
|
||||||
Optional parameters for the phrase query.
|
|
||||||
- `slop`: The maximum number of intervening unmatched positions allowed between words in the phrase (default is 0).
|
|
||||||
|
|
||||||
* **options.slop?**: `number`
|
|
||||||
|
|
||||||
#### Returns
|
#### Returns
|
||||||
|
|
||||||
[`PhraseQuery`](PhraseQuery.md)
|
[`PhraseQuery`](PhraseQuery.md)
|
||||||
|
|||||||
@@ -40,7 +40,7 @@ Returns the name of the table
|
|||||||
### add()
|
### add()
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
abstract add(data, options?): Promise<AddResult>
|
abstract add(data, options?): Promise<void>
|
||||||
```
|
```
|
||||||
|
|
||||||
Insert records into this Table.
|
Insert records into this Table.
|
||||||
@@ -54,17 +54,14 @@ Insert records into this Table.
|
|||||||
|
|
||||||
#### Returns
|
#### Returns
|
||||||
|
|
||||||
`Promise`<[`AddResult`](../interfaces/AddResult.md)>
|
`Promise`<`void`>
|
||||||
|
|
||||||
A promise that resolves to an object
|
|
||||||
containing the new version number of the table
|
|
||||||
|
|
||||||
***
|
***
|
||||||
|
|
||||||
### addColumns()
|
### addColumns()
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
abstract addColumns(newColumnTransforms): Promise<AddColumnsResult>
|
abstract addColumns(newColumnTransforms): Promise<void>
|
||||||
```
|
```
|
||||||
|
|
||||||
Add new columns with defined values.
|
Add new columns with defined values.
|
||||||
@@ -79,17 +76,14 @@ Add new columns with defined values.
|
|||||||
|
|
||||||
#### Returns
|
#### Returns
|
||||||
|
|
||||||
`Promise`<[`AddColumnsResult`](../interfaces/AddColumnsResult.md)>
|
`Promise`<`void`>
|
||||||
|
|
||||||
A promise that resolves to an object
|
|
||||||
containing the new version number of the table after adding the columns.
|
|
||||||
|
|
||||||
***
|
***
|
||||||
|
|
||||||
### alterColumns()
|
### alterColumns()
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
abstract alterColumns(columnAlterations): Promise<AlterColumnsResult>
|
abstract alterColumns(columnAlterations): Promise<void>
|
||||||
```
|
```
|
||||||
|
|
||||||
Alter the name or nullability of columns.
|
Alter the name or nullability of columns.
|
||||||
@@ -102,10 +96,7 @@ Alter the name or nullability of columns.
|
|||||||
|
|
||||||
#### Returns
|
#### Returns
|
||||||
|
|
||||||
`Promise`<[`AlterColumnsResult`](../interfaces/AlterColumnsResult.md)>
|
`Promise`<`void`>
|
||||||
|
|
||||||
A promise that resolves to an object
|
|
||||||
containing the new version number of the table after altering the columns.
|
|
||||||
|
|
||||||
***
|
***
|
||||||
|
|
||||||
@@ -261,7 +252,7 @@ await table.createIndex("my_float_col");
|
|||||||
### delete()
|
### delete()
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
abstract delete(predicate): Promise<DeleteResult>
|
abstract delete(predicate): Promise<void>
|
||||||
```
|
```
|
||||||
|
|
||||||
Delete the rows that satisfy the predicate.
|
Delete the rows that satisfy the predicate.
|
||||||
@@ -272,10 +263,7 @@ Delete the rows that satisfy the predicate.
|
|||||||
|
|
||||||
#### Returns
|
#### Returns
|
||||||
|
|
||||||
`Promise`<[`DeleteResult`](../interfaces/DeleteResult.md)>
|
`Promise`<`void`>
|
||||||
|
|
||||||
A promise that resolves to an object
|
|
||||||
containing the new version number of the table
|
|
||||||
|
|
||||||
***
|
***
|
||||||
|
|
||||||
@@ -296,7 +284,7 @@ Return a brief description of the table
|
|||||||
### dropColumns()
|
### dropColumns()
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
abstract dropColumns(columnNames): Promise<DropColumnsResult>
|
abstract dropColumns(columnNames): Promise<void>
|
||||||
```
|
```
|
||||||
|
|
||||||
Drop one or more columns from the dataset
|
Drop one or more columns from the dataset
|
||||||
@@ -315,10 +303,7 @@ then call ``cleanup_files`` to remove the old files.
|
|||||||
|
|
||||||
#### Returns
|
#### Returns
|
||||||
|
|
||||||
`Promise`<[`DropColumnsResult`](../interfaces/DropColumnsResult.md)>
|
`Promise`<`void`>
|
||||||
|
|
||||||
A promise that resolves to an object
|
|
||||||
containing the new version number of the table after dropping the columns.
|
|
||||||
|
|
||||||
***
|
***
|
||||||
|
|
||||||
@@ -612,7 +597,7 @@ of the given query
|
|||||||
|
|
||||||
#### Parameters
|
#### Parameters
|
||||||
|
|
||||||
* **query**: `string` \| [`IntoVector`](../type-aliases/IntoVector.md) \| [`MultiVector`](../type-aliases/MultiVector.md) \| [`FullTextQuery`](../interfaces/FullTextQuery.md)
|
* **query**: `string` \| [`IntoVector`](../type-aliases/IntoVector.md) \| [`FullTextQuery`](../interfaces/FullTextQuery.md)
|
||||||
the query, a vector or string
|
the query, a vector or string
|
||||||
|
|
||||||
* **queryType?**: `string`
|
* **queryType?**: `string`
|
||||||
@@ -693,7 +678,7 @@ Return the table as an arrow table
|
|||||||
#### update(opts)
|
#### update(opts)
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
abstract update(opts): Promise<UpdateResult>
|
abstract update(opts): Promise<void>
|
||||||
```
|
```
|
||||||
|
|
||||||
Update existing records in the Table
|
Update existing records in the Table
|
||||||
@@ -704,10 +689,7 @@ Update existing records in the Table
|
|||||||
|
|
||||||
##### Returns
|
##### Returns
|
||||||
|
|
||||||
`Promise`<[`UpdateResult`](../interfaces/UpdateResult.md)>
|
`Promise`<`void`>
|
||||||
|
|
||||||
A promise that resolves to an object containing
|
|
||||||
the number of rows updated and the new version number
|
|
||||||
|
|
||||||
##### Example
|
##### Example
|
||||||
|
|
||||||
@@ -718,7 +700,7 @@ table.update({where:"x = 2", values:{"vector": [10, 10]}})
|
|||||||
#### update(opts)
|
#### update(opts)
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
abstract update(opts): Promise<UpdateResult>
|
abstract update(opts): Promise<void>
|
||||||
```
|
```
|
||||||
|
|
||||||
Update existing records in the Table
|
Update existing records in the Table
|
||||||
@@ -729,10 +711,7 @@ Update existing records in the Table
|
|||||||
|
|
||||||
##### Returns
|
##### Returns
|
||||||
|
|
||||||
`Promise`<[`UpdateResult`](../interfaces/UpdateResult.md)>
|
`Promise`<`void`>
|
||||||
|
|
||||||
A promise that resolves to an object containing
|
|
||||||
the number of rows updated and the new version number
|
|
||||||
|
|
||||||
##### Example
|
##### Example
|
||||||
|
|
||||||
@@ -743,7 +722,7 @@ table.update({where:"x = 2", valuesSql:{"x": "x + 1"}})
|
|||||||
#### update(updates, options)
|
#### update(updates, options)
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
abstract update(updates, options?): Promise<UpdateResult>
|
abstract update(updates, options?): Promise<void>
|
||||||
```
|
```
|
||||||
|
|
||||||
Update existing records in the Table
|
Update existing records in the Table
|
||||||
@@ -766,6 +745,10 @@ repeatedly calilng this method.
|
|||||||
* **updates**: `Record`<`string`, `string`> \| `Map`<`string`, `string`>
|
* **updates**: `Record`<`string`, `string`> \| `Map`<`string`, `string`>
|
||||||
the
|
the
|
||||||
columns to update
|
columns to update
|
||||||
|
Keys in the map should specify the name of the column to update.
|
||||||
|
Values in the map provide the new value of the column. These can
|
||||||
|
be SQL literal strings (e.g. "7" or "'foo'") or they can be expressions
|
||||||
|
based on the row being updated (e.g. "my_col + 1")
|
||||||
|
|
||||||
* **options?**: `Partial`<[`UpdateOptions`](../interfaces/UpdateOptions.md)>
|
* **options?**: `Partial`<[`UpdateOptions`](../interfaces/UpdateOptions.md)>
|
||||||
additional options to control
|
additional options to control
|
||||||
@@ -773,15 +756,7 @@ repeatedly calilng this method.
|
|||||||
|
|
||||||
##### Returns
|
##### Returns
|
||||||
|
|
||||||
`Promise`<[`UpdateResult`](../interfaces/UpdateResult.md)>
|
`Promise`<`void`>
|
||||||
|
|
||||||
A promise that resolves to an object
|
|
||||||
containing the number of rows updated and the new version number
|
|
||||||
|
|
||||||
Keys in the map should specify the name of the column to update.
|
|
||||||
Values in the map provide the new value of the column. These can
|
|
||||||
be SQL literal strings (e.g. "7" or "'foo'") or they can be expressions
|
|
||||||
based on the row being updated (e.g. "my_col + 1")
|
|
||||||
|
|
||||||
***
|
***
|
||||||
|
|
||||||
@@ -799,7 +774,7 @@ by `query`.
|
|||||||
|
|
||||||
#### Parameters
|
#### Parameters
|
||||||
|
|
||||||
* **vector**: [`IntoVector`](../type-aliases/IntoVector.md) \| [`MultiVector`](../type-aliases/MultiVector.md)
|
* **vector**: [`IntoVector`](../type-aliases/IntoVector.md)
|
||||||
|
|
||||||
#### Returns
|
#### Returns
|
||||||
|
|
||||||
|
|||||||
@@ -386,53 +386,6 @@ called then every valid row from the table will be returned.
|
|||||||
|
|
||||||
***
|
***
|
||||||
|
|
||||||
### maximumNprobes()
|
|
||||||
|
|
||||||
```ts
|
|
||||||
maximumNprobes(maximumNprobes): VectorQuery
|
|
||||||
```
|
|
||||||
|
|
||||||
Set the maximum number of probes used.
|
|
||||||
|
|
||||||
This controls the maximum number of partitions that will be searched. If this
|
|
||||||
number is greater than minimumNprobes then the excess partitions will _only_ be
|
|
||||||
searched if we have not found enough results. This can be useful when there is
|
|
||||||
a narrow filter to allow these queries to spend more time searching and avoid
|
|
||||||
potential false negatives.
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
|
|
||||||
* **maximumNprobes**: `number`
|
|
||||||
|
|
||||||
#### Returns
|
|
||||||
|
|
||||||
[`VectorQuery`](VectorQuery.md)
|
|
||||||
|
|
||||||
***
|
|
||||||
|
|
||||||
### minimumNprobes()
|
|
||||||
|
|
||||||
```ts
|
|
||||||
minimumNprobes(minimumNprobes): VectorQuery
|
|
||||||
```
|
|
||||||
|
|
||||||
Set the minimum number of probes used.
|
|
||||||
|
|
||||||
This controls the minimum number of partitions that will be searched. This
|
|
||||||
parameter will impact every query against a vector index, regardless of the
|
|
||||||
filter. See `nprobes` for more details. Higher values will increase recall
|
|
||||||
but will also increase latency.
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
|
|
||||||
* **minimumNprobes**: `number`
|
|
||||||
|
|
||||||
#### Returns
|
|
||||||
|
|
||||||
[`VectorQuery`](VectorQuery.md)
|
|
||||||
|
|
||||||
***
|
|
||||||
|
|
||||||
### nprobes()
|
### nprobes()
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
@@ -460,10 +413,6 @@ For best results we recommend tuning this parameter with a benchmark against
|
|||||||
your actual data to find the smallest possible value that will still give
|
your actual data to find the smallest possible value that will still give
|
||||||
you the desired recall.
|
you the desired recall.
|
||||||
|
|
||||||
For more fine grained control over behavior when you have a very narrow filter
|
|
||||||
you can use `minimumNprobes` and `maximumNprobes`. This method sets both
|
|
||||||
the minimum and maximum to the same value.
|
|
||||||
|
|
||||||
#### Parameters
|
#### Parameters
|
||||||
|
|
||||||
* **nprobes**: `number`
|
* **nprobes**: `number`
|
||||||
|
|||||||
@@ -15,14 +15,6 @@ Enum representing the types of full-text queries supported.
|
|||||||
|
|
||||||
## Enumeration Members
|
## Enumeration Members
|
||||||
|
|
||||||
### Boolean
|
|
||||||
|
|
||||||
```ts
|
|
||||||
Boolean: "boolean";
|
|
||||||
```
|
|
||||||
|
|
||||||
***
|
|
||||||
|
|
||||||
### Boost
|
### Boost
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
|
|||||||
@@ -1,37 +0,0 @@
|
|||||||
[**@lancedb/lancedb**](../README.md) • **Docs**
|
|
||||||
|
|
||||||
***
|
|
||||||
|
|
||||||
[@lancedb/lancedb](../globals.md) / Occur
|
|
||||||
|
|
||||||
# Enumeration: Occur
|
|
||||||
|
|
||||||
Enum representing the occurrence of terms in full-text queries.
|
|
||||||
|
|
||||||
- `Must`: The term must be present in the document.
|
|
||||||
- `Should`: The term should contribute to the document score, but is not required.
|
|
||||||
- `MustNot`: The term must not be present in the document.
|
|
||||||
|
|
||||||
## Enumeration Members
|
|
||||||
|
|
||||||
### Must
|
|
||||||
|
|
||||||
```ts
|
|
||||||
Must: "MUST";
|
|
||||||
```
|
|
||||||
|
|
||||||
***
|
|
||||||
|
|
||||||
### MustNot
|
|
||||||
|
|
||||||
```ts
|
|
||||||
MustNot: "MUST_NOT";
|
|
||||||
```
|
|
||||||
|
|
||||||
***
|
|
||||||
|
|
||||||
### Should
|
|
||||||
|
|
||||||
```ts
|
|
||||||
Should: "SHOULD";
|
|
||||||
```
|
|
||||||
@@ -1,28 +0,0 @@
|
|||||||
[**@lancedb/lancedb**](../README.md) • **Docs**
|
|
||||||
|
|
||||||
***
|
|
||||||
|
|
||||||
[@lancedb/lancedb](../globals.md) / Operator
|
|
||||||
|
|
||||||
# Enumeration: Operator
|
|
||||||
|
|
||||||
Enum representing the logical operators used in full-text queries.
|
|
||||||
|
|
||||||
- `And`: All terms must match.
|
|
||||||
- `Or`: At least one term must match.
|
|
||||||
|
|
||||||
## Enumeration Members
|
|
||||||
|
|
||||||
### And
|
|
||||||
|
|
||||||
```ts
|
|
||||||
And: "AND";
|
|
||||||
```
|
|
||||||
|
|
||||||
***
|
|
||||||
|
|
||||||
### Or
|
|
||||||
|
|
||||||
```ts
|
|
||||||
Or: "OR";
|
|
||||||
```
|
|
||||||
@@ -12,12 +12,9 @@
|
|||||||
## Enumerations
|
## Enumerations
|
||||||
|
|
||||||
- [FullTextQueryType](enumerations/FullTextQueryType.md)
|
- [FullTextQueryType](enumerations/FullTextQueryType.md)
|
||||||
- [Occur](enumerations/Occur.md)
|
|
||||||
- [Operator](enumerations/Operator.md)
|
|
||||||
|
|
||||||
## Classes
|
## Classes
|
||||||
|
|
||||||
- [BooleanQuery](classes/BooleanQuery.md)
|
|
||||||
- [BoostQuery](classes/BoostQuery.md)
|
- [BoostQuery](classes/BoostQuery.md)
|
||||||
- [Connection](classes/Connection.md)
|
- [Connection](classes/Connection.md)
|
||||||
- [Index](classes/Index.md)
|
- [Index](classes/Index.md)
|
||||||
@@ -37,18 +34,13 @@
|
|||||||
|
|
||||||
## Interfaces
|
## Interfaces
|
||||||
|
|
||||||
- [AddColumnsResult](interfaces/AddColumnsResult.md)
|
|
||||||
- [AddColumnsSql](interfaces/AddColumnsSql.md)
|
- [AddColumnsSql](interfaces/AddColumnsSql.md)
|
||||||
- [AddDataOptions](interfaces/AddDataOptions.md)
|
- [AddDataOptions](interfaces/AddDataOptions.md)
|
||||||
- [AddResult](interfaces/AddResult.md)
|
|
||||||
- [AlterColumnsResult](interfaces/AlterColumnsResult.md)
|
|
||||||
- [ClientConfig](interfaces/ClientConfig.md)
|
- [ClientConfig](interfaces/ClientConfig.md)
|
||||||
- [ColumnAlteration](interfaces/ColumnAlteration.md)
|
- [ColumnAlteration](interfaces/ColumnAlteration.md)
|
||||||
- [CompactionStats](interfaces/CompactionStats.md)
|
- [CompactionStats](interfaces/CompactionStats.md)
|
||||||
- [ConnectionOptions](interfaces/ConnectionOptions.md)
|
- [ConnectionOptions](interfaces/ConnectionOptions.md)
|
||||||
- [CreateTableOptions](interfaces/CreateTableOptions.md)
|
- [CreateTableOptions](interfaces/CreateTableOptions.md)
|
||||||
- [DeleteResult](interfaces/DeleteResult.md)
|
|
||||||
- [DropColumnsResult](interfaces/DropColumnsResult.md)
|
|
||||||
- [ExecutableQuery](interfaces/ExecutableQuery.md)
|
- [ExecutableQuery](interfaces/ExecutableQuery.md)
|
||||||
- [FragmentStatistics](interfaces/FragmentStatistics.md)
|
- [FragmentStatistics](interfaces/FragmentStatistics.md)
|
||||||
- [FragmentSummaryStats](interfaces/FragmentSummaryStats.md)
|
- [FragmentSummaryStats](interfaces/FragmentSummaryStats.md)
|
||||||
@@ -62,7 +54,7 @@
|
|||||||
- [IndexStatistics](interfaces/IndexStatistics.md)
|
- [IndexStatistics](interfaces/IndexStatistics.md)
|
||||||
- [IvfFlatOptions](interfaces/IvfFlatOptions.md)
|
- [IvfFlatOptions](interfaces/IvfFlatOptions.md)
|
||||||
- [IvfPqOptions](interfaces/IvfPqOptions.md)
|
- [IvfPqOptions](interfaces/IvfPqOptions.md)
|
||||||
- [MergeResult](interfaces/MergeResult.md)
|
- [MergeStats](interfaces/MergeStats.md)
|
||||||
- [OpenTableOptions](interfaces/OpenTableOptions.md)
|
- [OpenTableOptions](interfaces/OpenTableOptions.md)
|
||||||
- [OptimizeOptions](interfaces/OptimizeOptions.md)
|
- [OptimizeOptions](interfaces/OptimizeOptions.md)
|
||||||
- [OptimizeStats](interfaces/OptimizeStats.md)
|
- [OptimizeStats](interfaces/OptimizeStats.md)
|
||||||
@@ -73,9 +65,7 @@
|
|||||||
- [TableStatistics](interfaces/TableStatistics.md)
|
- [TableStatistics](interfaces/TableStatistics.md)
|
||||||
- [TimeoutConfig](interfaces/TimeoutConfig.md)
|
- [TimeoutConfig](interfaces/TimeoutConfig.md)
|
||||||
- [UpdateOptions](interfaces/UpdateOptions.md)
|
- [UpdateOptions](interfaces/UpdateOptions.md)
|
||||||
- [UpdateResult](interfaces/UpdateResult.md)
|
|
||||||
- [Version](interfaces/Version.md)
|
- [Version](interfaces/Version.md)
|
||||||
- [WriteExecutionOptions](interfaces/WriteExecutionOptions.md)
|
|
||||||
|
|
||||||
## Type Aliases
|
## Type Aliases
|
||||||
|
|
||||||
@@ -84,7 +74,6 @@
|
|||||||
- [FieldLike](type-aliases/FieldLike.md)
|
- [FieldLike](type-aliases/FieldLike.md)
|
||||||
- [IntoSql](type-aliases/IntoSql.md)
|
- [IntoSql](type-aliases/IntoSql.md)
|
||||||
- [IntoVector](type-aliases/IntoVector.md)
|
- [IntoVector](type-aliases/IntoVector.md)
|
||||||
- [MultiVector](type-aliases/MultiVector.md)
|
|
||||||
- [RecordBatchLike](type-aliases/RecordBatchLike.md)
|
- [RecordBatchLike](type-aliases/RecordBatchLike.md)
|
||||||
- [SchemaLike](type-aliases/SchemaLike.md)
|
- [SchemaLike](type-aliases/SchemaLike.md)
|
||||||
- [TableLike](type-aliases/TableLike.md)
|
- [TableLike](type-aliases/TableLike.md)
|
||||||
|
|||||||
@@ -1,15 +0,0 @@
|
|||||||
[**@lancedb/lancedb**](../README.md) • **Docs**
|
|
||||||
|
|
||||||
***
|
|
||||||
|
|
||||||
[@lancedb/lancedb](../globals.md) / AddColumnsResult
|
|
||||||
|
|
||||||
# Interface: AddColumnsResult
|
|
||||||
|
|
||||||
## Properties
|
|
||||||
|
|
||||||
### version
|
|
||||||
|
|
||||||
```ts
|
|
||||||
version: number;
|
|
||||||
```
|
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
[**@lancedb/lancedb**](../README.md) • **Docs**
|
|
||||||
|
|
||||||
***
|
|
||||||
|
|
||||||
[@lancedb/lancedb](../globals.md) / AddResult
|
|
||||||
|
|
||||||
# Interface: AddResult
|
|
||||||
|
|
||||||
## Properties
|
|
||||||
|
|
||||||
### version
|
|
||||||
|
|
||||||
```ts
|
|
||||||
version: number;
|
|
||||||
```
|
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
[**@lancedb/lancedb**](../README.md) • **Docs**
|
|
||||||
|
|
||||||
***
|
|
||||||
|
|
||||||
[@lancedb/lancedb](../globals.md) / AlterColumnsResult
|
|
||||||
|
|
||||||
# Interface: AlterColumnsResult
|
|
||||||
|
|
||||||
## Properties
|
|
||||||
|
|
||||||
### version
|
|
||||||
|
|
||||||
```ts
|
|
||||||
version: number;
|
|
||||||
```
|
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
[**@lancedb/lancedb**](../README.md) • **Docs**
|
|
||||||
|
|
||||||
***
|
|
||||||
|
|
||||||
[@lancedb/lancedb](../globals.md) / DeleteResult
|
|
||||||
|
|
||||||
# Interface: DeleteResult
|
|
||||||
|
|
||||||
## Properties
|
|
||||||
|
|
||||||
### version
|
|
||||||
|
|
||||||
```ts
|
|
||||||
version: number;
|
|
||||||
```
|
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
[**@lancedb/lancedb**](../README.md) • **Docs**
|
|
||||||
|
|
||||||
***
|
|
||||||
|
|
||||||
[@lancedb/lancedb](../globals.md) / DropColumnsResult
|
|
||||||
|
|
||||||
# Interface: DropColumnsResult
|
|
||||||
|
|
||||||
## Properties
|
|
||||||
|
|
||||||
### version
|
|
||||||
|
|
||||||
```ts
|
|
||||||
version: number;
|
|
||||||
```
|
|
||||||
@@ -23,7 +23,7 @@ whether to remove punctuation
|
|||||||
### baseTokenizer?
|
### baseTokenizer?
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
optional baseTokenizer: "raw" | "simple" | "whitespace" | "ngram";
|
optional baseTokenizer: "raw" | "simple" | "whitespace";
|
||||||
```
|
```
|
||||||
|
|
||||||
The tokenizer to use when building the index.
|
The tokenizer to use when building the index.
|
||||||
@@ -71,36 +71,6 @@ tokens longer than this length will be ignored
|
|||||||
|
|
||||||
***
|
***
|
||||||
|
|
||||||
### ngramMaxLength?
|
|
||||||
|
|
||||||
```ts
|
|
||||||
optional ngramMaxLength: number;
|
|
||||||
```
|
|
||||||
|
|
||||||
ngram max length
|
|
||||||
|
|
||||||
***
|
|
||||||
|
|
||||||
### ngramMinLength?
|
|
||||||
|
|
||||||
```ts
|
|
||||||
optional ngramMinLength: number;
|
|
||||||
```
|
|
||||||
|
|
||||||
ngram min length
|
|
||||||
|
|
||||||
***
|
|
||||||
|
|
||||||
### prefixOnly?
|
|
||||||
|
|
||||||
```ts
|
|
||||||
optional prefixOnly: boolean;
|
|
||||||
```
|
|
||||||
|
|
||||||
whether to only index the prefix of the token for ngram tokenizer
|
|
||||||
|
|
||||||
***
|
|
||||||
|
|
||||||
### removeStopWords?
|
### removeStopWords?
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
|
|||||||
@@ -1,39 +0,0 @@
|
|||||||
[**@lancedb/lancedb**](../README.md) • **Docs**
|
|
||||||
|
|
||||||
***
|
|
||||||
|
|
||||||
[@lancedb/lancedb](../globals.md) / MergeResult
|
|
||||||
|
|
||||||
# Interface: MergeResult
|
|
||||||
|
|
||||||
## Properties
|
|
||||||
|
|
||||||
### numDeletedRows
|
|
||||||
|
|
||||||
```ts
|
|
||||||
numDeletedRows: number;
|
|
||||||
```
|
|
||||||
|
|
||||||
***
|
|
||||||
|
|
||||||
### numInsertedRows
|
|
||||||
|
|
||||||
```ts
|
|
||||||
numInsertedRows: number;
|
|
||||||
```
|
|
||||||
|
|
||||||
***
|
|
||||||
|
|
||||||
### numUpdatedRows
|
|
||||||
|
|
||||||
```ts
|
|
||||||
numUpdatedRows: number;
|
|
||||||
```
|
|
||||||
|
|
||||||
***
|
|
||||||
|
|
||||||
### version
|
|
||||||
|
|
||||||
```ts
|
|
||||||
version: number;
|
|
||||||
```
|
|
||||||
31
docs/src/js/interfaces/MergeStats.md
Normal file
31
docs/src/js/interfaces/MergeStats.md
Normal file
@@ -0,0 +1,31 @@
|
|||||||
|
[**@lancedb/lancedb**](../README.md) • **Docs**
|
||||||
|
|
||||||
|
***
|
||||||
|
|
||||||
|
[@lancedb/lancedb](../globals.md) / MergeStats
|
||||||
|
|
||||||
|
# Interface: MergeStats
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
### numDeletedRows
|
||||||
|
|
||||||
|
```ts
|
||||||
|
numDeletedRows: bigint;
|
||||||
|
```
|
||||||
|
|
||||||
|
***
|
||||||
|
|
||||||
|
### numInsertedRows
|
||||||
|
|
||||||
|
```ts
|
||||||
|
numInsertedRows: bigint;
|
||||||
|
```
|
||||||
|
|
||||||
|
***
|
||||||
|
|
||||||
|
### numUpdatedRows
|
||||||
|
|
||||||
|
```ts
|
||||||
|
numUpdatedRows: bigint;
|
||||||
|
```
|
||||||
@@ -24,10 +24,10 @@ The default is 7 days
|
|||||||
// Delete all versions older than 1 day
|
// Delete all versions older than 1 day
|
||||||
const olderThan = new Date();
|
const olderThan = new Date();
|
||||||
olderThan.setDate(olderThan.getDate() - 1));
|
olderThan.setDate(olderThan.getDate() - 1));
|
||||||
tbl.optimize({cleanupOlderThan: olderThan});
|
tbl.cleanupOlderVersions(olderThan);
|
||||||
|
|
||||||
// Delete all versions except the current version
|
// Delete all versions except the current version
|
||||||
tbl.optimize({cleanupOlderThan: new Date()});
|
tbl.cleanupOlderVersions(new Date());
|
||||||
```
|
```
|
||||||
|
|
||||||
***
|
***
|
||||||
|
|||||||
@@ -1,23 +0,0 @@
|
|||||||
[**@lancedb/lancedb**](../README.md) • **Docs**
|
|
||||||
|
|
||||||
***
|
|
||||||
|
|
||||||
[@lancedb/lancedb](../globals.md) / UpdateResult
|
|
||||||
|
|
||||||
# Interface: UpdateResult
|
|
||||||
|
|
||||||
## Properties
|
|
||||||
|
|
||||||
### rowsUpdated
|
|
||||||
|
|
||||||
```ts
|
|
||||||
rowsUpdated: number;
|
|
||||||
```
|
|
||||||
|
|
||||||
***
|
|
||||||
|
|
||||||
### version
|
|
||||||
|
|
||||||
```ts
|
|
||||||
version: number;
|
|
||||||
```
|
|
||||||
@@ -1,26 +0,0 @@
|
|||||||
[**@lancedb/lancedb**](../README.md) • **Docs**
|
|
||||||
|
|
||||||
***
|
|
||||||
|
|
||||||
[@lancedb/lancedb](../globals.md) / WriteExecutionOptions
|
|
||||||
|
|
||||||
# Interface: WriteExecutionOptions
|
|
||||||
|
|
||||||
## Properties
|
|
||||||
|
|
||||||
### timeoutMs?
|
|
||||||
|
|
||||||
```ts
|
|
||||||
optional timeoutMs: number;
|
|
||||||
```
|
|
||||||
|
|
||||||
Maximum time to run the operation before cancelling it.
|
|
||||||
|
|
||||||
By default, there is a 30-second timeout that is only enforced after the
|
|
||||||
first attempt. This is to prevent spending too long retrying to resolve
|
|
||||||
conflicts. For example, if a write attempt takes 20 seconds and fails,
|
|
||||||
the second attempt will be cancelled after 10 seconds, hitting the
|
|
||||||
30-second timeout. However, a write that takes one hour and succeeds on the
|
|
||||||
first attempt will not be cancelled.
|
|
||||||
|
|
||||||
When this is set, the timeout is enforced on all attempts, including the first.
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
[**@lancedb/lancedb**](../README.md) • **Docs**
|
|
||||||
|
|
||||||
***
|
|
||||||
|
|
||||||
[@lancedb/lancedb](../globals.md) / MultiVector
|
|
||||||
|
|
||||||
# Type Alias: MultiVector
|
|
||||||
|
|
||||||
```ts
|
|
||||||
type MultiVector: IntoVector[];
|
|
||||||
```
|
|
||||||
@@ -428,7 +428,7 @@
|
|||||||
"\n",
|
"\n",
|
||||||
"**Why?** \n",
|
"**Why?** \n",
|
||||||
"Embedding the UFO dataset and ingesting it into LanceDB takes **~2 hours on a T4 GPU**. To save time: \n",
|
"Embedding the UFO dataset and ingesting it into LanceDB takes **~2 hours on a T4 GPU**. To save time: \n",
|
||||||
"- **Use the pre-prepared table with index created** (provided below) to proceed directly to **Step 7**: search. \n",
|
"- **Use the pre-prepared table with index created ** (provided below) to proceed directly to step7: search. \n",
|
||||||
"- **Step 5a** contains the full ingestion code for reference (run it only if necessary). \n",
|
"- **Step 5a** contains the full ingestion code for reference (run it only if necessary). \n",
|
||||||
"- **Step 6** contains the details on creating the index on the multivector column"
|
"- **Step 6** contains the details on creating the index on the multivector column"
|
||||||
]
|
]
|
||||||
|
|||||||
@@ -1,53 +0,0 @@
|
|||||||
# Apache Datafusion
|
|
||||||
|
|
||||||
In Python, LanceDB tables can also be queried with [Apache Datafusion](https://datafusion.apache.org/), an extensible query engine written in Rust that uses Apache Arrow as its in-memory format. This means you can write complex SQL queries to analyze your data in LanceDB.
|
|
||||||
|
|
||||||
This integration is done via [Datafusion FFI](https://docs.rs/datafusion-ffi/latest/datafusion_ffi/), which provides a native integration between LanceDB and Datafusion.
|
|
||||||
The Datafusion FFI allows to pass down column selections and basic filters to LanceDB, reducing the amount of scanned data when executing your query. Additionally, the integration allows streaming data from LanceDB tables which allows to do aggregation larger-than-memory.
|
|
||||||
|
|
||||||
We can demonstrate this by first installing `datafusion` and `lancedb`.
|
|
||||||
|
|
||||||
```shell
|
|
||||||
pip install datafusion lancedb
|
|
||||||
```
|
|
||||||
|
|
||||||
We will re-use the dataset [created previously](./pandas_and_pyarrow.md):
|
|
||||||
|
|
||||||
```python
|
|
||||||
import lancedb
|
|
||||||
|
|
||||||
from datafusion import SessionContext
|
|
||||||
from lance import FFILanceTableProvider
|
|
||||||
|
|
||||||
db = lancedb.connect("data/sample-lancedb")
|
|
||||||
data = [
|
|
||||||
{"vector": [3.1, 4.1], "item": "foo", "price": 10.0},
|
|
||||||
{"vector": [5.9, 26.5], "item": "bar", "price": 20.0}
|
|
||||||
]
|
|
||||||
lance_table = db.create_table("lance_table", data)
|
|
||||||
|
|
||||||
ctx = SessionContext()
|
|
||||||
|
|
||||||
ffi_lance_table = FFILanceTableProvider(
|
|
||||||
lance_table.to_lance(), with_row_id=True, with_row_addr=True
|
|
||||||
)
|
|
||||||
ctx.register_table_provider("ffi_lance_table", ffi_lance_table)
|
|
||||||
```
|
|
||||||
|
|
||||||
The `to_lance` method converts the LanceDB table to a `LanceDataset`, which is accessible to Datafusion through the Datafusion FFI integration layer.
|
|
||||||
To query the resulting Lance dataset in Datafusion, you first need to register the dataset with Datafusion and then just reference it by the same name in your SQL query.
|
|
||||||
|
|
||||||
```python
|
|
||||||
ctx.table("ffi_lance_table")
|
|
||||||
ctx.sql("SELECT * FROM ffi_lance_table")
|
|
||||||
```
|
|
||||||
|
|
||||||
```
|
|
||||||
┌─────────────┬─────────┬────────┬─────────────────┬─────────────────┐
|
|
||||||
│ vector │ item │ price │ _rowid │ _rowaddr │
|
|
||||||
│ float[] │ varchar │ double │ bigint unsigned │ bigint unsigned │
|
|
||||||
├─────────────┼─────────┼────────┼─────────────────┼─────────────────┤
|
|
||||||
│ [3.1, 4.1] │ foo │ 10.0 │ 0 │ 0 │
|
|
||||||
│ [5.9, 26.5] │ bar │ 20.0 │ 1 │ 1 │
|
|
||||||
└─────────────┴─────────┴────────┴─────────────────┴─────────────────┘
|
|
||||||
```
|
|
||||||
101
docs/src/quickstart.md
Normal file
101
docs/src/quickstart.md
Normal file
@@ -0,0 +1,101 @@
|
|||||||
|
|
||||||
|
# Getting Started with LanceDB: A Minimal Vector Search Tutorial
|
||||||
|
|
||||||
|
Let's set up a LanceDB database, insert vector data, and perform a simple vector search. We'll use simple character classes like "knight" and "rogue" to illustrate semantic relevance.
|
||||||
|
|
||||||
|
## 1. Install Dependencies
|
||||||
|
|
||||||
|
Before starting, make sure you have the necessary packages:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
pip install lancedb pandas numpy
|
||||||
|
```
|
||||||
|
|
||||||
|
## 2. Import Required Libraries
|
||||||
|
|
||||||
|
```python
|
||||||
|
import lancedb
|
||||||
|
import pandas as pd
|
||||||
|
import numpy as np
|
||||||
|
```
|
||||||
|
|
||||||
|
## 3. Connect to LanceDB
|
||||||
|
|
||||||
|
You can use a local directory to store your database:
|
||||||
|
|
||||||
|
```python
|
||||||
|
db = lancedb.connect("./lancedb")
|
||||||
|
```
|
||||||
|
|
||||||
|
## 4. Create Sample Data
|
||||||
|
|
||||||
|
Add sample text data and corresponding 4D vectors:
|
||||||
|
|
||||||
|
```python
|
||||||
|
data = pd.DataFrame([
|
||||||
|
{"id": "1", "vector": [1.0, 0.0, 0.0, 0.0], "text": "knight"},
|
||||||
|
{"id": "2", "vector": [0.9, 0.1, 0.0, 0.0], "text": "warrior"},
|
||||||
|
{"id": "3", "vector": [0.0, 1.0, 0.0, 0.0], "text": "rogue"},
|
||||||
|
{"id": "4", "vector": [0.0, 0.9, 0.1, 0.0], "text": "thief"},
|
||||||
|
{"id": "5", "vector": [0.5, 0.5, 0.0, 0.0], "text": "ranger"},
|
||||||
|
])
|
||||||
|
```
|
||||||
|
|
||||||
|
## 5. Create a Table in LanceDB
|
||||||
|
|
||||||
|
```python
|
||||||
|
table = db.create_table("rpg_classes", data=data, mode="overwrite")
|
||||||
|
```
|
||||||
|
|
||||||
|
Let's see how the table looks:
|
||||||
|
```python
|
||||||
|
print(data)
|
||||||
|
```
|
||||||
|
|
||||||
|
| id | vector | text |
|
||||||
|
|----|--------|------|
|
||||||
|
| 1 | [1.0, 0.0, 0.0, 0.0] | knight |
|
||||||
|
| 2 | [0.9, 0.1, 0.0, 0.0] | warrior |
|
||||||
|
| 3 | [0.0, 1.0, 0.0, 0.0] | rogue |
|
||||||
|
| 4 | [0.0, 0.9, 0.1, 0.0] | thief |
|
||||||
|
| 5 | [0.5, 0.5, 0.0, 0.0] | ranger |
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## 6. Perform a Vector Search
|
||||||
|
|
||||||
|
Search for the most similar character classes to our query vector:
|
||||||
|
|
||||||
|
```python
|
||||||
|
# Query as if we are searching for "rogue"
|
||||||
|
results = table.search([0.95, 0.05, 0.0, 0.0]).limit(3).to_df()
|
||||||
|
print(results)
|
||||||
|
```
|
||||||
|
|
||||||
|
This will return the top 3 closest classes to the vector, effectively showing how LanceDB can be used for semantic search.
|
||||||
|
|
||||||
|
| id | vector | text | _distance |
|
||||||
|
|------|------------------------|----------|-----------|
|
||||||
|
| 3 | [0.0, 1.0, 0.0, 0.0] | rogue | 0.00 |
|
||||||
|
| 4 | [0.0, 0.9, 0.1, 0.0] | thief | 0.02 |
|
||||||
|
| 5 | [0.5, 0.5, 0.0, 0.0] | ranger | 0.50 |
|
||||||
|
|
||||||
|
Let's try searching for "knight"
|
||||||
|
|
||||||
|
```python
|
||||||
|
query_vector = [1.0, 0.0, 0.0, 0.0]
|
||||||
|
results = table.search(query_vector).limit(3).to_pandas()
|
||||||
|
print(results)
|
||||||
|
```
|
||||||
|
|
||||||
|
| id | vector | text | _distance |
|
||||||
|
|------|------------------------|----------|-----------|
|
||||||
|
| 1 | [1.0, 0.0, 0.0, 0.0] | knight | 0.00 |
|
||||||
|
| 2 | [0.9, 0.1, 0.0, 0.0] | warrior | 0.02 |
|
||||||
|
| 5 | [0.5, 0.5, 0.0, 0.0] | ranger | 0.50 |
|
||||||
|
|
||||||
|
## Next Steps
|
||||||
|
|
||||||
|
That's it - you just conducted vector search!
|
||||||
|
|
||||||
|
For more beginner tips, check out the [Basic Usage](basic.md) guide.
|
||||||
@@ -30,8 +30,7 @@ excluded_globs = [
|
|||||||
"../src/rag/advanced_techniques/*.md",
|
"../src/rag/advanced_techniques/*.md",
|
||||||
"../src/guides/scalar_index.md",
|
"../src/guides/scalar_index.md",
|
||||||
"../src/guides/storage.md",
|
"../src/guides/storage.md",
|
||||||
"../src/search.md",
|
"../src/search.md"
|
||||||
"../src/guides/sql_querying.md",
|
|
||||||
]
|
]
|
||||||
|
|
||||||
python_prefix = "py"
|
python_prefix = "py"
|
||||||
|
|||||||
@@ -7,4 +7,3 @@ tantivy==0.20.1
|
|||||||
--extra-index-url https://download.pytorch.org/whl/cpu
|
--extra-index-url https://download.pytorch.org/whl/cpu
|
||||||
torch
|
torch
|
||||||
polars>=0.19, <=1.3.0
|
polars>=0.19, <=1.3.0
|
||||||
datafusion
|
|
||||||
|
|||||||
19
java/.mvn/wrapper/maven-wrapper.properties
vendored
19
java/.mvn/wrapper/maven-wrapper.properties
vendored
@@ -1,19 +0,0 @@
|
|||||||
# Licensed to the Apache Software Foundation (ASF) under one
|
|
||||||
# or more contributor license agreements. See the NOTICE file
|
|
||||||
# distributed with this work for additional information
|
|
||||||
# regarding copyright ownership. The ASF licenses this file
|
|
||||||
# to you under the Apache License, Version 2.0 (the
|
|
||||||
# "License"); you may not use this file except in compliance
|
|
||||||
# with the License. You may obtain a copy of the License at
|
|
||||||
#
|
|
||||||
# http://www.apache.org/licenses/LICENSE-2.0
|
|
||||||
#
|
|
||||||
# Unless required by applicable law or agreed to in writing,
|
|
||||||
# software distributed under the License is distributed on an
|
|
||||||
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
|
||||||
# KIND, either express or implied. See the License for the
|
|
||||||
# specific language governing permissions and limitations
|
|
||||||
# under the License.
|
|
||||||
wrapperVersion=3.3.2
|
|
||||||
distributionType=only-script
|
|
||||||
distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.9/apache-maven-3.9.9-bin.zip
|
|
||||||
@@ -1,37 +0,0 @@
|
|||||||
# LanceDB Java SDK
|
|
||||||
|
|
||||||
## Configuration and Initialization
|
|
||||||
|
|
||||||
### LanceDB Cloud
|
|
||||||
|
|
||||||
For LanceDB Cloud, use the simplified builder API:
|
|
||||||
|
|
||||||
```java
|
|
||||||
import com.lancedb.lance.namespace.LanceRestNamespace;
|
|
||||||
|
|
||||||
// If your DB url is db://example-db, then your database here is example-db
|
|
||||||
LanceRestNamespace namespace = LanceDBRestNamespaces.builder()
|
|
||||||
.apiKey("your_lancedb_cloud_api_key")
|
|
||||||
.database("your_database_name")
|
|
||||||
.build();
|
|
||||||
```
|
|
||||||
|
|
||||||
### LanceDB Enterprise
|
|
||||||
|
|
||||||
For Enterprise deployments, use your VPC endpoint:
|
|
||||||
|
|
||||||
```java
|
|
||||||
LanceRestNamespace namespace = LanceDBRestNamespaces.builder()
|
|
||||||
.apiKey("your_lancedb_enterprise_api_key")
|
|
||||||
.database("your-top-dir") // Your top level folder under your cloud bucket, e.g. s3://your-bucket/your-top-dir/
|
|
||||||
.hostOverride("http://<vpc_endpoint_dns_name>:80")
|
|
||||||
.build();
|
|
||||||
```
|
|
||||||
|
|
||||||
## Development
|
|
||||||
|
|
||||||
Build:
|
|
||||||
|
|
||||||
```shell
|
|
||||||
./mvnw install
|
|
||||||
```
|
|
||||||
@@ -8,24 +8,18 @@
|
|||||||
<parent>
|
<parent>
|
||||||
<groupId>com.lancedb</groupId>
|
<groupId>com.lancedb</groupId>
|
||||||
<artifactId>lancedb-parent</artifactId>
|
<artifactId>lancedb-parent</artifactId>
|
||||||
<version>0.21.2-beta.0</version>
|
<version>0.19.1-beta.1</version>
|
||||||
<relativePath>../pom.xml</relativePath>
|
<relativePath>../pom.xml</relativePath>
|
||||||
</parent>
|
</parent>
|
||||||
|
|
||||||
<artifactId>lancedb-core</artifactId>
|
<artifactId>lancedb-core</artifactId>
|
||||||
<name>${project.artifactId}</name>
|
<name>LanceDB Core</name>
|
||||||
<description>LanceDB Core</description>
|
|
||||||
<packaging>jar</packaging>
|
<packaging>jar</packaging>
|
||||||
<properties>
|
<properties>
|
||||||
<rust.release.build>false</rust.release.build>
|
<rust.release.build>false</rust.release.build>
|
||||||
</properties>
|
</properties>
|
||||||
|
|
||||||
<dependencies>
|
<dependencies>
|
||||||
<dependency>
|
|
||||||
<groupId>com.lancedb</groupId>
|
|
||||||
<artifactId>lance-namespace-core</artifactId>
|
|
||||||
<version>0.0.1</version>
|
|
||||||
</dependency>
|
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>org.apache.arrow</groupId>
|
<groupId>org.apache.arrow</groupId>
|
||||||
<artifactId>arrow-vector</artifactId>
|
<artifactId>arrow-vector</artifactId>
|
||||||
|
|||||||
@@ -1,26 +0,0 @@
|
|||||||
<?xml version="1.0" encoding="UTF-8"?>
|
|
||||||
|
|
||||||
<project xmlns="http://maven.apache.org/POM/4.0.0"
|
|
||||||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
|
||||||
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
|
|
||||||
<modelVersion>4.0.0</modelVersion>
|
|
||||||
|
|
||||||
<parent>
|
|
||||||
<groupId>com.lancedb</groupId>
|
|
||||||
<artifactId>lancedb-parent</artifactId>
|
|
||||||
<version>0.21.2-beta.0</version>
|
|
||||||
<relativePath>../pom.xml</relativePath>
|
|
||||||
</parent>
|
|
||||||
|
|
||||||
<artifactId>lancedb-lance-namespace</artifactId>
|
|
||||||
<name>${project.artifactId}</name>
|
|
||||||
<description>LanceDB Java Integration with Lance Namespace</description>
|
|
||||||
<packaging>jar</packaging>
|
|
||||||
|
|
||||||
<dependencies>
|
|
||||||
<dependency>
|
|
||||||
<groupId>com.lancedb</groupId>
|
|
||||||
<artifactId>lance-namespace-core</artifactId>
|
|
||||||
</dependency>
|
|
||||||
</dependencies>
|
|
||||||
</project>
|
|
||||||
@@ -1,146 +0,0 @@
|
|||||||
/*
|
|
||||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
||||||
* you may not use this file except in compliance with the License.
|
|
||||||
* You may obtain a copy of the License at
|
|
||||||
*
|
|
||||||
* http://www.apache.org/licenses/LICENSE-2.0
|
|
||||||
*
|
|
||||||
* Unless required by applicable law or agreed to in writing, software
|
|
||||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
||||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
||||||
* See the License for the specific language governing permissions and
|
|
||||||
* limitations under the License.
|
|
||||||
*/
|
|
||||||
package com.lancedb.lancedb;
|
|
||||||
|
|
||||||
import com.lancedb.lance.namespace.LanceRestNamespace;
|
|
||||||
import com.lancedb.lance.namespace.client.apache.ApiClient;
|
|
||||||
|
|
||||||
import java.util.HashMap;
|
|
||||||
import java.util.Map;
|
|
||||||
import java.util.Optional;
|
|
||||||
|
|
||||||
/** Util class to help construct a {@link LanceRestNamespace} for LanceDB. */
|
|
||||||
public class LanceDbRestNamespaces {
|
|
||||||
private static final String DEFAULT_REGION = "us-east-1";
|
|
||||||
private static final String CLOUD_URL_PATTERN = "https://%s.%s.api.lancedb.com";
|
|
||||||
|
|
||||||
private String apiKey;
|
|
||||||
private String database;
|
|
||||||
private Optional<String> hostOverride = Optional.empty();
|
|
||||||
private Optional<String> region = Optional.empty();
|
|
||||||
private Map<String, String> additionalConfig = new HashMap<>();
|
|
||||||
|
|
||||||
private LanceDbRestNamespaces() {}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Create a new builder instance.
|
|
||||||
*
|
|
||||||
* @return A new LanceRestNamespaceBuilder
|
|
||||||
*/
|
|
||||||
public static LanceDbRestNamespaces builder() {
|
|
||||||
return new LanceDbRestNamespaces();
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Set the API key (required).
|
|
||||||
*
|
|
||||||
* @param apiKey The LanceDB API key
|
|
||||||
* @return This builder
|
|
||||||
*/
|
|
||||||
public LanceDbRestNamespaces apiKey(String apiKey) {
|
|
||||||
if (apiKey == null || apiKey.trim().isEmpty()) {
|
|
||||||
throw new IllegalArgumentException("API key cannot be null or empty");
|
|
||||||
}
|
|
||||||
this.apiKey = apiKey;
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Set the database name (required).
|
|
||||||
*
|
|
||||||
* @param database The database name
|
|
||||||
* @return This builder
|
|
||||||
*/
|
|
||||||
public LanceDbRestNamespaces database(String database) {
|
|
||||||
if (database == null || database.trim().isEmpty()) {
|
|
||||||
throw new IllegalArgumentException("Database cannot be null or empty");
|
|
||||||
}
|
|
||||||
this.database = database;
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Set a custom host override (optional). When set, this overrides the default LanceDB Cloud URL
|
|
||||||
* construction. Use this for LanceDB Enterprise deployments.
|
|
||||||
*
|
|
||||||
* @param hostOverride The complete base URL (e.g., "http://your-vpc-endpoint:80")
|
|
||||||
* @return This builder
|
|
||||||
*/
|
|
||||||
public LanceDbRestNamespaces hostOverride(String hostOverride) {
|
|
||||||
this.hostOverride = Optional.ofNullable(hostOverride);
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Set the region for LanceDB Cloud (optional). Defaults to "us-east-1" if not specified. This is
|
|
||||||
* ignored when hostOverride is set.
|
|
||||||
*
|
|
||||||
* @param region The AWS region (e.g., "us-east-1", "eu-west-1")
|
|
||||||
* @return This builder
|
|
||||||
*/
|
|
||||||
public LanceDbRestNamespaces region(String region) {
|
|
||||||
this.region = Optional.ofNullable(region);
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Add additional configuration parameters.
|
|
||||||
*
|
|
||||||
* @param key The configuration key
|
|
||||||
* @param value The configuration value
|
|
||||||
* @return This builder
|
|
||||||
*/
|
|
||||||
public LanceDbRestNamespaces config(String key, String value) {
|
|
||||||
this.additionalConfig.put(key, value);
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Build the LanceRestNamespace instance.
|
|
||||||
*
|
|
||||||
* @return A configured LanceRestNamespace
|
|
||||||
* @throws IllegalStateException if required parameters are missing
|
|
||||||
*/
|
|
||||||
public LanceRestNamespace build() {
|
|
||||||
// Validate required fields
|
|
||||||
if (apiKey == null) {
|
|
||||||
throw new IllegalStateException("API key is required");
|
|
||||||
}
|
|
||||||
if (database == null) {
|
|
||||||
throw new IllegalStateException("Database is required");
|
|
||||||
}
|
|
||||||
|
|
||||||
// Build configuration map
|
|
||||||
Map<String, String> config = new HashMap<>(additionalConfig);
|
|
||||||
config.put("headers.x-lancedb-database", database);
|
|
||||||
config.put("headers.x-api-key", apiKey);
|
|
||||||
|
|
||||||
// Determine base URL
|
|
||||||
String baseUrl;
|
|
||||||
if (hostOverride.isPresent()) {
|
|
||||||
baseUrl = hostOverride.get();
|
|
||||||
config.put("host_override", hostOverride.get());
|
|
||||||
} else {
|
|
||||||
String effectiveRegion = region.orElse(DEFAULT_REGION);
|
|
||||||
baseUrl = String.format(CLOUD_URL_PATTERN, database, effectiveRegion);
|
|
||||||
config.put("region", effectiveRegion);
|
|
||||||
}
|
|
||||||
|
|
||||||
// Create and configure ApiClient
|
|
||||||
ApiClient apiClient = new ApiClient();
|
|
||||||
apiClient.setBasePath(baseUrl);
|
|
||||||
|
|
||||||
return new LanceRestNamespace(apiClient, config);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
259
java/mvnw
vendored
259
java/mvnw
vendored
@@ -1,259 +0,0 @@
|
|||||||
#!/bin/sh
|
|
||||||
# ----------------------------------------------------------------------------
|
|
||||||
# Licensed to the Apache Software Foundation (ASF) under one
|
|
||||||
# or more contributor license agreements. See the NOTICE file
|
|
||||||
# distributed with this work for additional information
|
|
||||||
# regarding copyright ownership. The ASF licenses this file
|
|
||||||
# to you under the Apache License, Version 2.0 (the
|
|
||||||
# "License"); you may not use this file except in compliance
|
|
||||||
# with the License. You may obtain a copy of the License at
|
|
||||||
#
|
|
||||||
# http://www.apache.org/licenses/LICENSE-2.0
|
|
||||||
#
|
|
||||||
# Unless required by applicable law or agreed to in writing,
|
|
||||||
# software distributed under the License is distributed on an
|
|
||||||
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
|
||||||
# KIND, either express or implied. See the License for the
|
|
||||||
# specific language governing permissions and limitations
|
|
||||||
# under the License.
|
|
||||||
# ----------------------------------------------------------------------------
|
|
||||||
|
|
||||||
# ----------------------------------------------------------------------------
|
|
||||||
# Apache Maven Wrapper startup batch script, version 3.3.2
|
|
||||||
#
|
|
||||||
# Optional ENV vars
|
|
||||||
# -----------------
|
|
||||||
# JAVA_HOME - location of a JDK home dir, required when download maven via java source
|
|
||||||
# MVNW_REPOURL - repo url base for downloading maven distribution
|
|
||||||
# MVNW_USERNAME/MVNW_PASSWORD - user and password for downloading maven
|
|
||||||
# MVNW_VERBOSE - true: enable verbose log; debug: trace the mvnw script; others: silence the output
|
|
||||||
# ----------------------------------------------------------------------------
|
|
||||||
|
|
||||||
set -euf
|
|
||||||
[ "${MVNW_VERBOSE-}" != debug ] || set -x
|
|
||||||
|
|
||||||
# OS specific support.
|
|
||||||
native_path() { printf %s\\n "$1"; }
|
|
||||||
case "$(uname)" in
|
|
||||||
CYGWIN* | MINGW*)
|
|
||||||
[ -z "${JAVA_HOME-}" ] || JAVA_HOME="$(cygpath --unix "$JAVA_HOME")"
|
|
||||||
native_path() { cygpath --path --windows "$1"; }
|
|
||||||
;;
|
|
||||||
esac
|
|
||||||
|
|
||||||
# set JAVACMD and JAVACCMD
|
|
||||||
set_java_home() {
|
|
||||||
# For Cygwin and MinGW, ensure paths are in Unix format before anything is touched
|
|
||||||
if [ -n "${JAVA_HOME-}" ]; then
|
|
||||||
if [ -x "$JAVA_HOME/jre/sh/java" ]; then
|
|
||||||
# IBM's JDK on AIX uses strange locations for the executables
|
|
||||||
JAVACMD="$JAVA_HOME/jre/sh/java"
|
|
||||||
JAVACCMD="$JAVA_HOME/jre/sh/javac"
|
|
||||||
else
|
|
||||||
JAVACMD="$JAVA_HOME/bin/java"
|
|
||||||
JAVACCMD="$JAVA_HOME/bin/javac"
|
|
||||||
|
|
||||||
if [ ! -x "$JAVACMD" ] || [ ! -x "$JAVACCMD" ]; then
|
|
||||||
echo "The JAVA_HOME environment variable is not defined correctly, so mvnw cannot run." >&2
|
|
||||||
echo "JAVA_HOME is set to \"$JAVA_HOME\", but \"\$JAVA_HOME/bin/java\" or \"\$JAVA_HOME/bin/javac\" does not exist." >&2
|
|
||||||
return 1
|
|
||||||
fi
|
|
||||||
fi
|
|
||||||
else
|
|
||||||
JAVACMD="$(
|
|
||||||
'set' +e
|
|
||||||
'unset' -f command 2>/dev/null
|
|
||||||
'command' -v java
|
|
||||||
)" || :
|
|
||||||
JAVACCMD="$(
|
|
||||||
'set' +e
|
|
||||||
'unset' -f command 2>/dev/null
|
|
||||||
'command' -v javac
|
|
||||||
)" || :
|
|
||||||
|
|
||||||
if [ ! -x "${JAVACMD-}" ] || [ ! -x "${JAVACCMD-}" ]; then
|
|
||||||
echo "The java/javac command does not exist in PATH nor is JAVA_HOME set, so mvnw cannot run." >&2
|
|
||||||
return 1
|
|
||||||
fi
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
# hash string like Java String::hashCode
|
|
||||||
hash_string() {
|
|
||||||
str="${1:-}" h=0
|
|
||||||
while [ -n "$str" ]; do
|
|
||||||
char="${str%"${str#?}"}"
|
|
||||||
h=$(((h * 31 + $(LC_CTYPE=C printf %d "'$char")) % 4294967296))
|
|
||||||
str="${str#?}"
|
|
||||||
done
|
|
||||||
printf %x\\n $h
|
|
||||||
}
|
|
||||||
|
|
||||||
verbose() { :; }
|
|
||||||
[ "${MVNW_VERBOSE-}" != true ] || verbose() { printf %s\\n "${1-}"; }
|
|
||||||
|
|
||||||
die() {
|
|
||||||
printf %s\\n "$1" >&2
|
|
||||||
exit 1
|
|
||||||
}
|
|
||||||
|
|
||||||
trim() {
|
|
||||||
# MWRAPPER-139:
|
|
||||||
# Trims trailing and leading whitespace, carriage returns, tabs, and linefeeds.
|
|
||||||
# Needed for removing poorly interpreted newline sequences when running in more
|
|
||||||
# exotic environments such as mingw bash on Windows.
|
|
||||||
printf "%s" "${1}" | tr -d '[:space:]'
|
|
||||||
}
|
|
||||||
|
|
||||||
# parse distributionUrl and optional distributionSha256Sum, requires .mvn/wrapper/maven-wrapper.properties
|
|
||||||
while IFS="=" read -r key value; do
|
|
||||||
case "${key-}" in
|
|
||||||
distributionUrl) distributionUrl=$(trim "${value-}") ;;
|
|
||||||
distributionSha256Sum) distributionSha256Sum=$(trim "${value-}") ;;
|
|
||||||
esac
|
|
||||||
done <"${0%/*}/.mvn/wrapper/maven-wrapper.properties"
|
|
||||||
[ -n "${distributionUrl-}" ] || die "cannot read distributionUrl property in ${0%/*}/.mvn/wrapper/maven-wrapper.properties"
|
|
||||||
|
|
||||||
case "${distributionUrl##*/}" in
|
|
||||||
maven-mvnd-*bin.*)
|
|
||||||
MVN_CMD=mvnd.sh _MVNW_REPO_PATTERN=/maven/mvnd/
|
|
||||||
case "${PROCESSOR_ARCHITECTURE-}${PROCESSOR_ARCHITEW6432-}:$(uname -a)" in
|
|
||||||
*AMD64:CYGWIN* | *AMD64:MINGW*) distributionPlatform=windows-amd64 ;;
|
|
||||||
:Darwin*x86_64) distributionPlatform=darwin-amd64 ;;
|
|
||||||
:Darwin*arm64) distributionPlatform=darwin-aarch64 ;;
|
|
||||||
:Linux*x86_64*) distributionPlatform=linux-amd64 ;;
|
|
||||||
*)
|
|
||||||
echo "Cannot detect native platform for mvnd on $(uname)-$(uname -m), use pure java version" >&2
|
|
||||||
distributionPlatform=linux-amd64
|
|
||||||
;;
|
|
||||||
esac
|
|
||||||
distributionUrl="${distributionUrl%-bin.*}-$distributionPlatform.zip"
|
|
||||||
;;
|
|
||||||
maven-mvnd-*) MVN_CMD=mvnd.sh _MVNW_REPO_PATTERN=/maven/mvnd/ ;;
|
|
||||||
*) MVN_CMD="mvn${0##*/mvnw}" _MVNW_REPO_PATTERN=/org/apache/maven/ ;;
|
|
||||||
esac
|
|
||||||
|
|
||||||
# apply MVNW_REPOURL and calculate MAVEN_HOME
|
|
||||||
# maven home pattern: ~/.m2/wrapper/dists/{apache-maven-<version>,maven-mvnd-<version>-<platform>}/<hash>
|
|
||||||
[ -z "${MVNW_REPOURL-}" ] || distributionUrl="$MVNW_REPOURL$_MVNW_REPO_PATTERN${distributionUrl#*"$_MVNW_REPO_PATTERN"}"
|
|
||||||
distributionUrlName="${distributionUrl##*/}"
|
|
||||||
distributionUrlNameMain="${distributionUrlName%.*}"
|
|
||||||
distributionUrlNameMain="${distributionUrlNameMain%-bin}"
|
|
||||||
MAVEN_USER_HOME="${MAVEN_USER_HOME:-${HOME}/.m2}"
|
|
||||||
MAVEN_HOME="${MAVEN_USER_HOME}/wrapper/dists/${distributionUrlNameMain-}/$(hash_string "$distributionUrl")"
|
|
||||||
|
|
||||||
exec_maven() {
|
|
||||||
unset MVNW_VERBOSE MVNW_USERNAME MVNW_PASSWORD MVNW_REPOURL || :
|
|
||||||
exec "$MAVEN_HOME/bin/$MVN_CMD" "$@" || die "cannot exec $MAVEN_HOME/bin/$MVN_CMD"
|
|
||||||
}
|
|
||||||
|
|
||||||
if [ -d "$MAVEN_HOME" ]; then
|
|
||||||
verbose "found existing MAVEN_HOME at $MAVEN_HOME"
|
|
||||||
exec_maven "$@"
|
|
||||||
fi
|
|
||||||
|
|
||||||
case "${distributionUrl-}" in
|
|
||||||
*?-bin.zip | *?maven-mvnd-?*-?*.zip) ;;
|
|
||||||
*) die "distributionUrl is not valid, must match *-bin.zip or maven-mvnd-*.zip, but found '${distributionUrl-}'" ;;
|
|
||||||
esac
|
|
||||||
|
|
||||||
# prepare tmp dir
|
|
||||||
if TMP_DOWNLOAD_DIR="$(mktemp -d)" && [ -d "$TMP_DOWNLOAD_DIR" ]; then
|
|
||||||
clean() { rm -rf -- "$TMP_DOWNLOAD_DIR"; }
|
|
||||||
trap clean HUP INT TERM EXIT
|
|
||||||
else
|
|
||||||
die "cannot create temp dir"
|
|
||||||
fi
|
|
||||||
|
|
||||||
mkdir -p -- "${MAVEN_HOME%/*}"
|
|
||||||
|
|
||||||
# Download and Install Apache Maven
|
|
||||||
verbose "Couldn't find MAVEN_HOME, downloading and installing it ..."
|
|
||||||
verbose "Downloading from: $distributionUrl"
|
|
||||||
verbose "Downloading to: $TMP_DOWNLOAD_DIR/$distributionUrlName"
|
|
||||||
|
|
||||||
# select .zip or .tar.gz
|
|
||||||
if ! command -v unzip >/dev/null; then
|
|
||||||
distributionUrl="${distributionUrl%.zip}.tar.gz"
|
|
||||||
distributionUrlName="${distributionUrl##*/}"
|
|
||||||
fi
|
|
||||||
|
|
||||||
# verbose opt
|
|
||||||
__MVNW_QUIET_WGET=--quiet __MVNW_QUIET_CURL=--silent __MVNW_QUIET_UNZIP=-q __MVNW_QUIET_TAR=''
|
|
||||||
[ "${MVNW_VERBOSE-}" != true ] || __MVNW_QUIET_WGET='' __MVNW_QUIET_CURL='' __MVNW_QUIET_UNZIP='' __MVNW_QUIET_TAR=v
|
|
||||||
|
|
||||||
# normalize http auth
|
|
||||||
case "${MVNW_PASSWORD:+has-password}" in
|
|
||||||
'') MVNW_USERNAME='' MVNW_PASSWORD='' ;;
|
|
||||||
has-password) [ -n "${MVNW_USERNAME-}" ] || MVNW_USERNAME='' MVNW_PASSWORD='' ;;
|
|
||||||
esac
|
|
||||||
|
|
||||||
if [ -z "${MVNW_USERNAME-}" ] && command -v wget >/dev/null; then
|
|
||||||
verbose "Found wget ... using wget"
|
|
||||||
wget ${__MVNW_QUIET_WGET:+"$__MVNW_QUIET_WGET"} "$distributionUrl" -O "$TMP_DOWNLOAD_DIR/$distributionUrlName" || die "wget: Failed to fetch $distributionUrl"
|
|
||||||
elif [ -z "${MVNW_USERNAME-}" ] && command -v curl >/dev/null; then
|
|
||||||
verbose "Found curl ... using curl"
|
|
||||||
curl ${__MVNW_QUIET_CURL:+"$__MVNW_QUIET_CURL"} -f -L -o "$TMP_DOWNLOAD_DIR/$distributionUrlName" "$distributionUrl" || die "curl: Failed to fetch $distributionUrl"
|
|
||||||
elif set_java_home; then
|
|
||||||
verbose "Falling back to use Java to download"
|
|
||||||
javaSource="$TMP_DOWNLOAD_DIR/Downloader.java"
|
|
||||||
targetZip="$TMP_DOWNLOAD_DIR/$distributionUrlName"
|
|
||||||
cat >"$javaSource" <<-END
|
|
||||||
public class Downloader extends java.net.Authenticator
|
|
||||||
{
|
|
||||||
protected java.net.PasswordAuthentication getPasswordAuthentication()
|
|
||||||
{
|
|
||||||
return new java.net.PasswordAuthentication( System.getenv( "MVNW_USERNAME" ), System.getenv( "MVNW_PASSWORD" ).toCharArray() );
|
|
||||||
}
|
|
||||||
public static void main( String[] args ) throws Exception
|
|
||||||
{
|
|
||||||
setDefault( new Downloader() );
|
|
||||||
java.nio.file.Files.copy( java.net.URI.create( args[0] ).toURL().openStream(), java.nio.file.Paths.get( args[1] ).toAbsolutePath().normalize() );
|
|
||||||
}
|
|
||||||
}
|
|
||||||
END
|
|
||||||
# For Cygwin/MinGW, switch paths to Windows format before running javac and java
|
|
||||||
verbose " - Compiling Downloader.java ..."
|
|
||||||
"$(native_path "$JAVACCMD")" "$(native_path "$javaSource")" || die "Failed to compile Downloader.java"
|
|
||||||
verbose " - Running Downloader.java ..."
|
|
||||||
"$(native_path "$JAVACMD")" -cp "$(native_path "$TMP_DOWNLOAD_DIR")" Downloader "$distributionUrl" "$(native_path "$targetZip")"
|
|
||||||
fi
|
|
||||||
|
|
||||||
# If specified, validate the SHA-256 sum of the Maven distribution zip file
|
|
||||||
if [ -n "${distributionSha256Sum-}" ]; then
|
|
||||||
distributionSha256Result=false
|
|
||||||
if [ "$MVN_CMD" = mvnd.sh ]; then
|
|
||||||
echo "Checksum validation is not supported for maven-mvnd." >&2
|
|
||||||
echo "Please disable validation by removing 'distributionSha256Sum' from your maven-wrapper.properties." >&2
|
|
||||||
exit 1
|
|
||||||
elif command -v sha256sum >/dev/null; then
|
|
||||||
if echo "$distributionSha256Sum $TMP_DOWNLOAD_DIR/$distributionUrlName" | sha256sum -c >/dev/null 2>&1; then
|
|
||||||
distributionSha256Result=true
|
|
||||||
fi
|
|
||||||
elif command -v shasum >/dev/null; then
|
|
||||||
if echo "$distributionSha256Sum $TMP_DOWNLOAD_DIR/$distributionUrlName" | shasum -a 256 -c >/dev/null 2>&1; then
|
|
||||||
distributionSha256Result=true
|
|
||||||
fi
|
|
||||||
else
|
|
||||||
echo "Checksum validation was requested but neither 'sha256sum' or 'shasum' are available." >&2
|
|
||||||
echo "Please install either command, or disable validation by removing 'distributionSha256Sum' from your maven-wrapper.properties." >&2
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
if [ $distributionSha256Result = false ]; then
|
|
||||||
echo "Error: Failed to validate Maven distribution SHA-256, your Maven distribution might be compromised." >&2
|
|
||||||
echo "If you updated your Maven version, you need to update the specified distributionSha256Sum property." >&2
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
fi
|
|
||||||
|
|
||||||
# unzip and move
|
|
||||||
if command -v unzip >/dev/null; then
|
|
||||||
unzip ${__MVNW_QUIET_UNZIP:+"$__MVNW_QUIET_UNZIP"} "$TMP_DOWNLOAD_DIR/$distributionUrlName" -d "$TMP_DOWNLOAD_DIR" || die "failed to unzip"
|
|
||||||
else
|
|
||||||
tar xzf${__MVNW_QUIET_TAR:+"$__MVNW_QUIET_TAR"} "$TMP_DOWNLOAD_DIR/$distributionUrlName" -C "$TMP_DOWNLOAD_DIR" || die "failed to untar"
|
|
||||||
fi
|
|
||||||
printf %s\\n "$distributionUrl" >"$TMP_DOWNLOAD_DIR/$distributionUrlNameMain/mvnw.url"
|
|
||||||
mv -- "$TMP_DOWNLOAD_DIR/$distributionUrlNameMain" "$MAVEN_HOME" || [ -d "$MAVEN_HOME" ] || die "fail to move MAVEN_HOME"
|
|
||||||
|
|
||||||
clean || :
|
|
||||||
exec_maven "$@"
|
|
||||||
14
java/pom.xml
14
java/pom.xml
@@ -6,10 +6,11 @@
|
|||||||
|
|
||||||
<groupId>com.lancedb</groupId>
|
<groupId>com.lancedb</groupId>
|
||||||
<artifactId>lancedb-parent</artifactId>
|
<artifactId>lancedb-parent</artifactId>
|
||||||
<version>0.21.2-beta.0</version>
|
<version>0.19.1-beta.1</version>
|
||||||
<packaging>pom</packaging>
|
<packaging>pom</packaging>
|
||||||
<name>${project.artifactId}</name>
|
|
||||||
<description>LanceDB Java SDK Parent POM</description>
|
<name>LanceDB Parent</name>
|
||||||
|
<description>LanceDB vector database Java API</description>
|
||||||
<url>http://lancedb.com/</url>
|
<url>http://lancedb.com/</url>
|
||||||
|
|
||||||
<developers>
|
<developers>
|
||||||
@@ -28,7 +29,6 @@
|
|||||||
<properties>
|
<properties>
|
||||||
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
|
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
|
||||||
<arrow.version>15.0.0</arrow.version>
|
<arrow.version>15.0.0</arrow.version>
|
||||||
<lance-namespace.verison>0.0.1</lance-namespace.verison>
|
|
||||||
<spotless.skip>false</spotless.skip>
|
<spotless.skip>false</spotless.skip>
|
||||||
<spotless.version>2.30.0</spotless.version>
|
<spotless.version>2.30.0</spotless.version>
|
||||||
<spotless.java.googlejavaformat.version>1.7</spotless.java.googlejavaformat.version>
|
<spotless.java.googlejavaformat.version>1.7</spotless.java.googlejavaformat.version>
|
||||||
@@ -52,7 +52,6 @@
|
|||||||
|
|
||||||
<modules>
|
<modules>
|
||||||
<module>core</module>
|
<module>core</module>
|
||||||
<module>lance-namespace</module>
|
|
||||||
</modules>
|
</modules>
|
||||||
|
|
||||||
<scm>
|
<scm>
|
||||||
@@ -63,11 +62,6 @@
|
|||||||
|
|
||||||
<dependencyManagement>
|
<dependencyManagement>
|
||||||
<dependencies>
|
<dependencies>
|
||||||
<dependency>
|
|
||||||
<groupId>com.lancedb</groupId>
|
|
||||||
<artifactId>lance-namespace-core</artifactId>
|
|
||||||
<version>${lance-namespace.verison}</version>
|
|
||||||
</dependency>
|
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>org.apache.arrow</groupId>
|
<groupId>org.apache.arrow</groupId>
|
||||||
<artifactId>arrow-vector</artifactId>
|
<artifactId>arrow-vector</artifactId>
|
||||||
|
|||||||
44
node/package-lock.json
generated
44
node/package-lock.json
generated
@@ -1,12 +1,12 @@
|
|||||||
{
|
{
|
||||||
"name": "vectordb",
|
"name": "vectordb",
|
||||||
"version": "0.21.2-beta.0",
|
"version": "0.19.1-beta.1",
|
||||||
"lockfileVersion": 3,
|
"lockfileVersion": 3,
|
||||||
"requires": true,
|
"requires": true,
|
||||||
"packages": {
|
"packages": {
|
||||||
"": {
|
"": {
|
||||||
"name": "vectordb",
|
"name": "vectordb",
|
||||||
"version": "0.21.2-beta.0",
|
"version": "0.19.1-beta.1",
|
||||||
"cpu": [
|
"cpu": [
|
||||||
"x64",
|
"x64",
|
||||||
"arm64"
|
"arm64"
|
||||||
@@ -52,11 +52,11 @@
|
|||||||
"uuid": "^9.0.0"
|
"uuid": "^9.0.0"
|
||||||
},
|
},
|
||||||
"optionalDependencies": {
|
"optionalDependencies": {
|
||||||
"@lancedb/vectordb-darwin-arm64": "0.21.2-beta.0",
|
"@lancedb/vectordb-darwin-arm64": "0.19.1-beta.1",
|
||||||
"@lancedb/vectordb-darwin-x64": "0.21.2-beta.0",
|
"@lancedb/vectordb-darwin-x64": "0.19.1-beta.1",
|
||||||
"@lancedb/vectordb-linux-arm64-gnu": "0.21.2-beta.0",
|
"@lancedb/vectordb-linux-arm64-gnu": "0.19.1-beta.1",
|
||||||
"@lancedb/vectordb-linux-x64-gnu": "0.21.2-beta.0",
|
"@lancedb/vectordb-linux-x64-gnu": "0.19.1-beta.1",
|
||||||
"@lancedb/vectordb-win32-x64-msvc": "0.21.2-beta.0"
|
"@lancedb/vectordb-win32-x64-msvc": "0.19.1-beta.1"
|
||||||
},
|
},
|
||||||
"peerDependencies": {
|
"peerDependencies": {
|
||||||
"@apache-arrow/ts": "^14.0.2",
|
"@apache-arrow/ts": "^14.0.2",
|
||||||
@@ -327,9 +327,9 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
"node_modules/@lancedb/vectordb-darwin-arm64": {
|
"node_modules/@lancedb/vectordb-darwin-arm64": {
|
||||||
"version": "0.21.2-beta.0",
|
"version": "0.19.1-beta.1",
|
||||||
"resolved": "https://registry.npmjs.org/@lancedb/vectordb-darwin-arm64/-/vectordb-darwin-arm64-0.21.2-beta.0.tgz",
|
"resolved": "https://registry.npmjs.org/@lancedb/vectordb-darwin-arm64/-/vectordb-darwin-arm64-0.19.1-beta.1.tgz",
|
||||||
"integrity": "sha512-RiYqpKuq9v8A4wFuHt1iPNFYjWJ1KgGFLJwQO4ajp9Hee84sDHq8mP0ATgMcc24hiaOUQ1lRRTULjGbHn4NIYw==",
|
"integrity": "sha512-Epvel0pF5TM6MtIWQ2KhqezqSSHTL3Wr7a2rGAwz6X/XY23i6DbMPpPs0HyeIDzDrhxNfE3cz3S+SiCA6xpR0g==",
|
||||||
"cpu": [
|
"cpu": [
|
||||||
"arm64"
|
"arm64"
|
||||||
],
|
],
|
||||||
@@ -340,9 +340,9 @@
|
|||||||
]
|
]
|
||||||
},
|
},
|
||||||
"node_modules/@lancedb/vectordb-darwin-x64": {
|
"node_modules/@lancedb/vectordb-darwin-x64": {
|
||||||
"version": "0.21.2-beta.0",
|
"version": "0.19.1-beta.1",
|
||||||
"resolved": "https://registry.npmjs.org/@lancedb/vectordb-darwin-x64/-/vectordb-darwin-x64-0.21.2-beta.0.tgz",
|
"resolved": "https://registry.npmjs.org/@lancedb/vectordb-darwin-x64/-/vectordb-darwin-x64-0.19.1-beta.1.tgz",
|
||||||
"integrity": "sha512-togdP0YIjMYg/hBRMMxW434i5VB789JWU5o3hWrodbX8olEc0Txqw5Dg9CgIOldBIiCti6uTSQiTo6uldZon1w==",
|
"integrity": "sha512-hOiUSlIoISbiXytp46hToi/r6sF5pImAsfbzCsIq8ExDV4TPa8fjbhcIT80vxxOwc2mpSSK4HsVJYod95RSbEQ==",
|
||||||
"cpu": [
|
"cpu": [
|
||||||
"x64"
|
"x64"
|
||||||
],
|
],
|
||||||
@@ -353,9 +353,9 @@
|
|||||||
]
|
]
|
||||||
},
|
},
|
||||||
"node_modules/@lancedb/vectordb-linux-arm64-gnu": {
|
"node_modules/@lancedb/vectordb-linux-arm64-gnu": {
|
||||||
"version": "0.21.2-beta.0",
|
"version": "0.19.1-beta.1",
|
||||||
"resolved": "https://registry.npmjs.org/@lancedb/vectordb-linux-arm64-gnu/-/vectordb-linux-arm64-gnu-0.21.2-beta.0.tgz",
|
"resolved": "https://registry.npmjs.org/@lancedb/vectordb-linux-arm64-gnu/-/vectordb-linux-arm64-gnu-0.19.1-beta.1.tgz",
|
||||||
"integrity": "sha512-ErS4IQDQVTYVATPeOj/dZXQR34eZQ5rAXm3vJdQi5K6X4zCDaIjOhpmnwzPBGT9W1idaBAoDJhtNfsFaJ6/PQQ==",
|
"integrity": "sha512-/1JhGVDEngwrlM8o2TNW8G6nJ9U/VgHKAORmj/cTA7O30helJIoo9jfvUAUy+vZ4VoEwRXQbMI+gaYTg0l3MTg==",
|
||||||
"cpu": [
|
"cpu": [
|
||||||
"arm64"
|
"arm64"
|
||||||
],
|
],
|
||||||
@@ -366,9 +366,9 @@
|
|||||||
]
|
]
|
||||||
},
|
},
|
||||||
"node_modules/@lancedb/vectordb-linux-x64-gnu": {
|
"node_modules/@lancedb/vectordb-linux-x64-gnu": {
|
||||||
"version": "0.21.2-beta.0",
|
"version": "0.19.1-beta.1",
|
||||||
"resolved": "https://registry.npmjs.org/@lancedb/vectordb-linux-x64-gnu/-/vectordb-linux-x64-gnu-0.21.2-beta.0.tgz",
|
"resolved": "https://registry.npmjs.org/@lancedb/vectordb-linux-x64-gnu/-/vectordb-linux-x64-gnu-0.19.1-beta.1.tgz",
|
||||||
"integrity": "sha512-ycDpyBGbfxtnGGa/RQo5+So6dHALiem1pbYc/LDKKluUJpadtXtEwC61o6hZTcejoYjhEE8ET7vA3OCEJfMFaw==",
|
"integrity": "sha512-zNRGSSUt8nTJMmll4NdxhQjwxR8Rezq3T4dsRoiDts5ienMam5HFjYiZ3FkDZQo16rgq2BcbFuH1G8u1chywlg==",
|
||||||
"cpu": [
|
"cpu": [
|
||||||
"x64"
|
"x64"
|
||||||
],
|
],
|
||||||
@@ -379,9 +379,9 @@
|
|||||||
]
|
]
|
||||||
},
|
},
|
||||||
"node_modules/@lancedb/vectordb-win32-x64-msvc": {
|
"node_modules/@lancedb/vectordb-win32-x64-msvc": {
|
||||||
"version": "0.21.2-beta.0",
|
"version": "0.19.1-beta.1",
|
||||||
"resolved": "https://registry.npmjs.org/@lancedb/vectordb-win32-x64-msvc/-/vectordb-win32-x64-msvc-0.21.2-beta.0.tgz",
|
"resolved": "https://registry.npmjs.org/@lancedb/vectordb-win32-x64-msvc/-/vectordb-win32-x64-msvc-0.19.1-beta.1.tgz",
|
||||||
"integrity": "sha512-IgVkAP/LiNIQD5P6n/9x3bgQOt5pGJarjtSF8r+ialD95QHmo6tcxrwTy/DlA+H1uI6B6h+sbN0c1KXTh1rYcg==",
|
"integrity": "sha512-yV550AJGlsIFdm1KoHQPJ1TZx121ZXCIdebBtBZj3wOObIhyB/i0kZAtGvwjkmr7EYyfzt1EHZzbjSGVdehIAA==",
|
||||||
"cpu": [
|
"cpu": [
|
||||||
"x64"
|
"x64"
|
||||||
],
|
],
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "vectordb",
|
"name": "vectordb",
|
||||||
"version": "0.21.2-beta.0",
|
"version": "0.19.1-beta.1",
|
||||||
"description": " Serverless, low-latency vector database for AI applications",
|
"description": " Serverless, low-latency vector database for AI applications",
|
||||||
"private": false,
|
"private": false,
|
||||||
"main": "dist/index.js",
|
"main": "dist/index.js",
|
||||||
@@ -89,10 +89,10 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
"optionalDependencies": {
|
"optionalDependencies": {
|
||||||
"@lancedb/vectordb-darwin-x64": "0.21.2-beta.0",
|
"@lancedb/vectordb-darwin-x64": "0.19.1-beta.1",
|
||||||
"@lancedb/vectordb-darwin-arm64": "0.21.2-beta.0",
|
"@lancedb/vectordb-darwin-arm64": "0.19.1-beta.1",
|
||||||
"@lancedb/vectordb-linux-x64-gnu": "0.21.2-beta.0",
|
"@lancedb/vectordb-linux-x64-gnu": "0.19.1-beta.1",
|
||||||
"@lancedb/vectordb-linux-arm64-gnu": "0.21.2-beta.0",
|
"@lancedb/vectordb-linux-arm64-gnu": "0.19.1-beta.1",
|
||||||
"@lancedb/vectordb-win32-x64-msvc": "0.21.2-beta.0"
|
"@lancedb/vectordb-win32-x64-msvc": "0.19.1-beta.1"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
[package]
|
[package]
|
||||||
name = "lancedb-nodejs"
|
name = "lancedb-nodejs"
|
||||||
edition.workspace = true
|
edition.workspace = true
|
||||||
version = "0.21.2-beta.0"
|
version = "0.19.1-beta.1"
|
||||||
license.workspace = true
|
license.workspace = true
|
||||||
description.workspace = true
|
description.workspace = true
|
||||||
repository.workspace = true
|
repository.workspace = true
|
||||||
@@ -30,7 +30,6 @@ log.workspace = true
|
|||||||
|
|
||||||
# Workaround for build failure until we can fix it.
|
# Workaround for build failure until we can fix it.
|
||||||
aws-lc-sys = "=0.28.0"
|
aws-lc-sys = "=0.28.0"
|
||||||
aws-lc-rs = "=1.13.0"
|
|
||||||
|
|
||||||
[build-dependencies]
|
[build-dependencies]
|
||||||
napi-build = "2.1"
|
napi-build = "2.1"
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
// SPDX-License-Identifier: Apache-2.0
|
// SPDX-License-Identifier: Apache-2.0
|
||||||
// SPDX-FileCopyrightText: Copyright The LanceDB Authors
|
// SPDX-FileCopyrightText: Copyright The LanceDB Authors
|
||||||
|
|
||||||
import { Bool, Field, Int32, List, Schema, Struct, Utf8 } from "apache-arrow";
|
import { Schema } from "apache-arrow";
|
||||||
|
|
||||||
import * as arrow15 from "apache-arrow-15";
|
import * as arrow15 from "apache-arrow-15";
|
||||||
import * as arrow16 from "apache-arrow-16";
|
import * as arrow16 from "apache-arrow-16";
|
||||||
@@ -11,12 +11,10 @@ import * as arrow18 from "apache-arrow-18";
|
|||||||
import {
|
import {
|
||||||
convertToTable,
|
convertToTable,
|
||||||
fromBufferToRecordBatch,
|
fromBufferToRecordBatch,
|
||||||
fromDataToBuffer,
|
|
||||||
fromRecordBatchToBuffer,
|
fromRecordBatchToBuffer,
|
||||||
fromTableToBuffer,
|
fromTableToBuffer,
|
||||||
makeArrowTable,
|
makeArrowTable,
|
||||||
makeEmptyTable,
|
makeEmptyTable,
|
||||||
tableFromIPC,
|
|
||||||
} from "../lancedb/arrow";
|
} from "../lancedb/arrow";
|
||||||
import {
|
import {
|
||||||
EmbeddingFunction,
|
EmbeddingFunction,
|
||||||
@@ -377,221 +375,8 @@ describe.each([arrow15, arrow16, arrow17, arrow18])(
|
|||||||
expect(table2.schema).toEqual(schema);
|
expect(table2.schema).toEqual(schema);
|
||||||
});
|
});
|
||||||
|
|
||||||
it("will handle missing columns in schema alignment when using embeddings", async function () {
|
|
||||||
const schema = new Schema(
|
|
||||||
[
|
|
||||||
new Field("domain", new Utf8(), true),
|
|
||||||
new Field("name", new Utf8(), true),
|
|
||||||
new Field("description", new Utf8(), true),
|
|
||||||
],
|
|
||||||
new Map([["embedding_functions", JSON.stringify([])]]),
|
|
||||||
);
|
|
||||||
|
|
||||||
const data = [
|
|
||||||
{ domain: "google.com", name: "Google" },
|
|
||||||
{ domain: "facebook.com", name: "Facebook" },
|
|
||||||
];
|
|
||||||
|
|
||||||
const table = await convertToTable(data, undefined, { schema });
|
|
||||||
|
|
||||||
expect(table.numCols).toBe(3);
|
|
||||||
expect(table.numRows).toBe(2);
|
|
||||||
|
|
||||||
const descriptionColumn = table.getChild("description");
|
|
||||||
expect(descriptionColumn).toBeDefined();
|
|
||||||
expect(descriptionColumn?.nullCount).toBe(2);
|
|
||||||
expect(descriptionColumn?.toArray()).toEqual([null, null]);
|
|
||||||
|
|
||||||
expect(table.getChild("domain")?.toArray()).toEqual([
|
|
||||||
"google.com",
|
|
||||||
"facebook.com",
|
|
||||||
]);
|
|
||||||
expect(table.getChild("name")?.toArray()).toEqual([
|
|
||||||
"Google",
|
|
||||||
"Facebook",
|
|
||||||
]);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("will handle completely missing nested struct columns", async function () {
|
|
||||||
const schema = new Schema(
|
|
||||||
[
|
|
||||||
new Field("id", new Utf8(), true),
|
|
||||||
new Field("name", new Utf8(), true),
|
|
||||||
new Field(
|
|
||||||
"metadata",
|
|
||||||
new Struct([
|
|
||||||
new Field("version", new Int32(), true),
|
|
||||||
new Field("author", new Utf8(), true),
|
|
||||||
new Field(
|
|
||||||
"tags",
|
|
||||||
new List(new Field("item", new Utf8(), true)),
|
|
||||||
true,
|
|
||||||
),
|
|
||||||
]),
|
|
||||||
true,
|
|
||||||
),
|
|
||||||
],
|
|
||||||
new Map([["embedding_functions", JSON.stringify([])]]),
|
|
||||||
);
|
|
||||||
|
|
||||||
const data = [
|
|
||||||
{ id: "doc1", name: "Document 1" },
|
|
||||||
{ id: "doc2", name: "Document 2" },
|
|
||||||
];
|
|
||||||
|
|
||||||
const table = await convertToTable(data, undefined, { schema });
|
|
||||||
|
|
||||||
expect(table.numCols).toBe(3);
|
|
||||||
expect(table.numRows).toBe(2);
|
|
||||||
|
|
||||||
const buf = await fromTableToBuffer(table);
|
|
||||||
const retrievedTable = tableFromIPC(buf);
|
|
||||||
|
|
||||||
const rows = [];
|
|
||||||
for (let i = 0; i < retrievedTable.numRows; i++) {
|
|
||||||
rows.push(retrievedTable.get(i));
|
|
||||||
}
|
|
||||||
|
|
||||||
expect(rows[0].metadata.version).toBe(null);
|
|
||||||
expect(rows[0].metadata.author).toBe(null);
|
|
||||||
expect(rows[0].metadata.tags).toBe(null);
|
|
||||||
expect(rows[0].id).toBe("doc1");
|
|
||||||
expect(rows[0].name).toBe("Document 1");
|
|
||||||
});
|
|
||||||
|
|
||||||
it("will handle partially missing nested struct fields", async function () {
|
|
||||||
const schema = new Schema(
|
|
||||||
[
|
|
||||||
new Field("id", new Utf8(), true),
|
|
||||||
new Field(
|
|
||||||
"metadata",
|
|
||||||
new Struct([
|
|
||||||
new Field("version", new Int32(), true),
|
|
||||||
new Field("author", new Utf8(), true),
|
|
||||||
new Field("created_at", new Utf8(), true),
|
|
||||||
]),
|
|
||||||
true,
|
|
||||||
),
|
|
||||||
],
|
|
||||||
new Map([["embedding_functions", JSON.stringify([])]]),
|
|
||||||
);
|
|
||||||
|
|
||||||
const data = [
|
|
||||||
{ id: "doc1", metadata: { version: 1, author: "Alice" } },
|
|
||||||
{ id: "doc2", metadata: { version: 2 } },
|
|
||||||
];
|
|
||||||
|
|
||||||
const table = await convertToTable(data, undefined, { schema });
|
|
||||||
|
|
||||||
expect(table.numCols).toBe(2);
|
|
||||||
expect(table.numRows).toBe(2);
|
|
||||||
|
|
||||||
const metadataColumn = table.getChild("metadata");
|
|
||||||
expect(metadataColumn).toBeDefined();
|
|
||||||
expect(metadataColumn?.type.toString()).toBe(
|
|
||||||
"Struct<{version:Int32, author:Utf8, created_at:Utf8}>",
|
|
||||||
);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("will handle multiple levels of nested structures", async function () {
|
|
||||||
const schema = new Schema(
|
|
||||||
[
|
|
||||||
new Field("id", new Utf8(), true),
|
|
||||||
new Field(
|
|
||||||
"config",
|
|
||||||
new Struct([
|
|
||||||
new Field("database", new Utf8(), true),
|
|
||||||
new Field(
|
|
||||||
"connection",
|
|
||||||
new Struct([
|
|
||||||
new Field("host", new Utf8(), true),
|
|
||||||
new Field("port", new Int32(), true),
|
|
||||||
new Field(
|
|
||||||
"ssl",
|
|
||||||
new Struct([
|
|
||||||
new Field("enabled", new Bool(), true),
|
|
||||||
new Field("cert_path", new Utf8(), true),
|
|
||||||
]),
|
|
||||||
true,
|
|
||||||
),
|
|
||||||
]),
|
|
||||||
true,
|
|
||||||
),
|
|
||||||
]),
|
|
||||||
true,
|
|
||||||
),
|
|
||||||
],
|
|
||||||
new Map([["embedding_functions", JSON.stringify([])]]),
|
|
||||||
);
|
|
||||||
|
|
||||||
const data = [
|
|
||||||
{
|
|
||||||
id: "config1",
|
|
||||||
config: {
|
|
||||||
database: "postgres",
|
|
||||||
connection: { host: "localhost" },
|
|
||||||
},
|
|
||||||
},
|
|
||||||
{
|
|
||||||
id: "config2",
|
|
||||||
config: { database: "mysql" },
|
|
||||||
},
|
|
||||||
{
|
|
||||||
id: "config3",
|
|
||||||
},
|
|
||||||
];
|
|
||||||
|
|
||||||
const table = await convertToTable(data, undefined, { schema });
|
|
||||||
|
|
||||||
expect(table.numCols).toBe(2);
|
|
||||||
expect(table.numRows).toBe(3);
|
|
||||||
|
|
||||||
const configColumn = table.getChild("config");
|
|
||||||
expect(configColumn).toBeDefined();
|
|
||||||
expect(configColumn?.type.toString()).toBe(
|
|
||||||
"Struct<{database:Utf8, connection:Struct<{host:Utf8, port:Int32, ssl:Struct<{enabled:Bool, cert_path:Utf8}>}>}>",
|
|
||||||
);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("will handle missing columns in Arrow table input when using embeddings", async function () {
|
|
||||||
const incompleteTable = makeArrowTable([
|
|
||||||
{ domain: "google.com", name: "Google" },
|
|
||||||
{ domain: "facebook.com", name: "Facebook" },
|
|
||||||
]);
|
|
||||||
|
|
||||||
const schema = new Schema(
|
|
||||||
[
|
|
||||||
new Field("domain", new Utf8(), true),
|
|
||||||
new Field("name", new Utf8(), true),
|
|
||||||
new Field("description", new Utf8(), true),
|
|
||||||
],
|
|
||||||
new Map([["embedding_functions", JSON.stringify([])]]),
|
|
||||||
);
|
|
||||||
|
|
||||||
const buf = await fromDataToBuffer(incompleteTable, undefined, schema);
|
|
||||||
|
|
||||||
expect(buf.byteLength).toBeGreaterThan(0);
|
|
||||||
|
|
||||||
const retrievedTable = tableFromIPC(buf);
|
|
||||||
expect(retrievedTable.numCols).toBe(3);
|
|
||||||
expect(retrievedTable.numRows).toBe(2);
|
|
||||||
|
|
||||||
const descriptionColumn = retrievedTable.getChild("description");
|
|
||||||
expect(descriptionColumn).toBeDefined();
|
|
||||||
expect(descriptionColumn?.nullCount).toBe(2);
|
|
||||||
expect(descriptionColumn?.toArray()).toEqual([null, null]);
|
|
||||||
|
|
||||||
expect(retrievedTable.getChild("domain")?.toArray()).toEqual([
|
|
||||||
"google.com",
|
|
||||||
"facebook.com",
|
|
||||||
]);
|
|
||||||
expect(retrievedTable.getChild("name")?.toArray()).toEqual([
|
|
||||||
"Google",
|
|
||||||
"Facebook",
|
|
||||||
]);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("should correctly retain values in nested struct fields", async function () {
|
it("should correctly retain values in nested struct fields", async function () {
|
||||||
|
// Define test data with nested struct
|
||||||
const testData = [
|
const testData = [
|
||||||
{
|
{
|
||||||
id: "doc1",
|
id: "doc1",
|
||||||
@@ -615,8 +400,10 @@ describe.each([arrow15, arrow16, arrow17, arrow18])(
|
|||||||
},
|
},
|
||||||
];
|
];
|
||||||
|
|
||||||
|
// Create Arrow table from the data
|
||||||
const table = makeArrowTable(testData);
|
const table = makeArrowTable(testData);
|
||||||
|
|
||||||
|
// Verify schema has the nested struct fields
|
||||||
const metadataField = table.schema.fields.find(
|
const metadataField = table.schema.fields.find(
|
||||||
(f) => f.name === "metadata",
|
(f) => f.name === "metadata",
|
||||||
);
|
);
|
||||||
@@ -630,17 +417,23 @@ describe.each([arrow15, arrow16, arrow17, arrow18])(
|
|||||||
"text",
|
"text",
|
||||||
]);
|
]);
|
||||||
|
|
||||||
|
// Convert to buffer and back (simulating storage and retrieval)
|
||||||
const buf = await fromTableToBuffer(table);
|
const buf = await fromTableToBuffer(table);
|
||||||
const retrievedTable = tableFromIPC(buf);
|
const retrievedTable = tableFromIPC(buf);
|
||||||
|
|
||||||
|
// Verify the retrieved table has the same structure
|
||||||
const rows = [];
|
const rows = [];
|
||||||
for (let i = 0; i < retrievedTable.numRows; i++) {
|
for (let i = 0; i < retrievedTable.numRows; i++) {
|
||||||
rows.push(retrievedTable.get(i));
|
rows.push(retrievedTable.get(i));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Check values in the first row
|
||||||
const firstRow = rows[0];
|
const firstRow = rows[0];
|
||||||
expect(firstRow.id).toBe("doc1");
|
expect(firstRow.id).toBe("doc1");
|
||||||
expect(firstRow.vector.toJSON()).toEqual([1, 2, 3]);
|
expect(firstRow.vector.toJSON()).toEqual([1, 2, 3]);
|
||||||
|
|
||||||
|
// Verify metadata values are preserved (this is where the bug is)
|
||||||
|
expect(firstRow.metadata).toBeDefined();
|
||||||
expect(firstRow.metadata.filePath).toBe("/path/to/file1.ts");
|
expect(firstRow.metadata.filePath).toBe("/path/to/file1.ts");
|
||||||
expect(firstRow.metadata.startLine).toBe(10);
|
expect(firstRow.metadata.startLine).toBe(10);
|
||||||
expect(firstRow.metadata.endLine).toBe(20);
|
expect(firstRow.metadata.endLine).toBe(20);
|
||||||
@@ -799,14 +592,14 @@ describe.each([arrow15, arrow16, arrow17, arrow18])(
|
|||||||
).rejects.toThrow("column vector was missing");
|
).rejects.toThrow("column vector was missing");
|
||||||
});
|
});
|
||||||
|
|
||||||
it("will skip embedding application if already applied", async function () {
|
it("will provide a nice error if run twice", async function () {
|
||||||
const records = sampleRecords();
|
const records = sampleRecords();
|
||||||
const table = await convertToTable(records, dummyEmbeddingConfig);
|
const table = await convertToTable(records, dummyEmbeddingConfig);
|
||||||
|
|
||||||
// fromTableToBuffer will try and apply the embeddings again
|
// fromTableToBuffer will try and apply the embeddings again
|
||||||
// but should skip since the column already has non-null values
|
await expect(
|
||||||
const result = await fromTableToBuffer(table, dummyEmbeddingConfig);
|
fromTableToBuffer(table, dummyEmbeddingConfig),
|
||||||
expect(result.byteLength).toBeGreaterThan(0);
|
).rejects.toThrow("already existed");
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
|
|||||||
@@ -33,13 +33,7 @@ import {
|
|||||||
register,
|
register,
|
||||||
} from "../lancedb/embedding";
|
} from "../lancedb/embedding";
|
||||||
import { Index } from "../lancedb/indices";
|
import { Index } from "../lancedb/indices";
|
||||||
import {
|
import { instanceOfFullTextQuery } from "../lancedb/query";
|
||||||
BooleanQuery,
|
|
||||||
Occur,
|
|
||||||
Operator,
|
|
||||||
instanceOfFullTextQuery,
|
|
||||||
} from "../lancedb/query";
|
|
||||||
import exp = require("constants");
|
|
||||||
|
|
||||||
describe.each([arrow15, arrow16, arrow17, arrow18])(
|
describe.each([arrow15, arrow16, arrow17, arrow18])(
|
||||||
"Given a table",
|
"Given a table",
|
||||||
@@ -101,9 +95,7 @@ describe.each([arrow15, arrow16, arrow17, arrow18])(
|
|||||||
});
|
});
|
||||||
|
|
||||||
it("should overwrite data if asked", async () => {
|
it("should overwrite data if asked", async () => {
|
||||||
const addRes = await table.add([{ id: 1 }, { id: 2 }]);
|
await table.add([{ id: 1 }, { id: 2 }]);
|
||||||
expect(addRes).toHaveProperty("version");
|
|
||||||
expect(addRes.version).toBe(2);
|
|
||||||
await table.add([{ id: 1 }], { mode: "overwrite" });
|
await table.add([{ id: 1 }], { mode: "overwrite" });
|
||||||
await expect(table.countRows()).resolves.toBe(1);
|
await expect(table.countRows()).resolves.toBe(1);
|
||||||
});
|
});
|
||||||
@@ -119,11 +111,7 @@ describe.each([arrow15, arrow16, arrow17, arrow18])(
|
|||||||
await table.add([{ id: 1 }]);
|
await table.add([{ id: 1 }]);
|
||||||
expect(await table.countRows("id == 1")).toBe(1);
|
expect(await table.countRows("id == 1")).toBe(1);
|
||||||
expect(await table.countRows("id == 7")).toBe(0);
|
expect(await table.countRows("id == 7")).toBe(0);
|
||||||
const updateRes = await table.update({ id: "7" });
|
await table.update({ id: "7" });
|
||||||
expect(updateRes).toHaveProperty("version");
|
|
||||||
expect(updateRes.version).toBe(3);
|
|
||||||
expect(updateRes).toHaveProperty("rowsUpdated");
|
|
||||||
expect(updateRes.rowsUpdated).toBe(1);
|
|
||||||
expect(await table.countRows("id == 1")).toBe(0);
|
expect(await table.countRows("id == 1")).toBe(0);
|
||||||
expect(await table.countRows("id == 7")).toBe(1);
|
expect(await table.countRows("id == 7")).toBe(1);
|
||||||
await table.add([{ id: 2 }]);
|
await table.add([{ id: 2 }]);
|
||||||
@@ -350,16 +338,15 @@ describe("merge insert", () => {
|
|||||||
{ a: 3, b: "y" },
|
{ a: 3, b: "y" },
|
||||||
{ a: 4, b: "z" },
|
{ a: 4, b: "z" },
|
||||||
];
|
];
|
||||||
const mergeInsertRes = await table
|
const stats = await table
|
||||||
.mergeInsert("a")
|
.mergeInsert("a")
|
||||||
.whenMatchedUpdateAll()
|
.whenMatchedUpdateAll()
|
||||||
.whenNotMatchedInsertAll()
|
.whenNotMatchedInsertAll()
|
||||||
.execute(newData, { timeoutMs: 10_000 });
|
.execute(newData);
|
||||||
expect(mergeInsertRes).toHaveProperty("version");
|
|
||||||
expect(mergeInsertRes.version).toBe(2);
|
expect(stats.numInsertedRows).toBe(1n);
|
||||||
expect(mergeInsertRes.numInsertedRows).toBe(1);
|
expect(stats.numUpdatedRows).toBe(2n);
|
||||||
expect(mergeInsertRes.numUpdatedRows).toBe(2);
|
expect(stats.numDeletedRows).toBe(0n);
|
||||||
expect(mergeInsertRes.numDeletedRows).toBe(0);
|
|
||||||
|
|
||||||
const expected = [
|
const expected = [
|
||||||
{ a: 1, b: "a" },
|
{ a: 1, b: "a" },
|
||||||
@@ -368,9 +355,9 @@ describe("merge insert", () => {
|
|||||||
{ a: 4, b: "z" },
|
{ a: 4, b: "z" },
|
||||||
];
|
];
|
||||||
|
|
||||||
const result = (await table.toArrow()).toArray().sort((a, b) => a.a - b.a);
|
expect(
|
||||||
|
JSON.parse(JSON.stringify((await table.toArrow()).toArray())),
|
||||||
expect(result.map((row) => ({ ...row }))).toEqual(expected);
|
).toEqual(expected);
|
||||||
});
|
});
|
||||||
test("conditional update", async () => {
|
test("conditional update", async () => {
|
||||||
const newData = [
|
const newData = [
|
||||||
@@ -378,12 +365,10 @@ describe("merge insert", () => {
|
|||||||
{ a: 3, b: "y" },
|
{ a: 3, b: "y" },
|
||||||
{ a: 4, b: "z" },
|
{ a: 4, b: "z" },
|
||||||
];
|
];
|
||||||
const mergeInsertRes = await table
|
await table
|
||||||
.mergeInsert("a")
|
.mergeInsert("a")
|
||||||
.whenMatchedUpdateAll({ where: "target.b = 'b'" })
|
.whenMatchedUpdateAll({ where: "target.b = 'b'" })
|
||||||
.execute(newData);
|
.execute(newData);
|
||||||
expect(mergeInsertRes).toHaveProperty("version");
|
|
||||||
expect(mergeInsertRes.version).toBe(2);
|
|
||||||
|
|
||||||
const expected = [
|
const expected = [
|
||||||
{ a: 1, b: "a" },
|
{ a: 1, b: "a" },
|
||||||
@@ -468,20 +453,6 @@ describe("merge insert", () => {
|
|||||||
res = res.sort((a, b) => a.a - b.a);
|
res = res.sort((a, b) => a.a - b.a);
|
||||||
expect(res).toEqual(expected);
|
expect(res).toEqual(expected);
|
||||||
});
|
});
|
||||||
|
|
||||||
test("timeout", async () => {
|
|
||||||
const newData = [
|
|
||||||
{ a: 2, b: "x" },
|
|
||||||
{ a: 4, b: "z" },
|
|
||||||
];
|
|
||||||
await expect(
|
|
||||||
table
|
|
||||||
.mergeInsert("a")
|
|
||||||
.whenMatchedUpdateAll()
|
|
||||||
.whenNotMatchedInsertAll()
|
|
||||||
.execute(newData, { timeoutMs: 0 }),
|
|
||||||
).rejects.toThrow("merge insert timed out");
|
|
||||||
});
|
|
||||||
});
|
});
|
||||||
|
|
||||||
describe("When creating an index", () => {
|
describe("When creating an index", () => {
|
||||||
@@ -559,32 +530,6 @@ describe("When creating an index", () => {
|
|||||||
rst = await tbl.query().limit(2).offset(1).nearestTo(queryVec).toArrow();
|
rst = await tbl.query().limit(2).offset(1).nearestTo(queryVec).toArrow();
|
||||||
expect(rst.numRows).toBe(1);
|
expect(rst.numRows).toBe(1);
|
||||||
|
|
||||||
// test nprobes
|
|
||||||
rst = await tbl.query().nearestTo(queryVec).limit(2).nprobes(50).toArrow();
|
|
||||||
expect(rst.numRows).toBe(2);
|
|
||||||
rst = await tbl
|
|
||||||
.query()
|
|
||||||
.nearestTo(queryVec)
|
|
||||||
.limit(2)
|
|
||||||
.minimumNprobes(15)
|
|
||||||
.toArrow();
|
|
||||||
expect(rst.numRows).toBe(2);
|
|
||||||
rst = await tbl
|
|
||||||
.query()
|
|
||||||
.nearestTo(queryVec)
|
|
||||||
.limit(2)
|
|
||||||
.minimumNprobes(10)
|
|
||||||
.maximumNprobes(20)
|
|
||||||
.toArrow();
|
|
||||||
expect(rst.numRows).toBe(2);
|
|
||||||
|
|
||||||
expect(() => tbl.query().nearestTo(queryVec).minimumNprobes(0)).toThrow(
|
|
||||||
"Invalid input, minimum_nprobes must be greater than 0",
|
|
||||||
);
|
|
||||||
expect(() => tbl.query().nearestTo(queryVec).maximumNprobes(5)).toThrow(
|
|
||||||
"Invalid input, maximum_nprobes must be greater than minimum_nprobes",
|
|
||||||
);
|
|
||||||
|
|
||||||
await tbl.dropIndex("vec_idx");
|
await tbl.dropIndex("vec_idx");
|
||||||
const indices2 = await tbl.listIndices();
|
const indices2 = await tbl.listIndices();
|
||||||
expect(indices2.length).toBe(0);
|
expect(indices2.length).toBe(0);
|
||||||
@@ -1083,19 +1028,15 @@ describe("schema evolution", function () {
|
|||||||
{ id: 1n, vector: [0.1, 0.2] },
|
{ id: 1n, vector: [0.1, 0.2] },
|
||||||
]);
|
]);
|
||||||
// Can create a non-nullable column only through addColumns at the moment.
|
// Can create a non-nullable column only through addColumns at the moment.
|
||||||
const addColumnsRes = await table.addColumns([
|
await table.addColumns([
|
||||||
{ name: "price", valueSql: "cast(10.0 as double)" },
|
{ name: "price", valueSql: "cast(10.0 as double)" },
|
||||||
]);
|
]);
|
||||||
expect(addColumnsRes).toHaveProperty("version");
|
|
||||||
expect(addColumnsRes.version).toBe(2);
|
|
||||||
expect(await table.schema()).toEqual(schema);
|
expect(await table.schema()).toEqual(schema);
|
||||||
|
|
||||||
const alterColumnsRes = await table.alterColumns([
|
await table.alterColumns([
|
||||||
{ path: "id", rename: "new_id" },
|
{ path: "id", rename: "new_id" },
|
||||||
{ path: "price", nullable: true },
|
{ path: "price", nullable: true },
|
||||||
]);
|
]);
|
||||||
expect(alterColumnsRes).toHaveProperty("version");
|
|
||||||
expect(alterColumnsRes.version).toBe(3);
|
|
||||||
|
|
||||||
const expectedSchema = new Schema([
|
const expectedSchema = new Schema([
|
||||||
new Field("new_id", new Int64(), true),
|
new Field("new_id", new Int64(), true),
|
||||||
@@ -1213,9 +1154,7 @@ describe("schema evolution", function () {
|
|||||||
const table = await con.createTable("vectors", [
|
const table = await con.createTable("vectors", [
|
||||||
{ id: 1n, vector: [0.1, 0.2] },
|
{ id: 1n, vector: [0.1, 0.2] },
|
||||||
]);
|
]);
|
||||||
const dropColumnsRes = await table.dropColumns(["vector"]);
|
await table.dropColumns(["vector"]);
|
||||||
expect(dropColumnsRes).toHaveProperty("version");
|
|
||||||
expect(dropColumnsRes.version).toBe(2);
|
|
||||||
|
|
||||||
const expectedSchema = new Schema([new Field("id", new Int64(), true)]);
|
const expectedSchema = new Schema([new Field("id", new Int64(), true)]);
|
||||||
expect(await table.schema()).toEqual(expectedSchema);
|
expect(await table.schema()).toEqual(expectedSchema);
|
||||||
@@ -1332,32 +1271,6 @@ describe("when dealing with tags", () => {
|
|||||||
await table.checkoutLatest();
|
await table.checkoutLatest();
|
||||||
expect(await table.version()).toBe(4);
|
expect(await table.version()).toBe(4);
|
||||||
});
|
});
|
||||||
|
|
||||||
it("can checkout and restore tags", async () => {
|
|
||||||
const conn = await connect(tmpDir.name, {
|
|
||||||
readConsistencyInterval: 0,
|
|
||||||
});
|
|
||||||
|
|
||||||
const table = await conn.createTable("my_table", [
|
|
||||||
{ id: 1n, vector: [0.1, 0.2] },
|
|
||||||
]);
|
|
||||||
expect(await table.version()).toBe(1);
|
|
||||||
expect(await table.countRows()).toBe(1);
|
|
||||||
const tagsManager = await table.tags();
|
|
||||||
const tag1 = "tag1";
|
|
||||||
await tagsManager.create(tag1, 1);
|
|
||||||
await table.add([{ id: 2n, vector: [0.3, 0.4] }]);
|
|
||||||
const tag2 = "tag2";
|
|
||||||
await tagsManager.create(tag2, 2);
|
|
||||||
expect(await table.version()).toBe(2);
|
|
||||||
await table.checkout(tag1);
|
|
||||||
expect(await table.version()).toBe(1);
|
|
||||||
await table.restore();
|
|
||||||
expect(await table.version()).toBe(3);
|
|
||||||
expect(await table.countRows()).toBe(1);
|
|
||||||
await table.add([{ id: 3n, vector: [0.5, 0.6] }]);
|
|
||||||
expect(await table.countRows()).toBe(2);
|
|
||||||
});
|
|
||||||
});
|
});
|
||||||
|
|
||||||
describe("when optimizing a dataset", () => {
|
describe("when optimizing a dataset", () => {
|
||||||
@@ -1537,9 +1450,7 @@ describe.each([arrow15, arrow16, arrow17, arrow18])(
|
|||||||
];
|
];
|
||||||
const table = await db.createTable("test", data);
|
const table = await db.createTable("test", data);
|
||||||
await table.createIndex("text", {
|
await table.createIndex("text", {
|
||||||
config: Index.fts({
|
config: Index.fts(),
|
||||||
withPosition: true,
|
|
||||||
}),
|
|
||||||
});
|
});
|
||||||
|
|
||||||
const results = await table.search("lance").toArray();
|
const results = await table.search("lance").toArray();
|
||||||
@@ -1562,18 +1473,6 @@ describe.each([arrow15, arrow16, arrow17, arrow18])(
|
|||||||
|
|
||||||
const results = await table.search("hello").toArray();
|
const results = await table.search("hello").toArray();
|
||||||
expect(results[0].text).toBe(data[0].text);
|
expect(results[0].text).toBe(data[0].text);
|
||||||
|
|
||||||
const results2 = await table
|
|
||||||
.search(new MatchQuery("hello world", "text"))
|
|
||||||
.toArray();
|
|
||||||
expect(results2.length).toBe(2);
|
|
||||||
|
|
||||||
const results3 = await table
|
|
||||||
.search(
|
|
||||||
new MatchQuery("hello world", "text", { operator: Operator.And }),
|
|
||||||
)
|
|
||||||
.toArray();
|
|
||||||
expect(results3.length).toBe(1);
|
|
||||||
});
|
});
|
||||||
|
|
||||||
test("full text search without lowercase", async () => {
|
test("full text search without lowercase", async () => {
|
||||||
@@ -1604,9 +1503,7 @@ describe.each([arrow15, arrow16, arrow17, arrow18])(
|
|||||||
];
|
];
|
||||||
const table = await db.createTable("test", data);
|
const table = await db.createTable("test", data);
|
||||||
await table.createIndex("text", {
|
await table.createIndex("text", {
|
||||||
config: Index.fts({
|
config: Index.fts(),
|
||||||
withPosition: true,
|
|
||||||
}),
|
|
||||||
});
|
});
|
||||||
|
|
||||||
const results = await table.search("world").toArray();
|
const results = await table.search("world").toArray();
|
||||||
@@ -1650,114 +1547,6 @@ describe.each([arrow15, arrow16, arrow17, arrow18])(
|
|||||||
expect(resultSet.has("fob")).toBe(true);
|
expect(resultSet.has("fob")).toBe(true);
|
||||||
expect(resultSet.has("fo")).toBe(true);
|
expect(resultSet.has("fo")).toBe(true);
|
||||||
expect(resultSet.has("food")).toBe(true);
|
expect(resultSet.has("food")).toBe(true);
|
||||||
|
|
||||||
const prefixResults = await table
|
|
||||||
.search(
|
|
||||||
new MatchQuery("foo", "text", { fuzziness: 3, prefixLength: 3 }),
|
|
||||||
)
|
|
||||||
.toArray();
|
|
||||||
expect(prefixResults.length).toBe(2);
|
|
||||||
const resultSet2 = new Set(prefixResults.map((r) => r.text));
|
|
||||||
expect(resultSet2.has("foo")).toBe(true);
|
|
||||||
expect(resultSet2.has("food")).toBe(true);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("full text search boolean query", async () => {
|
|
||||||
const db = await connect(tmpDir.name);
|
|
||||||
const data = [
|
|
||||||
{ text: "The cat and dog are playing" },
|
|
||||||
{ text: "The cat is sleeping" },
|
|
||||||
{ text: "The dog is barking" },
|
|
||||||
{ text: "The dog chases the cat" },
|
|
||||||
];
|
|
||||||
const table = await db.createTable("test", data);
|
|
||||||
await table.createIndex("text", {
|
|
||||||
config: Index.fts({ withPosition: false }),
|
|
||||||
});
|
|
||||||
|
|
||||||
const shouldResults = await table
|
|
||||||
.search(
|
|
||||||
new BooleanQuery([
|
|
||||||
[Occur.Should, new MatchQuery("cat", "text")],
|
|
||||||
[Occur.Should, new MatchQuery("dog", "text")],
|
|
||||||
]),
|
|
||||||
)
|
|
||||||
.toArray();
|
|
||||||
expect(shouldResults.length).toBe(4);
|
|
||||||
|
|
||||||
const mustResults = await table
|
|
||||||
.search(
|
|
||||||
new BooleanQuery([
|
|
||||||
[Occur.Must, new MatchQuery("cat", "text")],
|
|
||||||
[Occur.Must, new MatchQuery("dog", "text")],
|
|
||||||
]),
|
|
||||||
)
|
|
||||||
.toArray();
|
|
||||||
expect(mustResults.length).toBe(2);
|
|
||||||
|
|
||||||
const mustNotResults = await table
|
|
||||||
.search(
|
|
||||||
new BooleanQuery([
|
|
||||||
[Occur.Must, new MatchQuery("cat", "text")],
|
|
||||||
[Occur.MustNot, new MatchQuery("dog", "text")],
|
|
||||||
]),
|
|
||||||
)
|
|
||||||
.toArray();
|
|
||||||
expect(mustNotResults.length).toBe(1);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("full text search ngram", async () => {
|
|
||||||
const db = await connect(tmpDir.name);
|
|
||||||
const data = [
|
|
||||||
{ text: "hello world", vector: [0.1, 0.2, 0.3] },
|
|
||||||
{ text: "lance database", vector: [0.4, 0.5, 0.6] },
|
|
||||||
{ text: "lance is cool", vector: [0.7, 0.8, 0.9] },
|
|
||||||
];
|
|
||||||
const table = await db.createTable("test", data);
|
|
||||||
await table.createIndex("text", {
|
|
||||||
config: Index.fts({ baseTokenizer: "ngram" }),
|
|
||||||
});
|
|
||||||
|
|
||||||
const results = await table.search("lan").toArray();
|
|
||||||
expect(results.length).toBe(2);
|
|
||||||
const resultSet = new Set(results.map((r) => r.text));
|
|
||||||
expect(resultSet.has("lance database")).toBe(true);
|
|
||||||
expect(resultSet.has("lance is cool")).toBe(true);
|
|
||||||
|
|
||||||
const results2 = await table.search("nce").toArray(); // spellchecker:disable-line
|
|
||||||
expect(results2.length).toBe(2);
|
|
||||||
const resultSet2 = new Set(results2.map((r) => r.text));
|
|
||||||
expect(resultSet2.has("lance database")).toBe(true);
|
|
||||||
expect(resultSet2.has("lance is cool")).toBe(true);
|
|
||||||
|
|
||||||
// the default min_ngram_length is 3, so "la" should not match
|
|
||||||
const results3 = await table.search("la").toArray();
|
|
||||||
expect(results3.length).toBe(0);
|
|
||||||
|
|
||||||
// test setting min_ngram_length and prefix_only
|
|
||||||
await table.createIndex("text", {
|
|
||||||
config: Index.fts({
|
|
||||||
baseTokenizer: "ngram",
|
|
||||||
ngramMinLength: 2,
|
|
||||||
prefixOnly: true,
|
|
||||||
}),
|
|
||||||
replace: true,
|
|
||||||
});
|
|
||||||
|
|
||||||
const results4 = await table.search("lan").toArray();
|
|
||||||
expect(results4.length).toBe(2);
|
|
||||||
const resultSet4 = new Set(results4.map((r) => r.text));
|
|
||||||
expect(resultSet4.has("lance database")).toBe(true);
|
|
||||||
expect(resultSet4.has("lance is cool")).toBe(true);
|
|
||||||
|
|
||||||
const results5 = await table.search("nce").toArray(); // spellchecker:disable-line
|
|
||||||
expect(results5.length).toBe(0);
|
|
||||||
|
|
||||||
const results6 = await table.search("la").toArray();
|
|
||||||
expect(results6.length).toBe(2);
|
|
||||||
const resultSet6 = new Set(results6.map((r) => r.text));
|
|
||||||
expect(resultSet6.has("lance database")).toBe(true);
|
|
||||||
expect(resultSet6.has("lance is cool")).toBe(true);
|
|
||||||
});
|
});
|
||||||
|
|
||||||
test.each([
|
test.each([
|
||||||
@@ -1863,43 +1652,4 @@ describe("column name options", () => {
|
|||||||
expect(results[0].query_index).toBe(0);
|
expect(results[0].query_index).toBe(0);
|
||||||
expect(results[1].query_index).toBe(1);
|
expect(results[1].query_index).toBe(1);
|
||||||
});
|
});
|
||||||
|
|
||||||
test("index and search multivectors", async () => {
|
|
||||||
const db = await connect(tmpDir.name);
|
|
||||||
const data = [];
|
|
||||||
// generate 512 random multivectors
|
|
||||||
for (let i = 0; i < 256; i++) {
|
|
||||||
data.push({
|
|
||||||
multivector: Array.from({ length: 10 }, () =>
|
|
||||||
Array(2).fill(Math.random()),
|
|
||||||
),
|
|
||||||
});
|
|
||||||
}
|
|
||||||
const table = await db.createTable("multivectors", data, {
|
|
||||||
schema: new Schema([
|
|
||||||
new Field(
|
|
||||||
"multivector",
|
|
||||||
new List(
|
|
||||||
new Field(
|
|
||||||
"item",
|
|
||||||
new FixedSizeList(2, new Field("item", new Float32())),
|
|
||||||
),
|
|
||||||
),
|
|
||||||
),
|
|
||||||
]),
|
|
||||||
});
|
|
||||||
|
|
||||||
const results = await table.search(data[0].multivector).limit(10).toArray();
|
|
||||||
expect(results.length).toBe(10);
|
|
||||||
|
|
||||||
await table.createIndex("multivector", {
|
|
||||||
config: Index.ivfPq({ numPartitions: 2, distanceType: "cosine" }),
|
|
||||||
});
|
|
||||||
|
|
||||||
const results2 = await table
|
|
||||||
.search(data[0].multivector)
|
|
||||||
.limit(10)
|
|
||||||
.toArray();
|
|
||||||
expect(results2.length).toBe(10);
|
|
||||||
});
|
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -107,20 +107,6 @@ export type IntoVector =
|
|||||||
| number[]
|
| number[]
|
||||||
| Promise<Float32Array | Float64Array | number[]>;
|
| Promise<Float32Array | Float64Array | number[]>;
|
||||||
|
|
||||||
export type MultiVector = IntoVector[];
|
|
||||||
|
|
||||||
export function isMultiVector(value: unknown): value is MultiVector {
|
|
||||||
return Array.isArray(value) && isIntoVector(value[0]);
|
|
||||||
}
|
|
||||||
|
|
||||||
export function isIntoVector(value: unknown): value is IntoVector {
|
|
||||||
return (
|
|
||||||
value instanceof Float32Array ||
|
|
||||||
value instanceof Float64Array ||
|
|
||||||
(Array.isArray(value) && !Array.isArray(value[0]))
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
export function isArrowTable(value: object): value is TableLike {
|
export function isArrowTable(value: object): value is TableLike {
|
||||||
if (value instanceof ArrowTable) return true;
|
if (value instanceof ArrowTable) return true;
|
||||||
return "schema" in value && "batches" in value;
|
return "schema" in value && "batches" in value;
|
||||||
@@ -431,9 +417,7 @@ function inferSchema(
|
|||||||
} else {
|
} else {
|
||||||
const inferredType = inferType(value, path, opts);
|
const inferredType = inferType(value, path, opts);
|
||||||
if (inferredType === undefined) {
|
if (inferredType === undefined) {
|
||||||
throw new Error(`Failed to infer data type for field ${path.join(
|
throw new Error(`Failed to infer data type for field ${path.join(".")} at row ${rowI}. \
|
||||||
".",
|
|
||||||
)} at row ${rowI}. \
|
|
||||||
Consider providing an explicit schema.`);
|
Consider providing an explicit schema.`);
|
||||||
}
|
}
|
||||||
pathTree.set(path, inferredType);
|
pathTree.set(path, inferredType);
|
||||||
@@ -815,17 +799,11 @@ async function applyEmbeddingsFromMetadata(
|
|||||||
`Cannot apply embedding function because the source column '${functionEntry.sourceColumn}' was not present in the data`,
|
`Cannot apply embedding function because the source column '${functionEntry.sourceColumn}' was not present in the data`,
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
// Check if destination column exists and handle accordingly
|
|
||||||
if (columns[destColumn] !== undefined) {
|
if (columns[destColumn] !== undefined) {
|
||||||
const existingColumn = columns[destColumn];
|
throw new Error(
|
||||||
// If the column exists but is all null, we can fill it with embeddings
|
`Attempt to apply embeddings to table failed because column ${destColumn} already existed`,
|
||||||
if (existingColumn.nullCount !== existingColumn.length) {
|
);
|
||||||
// Column has non-null values, skip embedding application
|
|
||||||
continue;
|
|
||||||
}
|
}
|
||||||
}
|
|
||||||
|
|
||||||
if (table.batches.length > 1) {
|
if (table.batches.length > 1) {
|
||||||
throw new Error(
|
throw new Error(
|
||||||
"Internal error: `makeArrowTable` unexpectedly created a table with more than one batch",
|
"Internal error: `makeArrowTable` unexpectedly created a table with more than one batch",
|
||||||
@@ -853,15 +831,6 @@ async function applyEmbeddingsFromMetadata(
|
|||||||
const vector = makeVector(vectors, destType);
|
const vector = makeVector(vectors, destType);
|
||||||
columns[destColumn] = vector;
|
columns[destColumn] = vector;
|
||||||
}
|
}
|
||||||
|
|
||||||
// Add any missing columns from the schema as null vectors
|
|
||||||
for (const field of schema.fields) {
|
|
||||||
if (!(field.name in columns)) {
|
|
||||||
const nullValues = new Array(table.numRows).fill(null);
|
|
||||||
columns[field.name] = makeVector(nullValues, field.type);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
const newTable = new ArrowTable(columns);
|
const newTable = new ArrowTable(columns);
|
||||||
return alignTable(newTable, schema);
|
return alignTable(newTable, schema);
|
||||||
}
|
}
|
||||||
@@ -934,23 +903,11 @@ async function applyEmbeddings<T>(
|
|||||||
);
|
);
|
||||||
}
|
}
|
||||||
} else {
|
} else {
|
||||||
// Check if destination column exists and handle accordingly
|
|
||||||
if (Object.prototype.hasOwnProperty.call(newColumns, destColumn)) {
|
if (Object.prototype.hasOwnProperty.call(newColumns, destColumn)) {
|
||||||
const existingColumn = newColumns[destColumn];
|
throw new Error(
|
||||||
// If the column exists but is all null, we can fill it with embeddings
|
`Attempt to apply embeddings to table failed because column ${destColumn} already existed`,
|
||||||
if (existingColumn.nullCount !== existingColumn.length) {
|
|
||||||
// Column has non-null values, skip embedding application and return table as-is
|
|
||||||
let newTable = new ArrowTable(newColumns);
|
|
||||||
if (schema != null) {
|
|
||||||
newTable = alignTable(newTable, schema as Schema);
|
|
||||||
}
|
|
||||||
return new ArrowTable(
|
|
||||||
new Schema(newTable.schema.fields, schemaMetadata),
|
|
||||||
newTable.batches,
|
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
}
|
|
||||||
|
|
||||||
if (table.batches.length > 1) {
|
if (table.batches.length > 1) {
|
||||||
throw new Error(
|
throw new Error(
|
||||||
"Internal error: `makeArrowTable` unexpectedly created a table with more than one batch",
|
"Internal error: `makeArrowTable` unexpectedly created a table with more than one batch",
|
||||||
@@ -1010,21 +967,7 @@ export async function convertToTable(
|
|||||||
embeddings?: EmbeddingFunctionConfig,
|
embeddings?: EmbeddingFunctionConfig,
|
||||||
makeTableOptions?: Partial<MakeArrowTableOptions>,
|
makeTableOptions?: Partial<MakeArrowTableOptions>,
|
||||||
): Promise<ArrowTable> {
|
): Promise<ArrowTable> {
|
||||||
let processedData = data;
|
const table = makeArrowTable(data, makeTableOptions);
|
||||||
|
|
||||||
// If we have a schema with embedding metadata, we need to preprocess the data
|
|
||||||
// to ensure all nested fields are present
|
|
||||||
if (
|
|
||||||
makeTableOptions?.schema &&
|
|
||||||
makeTableOptions.schema.metadata?.has("embedding_functions")
|
|
||||||
) {
|
|
||||||
processedData = ensureNestedFieldsExist(
|
|
||||||
data,
|
|
||||||
makeTableOptions.schema as Schema,
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
const table = makeArrowTable(processedData, makeTableOptions);
|
|
||||||
return await applyEmbeddings(table, embeddings, makeTableOptions?.schema);
|
return await applyEmbeddings(table, embeddings, makeTableOptions?.schema);
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -1117,16 +1060,7 @@ export async function fromDataToBuffer(
|
|||||||
schema = sanitizeSchema(schema);
|
schema = sanitizeSchema(schema);
|
||||||
}
|
}
|
||||||
if (isArrowTable(data)) {
|
if (isArrowTable(data)) {
|
||||||
const table = sanitizeTable(data);
|
return fromTableToBuffer(sanitizeTable(data), embeddings, schema);
|
||||||
// If we have a schema with embedding functions, we need to ensure all columns exist
|
|
||||||
// before applying embeddings, since applyEmbeddingsFromMetadata expects all columns
|
|
||||||
// to be present in the table
|
|
||||||
if (schema && schema.metadata?.has("embedding_functions")) {
|
|
||||||
const alignedTable = alignTableToSchema(table, schema);
|
|
||||||
return fromTableToBuffer(alignedTable, embeddings, schema);
|
|
||||||
} else {
|
|
||||||
return fromTableToBuffer(table, embeddings, schema);
|
|
||||||
}
|
|
||||||
} else {
|
} else {
|
||||||
const table = await convertToTable(data, embeddings, { schema });
|
const table = await convertToTable(data, embeddings, { schema });
|
||||||
return fromTableToBuffer(table);
|
return fromTableToBuffer(table);
|
||||||
@@ -1195,7 +1129,7 @@ function alignBatch(batch: RecordBatch, schema: Schema): RecordBatch {
|
|||||||
type: new Struct(schema.fields),
|
type: new Struct(schema.fields),
|
||||||
length: batch.numRows,
|
length: batch.numRows,
|
||||||
nullCount: batch.nullCount,
|
nullCount: batch.nullCount,
|
||||||
children: alignedChildren as unknown as ArrowData<DataType>[],
|
children: alignedChildren,
|
||||||
});
|
});
|
||||||
return new RecordBatch(schema, newData);
|
return new RecordBatch(schema, newData);
|
||||||
}
|
}
|
||||||
@@ -1267,79 +1201,6 @@ function validateSchemaEmbeddings(
|
|||||||
return new Schema(fields, schema.metadata);
|
return new Schema(fields, schema.metadata);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Ensures that all nested fields defined in the schema exist in the data,
|
|
||||||
* filling missing fields with null values.
|
|
||||||
*/
|
|
||||||
export function ensureNestedFieldsExist(
|
|
||||||
data: Array<Record<string, unknown>>,
|
|
||||||
schema: Schema,
|
|
||||||
): Array<Record<string, unknown>> {
|
|
||||||
return data.map((row) => {
|
|
||||||
const completeRow: Record<string, unknown> = {};
|
|
||||||
|
|
||||||
for (const field of schema.fields) {
|
|
||||||
if (field.name in row) {
|
|
||||||
if (
|
|
||||||
field.type.constructor.name === "Struct" &&
|
|
||||||
row[field.name] !== null &&
|
|
||||||
row[field.name] !== undefined
|
|
||||||
) {
|
|
||||||
// Handle nested struct
|
|
||||||
const nestedValue = row[field.name] as Record<string, unknown>;
|
|
||||||
completeRow[field.name] = ensureStructFieldsExist(
|
|
||||||
nestedValue,
|
|
||||||
field.type,
|
|
||||||
);
|
|
||||||
} else {
|
|
||||||
// Non-struct field or null struct value
|
|
||||||
completeRow[field.name] = row[field.name];
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
// Field is missing from the data - set to null
|
|
||||||
completeRow[field.name] = null;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return completeRow;
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Recursively ensures that all fields in a struct type exist in the data,
|
|
||||||
* filling missing fields with null values.
|
|
||||||
*/
|
|
||||||
function ensureStructFieldsExist(
|
|
||||||
data: Record<string, unknown>,
|
|
||||||
structType: Struct,
|
|
||||||
): Record<string, unknown> {
|
|
||||||
const completeStruct: Record<string, unknown> = {};
|
|
||||||
|
|
||||||
for (const childField of structType.children) {
|
|
||||||
if (childField.name in data) {
|
|
||||||
if (
|
|
||||||
childField.type.constructor.name === "Struct" &&
|
|
||||||
data[childField.name] !== null &&
|
|
||||||
data[childField.name] !== undefined
|
|
||||||
) {
|
|
||||||
// Recursively handle nested struct
|
|
||||||
completeStruct[childField.name] = ensureStructFieldsExist(
|
|
||||||
data[childField.name] as Record<string, unknown>,
|
|
||||||
childField.type,
|
|
||||||
);
|
|
||||||
} else {
|
|
||||||
// Non-struct field or null struct value
|
|
||||||
completeStruct[childField.name] = data[childField.name];
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
// Field is missing - set to null
|
|
||||||
completeStruct[childField.name] = null;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return completeStruct;
|
|
||||||
}
|
|
||||||
|
|
||||||
interface JsonDataType {
|
interface JsonDataType {
|
||||||
type: string;
|
type: string;
|
||||||
fields?: JsonField[];
|
fields?: JsonField[];
|
||||||
@@ -1473,64 +1334,3 @@ function fieldToJson(field: Field): JsonField {
|
|||||||
metadata: field.metadata,
|
metadata: field.metadata,
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
function alignTableToSchema(
|
|
||||||
table: ArrowTable,
|
|
||||||
targetSchema: Schema,
|
|
||||||
): ArrowTable {
|
|
||||||
const existingColumns = new Map<string, Vector>();
|
|
||||||
|
|
||||||
// Map existing columns
|
|
||||||
for (const field of table.schema.fields) {
|
|
||||||
existingColumns.set(field.name, table.getChild(field.name)!);
|
|
||||||
}
|
|
||||||
|
|
||||||
// Create vectors for all fields in target schema
|
|
||||||
const alignedColumns: Record<string, Vector> = {};
|
|
||||||
|
|
||||||
for (const field of targetSchema.fields) {
|
|
||||||
if (existingColumns.has(field.name)) {
|
|
||||||
// Column exists, use it
|
|
||||||
alignedColumns[field.name] = existingColumns.get(field.name)!;
|
|
||||||
} else {
|
|
||||||
// Column missing, create null vector
|
|
||||||
alignedColumns[field.name] = createNullVector(field, table.numRows);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Create new table with aligned schema and columns
|
|
||||||
return new ArrowTable(targetSchema, alignedColumns);
|
|
||||||
}
|
|
||||||
|
|
||||||
function createNullVector(field: Field, numRows: number): Vector {
|
|
||||||
if (field.type.constructor.name === "Struct") {
|
|
||||||
// For struct types, create a struct with null fields
|
|
||||||
const structType = field.type as Struct;
|
|
||||||
const childVectors = structType.children.map((childField) =>
|
|
||||||
createNullVector(childField, numRows),
|
|
||||||
);
|
|
||||||
|
|
||||||
// Create struct data
|
|
||||||
const structData = makeData({
|
|
||||||
type: structType,
|
|
||||||
length: numRows,
|
|
||||||
nullCount: 0,
|
|
||||||
children: childVectors.map((v) => v.data[0]),
|
|
||||||
});
|
|
||||||
|
|
||||||
return arrowMakeVector(structData);
|
|
||||||
} else {
|
|
||||||
// For other types, create a vector of nulls
|
|
||||||
const nullBitmap = new Uint8Array(Math.ceil(numRows / 8));
|
|
||||||
// All bits are 0, meaning all values are null
|
|
||||||
|
|
||||||
const data = makeData({
|
|
||||||
type: field.type,
|
|
||||||
length: numRows,
|
|
||||||
nullCount: numRows,
|
|
||||||
nullBitmap,
|
|
||||||
});
|
|
||||||
|
|
||||||
return arrowMakeVector(data);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|||||||
@@ -28,13 +28,7 @@ export {
|
|||||||
FragmentSummaryStats,
|
FragmentSummaryStats,
|
||||||
Tags,
|
Tags,
|
||||||
TagContents,
|
TagContents,
|
||||||
MergeResult,
|
MergeStats,
|
||||||
AddResult,
|
|
||||||
AddColumnsResult,
|
|
||||||
AlterColumnsResult,
|
|
||||||
DeleteResult,
|
|
||||||
DropColumnsResult,
|
|
||||||
UpdateResult,
|
|
||||||
} from "./native.js";
|
} from "./native.js";
|
||||||
|
|
||||||
export {
|
export {
|
||||||
@@ -64,10 +58,7 @@ export {
|
|||||||
PhraseQuery,
|
PhraseQuery,
|
||||||
BoostQuery,
|
BoostQuery,
|
||||||
MultiMatchQuery,
|
MultiMatchQuery,
|
||||||
BooleanQuery,
|
|
||||||
FullTextQueryType,
|
FullTextQueryType,
|
||||||
Operator,
|
|
||||||
Occur,
|
|
||||||
} from "./query";
|
} from "./query";
|
||||||
|
|
||||||
export {
|
export {
|
||||||
@@ -89,7 +80,7 @@ export {
|
|||||||
ColumnAlteration,
|
ColumnAlteration,
|
||||||
} from "./table";
|
} from "./table";
|
||||||
|
|
||||||
export { MergeInsertBuilder, WriteExecutionOptions } from "./merge";
|
export { MergeInsertBuilder } from "./merge";
|
||||||
|
|
||||||
export * as embedding from "./embedding";
|
export * as embedding from "./embedding";
|
||||||
export * as rerankers from "./rerankers";
|
export * as rerankers from "./rerankers";
|
||||||
@@ -100,7 +91,6 @@ export {
|
|||||||
RecordBatchLike,
|
RecordBatchLike,
|
||||||
DataLike,
|
DataLike,
|
||||||
IntoVector,
|
IntoVector,
|
||||||
MultiVector,
|
|
||||||
} from "./arrow";
|
} from "./arrow";
|
||||||
export { IntoSql, packBits } from "./util";
|
export { IntoSql, packBits } from "./util";
|
||||||
|
|
||||||
|
|||||||
@@ -439,7 +439,7 @@ export interface FtsOptions {
|
|||||||
*
|
*
|
||||||
* "raw" - Raw tokenizer. This tokenizer does not split the text into tokens and indexes the entire text as a single token.
|
* "raw" - Raw tokenizer. This tokenizer does not split the text into tokens and indexes the entire text as a single token.
|
||||||
*/
|
*/
|
||||||
baseTokenizer?: "simple" | "whitespace" | "raw" | "ngram";
|
baseTokenizer?: "simple" | "whitespace" | "raw";
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* language for stemming and stop words
|
* language for stemming and stop words
|
||||||
@@ -472,21 +472,6 @@ export interface FtsOptions {
|
|||||||
* whether to remove punctuation
|
* whether to remove punctuation
|
||||||
*/
|
*/
|
||||||
asciiFolding?: boolean;
|
asciiFolding?: boolean;
|
||||||
|
|
||||||
/**
|
|
||||||
* ngram min length
|
|
||||||
*/
|
|
||||||
ngramMinLength?: number;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* ngram max length
|
|
||||||
*/
|
|
||||||
ngramMaxLength?: number;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* whether to only index the prefix of the token for ngram tokenizer
|
|
||||||
*/
|
|
||||||
prefixOnly?: boolean;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
export class Index {
|
export class Index {
|
||||||
@@ -623,9 +608,6 @@ export class Index {
|
|||||||
options?.stem,
|
options?.stem,
|
||||||
options?.removeStopWords,
|
options?.removeStopWords,
|
||||||
options?.asciiFolding,
|
options?.asciiFolding,
|
||||||
options?.ngramMinLength,
|
|
||||||
options?.ngramMaxLength,
|
|
||||||
options?.prefixOnly,
|
|
||||||
),
|
),
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
// SPDX-License-Identifier: Apache-2.0
|
// SPDX-License-Identifier: Apache-2.0
|
||||||
// SPDX-FileCopyrightText: Copyright The LanceDB Authors
|
// SPDX-FileCopyrightText: Copyright The LanceDB Authors
|
||||||
import { Data, Schema, fromDataToBuffer } from "./arrow";
|
import { Data, Schema, fromDataToBuffer } from "./arrow";
|
||||||
import { MergeResult, NativeMergeInsertBuilder } from "./native";
|
import { MergeStats, NativeMergeInsertBuilder } from "./native";
|
||||||
|
|
||||||
/** A builder used to create and run a merge insert operation */
|
/** A builder used to create and run a merge insert operation */
|
||||||
export class MergeInsertBuilder {
|
export class MergeInsertBuilder {
|
||||||
@@ -73,12 +73,9 @@ export class MergeInsertBuilder {
|
|||||||
/**
|
/**
|
||||||
* Executes the merge insert operation
|
* Executes the merge insert operation
|
||||||
*
|
*
|
||||||
* @returns {Promise<MergeResult>} the merge result
|
* @returns Statistics about the merge operation: counts of inserted, updated, and deleted rows
|
||||||
*/
|
*/
|
||||||
async execute(
|
async execute(data: Data): Promise<MergeStats> {
|
||||||
data: Data,
|
|
||||||
execOptions?: Partial<WriteExecutionOptions>,
|
|
||||||
): Promise<MergeResult> {
|
|
||||||
let schema: Schema;
|
let schema: Schema;
|
||||||
if (this.#schema instanceof Promise) {
|
if (this.#schema instanceof Promise) {
|
||||||
schema = await this.#schema;
|
schema = await this.#schema;
|
||||||
@@ -86,28 +83,7 @@ export class MergeInsertBuilder {
|
|||||||
} else {
|
} else {
|
||||||
schema = this.#schema;
|
schema = this.#schema;
|
||||||
}
|
}
|
||||||
|
|
||||||
if (execOptions?.timeoutMs !== undefined) {
|
|
||||||
this.#native.setTimeout(execOptions.timeoutMs);
|
|
||||||
}
|
|
||||||
|
|
||||||
const buffer = await fromDataToBuffer(data, undefined, schema);
|
const buffer = await fromDataToBuffer(data, undefined, schema);
|
||||||
return await this.#native.execute(buffer);
|
return await this.#native.execute(buffer);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface WriteExecutionOptions {
|
|
||||||
/**
|
|
||||||
* Maximum time to run the operation before cancelling it.
|
|
||||||
*
|
|
||||||
* By default, there is a 30-second timeout that is only enforced after the
|
|
||||||
* first attempt. This is to prevent spending too long retrying to resolve
|
|
||||||
* conflicts. For example, if a write attempt takes 20 seconds and fails,
|
|
||||||
* the second attempt will be cancelled after 10 seconds, hitting the
|
|
||||||
* 30-second timeout. However, a write that takes one hour and succeeds on the
|
|
||||||
* first attempt will not be cancelled.
|
|
||||||
*
|
|
||||||
* When this is set, the timeout is enforced on all attempts, including the first.
|
|
||||||
*/
|
|
||||||
timeoutMs?: number;
|
|
||||||
}
|
|
||||||
|
|||||||
@@ -448,10 +448,6 @@ export class VectorQuery extends QueryBase<NativeVectorQuery> {
|
|||||||
* For best results we recommend tuning this parameter with a benchmark against
|
* For best results we recommend tuning this parameter with a benchmark against
|
||||||
* your actual data to find the smallest possible value that will still give
|
* your actual data to find the smallest possible value that will still give
|
||||||
* you the desired recall.
|
* you the desired recall.
|
||||||
*
|
|
||||||
* For more fine grained control over behavior when you have a very narrow filter
|
|
||||||
* you can use `minimumNprobes` and `maximumNprobes`. This method sets both
|
|
||||||
* the minimum and maximum to the same value.
|
|
||||||
*/
|
*/
|
||||||
nprobes(nprobes: number): VectorQuery {
|
nprobes(nprobes: number): VectorQuery {
|
||||||
super.doCall((inner) => inner.nprobes(nprobes));
|
super.doCall((inner) => inner.nprobes(nprobes));
|
||||||
@@ -459,33 +455,6 @@ export class VectorQuery extends QueryBase<NativeVectorQuery> {
|
|||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Set the minimum number of probes used.
|
|
||||||
*
|
|
||||||
* This controls the minimum number of partitions that will be searched. This
|
|
||||||
* parameter will impact every query against a vector index, regardless of the
|
|
||||||
* filter. See `nprobes` for more details. Higher values will increase recall
|
|
||||||
* but will also increase latency.
|
|
||||||
*/
|
|
||||||
minimumNprobes(minimumNprobes: number): VectorQuery {
|
|
||||||
super.doCall((inner) => inner.minimumNprobes(minimumNprobes));
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Set the maximum number of probes used.
|
|
||||||
*
|
|
||||||
* This controls the maximum number of partitions that will be searched. If this
|
|
||||||
* number is greater than minimumNprobes then the excess partitions will _only_ be
|
|
||||||
* searched if we have not found enough results. This can be useful when there is
|
|
||||||
* a narrow filter to allow these queries to spend more time searching and avoid
|
|
||||||
* potential false negatives.
|
|
||||||
*/
|
|
||||||
maximumNprobes(maximumNprobes: number): VectorQuery {
|
|
||||||
super.doCall((inner) => inner.maximumNprobes(maximumNprobes));
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
|
|
||||||
/*
|
/*
|
||||||
* Set the distance range to use
|
* Set the distance range to use
|
||||||
*
|
*
|
||||||
@@ -793,31 +762,6 @@ export enum FullTextQueryType {
|
|||||||
MatchPhrase = "match_phrase",
|
MatchPhrase = "match_phrase",
|
||||||
Boost = "boost",
|
Boost = "boost",
|
||||||
MultiMatch = "multi_match",
|
MultiMatch = "multi_match",
|
||||||
Boolean = "boolean",
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Enum representing the logical operators used in full-text queries.
|
|
||||||
*
|
|
||||||
* - `And`: All terms must match.
|
|
||||||
* - `Or`: At least one term must match.
|
|
||||||
*/
|
|
||||||
export enum Operator {
|
|
||||||
And = "AND",
|
|
||||||
Or = "OR",
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Enum representing the occurrence of terms in full-text queries.
|
|
||||||
*
|
|
||||||
* - `Must`: The term must be present in the document.
|
|
||||||
* - `Should`: The term should contribute to the document score, but is not required.
|
|
||||||
* - `MustNot`: The term must not be present in the document.
|
|
||||||
*/
|
|
||||||
export enum Occur {
|
|
||||||
Should = "SHOULD",
|
|
||||||
Must = "MUST",
|
|
||||||
MustNot = "MUST_NOT",
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -847,7 +791,6 @@ export function instanceOfFullTextQuery(obj: any): obj is FullTextQuery {
|
|||||||
export class MatchQuery implements FullTextQuery {
|
export class MatchQuery implements FullTextQuery {
|
||||||
/** @ignore */
|
/** @ignore */
|
||||||
public readonly inner: JsFullTextQuery;
|
public readonly inner: JsFullTextQuery;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Creates an instance of MatchQuery.
|
* Creates an instance of MatchQuery.
|
||||||
*
|
*
|
||||||
@@ -857,8 +800,6 @@ export class MatchQuery implements FullTextQuery {
|
|||||||
* - `boost`: The boost factor for the query (default is 1.0).
|
* - `boost`: The boost factor for the query (default is 1.0).
|
||||||
* - `fuzziness`: The fuzziness level for the query (default is 0).
|
* - `fuzziness`: The fuzziness level for the query (default is 0).
|
||||||
* - `maxExpansions`: The maximum number of terms to consider for fuzzy matching (default is 50).
|
* - `maxExpansions`: The maximum number of terms to consider for fuzzy matching (default is 50).
|
||||||
* - `operator`: The logical operator to use for combining terms in the query (default is "OR").
|
|
||||||
* - `prefixLength`: The number of beginning characters being unchanged for fuzzy matching.
|
|
||||||
*/
|
*/
|
||||||
constructor(
|
constructor(
|
||||||
query: string,
|
query: string,
|
||||||
@@ -867,8 +808,6 @@ export class MatchQuery implements FullTextQuery {
|
|||||||
boost?: number;
|
boost?: number;
|
||||||
fuzziness?: number;
|
fuzziness?: number;
|
||||||
maxExpansions?: number;
|
maxExpansions?: number;
|
||||||
operator?: Operator;
|
|
||||||
prefixLength?: number;
|
|
||||||
},
|
},
|
||||||
) {
|
) {
|
||||||
let fuzziness = options?.fuzziness;
|
let fuzziness = options?.fuzziness;
|
||||||
@@ -881,8 +820,6 @@ export class MatchQuery implements FullTextQuery {
|
|||||||
options?.boost ?? 1.0,
|
options?.boost ?? 1.0,
|
||||||
fuzziness,
|
fuzziness,
|
||||||
options?.maxExpansions ?? 50,
|
options?.maxExpansions ?? 50,
|
||||||
options?.operator ?? Operator.Or,
|
|
||||||
options?.prefixLength ?? 0,
|
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -899,11 +836,9 @@ export class PhraseQuery implements FullTextQuery {
|
|||||||
*
|
*
|
||||||
* @param query - The phrase to search for in the specified column.
|
* @param query - The phrase to search for in the specified column.
|
||||||
* @param column - The name of the column to search within.
|
* @param column - The name of the column to search within.
|
||||||
* @param options - Optional parameters for the phrase query.
|
|
||||||
* - `slop`: The maximum number of intervening unmatched positions allowed between words in the phrase (default is 0).
|
|
||||||
*/
|
*/
|
||||||
constructor(query: string, column: string, options?: { slop?: number }) {
|
constructor(query: string, column: string) {
|
||||||
this.inner = JsFullTextQuery.phraseQuery(query, column, options?.slop ?? 0);
|
this.inner = JsFullTextQuery.phraseQuery(query, column);
|
||||||
}
|
}
|
||||||
|
|
||||||
queryType(): FullTextQueryType {
|
queryType(): FullTextQueryType {
|
||||||
@@ -954,21 +889,18 @@ export class MultiMatchQuery implements FullTextQuery {
|
|||||||
* @param columns - An array of column names to search within.
|
* @param columns - An array of column names to search within.
|
||||||
* @param options - Optional parameters for the multi-match query.
|
* @param options - Optional parameters for the multi-match query.
|
||||||
* - `boosts`: An array of boost factors for each column (default is 1.0 for all).
|
* - `boosts`: An array of boost factors for each column (default is 1.0 for all).
|
||||||
* - `operator`: The logical operator to use for combining terms in the query (default is "OR").
|
|
||||||
*/
|
*/
|
||||||
constructor(
|
constructor(
|
||||||
query: string,
|
query: string,
|
||||||
columns: string[],
|
columns: string[],
|
||||||
options?: {
|
options?: {
|
||||||
boosts?: number[];
|
boosts?: number[];
|
||||||
operator?: Operator;
|
|
||||||
},
|
},
|
||||||
) {
|
) {
|
||||||
this.inner = JsFullTextQuery.multiMatchQuery(
|
this.inner = JsFullTextQuery.multiMatchQuery(
|
||||||
query,
|
query,
|
||||||
columns,
|
columns,
|
||||||
options?.boosts,
|
options?.boosts,
|
||||||
options?.operator ?? Operator.Or,
|
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -976,23 +908,3 @@ export class MultiMatchQuery implements FullTextQuery {
|
|||||||
return FullTextQueryType.MultiMatch;
|
return FullTextQueryType.MultiMatch;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
export class BooleanQuery implements FullTextQuery {
|
|
||||||
/** @ignore */
|
|
||||||
public readonly inner: JsFullTextQuery;
|
|
||||||
/**
|
|
||||||
* Creates an instance of BooleanQuery.
|
|
||||||
*
|
|
||||||
* @param queries - An array of (Occur, FullTextQuery objects) to combine.
|
|
||||||
* Occur specifies whether the query must match, or should match.
|
|
||||||
*/
|
|
||||||
constructor(queries: [Occur, FullTextQuery][]) {
|
|
||||||
this.inner = JsFullTextQuery.booleanQuery(
|
|
||||||
queries.map(([occur, query]) => [occur, query.inner]),
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
queryType(): FullTextQueryType {
|
|
||||||
return FullTextQueryType.Boolean;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|||||||
@@ -6,11 +6,9 @@ import {
|
|||||||
Data,
|
Data,
|
||||||
DataType,
|
DataType,
|
||||||
IntoVector,
|
IntoVector,
|
||||||
MultiVector,
|
|
||||||
Schema,
|
Schema,
|
||||||
dataTypeToJson,
|
dataTypeToJson,
|
||||||
fromDataToBuffer,
|
fromDataToBuffer,
|
||||||
isMultiVector,
|
|
||||||
tableFromIPC,
|
tableFromIPC,
|
||||||
} from "./arrow";
|
} from "./arrow";
|
||||||
|
|
||||||
@@ -18,18 +16,12 @@ import { EmbeddingFunctionConfig, getRegistry } from "./embedding/registry";
|
|||||||
import { IndexOptions } from "./indices";
|
import { IndexOptions } from "./indices";
|
||||||
import { MergeInsertBuilder } from "./merge";
|
import { MergeInsertBuilder } from "./merge";
|
||||||
import {
|
import {
|
||||||
AddColumnsResult,
|
|
||||||
AddColumnsSql,
|
AddColumnsSql,
|
||||||
AddResult,
|
|
||||||
AlterColumnsResult,
|
|
||||||
DeleteResult,
|
|
||||||
DropColumnsResult,
|
|
||||||
IndexConfig,
|
IndexConfig,
|
||||||
IndexStatistics,
|
IndexStatistics,
|
||||||
OptimizeStats,
|
OptimizeStats,
|
||||||
TableStatistics,
|
TableStatistics,
|
||||||
Tags,
|
Tags,
|
||||||
UpdateResult,
|
|
||||||
Table as _NativeTable,
|
Table as _NativeTable,
|
||||||
} from "./native";
|
} from "./native";
|
||||||
import {
|
import {
|
||||||
@@ -77,10 +69,10 @@ export interface OptimizeOptions {
|
|||||||
* // Delete all versions older than 1 day
|
* // Delete all versions older than 1 day
|
||||||
* const olderThan = new Date();
|
* const olderThan = new Date();
|
||||||
* olderThan.setDate(olderThan.getDate() - 1));
|
* olderThan.setDate(olderThan.getDate() - 1));
|
||||||
* tbl.optimize({cleanupOlderThan: olderThan});
|
* tbl.cleanupOlderVersions(olderThan);
|
||||||
*
|
*
|
||||||
* // Delete all versions except the current version
|
* // Delete all versions except the current version
|
||||||
* tbl.optimize({cleanupOlderThan: new Date()});
|
* tbl.cleanupOlderVersions(new Date());
|
||||||
*/
|
*/
|
||||||
cleanupOlderThan: Date;
|
cleanupOlderThan: Date;
|
||||||
deleteUnverified: boolean;
|
deleteUnverified: boolean;
|
||||||
@@ -134,19 +126,12 @@ export abstract class Table {
|
|||||||
/**
|
/**
|
||||||
* Insert records into this Table.
|
* Insert records into this Table.
|
||||||
* @param {Data} data Records to be inserted into the Table
|
* @param {Data} data Records to be inserted into the Table
|
||||||
* @returns {Promise<AddResult>} A promise that resolves to an object
|
|
||||||
* containing the new version number of the table
|
|
||||||
*/
|
*/
|
||||||
abstract add(
|
abstract add(data: Data, options?: Partial<AddDataOptions>): Promise<void>;
|
||||||
data: Data,
|
|
||||||
options?: Partial<AddDataOptions>,
|
|
||||||
): Promise<AddResult>;
|
|
||||||
/**
|
/**
|
||||||
* Update existing records in the Table
|
* Update existing records in the Table
|
||||||
* @param opts.values The values to update. The keys are the column names and the values
|
* @param opts.values The values to update. The keys are the column names and the values
|
||||||
* are the values to set.
|
* are the values to set.
|
||||||
* @returns {Promise<UpdateResult>} A promise that resolves to an object containing
|
|
||||||
* the number of rows updated and the new version number
|
|
||||||
* @example
|
* @example
|
||||||
* ```ts
|
* ```ts
|
||||||
* table.update({where:"x = 2", values:{"vector": [10, 10]}})
|
* table.update({where:"x = 2", values:{"vector": [10, 10]}})
|
||||||
@@ -156,13 +141,11 @@ export abstract class Table {
|
|||||||
opts: {
|
opts: {
|
||||||
values: Map<string, IntoSql> | Record<string, IntoSql>;
|
values: Map<string, IntoSql> | Record<string, IntoSql>;
|
||||||
} & Partial<UpdateOptions>,
|
} & Partial<UpdateOptions>,
|
||||||
): Promise<UpdateResult>;
|
): Promise<void>;
|
||||||
/**
|
/**
|
||||||
* Update existing records in the Table
|
* Update existing records in the Table
|
||||||
* @param opts.valuesSql The values to update. The keys are the column names and the values
|
* @param opts.valuesSql The values to update. The keys are the column names and the values
|
||||||
* are the values to set. The values are SQL expressions.
|
* are the values to set. The values are SQL expressions.
|
||||||
* @returns {Promise<UpdateResult>} A promise that resolves to an object containing
|
|
||||||
* the number of rows updated and the new version number
|
|
||||||
* @example
|
* @example
|
||||||
* ```ts
|
* ```ts
|
||||||
* table.update({where:"x = 2", valuesSql:{"x": "x + 1"}})
|
* table.update({where:"x = 2", valuesSql:{"x": "x + 1"}})
|
||||||
@@ -172,7 +155,7 @@ export abstract class Table {
|
|||||||
opts: {
|
opts: {
|
||||||
valuesSql: Map<string, string> | Record<string, string>;
|
valuesSql: Map<string, string> | Record<string, string>;
|
||||||
} & Partial<UpdateOptions>,
|
} & Partial<UpdateOptions>,
|
||||||
): Promise<UpdateResult>;
|
): Promise<void>;
|
||||||
/**
|
/**
|
||||||
* Update existing records in the Table
|
* Update existing records in the Table
|
||||||
*
|
*
|
||||||
@@ -190,8 +173,6 @@ export abstract class Table {
|
|||||||
* repeatedly calilng this method.
|
* repeatedly calilng this method.
|
||||||
* @param {Map<string, string> | Record<string, string>} updates - the
|
* @param {Map<string, string> | Record<string, string>} updates - the
|
||||||
* columns to update
|
* columns to update
|
||||||
* @returns {Promise<UpdateResult>} A promise that resolves to an object
|
|
||||||
* containing the number of rows updated and the new version number
|
|
||||||
*
|
*
|
||||||
* Keys in the map should specify the name of the column to update.
|
* Keys in the map should specify the name of the column to update.
|
||||||
* Values in the map provide the new value of the column. These can
|
* Values in the map provide the new value of the column. These can
|
||||||
@@ -203,16 +184,12 @@ export abstract class Table {
|
|||||||
abstract update(
|
abstract update(
|
||||||
updates: Map<string, string> | Record<string, string>,
|
updates: Map<string, string> | Record<string, string>,
|
||||||
options?: Partial<UpdateOptions>,
|
options?: Partial<UpdateOptions>,
|
||||||
): Promise<UpdateResult>;
|
): Promise<void>;
|
||||||
|
|
||||||
/** Count the total number of rows in the dataset. */
|
/** Count the total number of rows in the dataset. */
|
||||||
abstract countRows(filter?: string): Promise<number>;
|
abstract countRows(filter?: string): Promise<number>;
|
||||||
/**
|
/** Delete the rows that satisfy the predicate. */
|
||||||
* Delete the rows that satisfy the predicate.
|
abstract delete(predicate: string): Promise<void>;
|
||||||
* @returns {Promise<DeleteResult>} A promise that resolves to an object
|
|
||||||
* containing the new version number of the table
|
|
||||||
*/
|
|
||||||
abstract delete(predicate: string): Promise<DeleteResult>;
|
|
||||||
/**
|
/**
|
||||||
* Create an index to speed up queries.
|
* Create an index to speed up queries.
|
||||||
*
|
*
|
||||||
@@ -348,7 +325,7 @@ export abstract class Table {
|
|||||||
* if the query is a string and no embedding function is defined, it will be treated as a full text search query
|
* if the query is a string and no embedding function is defined, it will be treated as a full text search query
|
||||||
*/
|
*/
|
||||||
abstract search(
|
abstract search(
|
||||||
query: string | IntoVector | MultiVector | FullTextQuery,
|
query: string | IntoVector | FullTextQuery,
|
||||||
queryType?: string,
|
queryType?: string,
|
||||||
ftsColumns?: string | string[],
|
ftsColumns?: string | string[],
|
||||||
): VectorQuery | Query;
|
): VectorQuery | Query;
|
||||||
@@ -359,30 +336,22 @@ export abstract class Table {
|
|||||||
* is the same thing as calling `nearestTo` on the builder returned
|
* is the same thing as calling `nearestTo` on the builder returned
|
||||||
* by `query`. @see {@link Query#nearestTo} for more details.
|
* by `query`. @see {@link Query#nearestTo} for more details.
|
||||||
*/
|
*/
|
||||||
abstract vectorSearch(vector: IntoVector | MultiVector): VectorQuery;
|
abstract vectorSearch(vector: IntoVector): VectorQuery;
|
||||||
/**
|
/**
|
||||||
* Add new columns with defined values.
|
* Add new columns with defined values.
|
||||||
* @param {AddColumnsSql[]} newColumnTransforms pairs of column names and
|
* @param {AddColumnsSql[]} newColumnTransforms pairs of column names and
|
||||||
* the SQL expression to use to calculate the value of the new column. These
|
* the SQL expression to use to calculate the value of the new column. These
|
||||||
* expressions will be evaluated for each row in the table, and can
|
* expressions will be evaluated for each row in the table, and can
|
||||||
* reference existing columns in the table.
|
* reference existing columns in the table.
|
||||||
* @returns {Promise<AddColumnsResult>} A promise that resolves to an object
|
|
||||||
* containing the new version number of the table after adding the columns.
|
|
||||||
*/
|
*/
|
||||||
abstract addColumns(
|
abstract addColumns(newColumnTransforms: AddColumnsSql[]): Promise<void>;
|
||||||
newColumnTransforms: AddColumnsSql[],
|
|
||||||
): Promise<AddColumnsResult>;
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Alter the name or nullability of columns.
|
* Alter the name or nullability of columns.
|
||||||
* @param {ColumnAlteration[]} columnAlterations One or more alterations to
|
* @param {ColumnAlteration[]} columnAlterations One or more alterations to
|
||||||
* apply to columns.
|
* apply to columns.
|
||||||
* @returns {Promise<AlterColumnsResult>} A promise that resolves to an object
|
|
||||||
* containing the new version number of the table after altering the columns.
|
|
||||||
*/
|
*/
|
||||||
abstract alterColumns(
|
abstract alterColumns(columnAlterations: ColumnAlteration[]): Promise<void>;
|
||||||
columnAlterations: ColumnAlteration[],
|
|
||||||
): Promise<AlterColumnsResult>;
|
|
||||||
/**
|
/**
|
||||||
* Drop one or more columns from the dataset
|
* Drop one or more columns from the dataset
|
||||||
*
|
*
|
||||||
@@ -393,10 +362,8 @@ export abstract class Table {
|
|||||||
* @param {string[]} columnNames The names of the columns to drop. These can
|
* @param {string[]} columnNames The names of the columns to drop. These can
|
||||||
* be nested column references (e.g. "a.b.c") or top-level column names
|
* be nested column references (e.g. "a.b.c") or top-level column names
|
||||||
* (e.g. "a").
|
* (e.g. "a").
|
||||||
* @returns {Promise<DropColumnsResult>} A promise that resolves to an object
|
|
||||||
* containing the new version number of the table after dropping the columns.
|
|
||||||
*/
|
*/
|
||||||
abstract dropColumns(columnNames: string[]): Promise<DropColumnsResult>;
|
abstract dropColumns(columnNames: string[]): Promise<void>;
|
||||||
/** Retrieve the version of the table */
|
/** Retrieve the version of the table */
|
||||||
|
|
||||||
abstract version(): Promise<number>;
|
abstract version(): Promise<number>;
|
||||||
@@ -562,12 +529,12 @@ export class LocalTable extends Table {
|
|||||||
return tbl.schema;
|
return tbl.schema;
|
||||||
}
|
}
|
||||||
|
|
||||||
async add(data: Data, options?: Partial<AddDataOptions>): Promise<AddResult> {
|
async add(data: Data, options?: Partial<AddDataOptions>): Promise<void> {
|
||||||
const mode = options?.mode ?? "append";
|
const mode = options?.mode ?? "append";
|
||||||
const schema = await this.schema();
|
const schema = await this.schema();
|
||||||
|
|
||||||
const buffer = await fromDataToBuffer(data, undefined, schema);
|
const buffer = await fromDataToBuffer(data, undefined, schema);
|
||||||
return await this.inner.add(buffer, mode);
|
await this.inner.add(buffer, mode);
|
||||||
}
|
}
|
||||||
|
|
||||||
async update(
|
async update(
|
||||||
@@ -580,7 +547,7 @@ export class LocalTable extends Table {
|
|||||||
valuesSql: Map<string, string> | Record<string, string>;
|
valuesSql: Map<string, string> | Record<string, string>;
|
||||||
} & Partial<UpdateOptions>),
|
} & Partial<UpdateOptions>),
|
||||||
options?: Partial<UpdateOptions>,
|
options?: Partial<UpdateOptions>,
|
||||||
): Promise<UpdateResult> {
|
) {
|
||||||
const isValues =
|
const isValues =
|
||||||
"values" in optsOrUpdates && typeof optsOrUpdates.values !== "string";
|
"values" in optsOrUpdates && typeof optsOrUpdates.values !== "string";
|
||||||
const isValuesSql =
|
const isValuesSql =
|
||||||
@@ -627,15 +594,15 @@ export class LocalTable extends Table {
|
|||||||
columns = Object.entries(optsOrUpdates as Record<string, string>);
|
columns = Object.entries(optsOrUpdates as Record<string, string>);
|
||||||
predicate = options?.where;
|
predicate = options?.where;
|
||||||
}
|
}
|
||||||
return await this.inner.update(predicate, columns);
|
await this.inner.update(predicate, columns);
|
||||||
}
|
}
|
||||||
|
|
||||||
async countRows(filter?: string): Promise<number> {
|
async countRows(filter?: string): Promise<number> {
|
||||||
return await this.inner.countRows(filter);
|
return await this.inner.countRows(filter);
|
||||||
}
|
}
|
||||||
|
|
||||||
async delete(predicate: string): Promise<DeleteResult> {
|
async delete(predicate: string): Promise<void> {
|
||||||
return await this.inner.delete(predicate);
|
await this.inner.delete(predicate);
|
||||||
}
|
}
|
||||||
|
|
||||||
async createIndex(column: string, options?: Partial<IndexOptions>) {
|
async createIndex(column: string, options?: Partial<IndexOptions>) {
|
||||||
@@ -670,7 +637,7 @@ export class LocalTable extends Table {
|
|||||||
}
|
}
|
||||||
|
|
||||||
search(
|
search(
|
||||||
query: string | IntoVector | MultiVector | FullTextQuery,
|
query: string | IntoVector | FullTextQuery,
|
||||||
queryType: string = "auto",
|
queryType: string = "auto",
|
||||||
ftsColumns?: string | string[],
|
ftsColumns?: string | string[],
|
||||||
): VectorQuery | Query {
|
): VectorQuery | Query {
|
||||||
@@ -717,29 +684,17 @@ export class LocalTable extends Table {
|
|||||||
return this.query().nearestTo(queryPromise);
|
return this.query().nearestTo(queryPromise);
|
||||||
}
|
}
|
||||||
|
|
||||||
vectorSearch(vector: IntoVector | MultiVector): VectorQuery {
|
vectorSearch(vector: IntoVector): VectorQuery {
|
||||||
if (isMultiVector(vector)) {
|
|
||||||
const query = this.query().nearestTo(vector[0]);
|
|
||||||
for (const v of vector.slice(1)) {
|
|
||||||
query.addQueryVector(v);
|
|
||||||
}
|
|
||||||
return query;
|
|
||||||
}
|
|
||||||
|
|
||||||
return this.query().nearestTo(vector);
|
return this.query().nearestTo(vector);
|
||||||
}
|
}
|
||||||
|
|
||||||
// TODO: Support BatchUDF
|
// TODO: Support BatchUDF
|
||||||
|
|
||||||
async addColumns(
|
async addColumns(newColumnTransforms: AddColumnsSql[]): Promise<void> {
|
||||||
newColumnTransforms: AddColumnsSql[],
|
await this.inner.addColumns(newColumnTransforms);
|
||||||
): Promise<AddColumnsResult> {
|
|
||||||
return await this.inner.addColumns(newColumnTransforms);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
async alterColumns(
|
async alterColumns(columnAlterations: ColumnAlteration[]): Promise<void> {
|
||||||
columnAlterations: ColumnAlteration[],
|
|
||||||
): Promise<AlterColumnsResult> {
|
|
||||||
const processedAlterations = columnAlterations.map((alteration) => {
|
const processedAlterations = columnAlterations.map((alteration) => {
|
||||||
if (typeof alteration.dataType === "string") {
|
if (typeof alteration.dataType === "string") {
|
||||||
return {
|
return {
|
||||||
@@ -760,11 +715,11 @@ export class LocalTable extends Table {
|
|||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
return await this.inner.alterColumns(processedAlterations);
|
await this.inner.alterColumns(processedAlterations);
|
||||||
}
|
}
|
||||||
|
|
||||||
async dropColumns(columnNames: string[]): Promise<DropColumnsResult> {
|
async dropColumns(columnNames: string[]): Promise<void> {
|
||||||
return await this.inner.dropColumns(columnNames);
|
await this.inner.dropColumns(columnNames);
|
||||||
}
|
}
|
||||||
|
|
||||||
async version(): Promise<number> {
|
async version(): Promise<number> {
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@lancedb/lancedb-darwin-arm64",
|
"name": "@lancedb/lancedb-darwin-arm64",
|
||||||
"version": "0.21.2-beta.0",
|
"version": "0.19.1-beta.1",
|
||||||
"os": ["darwin"],
|
"os": ["darwin"],
|
||||||
"cpu": ["arm64"],
|
"cpu": ["arm64"],
|
||||||
"main": "lancedb.darwin-arm64.node",
|
"main": "lancedb.darwin-arm64.node",
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@lancedb/lancedb-darwin-x64",
|
"name": "@lancedb/lancedb-darwin-x64",
|
||||||
"version": "0.21.2-beta.0",
|
"version": "0.19.1-beta.1",
|
||||||
"os": ["darwin"],
|
"os": ["darwin"],
|
||||||
"cpu": ["x64"],
|
"cpu": ["x64"],
|
||||||
"main": "lancedb.darwin-x64.node",
|
"main": "lancedb.darwin-x64.node",
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@lancedb/lancedb-linux-arm64-gnu",
|
"name": "@lancedb/lancedb-linux-arm64-gnu",
|
||||||
"version": "0.21.2-beta.0",
|
"version": "0.19.1-beta.1",
|
||||||
"os": ["linux"],
|
"os": ["linux"],
|
||||||
"cpu": ["arm64"],
|
"cpu": ["arm64"],
|
||||||
"main": "lancedb.linux-arm64-gnu.node",
|
"main": "lancedb.linux-arm64-gnu.node",
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@lancedb/lancedb-linux-arm64-musl",
|
"name": "@lancedb/lancedb-linux-arm64-musl",
|
||||||
"version": "0.21.2-beta.0",
|
"version": "0.19.1-beta.1",
|
||||||
"os": ["linux"],
|
"os": ["linux"],
|
||||||
"cpu": ["arm64"],
|
"cpu": ["arm64"],
|
||||||
"main": "lancedb.linux-arm64-musl.node",
|
"main": "lancedb.linux-arm64-musl.node",
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@lancedb/lancedb-linux-x64-gnu",
|
"name": "@lancedb/lancedb-linux-x64-gnu",
|
||||||
"version": "0.21.2-beta.0",
|
"version": "0.19.1-beta.1",
|
||||||
"os": ["linux"],
|
"os": ["linux"],
|
||||||
"cpu": ["x64"],
|
"cpu": ["x64"],
|
||||||
"main": "lancedb.linux-x64-gnu.node",
|
"main": "lancedb.linux-x64-gnu.node",
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@lancedb/lancedb-linux-x64-musl",
|
"name": "@lancedb/lancedb-linux-x64-musl",
|
||||||
"version": "0.21.2-beta.0",
|
"version": "0.19.1-beta.1",
|
||||||
"os": ["linux"],
|
"os": ["linux"],
|
||||||
"cpu": ["x64"],
|
"cpu": ["x64"],
|
||||||
"main": "lancedb.linux-x64-musl.node",
|
"main": "lancedb.linux-x64-musl.node",
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@lancedb/lancedb-win32-arm64-msvc",
|
"name": "@lancedb/lancedb-win32-arm64-msvc",
|
||||||
"version": "0.21.2-beta.0",
|
"version": "0.19.1-beta.1",
|
||||||
"os": [
|
"os": [
|
||||||
"win32"
|
"win32"
|
||||||
],
|
],
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@lancedb/lancedb-win32-x64-msvc",
|
"name": "@lancedb/lancedb-win32-x64-msvc",
|
||||||
"version": "0.21.2-beta.0",
|
"version": "0.19.1-beta.1",
|
||||||
"os": ["win32"],
|
"os": ["win32"],
|
||||||
"cpu": ["x64"],
|
"cpu": ["x64"],
|
||||||
"main": "lancedb.win32-x64-msvc.node",
|
"main": "lancedb.win32-x64-msvc.node",
|
||||||
|
|||||||
4
nodejs/package-lock.json
generated
4
nodejs/package-lock.json
generated
@@ -1,12 +1,12 @@
|
|||||||
{
|
{
|
||||||
"name": "@lancedb/lancedb",
|
"name": "@lancedb/lancedb",
|
||||||
"version": "0.21.2-beta.0",
|
"version": "0.19.1-beta.1",
|
||||||
"lockfileVersion": 3,
|
"lockfileVersion": 3,
|
||||||
"requires": true,
|
"requires": true,
|
||||||
"packages": {
|
"packages": {
|
||||||
"": {
|
"": {
|
||||||
"name": "@lancedb/lancedb",
|
"name": "@lancedb/lancedb",
|
||||||
"version": "0.21.2-beta.0",
|
"version": "0.19.1-beta.1",
|
||||||
"cpu": [
|
"cpu": [
|
||||||
"x64",
|
"x64",
|
||||||
"arm64"
|
"arm64"
|
||||||
|
|||||||
@@ -11,7 +11,7 @@
|
|||||||
"ann"
|
"ann"
|
||||||
],
|
],
|
||||||
"private": false,
|
"private": false,
|
||||||
"version": "0.21.2-beta.0",
|
"version": "0.19.1-beta.1",
|
||||||
"main": "dist/index.js",
|
"main": "dist/index.js",
|
||||||
"exports": {
|
"exports": {
|
||||||
".": "./dist/index.js",
|
".": "./dist/index.js",
|
||||||
|
|||||||
@@ -123,44 +123,34 @@ impl Index {
|
|||||||
stem: Option<bool>,
|
stem: Option<bool>,
|
||||||
remove_stop_words: Option<bool>,
|
remove_stop_words: Option<bool>,
|
||||||
ascii_folding: Option<bool>,
|
ascii_folding: Option<bool>,
|
||||||
ngram_min_length: Option<u32>,
|
|
||||||
ngram_max_length: Option<u32>,
|
|
||||||
prefix_only: Option<bool>,
|
|
||||||
) -> Self {
|
) -> Self {
|
||||||
let mut opts = FtsIndexBuilder::default();
|
let mut opts = FtsIndexBuilder::default();
|
||||||
|
let mut tokenizer_configs = opts.tokenizer_configs.clone();
|
||||||
if let Some(with_position) = with_position {
|
if let Some(with_position) = with_position {
|
||||||
opts = opts.with_position(with_position);
|
opts = opts.with_position(with_position);
|
||||||
}
|
}
|
||||||
if let Some(base_tokenizer) = base_tokenizer {
|
if let Some(base_tokenizer) = base_tokenizer {
|
||||||
opts = opts.base_tokenizer(base_tokenizer);
|
tokenizer_configs = tokenizer_configs.base_tokenizer(base_tokenizer);
|
||||||
}
|
}
|
||||||
if let Some(language) = language {
|
if let Some(language) = language {
|
||||||
opts = opts.language(&language).unwrap();
|
tokenizer_configs = tokenizer_configs.language(&language).unwrap();
|
||||||
}
|
}
|
||||||
if let Some(max_token_length) = max_token_length {
|
if let Some(max_token_length) = max_token_length {
|
||||||
opts = opts.max_token_length(Some(max_token_length as usize));
|
tokenizer_configs = tokenizer_configs.max_token_length(Some(max_token_length as usize));
|
||||||
}
|
}
|
||||||
if let Some(lower_case) = lower_case {
|
if let Some(lower_case) = lower_case {
|
||||||
opts = opts.lower_case(lower_case);
|
tokenizer_configs = tokenizer_configs.lower_case(lower_case);
|
||||||
}
|
}
|
||||||
if let Some(stem) = stem {
|
if let Some(stem) = stem {
|
||||||
opts = opts.stem(stem);
|
tokenizer_configs = tokenizer_configs.stem(stem);
|
||||||
}
|
}
|
||||||
if let Some(remove_stop_words) = remove_stop_words {
|
if let Some(remove_stop_words) = remove_stop_words {
|
||||||
opts = opts.remove_stop_words(remove_stop_words);
|
tokenizer_configs = tokenizer_configs.remove_stop_words(remove_stop_words);
|
||||||
}
|
}
|
||||||
if let Some(ascii_folding) = ascii_folding {
|
if let Some(ascii_folding) = ascii_folding {
|
||||||
opts = opts.ascii_folding(ascii_folding);
|
tokenizer_configs = tokenizer_configs.ascii_folding(ascii_folding);
|
||||||
}
|
|
||||||
if let Some(ngram_min_length) = ngram_min_length {
|
|
||||||
opts = opts.ngram_min_length(ngram_min_length);
|
|
||||||
}
|
|
||||||
if let Some(ngram_max_length) = ngram_max_length {
|
|
||||||
opts = opts.ngram_max_length(ngram_max_length);
|
|
||||||
}
|
|
||||||
if let Some(prefix_only) = prefix_only {
|
|
||||||
opts = opts.ngram_prefix_only(prefix_only);
|
|
||||||
}
|
}
|
||||||
|
opts.tokenizer_configs = tokenizer_configs;
|
||||||
|
|
||||||
Self {
|
Self {
|
||||||
inner: Mutex::new(Some(LanceDbIndex::FTS(opts))),
|
inner: Mutex::new(Some(LanceDbIndex::FTS(opts))),
|
||||||
|
|||||||
@@ -1,13 +1,11 @@
|
|||||||
// SPDX-License-Identifier: Apache-2.0
|
// SPDX-License-Identifier: Apache-2.0
|
||||||
// SPDX-FileCopyrightText: Copyright The LanceDB Authors
|
// SPDX-FileCopyrightText: Copyright The LanceDB Authors
|
||||||
|
|
||||||
use std::time::Duration;
|
|
||||||
|
|
||||||
use lancedb::{arrow::IntoArrow, ipc::ipc_file_to_batches, table::merge::MergeInsertBuilder};
|
use lancedb::{arrow::IntoArrow, ipc::ipc_file_to_batches, table::merge::MergeInsertBuilder};
|
||||||
use napi::bindgen_prelude::*;
|
use napi::bindgen_prelude::*;
|
||||||
use napi_derive::napi;
|
use napi_derive::napi;
|
||||||
|
|
||||||
use crate::{error::convert_error, table::MergeResult};
|
use crate::error::convert_error;
|
||||||
|
|
||||||
#[napi]
|
#[napi]
|
||||||
#[derive(Clone)]
|
#[derive(Clone)]
|
||||||
@@ -38,13 +36,8 @@ impl NativeMergeInsertBuilder {
|
|||||||
this
|
this
|
||||||
}
|
}
|
||||||
|
|
||||||
#[napi]
|
|
||||||
pub fn set_timeout(&mut self, timeout: u32) {
|
|
||||||
self.inner.timeout(Duration::from_millis(timeout as u64));
|
|
||||||
}
|
|
||||||
|
|
||||||
#[napi(catch_unwind)]
|
#[napi(catch_unwind)]
|
||||||
pub async fn execute(&self, buf: Buffer) -> napi::Result<MergeResult> {
|
pub async fn execute(&self, buf: Buffer) -> napi::Result<MergeStats> {
|
||||||
let data = ipc_file_to_batches(buf.to_vec())
|
let data = ipc_file_to_batches(buf.to_vec())
|
||||||
.and_then(IntoArrow::into_arrow)
|
.and_then(IntoArrow::into_arrow)
|
||||||
.map_err(|e| {
|
.map_err(|e| {
|
||||||
@@ -53,13 +46,14 @@ impl NativeMergeInsertBuilder {
|
|||||||
|
|
||||||
let this = self.clone();
|
let this = self.clone();
|
||||||
|
|
||||||
let res = this.inner.execute(data).await.map_err(|e| {
|
let stats = this.inner.execute(data).await.map_err(|e| {
|
||||||
napi::Error::from_reason(format!(
|
napi::Error::from_reason(format!(
|
||||||
"Failed to execute merge insert: {}",
|
"Failed to execute merge insert: {}",
|
||||||
convert_error(&e)
|
convert_error(&e)
|
||||||
))
|
))
|
||||||
})?;
|
})?;
|
||||||
Ok(res.into())
|
|
||||||
|
Ok(stats.into())
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -68,3 +62,20 @@ impl From<MergeInsertBuilder> for NativeMergeInsertBuilder {
|
|||||||
Self { inner }
|
Self { inner }
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[napi(object)]
|
||||||
|
pub struct MergeStats {
|
||||||
|
pub num_inserted_rows: BigInt,
|
||||||
|
pub num_updated_rows: BigInt,
|
||||||
|
pub num_deleted_rows: BigInt,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl From<lancedb::table::MergeStats> for MergeStats {
|
||||||
|
fn from(stats: lancedb::table::MergeStats) -> Self {
|
||||||
|
Self {
|
||||||
|
num_inserted_rows: stats.num_inserted_rows.into(),
|
||||||
|
num_updated_rows: stats.num_updated_rows.into(),
|
||||||
|
num_deleted_rows: stats.num_deleted_rows.into(),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
@@ -4,8 +4,7 @@
|
|||||||
use std::sync::Arc;
|
use std::sync::Arc;
|
||||||
|
|
||||||
use lancedb::index::scalar::{
|
use lancedb::index::scalar::{
|
||||||
BooleanQuery, BoostQuery, FtsQuery, FullTextSearchQuery, MatchQuery, MultiMatchQuery, Occur,
|
BoostQuery, FtsQuery, FullTextSearchQuery, MatchQuery, MultiMatchQuery, PhraseQuery,
|
||||||
Operator, PhraseQuery,
|
|
||||||
};
|
};
|
||||||
use lancedb::query::ExecutableQuery;
|
use lancedb::query::ExecutableQuery;
|
||||||
use lancedb::query::Query as LanceDbQuery;
|
use lancedb::query::Query as LanceDbQuery;
|
||||||
@@ -178,31 +177,6 @@ impl VectorQuery {
|
|||||||
self.inner = self.inner.clone().nprobes(nprobe as usize);
|
self.inner = self.inner.clone().nprobes(nprobe as usize);
|
||||||
}
|
}
|
||||||
|
|
||||||
#[napi]
|
|
||||||
pub fn minimum_nprobes(&mut self, minimum_nprobe: u32) -> napi::Result<()> {
|
|
||||||
self.inner = self
|
|
||||||
.inner
|
|
||||||
.clone()
|
|
||||||
.minimum_nprobes(minimum_nprobe as usize)
|
|
||||||
.default_error()?;
|
|
||||||
Ok(())
|
|
||||||
}
|
|
||||||
|
|
||||||
#[napi]
|
|
||||||
pub fn maximum_nprobes(&mut self, maximum_nprobes: u32) -> napi::Result<()> {
|
|
||||||
let maximum_nprobes = if maximum_nprobes == 0 {
|
|
||||||
None
|
|
||||||
} else {
|
|
||||||
Some(maximum_nprobes as usize)
|
|
||||||
};
|
|
||||||
self.inner = self
|
|
||||||
.inner
|
|
||||||
.clone()
|
|
||||||
.maximum_nprobes(maximum_nprobes)
|
|
||||||
.default_error()?;
|
|
||||||
Ok(())
|
|
||||||
}
|
|
||||||
|
|
||||||
#[napi]
|
#[napi]
|
||||||
pub fn distance_range(&mut self, lower_bound: Option<f64>, upper_bound: Option<f64>) {
|
pub fn distance_range(&mut self, lower_bound: Option<f64>, upper_bound: Option<f64>) {
|
||||||
// napi doesn't support f32, so we have to convert to f32
|
// napi doesn't support f32, so we have to convert to f32
|
||||||
@@ -334,8 +308,6 @@ impl JsFullTextQuery {
|
|||||||
boost: f64,
|
boost: f64,
|
||||||
fuzziness: Option<u32>,
|
fuzziness: Option<u32>,
|
||||||
max_expansions: u32,
|
max_expansions: u32,
|
||||||
operator: String,
|
|
||||||
prefix_length: u32,
|
|
||||||
) -> napi::Result<Self> {
|
) -> napi::Result<Self> {
|
||||||
Ok(Self {
|
Ok(Self {
|
||||||
inner: MatchQuery::new(query)
|
inner: MatchQuery::new(query)
|
||||||
@@ -343,23 +315,14 @@ impl JsFullTextQuery {
|
|||||||
.with_boost(boost as f32)
|
.with_boost(boost as f32)
|
||||||
.with_fuzziness(fuzziness)
|
.with_fuzziness(fuzziness)
|
||||||
.with_max_expansions(max_expansions as usize)
|
.with_max_expansions(max_expansions as usize)
|
||||||
.with_operator(
|
|
||||||
Operator::try_from(operator.as_str()).map_err(|e| {
|
|
||||||
napi::Error::from_reason(format!("Invalid operator: {}", e))
|
|
||||||
})?,
|
|
||||||
)
|
|
||||||
.with_prefix_length(prefix_length)
|
|
||||||
.into(),
|
.into(),
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
#[napi(factory)]
|
#[napi(factory)]
|
||||||
pub fn phrase_query(query: String, column: String, slop: u32) -> napi::Result<Self> {
|
pub fn phrase_query(query: String, column: String) -> napi::Result<Self> {
|
||||||
Ok(Self {
|
Ok(Self {
|
||||||
inner: PhraseQuery::new(query)
|
inner: PhraseQuery::new(query).with_column(Some(column)).into(),
|
||||||
.with_column(Some(column))
|
|
||||||
.with_slop(slop)
|
|
||||||
.into(),
|
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -385,7 +348,6 @@ impl JsFullTextQuery {
|
|||||||
query: String,
|
query: String,
|
||||||
columns: Vec<String>,
|
columns: Vec<String>,
|
||||||
boosts: Option<Vec<f64>>,
|
boosts: Option<Vec<f64>>,
|
||||||
operator: String,
|
|
||||||
) -> napi::Result<Self> {
|
) -> napi::Result<Self> {
|
||||||
let q = match boosts {
|
let q = match boosts {
|
||||||
Some(boosts) => MultiMatchQuery::try_new(query, columns)
|
Some(boosts) => MultiMatchQuery::try_new(query, columns)
|
||||||
@@ -396,37 +358,7 @@ impl JsFullTextQuery {
|
|||||||
napi::Error::from_reason(format!("Failed to create multi match query: {}", e))
|
napi::Error::from_reason(format!("Failed to create multi match query: {}", e))
|
||||||
})?;
|
})?;
|
||||||
|
|
||||||
let operator = Operator::try_from(operator.as_str()).map_err(|e| {
|
Ok(Self { inner: q.into() })
|
||||||
napi::Error::from_reason(format!("Invalid operator for multi match query: {}", e))
|
|
||||||
})?;
|
|
||||||
|
|
||||||
Ok(Self {
|
|
||||||
inner: q.with_operator(operator).into(),
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
#[napi(factory)]
|
|
||||||
pub fn boolean_query(queries: Vec<(String, &JsFullTextQuery)>) -> napi::Result<Self> {
|
|
||||||
let mut sub_queries = Vec::with_capacity(queries.len());
|
|
||||||
for (occur, q) in queries {
|
|
||||||
let occur = Occur::try_from(occur.as_str())
|
|
||||||
.map_err(|e| napi::Error::from_reason(e.to_string()))?;
|
|
||||||
sub_queries.push((occur, q.inner.clone()));
|
|
||||||
}
|
|
||||||
Ok(Self {
|
|
||||||
inner: BooleanQuery::new(sub_queries).into(),
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
#[napi(getter)]
|
|
||||||
pub fn query_type(&self) -> String {
|
|
||||||
match self.inner {
|
|
||||||
FtsQuery::Match(_) => "match".to_string(),
|
|
||||||
FtsQuery::Phrase(_) => "phrase".to_string(),
|
|
||||||
FtsQuery::Boost(_) => "boost".to_string(),
|
|
||||||
FtsQuery::MultiMatch(_) => "multi_match".to_string(),
|
|
||||||
FtsQuery::Boolean(_) => "boolean".to_string(),
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -75,7 +75,7 @@ impl Table {
|
|||||||
}
|
}
|
||||||
|
|
||||||
#[napi(catch_unwind)]
|
#[napi(catch_unwind)]
|
||||||
pub async fn add(&self, buf: Buffer, mode: String) -> napi::Result<AddResult> {
|
pub async fn add(&self, buf: Buffer, mode: String) -> napi::Result<()> {
|
||||||
let batches = ipc_file_to_batches(buf.to_vec())
|
let batches = ipc_file_to_batches(buf.to_vec())
|
||||||
.map_err(|e| napi::Error::from_reason(format!("Failed to read IPC file: {}", e)))?;
|
.map_err(|e| napi::Error::from_reason(format!("Failed to read IPC file: {}", e)))?;
|
||||||
let mut op = self.inner_ref()?.add(batches);
|
let mut op = self.inner_ref()?.add(batches);
|
||||||
@@ -88,8 +88,7 @@ impl Table {
|
|||||||
return Err(napi::Error::from_reason(format!("Invalid mode: {}", mode)));
|
return Err(napi::Error::from_reason(format!("Invalid mode: {}", mode)));
|
||||||
};
|
};
|
||||||
|
|
||||||
let res = op.execute().await.default_error()?;
|
op.execute().await.default_error()
|
||||||
Ok(res.into())
|
|
||||||
}
|
}
|
||||||
|
|
||||||
#[napi(catch_unwind)]
|
#[napi(catch_unwind)]
|
||||||
@@ -102,9 +101,8 @@ impl Table {
|
|||||||
}
|
}
|
||||||
|
|
||||||
#[napi(catch_unwind)]
|
#[napi(catch_unwind)]
|
||||||
pub async fn delete(&self, predicate: String) -> napi::Result<DeleteResult> {
|
pub async fn delete(&self, predicate: String) -> napi::Result<()> {
|
||||||
let res = self.inner_ref()?.delete(&predicate).await.default_error()?;
|
self.inner_ref()?.delete(&predicate).await.default_error()
|
||||||
Ok(res.into())
|
|
||||||
}
|
}
|
||||||
|
|
||||||
#[napi(catch_unwind)]
|
#[napi(catch_unwind)]
|
||||||
@@ -170,7 +168,7 @@ impl Table {
|
|||||||
&self,
|
&self,
|
||||||
only_if: Option<String>,
|
only_if: Option<String>,
|
||||||
columns: Vec<(String, String)>,
|
columns: Vec<(String, String)>,
|
||||||
) -> napi::Result<UpdateResult> {
|
) -> napi::Result<u64> {
|
||||||
let mut op = self.inner_ref()?.update();
|
let mut op = self.inner_ref()?.update();
|
||||||
if let Some(only_if) = only_if {
|
if let Some(only_if) = only_if {
|
||||||
op = op.only_if(only_if);
|
op = op.only_if(only_if);
|
||||||
@@ -178,8 +176,7 @@ impl Table {
|
|||||||
for (column_name, value) in columns {
|
for (column_name, value) in columns {
|
||||||
op = op.column(column_name, value);
|
op = op.column(column_name, value);
|
||||||
}
|
}
|
||||||
let res = op.execute().await.default_error()?;
|
op.execute().await.default_error()
|
||||||
Ok(res.into())
|
|
||||||
}
|
}
|
||||||
|
|
||||||
#[napi(catch_unwind)]
|
#[napi(catch_unwind)]
|
||||||
@@ -193,28 +190,21 @@ impl Table {
|
|||||||
}
|
}
|
||||||
|
|
||||||
#[napi(catch_unwind)]
|
#[napi(catch_unwind)]
|
||||||
pub async fn add_columns(
|
pub async fn add_columns(&self, transforms: Vec<AddColumnsSql>) -> napi::Result<()> {
|
||||||
&self,
|
|
||||||
transforms: Vec<AddColumnsSql>,
|
|
||||||
) -> napi::Result<AddColumnsResult> {
|
|
||||||
let transforms = transforms
|
let transforms = transforms
|
||||||
.into_iter()
|
.into_iter()
|
||||||
.map(|sql| (sql.name, sql.value_sql))
|
.map(|sql| (sql.name, sql.value_sql))
|
||||||
.collect::<Vec<_>>();
|
.collect::<Vec<_>>();
|
||||||
let transforms = NewColumnTransform::SqlExpressions(transforms);
|
let transforms = NewColumnTransform::SqlExpressions(transforms);
|
||||||
let res = self
|
self.inner_ref()?
|
||||||
.inner_ref()?
|
|
||||||
.add_columns(transforms, None)
|
.add_columns(transforms, None)
|
||||||
.await
|
.await
|
||||||
.default_error()?;
|
.default_error()?;
|
||||||
Ok(res.into())
|
Ok(())
|
||||||
}
|
}
|
||||||
|
|
||||||
#[napi(catch_unwind)]
|
#[napi(catch_unwind)]
|
||||||
pub async fn alter_columns(
|
pub async fn alter_columns(&self, alterations: Vec<ColumnAlteration>) -> napi::Result<()> {
|
||||||
&self,
|
|
||||||
alterations: Vec<ColumnAlteration>,
|
|
||||||
) -> napi::Result<AlterColumnsResult> {
|
|
||||||
for alteration in &alterations {
|
for alteration in &alterations {
|
||||||
if alteration.rename.is_none()
|
if alteration.rename.is_none()
|
||||||
&& alteration.nullable.is_none()
|
&& alteration.nullable.is_none()
|
||||||
@@ -231,23 +221,21 @@ impl Table {
|
|||||||
.collect::<std::result::Result<Vec<_>, String>>()
|
.collect::<std::result::Result<Vec<_>, String>>()
|
||||||
.map_err(napi::Error::from_reason)?;
|
.map_err(napi::Error::from_reason)?;
|
||||||
|
|
||||||
let res = self
|
self.inner_ref()?
|
||||||
.inner_ref()?
|
|
||||||
.alter_columns(&alterations)
|
.alter_columns(&alterations)
|
||||||
.await
|
.await
|
||||||
.default_error()?;
|
.default_error()?;
|
||||||
Ok(res.into())
|
Ok(())
|
||||||
}
|
}
|
||||||
|
|
||||||
#[napi(catch_unwind)]
|
#[napi(catch_unwind)]
|
||||||
pub async fn drop_columns(&self, columns: Vec<String>) -> napi::Result<DropColumnsResult> {
|
pub async fn drop_columns(&self, columns: Vec<String>) -> napi::Result<()> {
|
||||||
let col_refs = columns.iter().map(String::as_str).collect::<Vec<_>>();
|
let col_refs = columns.iter().map(String::as_str).collect::<Vec<_>>();
|
||||||
let res = self
|
self.inner_ref()?
|
||||||
.inner_ref()?
|
|
||||||
.drop_columns(&col_refs)
|
.drop_columns(&col_refs)
|
||||||
.await
|
.await
|
||||||
.default_error()?;
|
.default_error()?;
|
||||||
Ok(res.into())
|
Ok(())
|
||||||
}
|
}
|
||||||
|
|
||||||
#[napi(catch_unwind)]
|
#[napi(catch_unwind)]
|
||||||
@@ -654,105 +642,6 @@ pub struct Version {
|
|||||||
pub metadata: HashMap<String, String>,
|
pub metadata: HashMap<String, String>,
|
||||||
}
|
}
|
||||||
|
|
||||||
#[napi(object)]
|
|
||||||
pub struct UpdateResult {
|
|
||||||
pub rows_updated: i64,
|
|
||||||
pub version: i64,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl From<lancedb::table::UpdateResult> for UpdateResult {
|
|
||||||
fn from(value: lancedb::table::UpdateResult) -> Self {
|
|
||||||
Self {
|
|
||||||
rows_updated: value.rows_updated as i64,
|
|
||||||
version: value.version as i64,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[napi(object)]
|
|
||||||
pub struct AddResult {
|
|
||||||
pub version: i64,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl From<lancedb::table::AddResult> for AddResult {
|
|
||||||
fn from(value: lancedb::table::AddResult) -> Self {
|
|
||||||
Self {
|
|
||||||
version: value.version as i64,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[napi(object)]
|
|
||||||
pub struct DeleteResult {
|
|
||||||
pub version: i64,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl From<lancedb::table::DeleteResult> for DeleteResult {
|
|
||||||
fn from(value: lancedb::table::DeleteResult) -> Self {
|
|
||||||
Self {
|
|
||||||
version: value.version as i64,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[napi(object)]
|
|
||||||
pub struct MergeResult {
|
|
||||||
pub version: i64,
|
|
||||||
pub num_inserted_rows: i64,
|
|
||||||
pub num_updated_rows: i64,
|
|
||||||
pub num_deleted_rows: i64,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl From<lancedb::table::MergeResult> for MergeResult {
|
|
||||||
fn from(value: lancedb::table::MergeResult) -> Self {
|
|
||||||
Self {
|
|
||||||
version: value.version as i64,
|
|
||||||
num_inserted_rows: value.num_inserted_rows as i64,
|
|
||||||
num_updated_rows: value.num_updated_rows as i64,
|
|
||||||
num_deleted_rows: value.num_deleted_rows as i64,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[napi(object)]
|
|
||||||
pub struct AddColumnsResult {
|
|
||||||
pub version: i64,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl From<lancedb::table::AddColumnsResult> for AddColumnsResult {
|
|
||||||
fn from(value: lancedb::table::AddColumnsResult) -> Self {
|
|
||||||
Self {
|
|
||||||
version: value.version as i64,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[napi(object)]
|
|
||||||
pub struct AlterColumnsResult {
|
|
||||||
pub version: i64,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl From<lancedb::table::AlterColumnsResult> for AlterColumnsResult {
|
|
||||||
fn from(value: lancedb::table::AlterColumnsResult) -> Self {
|
|
||||||
Self {
|
|
||||||
version: value.version as i64,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[napi(object)]
|
|
||||||
pub struct DropColumnsResult {
|
|
||||||
pub version: i64,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl From<lancedb::table::DropColumnsResult> for DropColumnsResult {
|
|
||||||
fn from(value: lancedb::table::DropColumnsResult) -> Self {
|
|
||||||
Self {
|
|
||||||
version: value.version as i64,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[napi]
|
#[napi]
|
||||||
pub struct TagContents {
|
pub struct TagContents {
|
||||||
pub version: i64,
|
pub version: i64,
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
[tool.bumpversion]
|
[tool.bumpversion]
|
||||||
current_version = "0.24.2-beta.1"
|
current_version = "0.22.1-beta.1"
|
||||||
parse = """(?x)
|
parse = """(?x)
|
||||||
(?P<major>0|[1-9]\\d*)\\.
|
(?P<major>0|[1-9]\\d*)\\.
|
||||||
(?P<minor>0|[1-9]\\d*)\\.
|
(?P<minor>0|[1-9]\\d*)\\.
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
[package]
|
[package]
|
||||||
name = "lancedb-python"
|
name = "lancedb-python"
|
||||||
version = "0.24.2-beta.1"
|
version = "0.22.1-beta.1"
|
||||||
edition.workspace = true
|
edition.workspace = true
|
||||||
description = "Python bindings for LanceDB"
|
description = "Python bindings for LanceDB"
|
||||||
license.workspace = true
|
license.workspace = true
|
||||||
@@ -14,11 +14,11 @@ name = "_lancedb"
|
|||||||
crate-type = ["cdylib"]
|
crate-type = ["cdylib"]
|
||||||
|
|
||||||
[dependencies]
|
[dependencies]
|
||||||
arrow = { version = "55.1", features = ["pyarrow"] }
|
arrow = { version = "54.1", features = ["pyarrow"] }
|
||||||
lancedb = { path = "../rust/lancedb", default-features = false }
|
lancedb = { path = "../rust/lancedb", default-features = false }
|
||||||
env_logger.workspace = true
|
env_logger.workspace = true
|
||||||
pyo3 = { version = "0.24", features = ["extension-module", "abi3-py39"] }
|
pyo3 = { version = "0.23", features = ["extension-module", "abi3-py39"] }
|
||||||
pyo3-async-runtimes = { version = "0.24", features = [
|
pyo3-async-runtimes = { version = "0.23", features = [
|
||||||
"attributes",
|
"attributes",
|
||||||
"tokio-runtime",
|
"tokio-runtime",
|
||||||
] }
|
] }
|
||||||
@@ -27,7 +27,7 @@ futures.workspace = true
|
|||||||
tokio = { version = "1.40", features = ["sync"] }
|
tokio = { version = "1.40", features = ["sync"] }
|
||||||
|
|
||||||
[build-dependencies]
|
[build-dependencies]
|
||||||
pyo3-build-config = { version = "0.24", features = [
|
pyo3-build-config = { version = "0.23", features = [
|
||||||
"extension-module",
|
"extension-module",
|
||||||
"abi3-py39",
|
"abi3-py39",
|
||||||
] }
|
] }
|
||||||
|
|||||||
@@ -60,7 +60,6 @@ tests = [
|
|||||||
"pyarrow-stubs",
|
"pyarrow-stubs",
|
||||||
"pylance>=0.25",
|
"pylance>=0.25",
|
||||||
"requests",
|
"requests",
|
||||||
"datafusion",
|
|
||||||
]
|
]
|
||||||
dev = [
|
dev = [
|
||||||
"ruff",
|
"ruff",
|
||||||
@@ -85,7 +84,7 @@ embeddings = [
|
|||||||
"boto3>=1.28.57",
|
"boto3>=1.28.57",
|
||||||
"awscli>=1.29.57",
|
"awscli>=1.29.57",
|
||||||
"botocore>=1.31.57",
|
"botocore>=1.31.57",
|
||||||
"ollama>=0.3.0",
|
"ollama",
|
||||||
"ibm-watsonx-ai>=1.1.2",
|
"ibm-watsonx-ai>=1.1.2",
|
||||||
]
|
]
|
||||||
azure = ["adlfs>=2024.2.0"]
|
azure = ["adlfs>=2024.2.0"]
|
||||||
|
|||||||
@@ -36,10 +36,8 @@ class Table:
|
|||||||
async def schema(self) -> pa.Schema: ...
|
async def schema(self) -> pa.Schema: ...
|
||||||
async def add(
|
async def add(
|
||||||
self, data: pa.RecordBatchReader, mode: Literal["append", "overwrite"]
|
self, data: pa.RecordBatchReader, mode: Literal["append", "overwrite"]
|
||||||
) -> AddResult: ...
|
) -> None: ...
|
||||||
async def update(
|
async def update(self, updates: Dict[str, str], where: Optional[str]) -> None: ...
|
||||||
self, updates: Dict[str, str], where: Optional[str]
|
|
||||||
) -> UpdateResult: ...
|
|
||||||
async def count_rows(self, filter: Optional[str]) -> int: ...
|
async def count_rows(self, filter: Optional[str]) -> int: ...
|
||||||
async def create_index(
|
async def create_index(
|
||||||
self,
|
self,
|
||||||
@@ -51,14 +49,12 @@ class Table:
|
|||||||
async def version(self) -> int: ...
|
async def version(self) -> int: ...
|
||||||
async def checkout(self, version: Union[int, str]): ...
|
async def checkout(self, version: Union[int, str]): ...
|
||||||
async def checkout_latest(self): ...
|
async def checkout_latest(self): ...
|
||||||
async def restore(self, version: Optional[Union[int, str]] = None): ...
|
async def restore(self, version: Optional[int] = None): ...
|
||||||
async def list_indices(self) -> list[IndexConfig]: ...
|
async def list_indices(self) -> list[IndexConfig]: ...
|
||||||
async def delete(self, filter: str) -> DeleteResult: ...
|
async def delete(self, filter: str): ...
|
||||||
async def add_columns(self, columns: list[tuple[str, str]]) -> AddColumnsResult: ...
|
async def add_columns(self, columns: list[tuple[str, str]]) -> None: ...
|
||||||
async def add_columns_with_schema(self, schema: pa.Schema) -> AddColumnsResult: ...
|
async def add_columns_with_schema(self, schema: pa.Schema) -> None: ...
|
||||||
async def alter_columns(
|
async def alter_columns(self, columns: list[dict[str, Any]]) -> None: ...
|
||||||
self, columns: list[dict[str, Any]]
|
|
||||||
) -> AlterColumnsResult: ...
|
|
||||||
async def optimize(
|
async def optimize(
|
||||||
self,
|
self,
|
||||||
*,
|
*,
|
||||||
@@ -143,8 +139,6 @@ class VectorQuery:
|
|||||||
def postfilter(self): ...
|
def postfilter(self): ...
|
||||||
def refine_factor(self, refine_factor: int): ...
|
def refine_factor(self, refine_factor: int): ...
|
||||||
def nprobes(self, nprobes: int): ...
|
def nprobes(self, nprobes: int): ...
|
||||||
def minimum_nprobes(self, minimum_nprobes: int): ...
|
|
||||||
def maximum_nprobes(self, maximum_nprobes: int): ...
|
|
||||||
def bypass_vector_index(self): ...
|
def bypass_vector_index(self): ...
|
||||||
def nearest_to_text(self, query: dict) -> HybridQuery: ...
|
def nearest_to_text(self, query: dict) -> HybridQuery: ...
|
||||||
def to_query_request(self) -> PyQueryRequest: ...
|
def to_query_request(self) -> PyQueryRequest: ...
|
||||||
@@ -160,8 +154,6 @@ class HybridQuery:
|
|||||||
def distance_type(self, distance_type: str): ...
|
def distance_type(self, distance_type: str): ...
|
||||||
def refine_factor(self, refine_factor: int): ...
|
def refine_factor(self, refine_factor: int): ...
|
||||||
def nprobes(self, nprobes: int): ...
|
def nprobes(self, nprobes: int): ...
|
||||||
def minimum_nprobes(self, minimum_nprobes: int): ...
|
|
||||||
def maximum_nprobes(self, maximum_nprobes: int): ...
|
|
||||||
def bypass_vector_index(self): ...
|
def bypass_vector_index(self): ...
|
||||||
def to_vector_query(self) -> VectorQuery: ...
|
def to_vector_query(self) -> VectorQuery: ...
|
||||||
def to_fts_query(self) -> FTSQuery: ...
|
def to_fts_query(self) -> FTSQuery: ...
|
||||||
@@ -169,21 +161,23 @@ class HybridQuery:
|
|||||||
def get_with_row_id(self) -> bool: ...
|
def get_with_row_id(self) -> bool: ...
|
||||||
def to_query_request(self) -> PyQueryRequest: ...
|
def to_query_request(self) -> PyQueryRequest: ...
|
||||||
|
|
||||||
class FullTextQuery:
|
class PyFullTextSearchQuery:
|
||||||
pass
|
columns: Optional[List[str]]
|
||||||
|
query: str
|
||||||
|
limit: Optional[int]
|
||||||
|
wand_factor: Optional[float]
|
||||||
|
|
||||||
class PyQueryRequest:
|
class PyQueryRequest:
|
||||||
limit: Optional[int]
|
limit: Optional[int]
|
||||||
offset: Optional[int]
|
offset: Optional[int]
|
||||||
filter: Optional[Union[str, bytes]]
|
filter: Optional[Union[str, bytes]]
|
||||||
full_text_search: Optional[FullTextQuery]
|
full_text_search: Optional[PyFullTextSearchQuery]
|
||||||
select: Optional[Union[str, List[str]]]
|
select: Optional[Union[str, List[str]]]
|
||||||
fast_search: Optional[bool]
|
fast_search: Optional[bool]
|
||||||
with_row_id: Optional[bool]
|
with_row_id: Optional[bool]
|
||||||
column: Optional[str]
|
column: Optional[str]
|
||||||
query_vector: Optional[List[pa.Array]]
|
query_vector: Optional[List[pa.Array]]
|
||||||
minimum_nprobes: Optional[int]
|
nprobes: Optional[int]
|
||||||
maximum_nprobes: Optional[int]
|
|
||||||
lower_bound: Optional[float]
|
lower_bound: Optional[float]
|
||||||
upper_bound: Optional[float]
|
upper_bound: Optional[float]
|
||||||
ef: Optional[int]
|
ef: Optional[int]
|
||||||
@@ -214,28 +208,3 @@ class OptimizeStats:
|
|||||||
class Tag(TypedDict):
|
class Tag(TypedDict):
|
||||||
version: int
|
version: int
|
||||||
manifest_size: int
|
manifest_size: int
|
||||||
|
|
||||||
class AddResult:
|
|
||||||
version: int
|
|
||||||
|
|
||||||
class DeleteResult:
|
|
||||||
version: int
|
|
||||||
|
|
||||||
class UpdateResult:
|
|
||||||
rows_updated: int
|
|
||||||
version: int
|
|
||||||
|
|
||||||
class MergeResult:
|
|
||||||
version: int
|
|
||||||
num_updated_rows: int
|
|
||||||
num_inserted_rows: int
|
|
||||||
num_deleted_rows: int
|
|
||||||
|
|
||||||
class AddColumnsResult:
|
|
||||||
version: int
|
|
||||||
|
|
||||||
class AlterColumnsResult:
|
|
||||||
version: int
|
|
||||||
|
|
||||||
class DropColumnsResult:
|
|
||||||
version: int
|
|
||||||
|
|||||||
@@ -2,15 +2,14 @@
|
|||||||
# SPDX-FileCopyrightText: Copyright The LanceDB Authors
|
# SPDX-FileCopyrightText: Copyright The LanceDB Authors
|
||||||
|
|
||||||
from functools import cached_property
|
from functools import cached_property
|
||||||
from typing import TYPE_CHECKING, List, Optional, Sequence, Union
|
from typing import TYPE_CHECKING, List, Optional, Union
|
||||||
|
|
||||||
import numpy as np
|
|
||||||
|
|
||||||
from ..util import attempt_import_or_raise
|
from ..util import attempt_import_or_raise
|
||||||
from .base import TextEmbeddingFunction
|
from .base import TextEmbeddingFunction
|
||||||
from .registry import register
|
from .registry import register
|
||||||
|
|
||||||
if TYPE_CHECKING:
|
if TYPE_CHECKING:
|
||||||
|
import numpy as np
|
||||||
import ollama
|
import ollama
|
||||||
|
|
||||||
|
|
||||||
@@ -29,21 +28,23 @@ class OllamaEmbeddings(TextEmbeddingFunction):
|
|||||||
keep_alive: Optional[Union[float, str]] = None
|
keep_alive: Optional[Union[float, str]] = None
|
||||||
ollama_client_kwargs: Optional[dict] = {}
|
ollama_client_kwargs: Optional[dict] = {}
|
||||||
|
|
||||||
def ndims(self) -> int:
|
def ndims(self):
|
||||||
return len(self.generate_embeddings(["foo"])[0])
|
return len(self.generate_embeddings(["foo"])[0])
|
||||||
|
|
||||||
def _compute_embedding(self, text: Sequence[str]) -> Sequence[Sequence[float]]:
|
def _compute_embedding(self, text) -> Union["np.array", None]:
|
||||||
response = self._ollama_client.embed(
|
return (
|
||||||
|
self._ollama_client.embeddings(
|
||||||
model=self.name,
|
model=self.name,
|
||||||
input=text,
|
prompt=text,
|
||||||
options=self.options,
|
options=self.options,
|
||||||
keep_alive=self.keep_alive,
|
keep_alive=self.keep_alive,
|
||||||
|
)["embedding"]
|
||||||
|
or None
|
||||||
)
|
)
|
||||||
return response.embeddings
|
|
||||||
|
|
||||||
def generate_embeddings(
|
def generate_embeddings(
|
||||||
self, texts: Union[List[str], np.ndarray]
|
self, texts: Union[List[str], "np.ndarray"]
|
||||||
) -> list[Union[np.array, None]]:
|
) -> list[Union["np.array", None]]:
|
||||||
"""
|
"""
|
||||||
Get the embeddings for the given texts
|
Get the embeddings for the given texts
|
||||||
|
|
||||||
@@ -53,8 +54,8 @@ class OllamaEmbeddings(TextEmbeddingFunction):
|
|||||||
The texts to embed
|
The texts to embed
|
||||||
"""
|
"""
|
||||||
# TODO retry, rate limit, token limit
|
# TODO retry, rate limit, token limit
|
||||||
embeddings = self._compute_embedding(texts)
|
embeddings = [self._compute_embedding(text) for text in texts]
|
||||||
return list(embeddings)
|
return embeddings
|
||||||
|
|
||||||
@cached_property
|
@cached_property
|
||||||
def _ollama_client(self) -> "ollama.Client":
|
def _ollama_client(self) -> "ollama.Client":
|
||||||
|
|||||||
@@ -102,7 +102,7 @@ class FTS:
|
|||||||
|
|
||||||
Attributes
|
Attributes
|
||||||
----------
|
----------
|
||||||
with_position : bool, default False
|
with_position : bool, default True
|
||||||
Whether to store the position of the token in the document. Setting this
|
Whether to store the position of the token in the document. Setting this
|
||||||
to False can reduce the size of the index and improve indexing speed,
|
to False can reduce the size of the index and improve indexing speed,
|
||||||
but it will disable support for phrase queries.
|
but it will disable support for phrase queries.
|
||||||
@@ -118,28 +118,25 @@ class FTS:
|
|||||||
ignored.
|
ignored.
|
||||||
lower_case : bool, default True
|
lower_case : bool, default True
|
||||||
Whether to convert the token to lower case. This makes queries case-insensitive.
|
Whether to convert the token to lower case. This makes queries case-insensitive.
|
||||||
stem : bool, default True
|
stem : bool, default False
|
||||||
Whether to stem the token. Stemming reduces words to their root form.
|
Whether to stem the token. Stemming reduces words to their root form.
|
||||||
For example, in English "running" and "runs" would both be reduced to "run".
|
For example, in English "running" and "runs" would both be reduced to "run".
|
||||||
remove_stop_words : bool, default True
|
remove_stop_words : bool, default False
|
||||||
Whether to remove stop words. Stop words are common words that are often
|
Whether to remove stop words. Stop words are common words that are often
|
||||||
removed from text before indexing. For example, in English "the" and "and".
|
removed from text before indexing. For example, in English "the" and "and".
|
||||||
ascii_folding : bool, default True
|
ascii_folding : bool, default False
|
||||||
Whether to fold ASCII characters. This converts accented characters to
|
Whether to fold ASCII characters. This converts accented characters to
|
||||||
their ASCII equivalent. For example, "café" would be converted to "cafe".
|
their ASCII equivalent. For example, "café" would be converted to "cafe".
|
||||||
"""
|
"""
|
||||||
|
|
||||||
with_position: bool = False
|
with_position: bool = True
|
||||||
base_tokenizer: Literal["simple", "raw", "whitespace"] = "simple"
|
base_tokenizer: Literal["simple", "raw", "whitespace"] = "simple"
|
||||||
language: str = "English"
|
language: str = "English"
|
||||||
max_token_length: Optional[int] = 40
|
max_token_length: Optional[int] = 40
|
||||||
lower_case: bool = True
|
lower_case: bool = True
|
||||||
stem: bool = True
|
stem: bool = False
|
||||||
remove_stop_words: bool = True
|
remove_stop_words: bool = False
|
||||||
ascii_folding: bool = True
|
ascii_folding: bool = False
|
||||||
ngram_min_length: int = 3
|
|
||||||
ngram_max_length: int = 3
|
|
||||||
prefix_only: bool = False
|
|
||||||
|
|
||||||
|
|
||||||
@dataclass
|
@dataclass
|
||||||
|
|||||||
@@ -4,14 +4,10 @@
|
|||||||
|
|
||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|
||||||
from datetime import timedelta
|
|
||||||
from typing import TYPE_CHECKING, List, Optional
|
from typing import TYPE_CHECKING, List, Optional
|
||||||
|
|
||||||
if TYPE_CHECKING:
|
if TYPE_CHECKING:
|
||||||
from .common import DATA
|
from .common import DATA
|
||||||
from ._lancedb import (
|
|
||||||
MergeInsertResult,
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
class LanceMergeInsertBuilder(object):
|
class LanceMergeInsertBuilder(object):
|
||||||
@@ -32,7 +28,6 @@ class LanceMergeInsertBuilder(object):
|
|||||||
self._when_not_matched_insert_all = False
|
self._when_not_matched_insert_all = False
|
||||||
self._when_not_matched_by_source_delete = False
|
self._when_not_matched_by_source_delete = False
|
||||||
self._when_not_matched_by_source_condition = None
|
self._when_not_matched_by_source_condition = None
|
||||||
self._timeout = None
|
|
||||||
|
|
||||||
def when_matched_update_all(
|
def when_matched_update_all(
|
||||||
self, *, where: Optional[str] = None
|
self, *, where: Optional[str] = None
|
||||||
@@ -83,8 +78,7 @@ class LanceMergeInsertBuilder(object):
|
|||||||
new_data: DATA,
|
new_data: DATA,
|
||||||
on_bad_vectors: str = "error",
|
on_bad_vectors: str = "error",
|
||||||
fill_value: float = 0.0,
|
fill_value: float = 0.0,
|
||||||
timeout: Optional[timedelta] = None,
|
):
|
||||||
) -> MergeInsertResult:
|
|
||||||
"""
|
"""
|
||||||
Executes the merge insert operation
|
Executes the merge insert operation
|
||||||
|
|
||||||
@@ -101,24 +95,5 @@ class LanceMergeInsertBuilder(object):
|
|||||||
One of "error", "drop", "fill".
|
One of "error", "drop", "fill".
|
||||||
fill_value: float, default 0.
|
fill_value: float, default 0.
|
||||||
The value to use when filling vectors. Only used if on_bad_vectors="fill".
|
The value to use when filling vectors. Only used if on_bad_vectors="fill".
|
||||||
timeout: Optional[timedelta], default None
|
|
||||||
Maximum time to run the operation before cancelling it.
|
|
||||||
|
|
||||||
By default, there is a 30-second timeout that is only enforced after the
|
|
||||||
first attempt. This is to prevent spending too long retrying to resolve
|
|
||||||
conflicts. For example, if a write attempt takes 20 seconds and fails,
|
|
||||||
the second attempt will be cancelled after 10 seconds, hitting the
|
|
||||||
30-second timeout. However, a write that takes one hour and succeeds on the
|
|
||||||
first attempt will not be cancelled.
|
|
||||||
|
|
||||||
When this is set, the timeout is enforced on all attempts, including
|
|
||||||
the first.
|
|
||||||
|
|
||||||
Returns
|
|
||||||
-------
|
|
||||||
MergeInsertResult
|
|
||||||
version: the new version number of the table after doing merge insert.
|
|
||||||
"""
|
"""
|
||||||
if timeout is not None:
|
|
||||||
self._timeout = timeout
|
|
||||||
return self._table._do_merge(self, new_data, on_bad_vectors, fill_value)
|
return self._table._do_merge(self, new_data, on_bad_vectors, fill_value)
|
||||||
|
|||||||
@@ -415,7 +415,6 @@ class LanceModel(pydantic.BaseModel):
|
|||||||
>>> table.add([
|
>>> table.add([
|
||||||
... TestModel(name="test", vector=[1.0, 2.0])
|
... TestModel(name="test", vector=[1.0, 2.0])
|
||||||
... ])
|
... ])
|
||||||
AddResult(version=2)
|
|
||||||
>>> table.search([0., 0.]).limit(1).to_pydantic(TestModel)
|
>>> table.search([0., 0.]).limit(1).to_pydantic(TestModel)
|
||||||
[TestModel(name='test', vector=FixedSizeList(dim=2))]
|
[TestModel(name='test', vector=FixedSizeList(dim=2))]
|
||||||
"""
|
"""
|
||||||
|
|||||||
@@ -4,6 +4,7 @@
|
|||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|
||||||
from abc import ABC, abstractmethod
|
from abc import ABC, abstractmethod
|
||||||
|
import abc
|
||||||
from concurrent.futures import ThreadPoolExecutor
|
from concurrent.futures import ThreadPoolExecutor
|
||||||
from enum import Enum
|
from enum import Enum
|
||||||
from datetime import timedelta
|
from datetime import timedelta
|
||||||
@@ -87,28 +88,15 @@ def ensure_vector_query(
|
|||||||
return val
|
return val
|
||||||
|
|
||||||
|
|
||||||
class FullTextQueryType(str, Enum):
|
class FullTextQueryType(Enum):
|
||||||
MATCH = "match"
|
MATCH = "match"
|
||||||
MATCH_PHRASE = "match_phrase"
|
MATCH_PHRASE = "match_phrase"
|
||||||
BOOST = "boost"
|
BOOST = "boost"
|
||||||
MULTI_MATCH = "multi_match"
|
MULTI_MATCH = "multi_match"
|
||||||
BOOLEAN = "boolean"
|
|
||||||
|
|
||||||
|
|
||||||
class FullTextOperator(str, Enum):
|
class FullTextQuery(abc.ABC, pydantic.BaseModel):
|
||||||
AND = "AND"
|
@abc.abstractmethod
|
||||||
OR = "OR"
|
|
||||||
|
|
||||||
|
|
||||||
class Occur(str, Enum):
|
|
||||||
SHOULD = "SHOULD"
|
|
||||||
MUST = "MUST"
|
|
||||||
MUST_NOT = "MUST_NOT"
|
|
||||||
|
|
||||||
|
|
||||||
@pydantic.dataclasses.dataclass
|
|
||||||
class FullTextQuery(ABC):
|
|
||||||
@abstractmethod
|
|
||||||
def query_type(self) -> FullTextQueryType:
|
def query_type(self) -> FullTextQueryType:
|
||||||
"""
|
"""
|
||||||
Get the query type of the query.
|
Get the query type of the query.
|
||||||
@@ -118,43 +106,35 @@ class FullTextQuery(ABC):
|
|||||||
str
|
str
|
||||||
The type of the query.
|
The type of the query.
|
||||||
"""
|
"""
|
||||||
pass
|
|
||||||
|
|
||||||
def __and__(self, other: "FullTextQuery") -> "FullTextQuery":
|
@abc.abstractmethod
|
||||||
|
def to_dict(self) -> dict:
|
||||||
"""
|
"""
|
||||||
Combine two queries with a logical AND operation.
|
Convert the query to a dictionary.
|
||||||
|
|
||||||
Parameters
|
|
||||||
----------
|
|
||||||
other : FullTextQuery
|
|
||||||
The other query to combine with.
|
|
||||||
|
|
||||||
Returns
|
Returns
|
||||||
-------
|
-------
|
||||||
FullTextQuery
|
dict
|
||||||
A new query that combines both queries with AND.
|
The query as a dictionary.
|
||||||
"""
|
"""
|
||||||
return BooleanQuery([(Occur.MUST, self), (Occur.MUST, other)])
|
|
||||||
|
|
||||||
def __or__(self, other: "FullTextQuery") -> "FullTextQuery":
|
|
||||||
"""
|
|
||||||
Combine two queries with a logical OR operation.
|
|
||||||
|
|
||||||
Parameters
|
|
||||||
----------
|
|
||||||
other : FullTextQuery
|
|
||||||
The other query to combine with.
|
|
||||||
|
|
||||||
Returns
|
|
||||||
-------
|
|
||||||
FullTextQuery
|
|
||||||
A new query that combines both queries with OR.
|
|
||||||
"""
|
|
||||||
return BooleanQuery([(Occur.SHOULD, self), (Occur.SHOULD, other)])
|
|
||||||
|
|
||||||
|
|
||||||
@pydantic.dataclasses.dataclass
|
|
||||||
class MatchQuery(FullTextQuery):
|
class MatchQuery(FullTextQuery):
|
||||||
|
query: str
|
||||||
|
column: str
|
||||||
|
boost: float = 1.0
|
||||||
|
fuzziness: int = 0
|
||||||
|
max_expansions: int = 50
|
||||||
|
|
||||||
|
def __init__(
|
||||||
|
self,
|
||||||
|
query: str,
|
||||||
|
column: str,
|
||||||
|
*,
|
||||||
|
boost: float = 1.0,
|
||||||
|
fuzziness: int = 0,
|
||||||
|
max_expansions: int = 50,
|
||||||
|
):
|
||||||
"""
|
"""
|
||||||
Match query for full-text search.
|
Match query for full-text search.
|
||||||
|
|
||||||
@@ -177,30 +157,36 @@ class MatchQuery(FullTextQuery):
|
|||||||
max_expansions : int, optional
|
max_expansions : int, optional
|
||||||
The maximum number of terms to consider for fuzzy matching.
|
The maximum number of terms to consider for fuzzy matching.
|
||||||
Defaults to 50.
|
Defaults to 50.
|
||||||
operator : FullTextOperator, default OR
|
|
||||||
The operator to use for combining the query results.
|
|
||||||
Can be either `AND` or `OR`.
|
|
||||||
If `AND`, all terms in the query must match.
|
|
||||||
If `OR`, at least one term in the query must match.
|
|
||||||
prefix_length : int, optional
|
|
||||||
The number of beginning characters being unchanged for fuzzy matching.
|
|
||||||
This is useful to achieve prefix matching.
|
|
||||||
"""
|
"""
|
||||||
|
super().__init__(
|
||||||
query: str
|
query=query,
|
||||||
column: str
|
column=column,
|
||||||
boost: float = pydantic.Field(1.0, kw_only=True)
|
boost=boost,
|
||||||
fuzziness: int = pydantic.Field(0, kw_only=True)
|
fuzziness=fuzziness,
|
||||||
max_expansions: int = pydantic.Field(50, kw_only=True)
|
max_expansions=max_expansions,
|
||||||
operator: FullTextOperator = pydantic.Field(FullTextOperator.OR, kw_only=True)
|
)
|
||||||
prefix_length: int = pydantic.Field(0, kw_only=True)
|
|
||||||
|
|
||||||
def query_type(self) -> FullTextQueryType:
|
def query_type(self) -> FullTextQueryType:
|
||||||
return FullTextQueryType.MATCH
|
return FullTextQueryType.MATCH
|
||||||
|
|
||||||
|
def to_dict(self) -> dict:
|
||||||
|
return {
|
||||||
|
"match": {
|
||||||
|
self.column: {
|
||||||
|
"query": self.query,
|
||||||
|
"boost": self.boost,
|
||||||
|
"fuzziness": self.fuzziness,
|
||||||
|
"max_expansions": self.max_expansions,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
@pydantic.dataclasses.dataclass
|
|
||||||
class PhraseQuery(FullTextQuery):
|
class PhraseQuery(FullTextQuery):
|
||||||
|
query: str
|
||||||
|
column: str
|
||||||
|
|
||||||
|
def __init__(self, query: str, column: str):
|
||||||
"""
|
"""
|
||||||
Phrase query for full-text search.
|
Phrase query for full-text search.
|
||||||
|
|
||||||
@@ -211,17 +197,31 @@ class PhraseQuery(FullTextQuery):
|
|||||||
column : str
|
column : str
|
||||||
The name of the column to match against.
|
The name of the column to match against.
|
||||||
"""
|
"""
|
||||||
|
super().__init__(query=query, column=column)
|
||||||
query: str
|
|
||||||
column: str
|
|
||||||
slop: int = pydantic.Field(0, kw_only=True)
|
|
||||||
|
|
||||||
def query_type(self) -> FullTextQueryType:
|
def query_type(self) -> FullTextQueryType:
|
||||||
return FullTextQueryType.MATCH_PHRASE
|
return FullTextQueryType.MATCH_PHRASE
|
||||||
|
|
||||||
|
def to_dict(self) -> dict:
|
||||||
|
return {
|
||||||
|
"match_phrase": {
|
||||||
|
self.column: self.query,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
@pydantic.dataclasses.dataclass
|
|
||||||
class BoostQuery(FullTextQuery):
|
class BoostQuery(FullTextQuery):
|
||||||
|
positive: FullTextQuery
|
||||||
|
negative: FullTextQuery
|
||||||
|
negative_boost: float = 0.5
|
||||||
|
|
||||||
|
def __init__(
|
||||||
|
self,
|
||||||
|
positive: FullTextQuery,
|
||||||
|
negative: FullTextQuery,
|
||||||
|
*,
|
||||||
|
negative_boost: float = 0.5,
|
||||||
|
):
|
||||||
"""
|
"""
|
||||||
Boost query for full-text search.
|
Boost query for full-text search.
|
||||||
|
|
||||||
@@ -231,65 +231,68 @@ class BoostQuery(FullTextQuery):
|
|||||||
The positive query object.
|
The positive query object.
|
||||||
negative : dict
|
negative : dict
|
||||||
The negative query object.
|
The negative query object.
|
||||||
negative_boost : float, default 0.5
|
negative_boost : float
|
||||||
The boost factor for the negative query.
|
The boost factor for the negative query.
|
||||||
"""
|
"""
|
||||||
|
super().__init__(
|
||||||
positive: FullTextQuery
|
positive=positive, negative=negative, negative_boost=negative_boost
|
||||||
negative: FullTextQuery
|
)
|
||||||
negative_boost: float = pydantic.Field(0.5, kw_only=True)
|
|
||||||
|
|
||||||
def query_type(self) -> FullTextQueryType:
|
def query_type(self) -> FullTextQueryType:
|
||||||
return FullTextQueryType.BOOST
|
return FullTextQueryType.BOOST
|
||||||
|
|
||||||
|
def to_dict(self) -> dict:
|
||||||
|
return {
|
||||||
|
"boost": {
|
||||||
|
"positive": self.positive.to_dict(),
|
||||||
|
"negative": self.negative.to_dict(),
|
||||||
|
"negative_boost": self.negative_boost,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
@pydantic.dataclasses.dataclass
|
|
||||||
class MultiMatchQuery(FullTextQuery):
|
class MultiMatchQuery(FullTextQuery):
|
||||||
|
query: str
|
||||||
|
columns: list[str]
|
||||||
|
boosts: list[float]
|
||||||
|
|
||||||
|
def __init__(
|
||||||
|
self,
|
||||||
|
query: str,
|
||||||
|
columns: list[str],
|
||||||
|
*,
|
||||||
|
boosts: Optional[list[float]] = None,
|
||||||
|
):
|
||||||
"""
|
"""
|
||||||
Multi-match query for full-text search.
|
Multi-match query for full-text search.
|
||||||
|
|
||||||
Parameters
|
Parameters
|
||||||
----------
|
----------
|
||||||
query : str | list[Query]
|
query : str
|
||||||
If a string, the query string to match against.
|
The query string to match against.
|
||||||
|
|
||||||
columns : list[str]
|
columns : list[str]
|
||||||
The list of columns to match against.
|
The list of columns to match against.
|
||||||
|
|
||||||
boosts : list[float], optional
|
boosts : list[float], optional
|
||||||
The list of boost factors for each column. If not provided,
|
The list of boost factors for each column. If not provided,
|
||||||
all columns will have the same boost factor.
|
all columns will have the same boost factor.
|
||||||
operator : FullTextOperator, default OR
|
|
||||||
The operator to use for combining the query results.
|
|
||||||
Can be either `AND` or `OR`.
|
|
||||||
It would be applied to all columns individually.
|
|
||||||
For example, if the operator is `AND`,
|
|
||||||
then the query "hello world" is equal to
|
|
||||||
`match("hello AND world", column1) OR match("hello AND world", column2)`.
|
|
||||||
"""
|
"""
|
||||||
|
if boosts is None:
|
||||||
query: str
|
boosts = [1.0] * len(columns)
|
||||||
columns: list[str]
|
super().__init__(query=query, columns=columns, boosts=boosts)
|
||||||
boosts: Optional[list[float]] = pydantic.Field(None, kw_only=True)
|
|
||||||
operator: FullTextOperator = pydantic.Field(FullTextOperator.OR, kw_only=True)
|
|
||||||
|
|
||||||
def query_type(self) -> FullTextQueryType:
|
def query_type(self) -> FullTextQueryType:
|
||||||
return FullTextQueryType.MULTI_MATCH
|
return FullTextQueryType.MULTI_MATCH
|
||||||
|
|
||||||
|
def to_dict(self) -> dict:
|
||||||
@pydantic.dataclasses.dataclass
|
return {
|
||||||
class BooleanQuery(FullTextQuery):
|
"multi_match": {
|
||||||
"""
|
"query": self.query,
|
||||||
Boolean query for full-text search.
|
"columns": self.columns,
|
||||||
|
"boost": self.boosts,
|
||||||
Parameters
|
}
|
||||||
----------
|
}
|
||||||
queries : list[tuple(Occur, FullTextQuery)]
|
|
||||||
The list of queries with their occurrence requirements.
|
|
||||||
"""
|
|
||||||
|
|
||||||
queries: list[tuple[Occur, FullTextQuery]]
|
|
||||||
|
|
||||||
def query_type(self) -> FullTextQueryType:
|
|
||||||
return FullTextQueryType.BOOLEAN
|
|
||||||
|
|
||||||
|
|
||||||
class FullTextSearchQuery(pydantic.BaseModel):
|
class FullTextSearchQuery(pydantic.BaseModel):
|
||||||
@@ -442,18 +445,8 @@ class Query(pydantic.BaseModel):
|
|||||||
# which columns to return in the results
|
# which columns to return in the results
|
||||||
columns: Optional[Union[List[str], Dict[str, str]]] = None
|
columns: Optional[Union[List[str], Dict[str, str]]] = None
|
||||||
|
|
||||||
# minimum number of IVF partitions to search
|
# number of IVF partitions to search
|
||||||
#
|
nprobes: Optional[int] = None
|
||||||
# If None then a default value (20) will be used.
|
|
||||||
minimum_nprobes: Optional[int] = None
|
|
||||||
|
|
||||||
# maximum number of IVF partitions to search
|
|
||||||
#
|
|
||||||
# If None then a default value (20) will be used.
|
|
||||||
#
|
|
||||||
# If 0 then no limit will be applied and all partitions could be searched
|
|
||||||
# if needed to satisfy the limit.
|
|
||||||
maximum_nprobes: Optional[int] = None
|
|
||||||
|
|
||||||
# lower bound for distance search
|
# lower bound for distance search
|
||||||
lower_bound: Optional[float] = None
|
lower_bound: Optional[float] = None
|
||||||
@@ -491,8 +484,7 @@ class Query(pydantic.BaseModel):
|
|||||||
query.vector_column = req.column
|
query.vector_column = req.column
|
||||||
query.vector = req.query_vector
|
query.vector = req.query_vector
|
||||||
query.distance_type = req.distance_type
|
query.distance_type = req.distance_type
|
||||||
query.minimum_nprobes = req.minimum_nprobes
|
query.nprobes = req.nprobes
|
||||||
query.maximum_nprobes = req.maximum_nprobes
|
|
||||||
query.lower_bound = req.lower_bound
|
query.lower_bound = req.lower_bound
|
||||||
query.upper_bound = req.upper_bound
|
query.upper_bound = req.upper_bound
|
||||||
query.ef = req.ef
|
query.ef = req.ef
|
||||||
@@ -501,8 +493,10 @@ class Query(pydantic.BaseModel):
|
|||||||
query.postfilter = req.postfilter
|
query.postfilter = req.postfilter
|
||||||
if req.full_text_search is not None:
|
if req.full_text_search is not None:
|
||||||
query.full_text_query = FullTextSearchQuery(
|
query.full_text_query = FullTextSearchQuery(
|
||||||
columns=None,
|
columns=req.full_text_search.columns,
|
||||||
query=req.full_text_search,
|
query=req.full_text_search.query,
|
||||||
|
limit=req.full_text_search.limit,
|
||||||
|
wand_factor=req.full_text_search.wand_factor,
|
||||||
)
|
)
|
||||||
return query
|
return query
|
||||||
|
|
||||||
@@ -1053,8 +1047,7 @@ class LanceVectorQueryBuilder(LanceQueryBuilder):
|
|||||||
super().__init__(table)
|
super().__init__(table)
|
||||||
self._query = query
|
self._query = query
|
||||||
self._distance_type = None
|
self._distance_type = None
|
||||||
self._minimum_nprobes = None
|
self._nprobes = None
|
||||||
self._maximum_nprobes = None
|
|
||||||
self._lower_bound = None
|
self._lower_bound = None
|
||||||
self._upper_bound = None
|
self._upper_bound = None
|
||||||
self._refine_factor = None
|
self._refine_factor = None
|
||||||
@@ -1117,10 +1110,6 @@ class LanceVectorQueryBuilder(LanceQueryBuilder):
|
|||||||
See discussion in [Querying an ANN Index][querying-an-ann-index] for
|
See discussion in [Querying an ANN Index][querying-an-ann-index] for
|
||||||
tuning advice.
|
tuning advice.
|
||||||
|
|
||||||
This method sets both the minimum and maximum number of probes to the same
|
|
||||||
value. See `minimum_nprobes` and `maximum_nprobes` for more fine-grained
|
|
||||||
control.
|
|
||||||
|
|
||||||
Parameters
|
Parameters
|
||||||
----------
|
----------
|
||||||
nprobes: int
|
nprobes: int
|
||||||
@@ -1131,36 +1120,7 @@ class LanceVectorQueryBuilder(LanceQueryBuilder):
|
|||||||
LanceVectorQueryBuilder
|
LanceVectorQueryBuilder
|
||||||
The LanceQueryBuilder object.
|
The LanceQueryBuilder object.
|
||||||
"""
|
"""
|
||||||
self._minimum_nprobes = nprobes
|
self._nprobes = nprobes
|
||||||
self._maximum_nprobes = nprobes
|
|
||||||
return self
|
|
||||||
|
|
||||||
def minimum_nprobes(self, minimum_nprobes: int) -> LanceVectorQueryBuilder:
|
|
||||||
"""Set the minimum number of probes to use.
|
|
||||||
|
|
||||||
See `nprobes` for more details.
|
|
||||||
|
|
||||||
These partitions will be searched on every vector query and will increase recall
|
|
||||||
at the expense of latency.
|
|
||||||
"""
|
|
||||||
self._minimum_nprobes = minimum_nprobes
|
|
||||||
return self
|
|
||||||
|
|
||||||
def maximum_nprobes(self, maximum_nprobes: int) -> LanceVectorQueryBuilder:
|
|
||||||
"""Set the maximum number of probes to use.
|
|
||||||
|
|
||||||
See `nprobes` for more details.
|
|
||||||
|
|
||||||
If this value is greater than `minimum_nprobes` then the excess partitions
|
|
||||||
will be searched only if we have not found enough results.
|
|
||||||
|
|
||||||
This can be useful when there is a narrow filter to allow these queries to
|
|
||||||
spend more time searching and avoid potential false negatives.
|
|
||||||
|
|
||||||
If this value is 0 then no limit will be applied and all partitions could be
|
|
||||||
searched if needed to satisfy the limit.
|
|
||||||
"""
|
|
||||||
self._maximum_nprobes = maximum_nprobes
|
|
||||||
return self
|
return self
|
||||||
|
|
||||||
def distance_range(
|
def distance_range(
|
||||||
@@ -1264,8 +1224,7 @@ class LanceVectorQueryBuilder(LanceQueryBuilder):
|
|||||||
limit=self._limit,
|
limit=self._limit,
|
||||||
distance_type=self._distance_type,
|
distance_type=self._distance_type,
|
||||||
columns=self._columns,
|
columns=self._columns,
|
||||||
minimum_nprobes=self._minimum_nprobes,
|
nprobes=self._nprobes,
|
||||||
maximum_nprobes=self._maximum_nprobes,
|
|
||||||
lower_bound=self._lower_bound,
|
lower_bound=self._lower_bound,
|
||||||
upper_bound=self._upper_bound,
|
upper_bound=self._upper_bound,
|
||||||
refine_factor=self._refine_factor,
|
refine_factor=self._refine_factor,
|
||||||
@@ -1374,8 +1333,6 @@ class LanceVectorQueryBuilder(LanceQueryBuilder):
|
|||||||
if query_string is not None and not isinstance(query_string, str):
|
if query_string is not None and not isinstance(query_string, str):
|
||||||
raise ValueError("Reranking currently only supports string queries")
|
raise ValueError("Reranking currently only supports string queries")
|
||||||
self._str_query = query_string if query_string is not None else self._str_query
|
self._str_query = query_string if query_string is not None else self._str_query
|
||||||
if reranker.score == "all":
|
|
||||||
self.with_row_id(True)
|
|
||||||
return self
|
return self
|
||||||
|
|
||||||
def bypass_vector_index(self) -> LanceVectorQueryBuilder:
|
def bypass_vector_index(self) -> LanceVectorQueryBuilder:
|
||||||
@@ -1453,13 +1410,10 @@ class LanceFtsQueryBuilder(LanceQueryBuilder):
|
|||||||
|
|
||||||
query = self._query
|
query = self._query
|
||||||
if self._phrase_query:
|
if self._phrase_query:
|
||||||
if isinstance(query, str):
|
raise NotImplementedError(
|
||||||
if not query.startswith('"') or not query.endswith('"'):
|
"Phrase query is not yet supported in Lance FTS. "
|
||||||
query = f'"{query}"'
|
"Use tantivy-based index instead for now."
|
||||||
elif isinstance(query, FullTextQuery) and not isinstance(
|
)
|
||||||
query, PhraseQuery
|
|
||||||
):
|
|
||||||
raise TypeError("Please use PhraseQuery for phrase queries.")
|
|
||||||
query = self.to_query_object()
|
query = self.to_query_object()
|
||||||
results = self._table._execute_query(query, timeout=timeout)
|
results = self._table._execute_query(query, timeout=timeout)
|
||||||
results = results.read_all()
|
results = results.read_all()
|
||||||
@@ -1571,8 +1525,6 @@ class LanceFtsQueryBuilder(LanceQueryBuilder):
|
|||||||
The LanceQueryBuilder object.
|
The LanceQueryBuilder object.
|
||||||
"""
|
"""
|
||||||
self._reranker = reranker
|
self._reranker = reranker
|
||||||
if reranker.score == "all":
|
|
||||||
self.with_row_id(True)
|
|
||||||
return self
|
return self
|
||||||
|
|
||||||
|
|
||||||
@@ -1636,8 +1588,7 @@ class LanceHybridQueryBuilder(LanceQueryBuilder):
|
|||||||
self._fts_columns = fts_columns
|
self._fts_columns = fts_columns
|
||||||
self._norm = None
|
self._norm = None
|
||||||
self._reranker = None
|
self._reranker = None
|
||||||
self._minimum_nprobes = None
|
self._nprobes = None
|
||||||
self._maximum_nprobes = None
|
|
||||||
self._refine_factor = None
|
self._refine_factor = None
|
||||||
self._distance_type = None
|
self._distance_type = None
|
||||||
self._phrase_query = None
|
self._phrase_query = None
|
||||||
@@ -1849,8 +1800,6 @@ class LanceHybridQueryBuilder(LanceQueryBuilder):
|
|||||||
|
|
||||||
self._norm = normalize
|
self._norm = normalize
|
||||||
self._reranker = reranker
|
self._reranker = reranker
|
||||||
if reranker.score == "all":
|
|
||||||
self.with_row_id(True)
|
|
||||||
|
|
||||||
return self
|
return self
|
||||||
|
|
||||||
@@ -1871,24 +1820,7 @@ class LanceHybridQueryBuilder(LanceQueryBuilder):
|
|||||||
LanceHybridQueryBuilder
|
LanceHybridQueryBuilder
|
||||||
The LanceHybridQueryBuilder object.
|
The LanceHybridQueryBuilder object.
|
||||||
"""
|
"""
|
||||||
self._minimum_nprobes = nprobes
|
self._nprobes = nprobes
|
||||||
self._maximum_nprobes = nprobes
|
|
||||||
return self
|
|
||||||
|
|
||||||
def minimum_nprobes(self, minimum_nprobes: int) -> LanceHybridQueryBuilder:
|
|
||||||
"""Set the minimum number of probes to use.
|
|
||||||
|
|
||||||
See `nprobes` for more details.
|
|
||||||
"""
|
|
||||||
self._minimum_nprobes = minimum_nprobes
|
|
||||||
return self
|
|
||||||
|
|
||||||
def maximum_nprobes(self, maximum_nprobes: int) -> LanceHybridQueryBuilder:
|
|
||||||
"""Set the maximum number of probes to use.
|
|
||||||
|
|
||||||
See `nprobes` for more details.
|
|
||||||
"""
|
|
||||||
self._maximum_nprobes = maximum_nprobes
|
|
||||||
return self
|
return self
|
||||||
|
|
||||||
def distance_range(
|
def distance_range(
|
||||||
@@ -2117,10 +2049,8 @@ class LanceHybridQueryBuilder(LanceQueryBuilder):
|
|||||||
self._fts_query.phrase_query(True)
|
self._fts_query.phrase_query(True)
|
||||||
if self._distance_type:
|
if self._distance_type:
|
||||||
self._vector_query.metric(self._distance_type)
|
self._vector_query.metric(self._distance_type)
|
||||||
if self._minimum_nprobes:
|
if self._nprobes:
|
||||||
self._vector_query.minimum_nprobes(self._minimum_nprobes)
|
self._vector_query.nprobes(self._nprobes)
|
||||||
if self._maximum_nprobes is not None:
|
|
||||||
self._vector_query.maximum_nprobes(self._maximum_nprobes)
|
|
||||||
if self._refine_factor:
|
if self._refine_factor:
|
||||||
self._vector_query.refine_factor(self._refine_factor)
|
self._vector_query.refine_factor(self._refine_factor)
|
||||||
if self._ef:
|
if self._ef:
|
||||||
@@ -2583,7 +2513,7 @@ class AsyncQuery(AsyncQueryBase):
|
|||||||
self._inner.nearest_to_text({"query": query, "columns": columns})
|
self._inner.nearest_to_text({"query": query, "columns": columns})
|
||||||
)
|
)
|
||||||
# FullTextQuery object
|
# FullTextQuery object
|
||||||
return AsyncFTSQuery(self._inner.nearest_to_text({"query": query}))
|
return AsyncFTSQuery(self._inner.nearest_to_text({"query": query.to_dict()}))
|
||||||
|
|
||||||
|
|
||||||
class AsyncFTSQuery(AsyncQueryBase):
|
class AsyncFTSQuery(AsyncQueryBase):
|
||||||
@@ -2731,34 +2661,6 @@ class AsyncVectorQueryBase:
|
|||||||
self._inner.nprobes(nprobes)
|
self._inner.nprobes(nprobes)
|
||||||
return self
|
return self
|
||||||
|
|
||||||
def minimum_nprobes(self, minimum_nprobes: int) -> Self:
|
|
||||||
"""Set the minimum number of probes to use.
|
|
||||||
|
|
||||||
See `nprobes` for more details.
|
|
||||||
|
|
||||||
These partitions will be searched on every indexed vector query and will
|
|
||||||
increase recall at the expense of latency.
|
|
||||||
"""
|
|
||||||
self._inner.minimum_nprobes(minimum_nprobes)
|
|
||||||
return self
|
|
||||||
|
|
||||||
def maximum_nprobes(self, maximum_nprobes: int) -> Self:
|
|
||||||
"""Set the maximum number of probes to use.
|
|
||||||
|
|
||||||
See `nprobes` for more details.
|
|
||||||
|
|
||||||
If this value is greater than `minimum_nprobes` then the excess partitions
|
|
||||||
will be searched only if we have not found enough results.
|
|
||||||
|
|
||||||
This can be useful when there is a narrow filter to allow these queries to
|
|
||||||
spend more time searching and avoid potential false negatives.
|
|
||||||
|
|
||||||
If this value is 0 then no limit will be applied and all partitions could be
|
|
||||||
searched if needed to satisfy the limit.
|
|
||||||
"""
|
|
||||||
self._inner.maximum_nprobes(maximum_nprobes)
|
|
||||||
return self
|
|
||||||
|
|
||||||
def distance_range(
|
def distance_range(
|
||||||
self, lower_bound: Optional[float] = None, upper_bound: Optional[float] = None
|
self, lower_bound: Optional[float] = None, upper_bound: Optional[float] = None
|
||||||
) -> Self:
|
) -> Self:
|
||||||
@@ -2933,7 +2835,7 @@ class AsyncVectorQuery(AsyncQueryBase, AsyncVectorQueryBase):
|
|||||||
self._inner.nearest_to_text({"query": query, "columns": columns})
|
self._inner.nearest_to_text({"query": query, "columns": columns})
|
||||||
)
|
)
|
||||||
# FullTextQuery object
|
# FullTextQuery object
|
||||||
return AsyncHybridQuery(self._inner.nearest_to_text({"query": query}))
|
return AsyncHybridQuery(self._inner.nearest_to_text({"query": query.to_dict()}))
|
||||||
|
|
||||||
async def to_batches(
|
async def to_batches(
|
||||||
self,
|
self,
|
||||||
@@ -3055,14 +2957,8 @@ class AsyncHybridQuery(AsyncQueryBase, AsyncVectorQueryBase):
|
|||||||
SortExec: TopK(fetch=10), expr=[_distance@2 ASC NULLS LAST], preserve_partitioning=[false]
|
SortExec: TopK(fetch=10), expr=[_distance@2 ASC NULLS LAST], preserve_partitioning=[false]
|
||||||
KNNVectorDistance: metric=l2
|
KNNVectorDistance: metric=l2
|
||||||
LanceScan: uri=..., projection=[vector], row_id=true, row_addr=false, ordered=false
|
LanceScan: uri=..., projection=[vector], row_id=true, row_addr=false, ordered=false
|
||||||
<BLANKLINE>
|
|
||||||
FTS Search Plan:
|
FTS Search Plan:
|
||||||
ProjectionExec: expr=[vector@2 as vector, text@3 as text, _score@1 as _score]
|
LanceScan: uri=..., projection=[vector, text], row_id=false, row_addr=false, ordered=true
|
||||||
Take: columns="_rowid, _score, (vector), (text)"
|
|
||||||
CoalesceBatchesExec: target_batch_size=1024
|
|
||||||
GlobalLimitExec: skip=0, fetch=10
|
|
||||||
MatchQuery: query=hello
|
|
||||||
<BLANKLINE>
|
|
||||||
|
|
||||||
Parameters
|
Parameters
|
||||||
----------
|
----------
|
||||||
|
|||||||
@@ -7,18 +7,9 @@ from functools import cached_property
|
|||||||
from typing import Dict, Iterable, List, Optional, Union, Literal
|
from typing import Dict, Iterable, List, Optional, Union, Literal
|
||||||
import warnings
|
import warnings
|
||||||
|
|
||||||
from lancedb._lancedb import (
|
from lancedb._lancedb import IndexConfig
|
||||||
AddColumnsResult,
|
|
||||||
AddResult,
|
|
||||||
AlterColumnsResult,
|
|
||||||
DeleteResult,
|
|
||||||
DropColumnsResult,
|
|
||||||
IndexConfig,
|
|
||||||
MergeResult,
|
|
||||||
UpdateResult,
|
|
||||||
)
|
|
||||||
from lancedb.embeddings.base import EmbeddingFunctionConfig
|
from lancedb.embeddings.base import EmbeddingFunctionConfig
|
||||||
from lancedb.index import FTS, BTree, Bitmap, HnswSq, IvfFlat, IvfPq, LabelList
|
from lancedb.index import FTS, BTree, Bitmap, HnswPq, HnswSq, IvfFlat, IvfPq, LabelList
|
||||||
from lancedb.remote.db import LOOP
|
from lancedb.remote.db import LOOP
|
||||||
import pyarrow as pa
|
import pyarrow as pa
|
||||||
|
|
||||||
@@ -47,6 +38,9 @@ class RemoteTable(Table):
|
|||||||
def __repr__(self) -> str:
|
def __repr__(self) -> str:
|
||||||
return f"RemoteTable({self.db_name}.{self.name})"
|
return f"RemoteTable({self.db_name}.{self.name})"
|
||||||
|
|
||||||
|
def __len__(self) -> int:
|
||||||
|
self.count_rows(None)
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def schema(self) -> pa.Schema:
|
def schema(self) -> pa.Schema:
|
||||||
"""The [Arrow Schema](https://arrow.apache.org/docs/python/api/datatypes.html#)
|
"""The [Arrow Schema](https://arrow.apache.org/docs/python/api/datatypes.html#)
|
||||||
@@ -89,7 +83,7 @@ class RemoteTable(Table):
|
|||||||
|
|
||||||
def to_pandas(self):
|
def to_pandas(self):
|
||||||
"""to_pandas() is not yet supported on LanceDB cloud."""
|
"""to_pandas() is not yet supported on LanceDB cloud."""
|
||||||
raise NotImplementedError("to_pandas() is not yet supported on LanceDB cloud.")
|
return NotImplementedError("to_pandas() is not yet supported on LanceDB cloud.")
|
||||||
|
|
||||||
def checkout(self, version: Union[int, str]):
|
def checkout(self, version: Union[int, str]):
|
||||||
return LOOP.run(self._table.checkout(version))
|
return LOOP.run(self._table.checkout(version))
|
||||||
@@ -97,7 +91,7 @@ class RemoteTable(Table):
|
|||||||
def checkout_latest(self):
|
def checkout_latest(self):
|
||||||
return LOOP.run(self._table.checkout_latest())
|
return LOOP.run(self._table.checkout_latest())
|
||||||
|
|
||||||
def restore(self, version: Optional[Union[int, str]] = None):
|
def restore(self, version: Optional[int] = None):
|
||||||
return LOOP.run(self._table.restore(version))
|
return LOOP.run(self._table.restore(version))
|
||||||
|
|
||||||
def list_indices(self) -> Iterable[IndexConfig]:
|
def list_indices(self) -> Iterable[IndexConfig]:
|
||||||
@@ -149,18 +143,15 @@ class RemoteTable(Table):
|
|||||||
*,
|
*,
|
||||||
replace: bool = False,
|
replace: bool = False,
|
||||||
wait_timeout: timedelta = None,
|
wait_timeout: timedelta = None,
|
||||||
with_position: bool = False,
|
with_position: bool = True,
|
||||||
# tokenizer configs:
|
# tokenizer configs:
|
||||||
base_tokenizer: str = "simple",
|
base_tokenizer: str = "simple",
|
||||||
language: str = "English",
|
language: str = "English",
|
||||||
max_token_length: Optional[int] = 40,
|
max_token_length: Optional[int] = 40,
|
||||||
lower_case: bool = True,
|
lower_case: bool = True,
|
||||||
stem: bool = True,
|
stem: bool = False,
|
||||||
remove_stop_words: bool = True,
|
remove_stop_words: bool = False,
|
||||||
ascii_folding: bool = True,
|
ascii_folding: bool = False,
|
||||||
ngram_min_length: int = 3,
|
|
||||||
ngram_max_length: int = 3,
|
|
||||||
prefix_only: bool = False,
|
|
||||||
):
|
):
|
||||||
config = FTS(
|
config = FTS(
|
||||||
with_position=with_position,
|
with_position=with_position,
|
||||||
@@ -171,9 +162,6 @@ class RemoteTable(Table):
|
|||||||
stem=stem,
|
stem=stem,
|
||||||
remove_stop_words=remove_stop_words,
|
remove_stop_words=remove_stop_words,
|
||||||
ascii_folding=ascii_folding,
|
ascii_folding=ascii_folding,
|
||||||
ngram_min_length=ngram_min_length,
|
|
||||||
ngram_max_length=ngram_max_length,
|
|
||||||
prefix_only=prefix_only,
|
|
||||||
)
|
)
|
||||||
LOOP.run(
|
LOOP.run(
|
||||||
self._table.create_index(
|
self._table.create_index(
|
||||||
@@ -192,8 +180,6 @@ class RemoteTable(Table):
|
|||||||
accelerator: Optional[str] = None,
|
accelerator: Optional[str] = None,
|
||||||
index_type="vector",
|
index_type="vector",
|
||||||
wait_timeout: Optional[timedelta] = None,
|
wait_timeout: Optional[timedelta] = None,
|
||||||
*,
|
|
||||||
num_bits: int = 8,
|
|
||||||
):
|
):
|
||||||
"""Create an index on the table.
|
"""Create an index on the table.
|
||||||
Currently, the only parameters that matter are
|
Currently, the only parameters that matter are
|
||||||
@@ -228,6 +214,11 @@ class RemoteTable(Table):
|
|||||||
>>> table.create_index("l2", "vector") # doctest: +SKIP
|
>>> table.create_index("l2", "vector") # doctest: +SKIP
|
||||||
"""
|
"""
|
||||||
|
|
||||||
|
if num_partitions is not None:
|
||||||
|
logging.warning(
|
||||||
|
"num_partitions is not supported on LanceDB cloud."
|
||||||
|
"This parameter will be tuned automatically."
|
||||||
|
)
|
||||||
if num_sub_vectors is not None:
|
if num_sub_vectors is not None:
|
||||||
logging.warning(
|
logging.warning(
|
||||||
"num_sub_vectors is not supported on LanceDB cloud."
|
"num_sub_vectors is not supported on LanceDB cloud."
|
||||||
@@ -247,21 +238,13 @@ class RemoteTable(Table):
|
|||||||
|
|
||||||
index_type = index_type.upper()
|
index_type = index_type.upper()
|
||||||
if index_type == "VECTOR" or index_type == "IVF_PQ":
|
if index_type == "VECTOR" or index_type == "IVF_PQ":
|
||||||
config = IvfPq(
|
config = IvfPq(distance_type=metric)
|
||||||
distance_type=metric,
|
|
||||||
num_partitions=num_partitions,
|
|
||||||
num_sub_vectors=num_sub_vectors,
|
|
||||||
num_bits=num_bits,
|
|
||||||
)
|
|
||||||
elif index_type == "IVF_HNSW_PQ":
|
elif index_type == "IVF_HNSW_PQ":
|
||||||
raise ValueError(
|
config = HnswPq(distance_type=metric)
|
||||||
"IVF_HNSW_PQ is not supported on LanceDB cloud."
|
|
||||||
"Please use IVF_HNSW_SQ instead."
|
|
||||||
)
|
|
||||||
elif index_type == "IVF_HNSW_SQ":
|
elif index_type == "IVF_HNSW_SQ":
|
||||||
config = HnswSq(distance_type=metric, num_partitions=num_partitions)
|
config = HnswSq(distance_type=metric)
|
||||||
elif index_type == "IVF_FLAT":
|
elif index_type == "IVF_FLAT":
|
||||||
config = IvfFlat(distance_type=metric, num_partitions=num_partitions)
|
config = IvfFlat(distance_type=metric)
|
||||||
else:
|
else:
|
||||||
raise ValueError(
|
raise ValueError(
|
||||||
f"Unknown vector index type: {index_type}. Valid options are"
|
f"Unknown vector index type: {index_type}. Valid options are"
|
||||||
@@ -280,7 +263,7 @@ class RemoteTable(Table):
|
|||||||
mode: str = "append",
|
mode: str = "append",
|
||||||
on_bad_vectors: str = "error",
|
on_bad_vectors: str = "error",
|
||||||
fill_value: float = 0.0,
|
fill_value: float = 0.0,
|
||||||
) -> AddResult:
|
) -> int:
|
||||||
"""Add more data to the [Table](Table). It has the same API signature as
|
"""Add more data to the [Table](Table). It has the same API signature as
|
||||||
the OSS version.
|
the OSS version.
|
||||||
|
|
||||||
@@ -303,12 +286,8 @@ class RemoteTable(Table):
|
|||||||
fill_value: float, default 0.
|
fill_value: float, default 0.
|
||||||
The value to use when filling vectors. Only used if on_bad_vectors="fill".
|
The value to use when filling vectors. Only used if on_bad_vectors="fill".
|
||||||
|
|
||||||
Returns
|
|
||||||
-------
|
|
||||||
AddResult
|
|
||||||
An object containing the new version number of the table after adding data.
|
|
||||||
"""
|
"""
|
||||||
return LOOP.run(
|
LOOP.run(
|
||||||
self._table.add(
|
self._table.add(
|
||||||
data, mode=mode, on_bad_vectors=on_bad_vectors, fill_value=fill_value
|
data, mode=mode, on_bad_vectors=on_bad_vectors, fill_value=fill_value
|
||||||
)
|
)
|
||||||
@@ -434,12 +413,10 @@ class RemoteTable(Table):
|
|||||||
new_data: DATA,
|
new_data: DATA,
|
||||||
on_bad_vectors: str,
|
on_bad_vectors: str,
|
||||||
fill_value: float,
|
fill_value: float,
|
||||||
) -> MergeResult:
|
):
|
||||||
return LOOP.run(
|
LOOP.run(self._table._do_merge(merge, new_data, on_bad_vectors, fill_value))
|
||||||
self._table._do_merge(merge, new_data, on_bad_vectors, fill_value)
|
|
||||||
)
|
|
||||||
|
|
||||||
def delete(self, predicate: str) -> DeleteResult:
|
def delete(self, predicate: str):
|
||||||
"""Delete rows from the table.
|
"""Delete rows from the table.
|
||||||
|
|
||||||
This can be used to delete a single row, many rows, all rows, or
|
This can be used to delete a single row, many rows, all rows, or
|
||||||
@@ -454,11 +431,6 @@ class RemoteTable(Table):
|
|||||||
|
|
||||||
The filter must not be empty, or it will error.
|
The filter must not be empty, or it will error.
|
||||||
|
|
||||||
Returns
|
|
||||||
-------
|
|
||||||
DeleteResult
|
|
||||||
An object containing the new version number of the table after deletion.
|
|
||||||
|
|
||||||
Examples
|
Examples
|
||||||
--------
|
--------
|
||||||
>>> import lancedb
|
>>> import lancedb
|
||||||
@@ -491,7 +463,7 @@ class RemoteTable(Table):
|
|||||||
x vector _distance # doctest: +SKIP
|
x vector _distance # doctest: +SKIP
|
||||||
0 2 [3.0, 4.0] 85.0 # doctest: +SKIP
|
0 2 [3.0, 4.0] 85.0 # doctest: +SKIP
|
||||||
"""
|
"""
|
||||||
return LOOP.run(self._table.delete(predicate))
|
LOOP.run(self._table.delete(predicate))
|
||||||
|
|
||||||
def update(
|
def update(
|
||||||
self,
|
self,
|
||||||
@@ -499,7 +471,7 @@ class RemoteTable(Table):
|
|||||||
values: Optional[dict] = None,
|
values: Optional[dict] = None,
|
||||||
*,
|
*,
|
||||||
values_sql: Optional[Dict[str, str]] = None,
|
values_sql: Optional[Dict[str, str]] = None,
|
||||||
) -> UpdateResult:
|
):
|
||||||
"""
|
"""
|
||||||
This can be used to update zero to all rows depending on how many
|
This can be used to update zero to all rows depending on how many
|
||||||
rows match the where clause.
|
rows match the where clause.
|
||||||
@@ -517,12 +489,6 @@ class RemoteTable(Table):
|
|||||||
reference existing columns. For example, {"x": "x + 1"} will increment
|
reference existing columns. For example, {"x": "x + 1"} will increment
|
||||||
the x column by 1.
|
the x column by 1.
|
||||||
|
|
||||||
Returns
|
|
||||||
-------
|
|
||||||
UpdateResult
|
|
||||||
- rows_updated: The number of rows that were updated
|
|
||||||
- version: The new version number of the table after the update
|
|
||||||
|
|
||||||
Examples
|
Examples
|
||||||
--------
|
--------
|
||||||
>>> import lancedb
|
>>> import lancedb
|
||||||
@@ -547,7 +513,7 @@ class RemoteTable(Table):
|
|||||||
2 2 [10.0, 10.0] # doctest: +SKIP
|
2 2 [10.0, 10.0] # doctest: +SKIP
|
||||||
|
|
||||||
"""
|
"""
|
||||||
return LOOP.run(
|
LOOP.run(
|
||||||
self._table.update(where=where, updates=values, updates_sql=values_sql)
|
self._table.update(where=where, updates=values, updates_sql=values_sql)
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -595,15 +561,13 @@ class RemoteTable(Table):
|
|||||||
def count_rows(self, filter: Optional[str] = None) -> int:
|
def count_rows(self, filter: Optional[str] = None) -> int:
|
||||||
return LOOP.run(self._table.count_rows(filter))
|
return LOOP.run(self._table.count_rows(filter))
|
||||||
|
|
||||||
def add_columns(self, transforms: Dict[str, str]) -> AddColumnsResult:
|
def add_columns(self, transforms: Dict[str, str]):
|
||||||
return LOOP.run(self._table.add_columns(transforms))
|
return LOOP.run(self._table.add_columns(transforms))
|
||||||
|
|
||||||
def alter_columns(
|
def alter_columns(self, *alterations: Iterable[Dict[str, str]]):
|
||||||
self, *alterations: Iterable[Dict[str, str]]
|
|
||||||
) -> AlterColumnsResult:
|
|
||||||
return LOOP.run(self._table.alter_columns(*alterations))
|
return LOOP.run(self._table.alter_columns(*alterations))
|
||||||
|
|
||||||
def drop_columns(self, columns: Iterable[str]) -> DropColumnsResult:
|
def drop_columns(self, columns: Iterable[str]):
|
||||||
return LOOP.run(self._table.drop_columns(columns))
|
return LOOP.run(self._table.drop_columns(columns))
|
||||||
|
|
||||||
def drop_index(self, index_name: str):
|
def drop_index(self, index_name: str):
|
||||||
|
|||||||
@@ -74,7 +74,9 @@ class AnswerdotaiRerankers(Reranker):
|
|||||||
if self.score == "relevance":
|
if self.score == "relevance":
|
||||||
combined_results = self._keep_relevance_score(combined_results)
|
combined_results = self._keep_relevance_score(combined_results)
|
||||||
elif self.score == "all":
|
elif self.score == "all":
|
||||||
combined_results = self._merge_and_keep_scores(vector_results, fts_results)
|
raise NotImplementedError(
|
||||||
|
"Answerdotai Reranker does not support score='all' yet"
|
||||||
|
)
|
||||||
combined_results = combined_results.sort_by(
|
combined_results = combined_results.sort_by(
|
||||||
[("_relevance_score", "descending")]
|
[("_relevance_score", "descending")]
|
||||||
)
|
)
|
||||||
|
|||||||
@@ -232,39 +232,6 @@ class Reranker(ABC):
|
|||||||
|
|
||||||
return deduped_table
|
return deduped_table
|
||||||
|
|
||||||
def _merge_and_keep_scores(self, vector_results: pa.Table, fts_results: pa.Table):
|
|
||||||
"""
|
|
||||||
Merge the results from the vector and FTS search and keep the scores.
|
|
||||||
This op is slower than just keeping relevance score but can be useful
|
|
||||||
for debugging.
|
|
||||||
"""
|
|
||||||
# add nulls to fts results for _distance
|
|
||||||
if "_distance" not in fts_results.column_names:
|
|
||||||
fts_results = fts_results.append_column(
|
|
||||||
"_distance",
|
|
||||||
pa.array([None] * len(fts_results), type=pa.float32()),
|
|
||||||
)
|
|
||||||
# add nulls to vector results for _score
|
|
||||||
if "_score" not in vector_results.column_names:
|
|
||||||
vector_results = vector_results.append_column(
|
|
||||||
"_score",
|
|
||||||
pa.array([None] * len(vector_results), type=pa.float32()),
|
|
||||||
)
|
|
||||||
|
|
||||||
# combine them and fill the scores
|
|
||||||
vector_results_dict = {row["_rowid"]: row for row in vector_results.to_pylist()}
|
|
||||||
fts_results_dict = {row["_rowid"]: row for row in fts_results.to_pylist()}
|
|
||||||
|
|
||||||
# merge them into vector_results
|
|
||||||
for key, value in fts_results_dict.items():
|
|
||||||
if key in vector_results_dict:
|
|
||||||
vector_results_dict[key]["_score"] = value["_score"]
|
|
||||||
else:
|
|
||||||
vector_results_dict[key] = value
|
|
||||||
|
|
||||||
combined = pa.Table.from_pylist(list(vector_results_dict.values()))
|
|
||||||
return combined
|
|
||||||
|
|
||||||
def _keep_relevance_score(self, combined_results: pa.Table):
|
def _keep_relevance_score(self, combined_results: pa.Table):
|
||||||
if self.score == "relevance":
|
if self.score == "relevance":
|
||||||
if "_score" in combined_results.column_names:
|
if "_score" in combined_results.column_names:
|
||||||
|
|||||||
@@ -92,14 +92,14 @@ class CohereReranker(Reranker):
|
|||||||
vector_results: pa.Table,
|
vector_results: pa.Table,
|
||||||
fts_results: pa.Table,
|
fts_results: pa.Table,
|
||||||
):
|
):
|
||||||
if self.score == "all":
|
|
||||||
combined_results = self._merge_and_keep_scores(vector_results, fts_results)
|
|
||||||
else:
|
|
||||||
combined_results = self.merge_results(vector_results, fts_results)
|
combined_results = self.merge_results(vector_results, fts_results)
|
||||||
combined_results = self._rerank(combined_results, query)
|
combined_results = self._rerank(combined_results, query)
|
||||||
if self.score == "relevance":
|
if self.score == "relevance":
|
||||||
combined_results = self._keep_relevance_score(combined_results)
|
combined_results = self._keep_relevance_score(combined_results)
|
||||||
|
elif self.score == "all":
|
||||||
|
raise NotImplementedError(
|
||||||
|
"return_score='all' not implemented for cohere reranker"
|
||||||
|
)
|
||||||
return combined_results
|
return combined_results
|
||||||
|
|
||||||
def rerank_vector(self, query: str, vector_results: pa.Table):
|
def rerank_vector(self, query: str, vector_results: pa.Table):
|
||||||
|
|||||||
@@ -81,15 +81,15 @@ class CrossEncoderReranker(Reranker):
|
|||||||
vector_results: pa.Table,
|
vector_results: pa.Table,
|
||||||
fts_results: pa.Table,
|
fts_results: pa.Table,
|
||||||
):
|
):
|
||||||
if self.score == "all":
|
|
||||||
combined_results = self._merge_and_keep_scores(vector_results, fts_results)
|
|
||||||
else:
|
|
||||||
combined_results = self.merge_results(vector_results, fts_results)
|
combined_results = self.merge_results(vector_results, fts_results)
|
||||||
combined_results = self._rerank(combined_results, query)
|
combined_results = self._rerank(combined_results, query)
|
||||||
# sort the results by _score
|
# sort the results by _score
|
||||||
if self.score == "relevance":
|
if self.score == "relevance":
|
||||||
combined_results = self._keep_relevance_score(combined_results)
|
combined_results = self._keep_relevance_score(combined_results)
|
||||||
|
elif self.score == "all":
|
||||||
|
raise NotImplementedError(
|
||||||
|
"return_score='all' not implemented for CrossEncoderReranker"
|
||||||
|
)
|
||||||
combined_results = combined_results.sort_by(
|
combined_results = combined_results.sort_by(
|
||||||
[("_relevance_score", "descending")]
|
[("_relevance_score", "descending")]
|
||||||
)
|
)
|
||||||
|
|||||||
@@ -97,14 +97,14 @@ class JinaReranker(Reranker):
|
|||||||
vector_results: pa.Table,
|
vector_results: pa.Table,
|
||||||
fts_results: pa.Table,
|
fts_results: pa.Table,
|
||||||
):
|
):
|
||||||
if self.score == "all":
|
|
||||||
combined_results = self._merge_and_keep_scores(vector_results, fts_results)
|
|
||||||
else:
|
|
||||||
combined_results = self.merge_results(vector_results, fts_results)
|
combined_results = self.merge_results(vector_results, fts_results)
|
||||||
combined_results = self._rerank(combined_results, query)
|
combined_results = self._rerank(combined_results, query)
|
||||||
if self.score == "relevance":
|
if self.score == "relevance":
|
||||||
combined_results = self._keep_relevance_score(combined_results)
|
combined_results = self._keep_relevance_score(combined_results)
|
||||||
|
elif self.score == "all":
|
||||||
|
raise NotImplementedError(
|
||||||
|
"return_score='all' not implemented for JinaReranker"
|
||||||
|
)
|
||||||
return combined_results
|
return combined_results
|
||||||
|
|
||||||
def rerank_vector(self, query: str, vector_results: pa.Table):
|
def rerank_vector(self, query: str, vector_results: pa.Table):
|
||||||
|
|||||||
@@ -88,13 +88,14 @@ class OpenaiReranker(Reranker):
|
|||||||
vector_results: pa.Table,
|
vector_results: pa.Table,
|
||||||
fts_results: pa.Table,
|
fts_results: pa.Table,
|
||||||
):
|
):
|
||||||
if self.score == "all":
|
|
||||||
combined_results = self._merge_and_keep_scores(vector_results, fts_results)
|
|
||||||
else:
|
|
||||||
combined_results = self.merge_results(vector_results, fts_results)
|
combined_results = self.merge_results(vector_results, fts_results)
|
||||||
combined_results = self._rerank(combined_results, query)
|
combined_results = self._rerank(combined_results, query)
|
||||||
if self.score == "relevance":
|
if self.score == "relevance":
|
||||||
combined_results = self._keep_relevance_score(combined_results)
|
combined_results = self._keep_relevance_score(combined_results)
|
||||||
|
elif self.score == "all":
|
||||||
|
raise NotImplementedError(
|
||||||
|
"OpenAI Reranker does not support score='all' yet"
|
||||||
|
)
|
||||||
|
|
||||||
combined_results = combined_results.sort_by(
|
combined_results = combined_results.sort_by(
|
||||||
[("_relevance_score", "descending")]
|
[("_relevance_score", "descending")]
|
||||||
|
|||||||
@@ -94,14 +94,14 @@ class VoyageAIReranker(Reranker):
|
|||||||
vector_results: pa.Table,
|
vector_results: pa.Table,
|
||||||
fts_results: pa.Table,
|
fts_results: pa.Table,
|
||||||
):
|
):
|
||||||
if self.score == "all":
|
|
||||||
combined_results = self._merge_and_keep_scores(vector_results, fts_results)
|
|
||||||
else:
|
|
||||||
combined_results = self.merge_results(vector_results, fts_results)
|
combined_results = self.merge_results(vector_results, fts_results)
|
||||||
combined_results = self._rerank(combined_results, query)
|
combined_results = self._rerank(combined_results, query)
|
||||||
if self.score == "relevance":
|
if self.score == "relevance":
|
||||||
combined_results = self._keep_relevance_score(combined_results)
|
combined_results = self._keep_relevance_score(combined_results)
|
||||||
|
elif self.score == "all":
|
||||||
|
raise NotImplementedError(
|
||||||
|
"return_score='all' not implemented for voyageai reranker"
|
||||||
|
)
|
||||||
return combined_results
|
return combined_results
|
||||||
|
|
||||||
def rerank_vector(self, query: str, vector_results: pa.Table):
|
def rerank_vector(self, query: str, vector_results: pa.Table):
|
||||||
|
|||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user