[docs] Python SDK Reference

docs/mkdocs.yml

@@ -1,8 +1,8 @@
 site_name: LanceDB Documentation
-site_url: https://lancedb.github.io/docs
-repo_url: https://github.com/lancedb/documentation
-edit_uri: https://github.com/lancedb/documentation
-repo_name: lancedb/documentation
+site_url: https://lancedb.com/documentation
+repo_url: https://github.com/lancedb/lancedb
+edit_uri: https://github.com/lancedb/lancedb
+repo_name: lancedb/lancedb
 docs_dir: src
 watch:
   - src
@@ -64,7 +64,7 @@ plugins:
         'guides/scalar_index.md': 'guides/indexing/scalar-index.md'
         'cloud/rest.md': 'api/cloud.md'
         'api_reference.md': 'api/index.md'
-        'migration.md': 'api/api-changes.md'
+        'migration.md': 'api/cloud.md'
         'faq.md': 'overview/faq.md'
         'cloud/cloud_faq.md': 'cloud/cloud-faq.md'
         'ann_indexes.md': 'guides/indexing/vector-index.md'
@@ -353,16 +353,30 @@ nav:
                   - HyDE: rag/advanced_techniques/hyde.md
                   - FLARE: rag/advanced_techniques/flare.md
 
-  - API & SDK Reference:
+  - API Reference:
       - Overview: api/index.md
-      - API Changes: api/api-changes.md
       - LanceDB Cloud REST API: api/cloud.md
-      - Client SDKs:
-          - Python SDK: python/python.md
-          - JavaScript SDK:
-              - Current SDK (@lancedb/lancedb): js/globals.md
-              - Legacy SDK (vectordb): javascript/modules.md
-          - Rust SDK: https://docs.rs/lancedb/latest/lancedb/
+      - Python SDK:
+              - Overview: python/index.md
+              - Connections:
+                  - Sync: python/sync/connections.md
+                  - Async: python/async/connections.md
+              - Tables & Data:
+                  - Sync: python/sync/tables.md
+                  - Async: python/async/tables.md
+                  - Pydantic Data Models: python/integrations/pydantic.md
+              - Search & Querying:
+                  - Sync: python/sync/querying.md
+                  - Async: python/async/querying.md
+                  - Indexes: python/features/indices.md
+              - AI & ML Features:
+                  - Embeddings: python/integrations/embeddings.md
+                  - Reranking: python/integrations/reranking.md
+                  - Context: python/features/context.md        
+              - LanceDBCloud: python/saas/index.md
+      - JavaScript SDK: 
+              - Overview: js/index.md
+      - Rust SDK: https://docs.rs/lancedb/latest/lancedb/
   - Changelog:
       - LanceDB Cloud & Enterprise: changelog/lancedb-changelog.md
       - ↗LanceDB Open Source: https://github.com/lancedb/lancedb/releases

docs/overrides/main.html

@@ -1,5 +1,5 @@
 {% extends "base.html" %}
 
 {% block announce %}
-<div class="custom-announce" style="text-align: center;">June 1st, 2025: We just launched <a href="https://accounts.lancedb.com/sign-up" target="_blank" style="font-weight: bold;">LanceDB Cloud - Sign up and access LanceDB for free!</a></div>
+<div class="custom-announce" style="text-align: center;">We just launched <a href="https://accounts.lancedb.com/sign-up" target="_blank" style="font-weight: bold;">LanceDB Cloud Beta - Sign up for early access!</a></div>
 {% endblock %}

docs/src/api/cloud.md

@@ -1,11 +1,7 @@
 ---
 title: LanceDB Cloud REST API Specification
-hide:
-  - navigation
 ---
 
-[Return to the previous page.](index.md)
-
 [OAD(../docs/openapi.yml)]
 
 

docs/src/python/async/connections.md

@@ -0,0 +1,7 @@
+# Connections (Asynchronous)
+
+Connections represent a connection to a LanceDb database and can be used to create, list, or open tables.
+
+::: lancedb.connect_async
+
+::: lancedb.db.AsyncConnection

docs/src/python/async/querying.md

@@ -0,0 +1,15 @@
+# Querying (Asynchronous)
+
+Queries allow you to return data from your database. Basic queries can be created with the [AsyncTable.query][lancedb.table.AsyncTable.query] method to return the entire (typically filtered) table. Vector searches return the rows nearest to a query vector and can be created with the [AsyncTable.vector_search][lancedb.table.AsyncTable.vector_search] method.
+
+::: lancedb.query.AsyncQuery
+    options:
+      inherited_members: true
+
+::: lancedb.query.AsyncVectorQuery
+    options:
+      inherited_members: true
+
+::: lancedb.query.AsyncHybridQuery
+    options:
+      inherited_members: true

docs/src/python/async/tables.md

@@ -0,0 +1,5 @@
+# Tables (Asynchronous)
+
+Tables hold your actual data as a collection of records / rows.
+
+::: lancedb.table.AsyncTable

docs/src/python/features/context.md

@@ -0,0 +1,5 @@
+# Context
+
+::: lancedb.context.contextualize
+
+::: lancedb.context.Contextualizer

docs/src/python/features/fts.md

@@ -0,0 +1,13 @@
+# Full Text Search
+
+This section covers the core Full Text Search (FTS) functionality in LanceDB. For building FTS queries in your application, see the [Synchronous FTS Query Builder](../sync/querying.md#lancedb.query.LanceFtsQueryBuilder) or [Asynchronous FTS Query Builder](../async/querying.md).
+
+## Core FTS Functions
+
+These functions provide the fundamental FTS capabilities:
+
+::: lancedb.fts.create_index
+
+::: lancedb.fts.populate_index
+
+::: lancedb.fts.search_index

docs/src/python/features/indices.md

@@ -0,0 +1,19 @@
+# Indexes
+
+Indices can be created on a table to speed up queries. This section lists the indices that LanceDb supports.
+
+::: lancedb.index.BTree
+
+::: lancedb.index.Bitmap
+
+::: lancedb.index.LabelList
+
+::: lancedb.index.FTS
+
+::: lancedb.index.IvfPq
+
+::: lancedb.index.HnswPq
+
+::: lancedb.index.HnswSq
+
+::: lancedb.index.IvfFlat

docs/src/python/index.md

@@ -0,0 +1,47 @@
+# Python API Reference
+
+This section contains the API reference for the Python API. LanceDB provides both synchronous and asynchronous API clients.
+
+## Installation
+
+```shell
+pip install lancedb
+```
+
+## Quick Start
+
+The general flow of using the API is:
+
+1. Use [lancedb.connect][] or [lancedb.connect_async][] to connect to a database.
+2. Use the returned [lancedb.DBConnection][] or [lancedb.AsyncConnection][] to create or open tables.
+3. Use the returned [lancedb.table.Table][] or [lancedb.AsyncTable][] to query or modify tables.
+
+## API Reference
+
+### Synchronous API
+- [Connections](sync/connections.md)
+- [Tables](sync/tables.md)
+- [Querying](sync/querying.md)
+
+### Asynchronous API
+- [Connections](async/connections.md)
+- [Tables](async/tables.md)
+- [Querying](async/querying.md)
+
+### Features
+- [Embeddings](features/embeddings.md)
+- [Context](features/context.md)
+- [Full Text Search](features/fts.md)
+- [Indices](features/indices.md)
+
+### Integrations
+- [Pydantic](integrations/pydantic.md)
+- [Reranking](integrations/reranking.md)
+
+### SaaS Integration
+For information about using LanceDB with SaaS services, see the [SaaS Integration Guide](../saas/index.md).
+
+## Common Issues
+
+Multiprocessing with `fork` is not supported. You should use `spawn` instead.
+

docs/src/python/integrations/embeddings.md

@@ -0,0 +1,15 @@
+# Embeddings
+
+::: lancedb.embeddings.registry.EmbeddingFunctionRegistry
+
+::: lancedb.embeddings.base.EmbeddingFunctionConfig
+
+::: lancedb.embeddings.base.EmbeddingFunction
+
+::: lancedb.embeddings.base.TextEmbeddingFunction
+
+::: lancedb.embeddings.sentence_transformers.SentenceTransformerEmbeddings
+
+::: lancedb.embeddings.openai.OpenAIEmbeddings
+
+::: lancedb.embeddings.open_clip.OpenClipEmbeddings

docs/src/python/integrations/pydantic.md

@@ -0,0 +1,7 @@
+# Pydantic Integration
+
+::: lancedb.pydantic.pydantic_to_schema
+
+::: lancedb.pydantic.vector
+
+::: lancedb.pydantic.LanceModel

docs/src/python/integrations/reranking.md

@@ -0,0 +1,11 @@
+# Reranking
+
+::: lancedb.rerankers.linear_combination.LinearCombinationReranker
+
+::: lancedb.rerankers.cohere.CohereReranker
+
+::: lancedb.rerankers.colbert.ColbertReranker
+
+::: lancedb.rerankers.cross_encoder.CrossEncoderReranker
+
+::: lancedb.rerankers.openai.OpenaiReranker