mirror of
https://github.com/lancedb/lancedb.git
synced 2026-10-12 23:02:28 +00:00
Jack YeandBrendan Clement
47b7babc08
Move the public website pages into `docs/web` beside the SDK, with
shared navigation and executable example sources in `docs/web-tests`.
The combined website is assembled by
[lancedb/docs#355](https://github.com/lancedb/docs/pull/355), with six
Enterprise replacements from
[lancedb/sophon#7681](https://github.com/lancedb/sophon/pull/7681).
This includes Function guidance, runnable Quickstarts, regenerated
snippets, production contact/demo fixes, the legacy SQL route, and the
LeRobot redirect. LeRobot remains attributed to Geneva; all 34 Geneva
pages remain in the docs repository until Function officially launches.
Materialized-view guidance follows the full rebuild refresh introduced
by #4373: local refresh writes the complete result, has no `full`
argument, supports `source_version`, and no longer requires stable row
IDs. Deployment SQL refresh options and stable-ID setup are qualified by
version/configuration. Function input guidance distinguishes ordinary
stored columns from computed inputs supported by newer deployments.
**Validation:** independently accepted local checks include 95 Python
tests (real Enterprise excluded), eight TypeScript tests, Rust
Quickstart, snippet parity, typos, deterministic assembly, Mint
validation and links/anchors/redirects. The combined baseline retains
all 181 production routes and 17 legacy redirects. Examples ran locally
against source-built Python SDK 0.40.0b13; existing GitHub workflows do
not run `docs/web-tests`. New main at `069b2f7d` is 0.41.0b0 and adds
computed Function inputs; that SDK was not exercised by the accepted
tests. Latest prose corrections receive focused site validation.
**Merge/rollout:** merge this and #7681 before #355's combined CI, which
reads producer `main`. This is migration infrastructure: section
overlays, source-owned skills and automatic versioned paired releases
remain follow-ups. The current manual publisher is transitional. Hosted
validation, a supported SDK/Enterprise release pair and a real
Enterprise walkthrough remain pending.
Production Mintlify watches `lancedb/docs:deploy-freeze`, directory
`docs`; preserve that source through review. The separate SDK GitHub
Pages reference workflow rebuilds on main merges.
**Updated-head CI (9a50f8db):**
[Typos](https://github.com/lancedb/lancedb/actions/runs/37654185443/job/112904990558),
[PR
title](https://github.com/lancedb/lancedb/actions/runs/37654179507/job/112904974595)
and
[Aikido](https://app.aikido.dev/featurebranch/scan/215386145?groupId=74229)
pass. Critical findings in the example lockfiles were patched: all Sharp
copies use 0.35.5, protobufjs 7.6.6, tar 7.5.22, quinn-proto 0.11.19,
zerovec 0.11.8 and zerovec-derive 0.11.6. The SDK's product dependencies
are unchanged. The revised lockfiles pass eight TypeScript examples,
HuggingFace decode/resize/crop/rescale/normalize plus AVIF roundtrip,
and Rust Quickstart. Aikido passing does not mean every advisory is
cleared; npm still reports 29 high and five moderate advisories in the
example dependency graph. No scanner bypass or suppression was added.
The Function prose correction passes combined/standalone Mint,
deterministic assembly, routes and assets. The revised 325-file site
checksum is
`175bec06864abb400dd292e667ba93448c0479b8359fd7bf6146afabf9040647`. This
PR remains open for independent review; further merges are on hold.
---------
Co-authored-by: Brendan Clement <brendan.clement@lancedb.com>
65 lines
3.2 KiB
Plaintext
65 lines
3.2 KiB
Plaintext
---
|
|
title: IBM watsonx
|
|
sidebarTitle: IBM WatsonX
|
|
---
|
|
|
|
import { PyEmbeddingIbmUsage } from '/snippets/integrations.mdx';
|
|
|
|
Generate text embeddings using IBM's watsonx.ai platform.
|
|
|
|
## Supported Models {#supported-models}
|
|
|
|
You can find a list of supported models at [IBM watsonx.ai Documentation](https://dataplatform.cloud.ibm.com/docs/content/wsj/analyze-data/fm-models-embed.html?context=wx). The currently supported model names are:
|
|
|
|
| Model ID | Dimensions |
|
|
|----------------------------------------------|------------|
|
|
| `ibm/granite-embedding-278m-multilingual` | 768 |
|
|
| `ibm/slate-125m-english-rtrvr-v2` | 768 |
|
|
| `ibm/slate-30m-english-rtrvr-v2` | 384 |
|
|
| `intfloat/multilingual-e5-large` | 1024 |
|
|
| `sentence-transformers/all-minilm-l6-v2` | 384 |
|
|
|
|
<Info>
|
|
For new tables, `ibm/granite-embedding-278m-multilingual` is the recommended default. Older model IDs (such as `ibm/slate-125m-english-rtrvr` and `sentence-transformers/all-minilm-l12-v2`) remain resolvable for tables whose stored metadata references them, but they are no longer advertised for new use.
|
|
</Info>
|
|
|
|
## Parameters {#parameters}
|
|
|
|
The following parameters can be passed to the `create` method:
|
|
|
|
| Parameter | Type | Default Value | Description |
|
|
|------------|----------|----------------------------------|-----------------------------------------------------------|
|
|
| name | str | `"ibm/slate-125m-english-rtrvr"` | The model ID of the watsonx.ai model to use. Pass one of the current supported IDs above (e.g. `"ibm/granite-embedding-278m-multilingual"`) when creating new tables. |
|
|
| api_key | str | None | Optional IBM Cloud API key (or set `WATSONX_API_KEY`) |
|
|
| project_id | str | None | Optional watsonx project ID (or set `WATSONX_PROJECT_ID`). Mutually exclusive with `space_id`. |
|
|
| space_id | str | None | Optional watsonx deployment space ID (or set `WATSONX_SPACE_ID`). Mutually exclusive with `project_id`. |
|
|
| url | str | None | Optional custom URL for the watsonx.ai instance |
|
|
| params | dict | None | Optional additional parameters for the embedding model (e.g. `{"truncate_input_tokens": 512}`) |
|
|
|
|
<Info>
|
|
You must supply exactly one of `project_id` or `space_id` (either as an argument or via its environment variable). Setting both, or neither, raises a `ValueError`.
|
|
</Info>
|
|
|
|
## Usage Example {#usage-example}
|
|
|
|
First, the watsonx.ai library is an optional dependency, so must be installed separately:
|
|
|
|
```
|
|
pip install ibm-watsonx-ai
|
|
```
|
|
|
|
Optionally set environment variables (if not passing credentials to `create` directly):
|
|
|
|
```sh
|
|
export WATSONX_API_KEY="YOUR_WATSONX_API_KEY"
|
|
# Provide exactly one of the following:
|
|
export WATSONX_PROJECT_ID="YOUR_WATSONX_PROJECT_ID"
|
|
export WATSONX_SPACE_ID="YOUR_WATSONX_SPACE_ID"
|
|
```
|
|
|
|
<CodeGroup>
|
|
<CodeBlock filename="Python" language="Python" icon="python">
|
|
{PyEmbeddingIbmUsage}
|
|
</CodeBlock>
|
|
</CodeGroup>
|