site_name: LanceDB site_url: https://lancedb.github.io/lancedb/ repo_url: https://github.com/lancedb/lancedb edit_uri: https://github.com/lancedb/lancedb/tree/main/docs/src repo_name: lancedb/lancedb docs_dir: src theme: name: "material" logo: assets/logo.png favicon: assets/logo.png palette: # Palette toggle for light mode - scheme: lancedb primary: custom toggle: icon: material/weather-night name: Switch to dark mode # Palette toggle for dark mode - scheme: slate primary: custom toggle: icon: material/weather-sunny name: Switch to light mode features: - content.code.copy - content.tabs.link - content.action.edit - toc.follow # - toc.integrate - navigation.top - navigation.tabs - navigation.tabs.sticky - navigation.footer - navigation.tracking - navigation.instant icon: repo: fontawesome/brands/github custom_dir: overrides plugins: - search - autorefs - mkdocstrings: handlers: python: paths: [../python] options: docstring_style: numpy heading_level: 4 show_source: true show_symbol_type_in_heading: true show_signature_annotations: true members_order: source import: # for cross references - https://arrow.apache.org/docs/objects.inv - https://pandas.pydata.org/docs/objects.inv - mkdocs-jupyter - ultralytics: verbose: True enabled: True default_image: "assets/lancedb_and_lance.png" # Default image for all pages add_image: True # Automatically add meta image add_keywords: True # Add page keywords in the header tag add_share_buttons: True # Add social share buttons add_authors: False # Display page authors add_desc: False add_dates: False markdown_extensions: - admonition - footnotes - pymdownx.details - pymdownx.highlight: anchor_linenums: true line_spans: __span pygments_lang_class: true - pymdownx.inlinehilite - pymdownx.snippets: base_path: .. dedent_subsections: true - pymdownx.superfences - pymdownx.tabbed: alternate_style: true - md_in_html - attr_list nav: - Home: - LanceDB: index.md - 🏃🏼‍♂️ Quick start: basic.md - 📚 Concepts: - Vector search: concepts/vector_search.md - Indexing: concepts/index_ivfpq.md - Storage: concepts/storage.md - Data management: concepts/data_management.md - 🔨 Guides: - Working with tables: guides/tables.md - Building an ANN index: ann_indexes.md - Vector Search: search.md - Full-text search: fts.md - Hybrid search: - Overview: hybrid_search/hybrid_search.md - Comparing Rerankers: hybrid_search/eval.md - Airbnb financial data example: notebooks/hybrid_search.ipynb - Filtering: sql.md - Versioning & Reproducibility: notebooks/reproducibility.ipynb - Configuring Storage: guides/storage.md - 🧬 Managing embeddings: - Overview: embeddings/index.md - Embedding functions: embeddings/embedding_functions.md - Available models: embeddings/default_embedding_functions.md - User-defined embedding functions: embeddings/custom_embedding_function.md - "Example: Multi-lingual semantic search": notebooks/multi_lingual_example.ipynb - "Example: MultiModal CLIP Embeddings": notebooks/DisappearingEmbeddingFunction.ipynb - 🔌 Integrations: - Tools and data formats: integrations/index.md - Pandas and PyArrow: python/pandas_and_pyarrow.md - Polars: python/polars_arrow.md - DuckDB: python/duckdb.md - LangChain 🔗: https://python.langchain.com/en/latest/modules/indexes/vectorstores/examples/lancedb.html - LangChain JS/TS 🔗: https://js.langchain.com/docs/modules/data_connection/vectorstores/integrations/lancedb - LlamaIndex 🦙: https://gpt-index.readthedocs.io/en/latest/examples/vector_stores/LanceDBIndexDemo.html - Pydantic: python/pydantic.md - Voxel51: integrations/voxel51.md - PromptTools: integrations/prompttools.md - 🎯 Examples: - Overview: examples/index.md - 🐍 Python: - Overview: examples/examples_python.md - YouTube Transcript Search: notebooks/youtube_transcript_search.ipynb - Documentation QA Bot using LangChain: notebooks/code_qa_bot.ipynb - Multimodal search using CLIP: notebooks/multimodal_search.ipynb - Example - Calculate CLIP Embeddings with Roboflow Inference: examples/image_embeddings_roboflow.md - Serverless QA Bot with S3 and Lambda: examples/serverless_lancedb_with_s3_and_lambda.md - Serverless QA Bot with Modal: examples/serverless_qa_bot_with_modal_and_langchain.md - 👾 JavaScript: - Overview: examples/examples_js.md - Serverless Website Chatbot: examples/serverless_website_chatbot.md - YouTube Transcript Search: examples/youtube_transcript_bot_with_nodejs.md - TransformersJS Embedding Search: examples/transformerjs_embedding_search_nodejs.md - 🔧 CLI & Config: cli_config.md - 💭 FAQs: faq.md - ⚙️ API reference: - 🐍 Python: python/python.md - 👾 JavaScript: javascript/modules.md - 🦀 Rust: https://docs.rs/vectordb/latest/vectordb/ - ☁️ LanceDB Cloud: - Overview: cloud/index.md - API reference: - 🐍 Python: python/saas-python.md - 👾 JavaScript: javascript/saas-modules.md - Quick start: basic.md - Concepts: - Vector search: concepts/vector_search.md - Indexing: concepts/index_ivfpq.md - Storage: concepts/storage.md - Data management: concepts/data_management.md - Guides: - Working with tables: guides/tables.md - Building an ANN index: ann_indexes.md - Vector Search: search.md - Full-text search: fts.md - Hybrid search: - Overview: hybrid_search/hybrid_search.md - Comparing Rerankers: hybrid_search/eval.md - Airbnb financial data example: notebooks/hybrid_search.ipynb - Filtering: sql.md - Versioning & Reproducibility: notebooks/reproducibility.ipynb - Configuring Storage: guides/storage.md - Managing Embeddings: - Overview: embeddings/index.md - Embedding functions: embeddings/embedding_functions.md - Available models: embeddings/default_embedding_functions.md - User-defined embedding functions: embeddings/custom_embedding_function.md - "Example: Multi-lingual semantic search": notebooks/multi_lingual_example.ipynb - "Example: MultiModal CLIP Embeddings": notebooks/DisappearingEmbeddingFunction.ipynb - Integrations: - Overview: integrations/index.md - Pandas and PyArrow: python/pandas_and_pyarrow.md - Polars: python/polars_arrow.md - DuckDB : python/duckdb.md - LangChain 🦜️🔗↗: https://python.langchain.com/en/latest/modules/indexes/vectorstores/examples/lancedb.html - LangChain.js 🦜️🔗↗: https://js.langchain.com/docs/modules/data_connection/vectorstores/integrations/lancedb - LlamaIndex 🦙↗: https://gpt-index.readthedocs.io/en/latest/examples/vector_stores/LanceDBIndexDemo.html - Pydantic: python/pydantic.md - Voxel51: integrations/voxel51.md - PromptTools: integrations/prompttools.md - Python examples: - examples/index.md - YouTube Transcript Search: notebooks/youtube_transcript_search.ipynb - Documentation QA Bot using LangChain: notebooks/code_qa_bot.ipynb - Multimodal search using CLIP: notebooks/multimodal_search.ipynb - Serverless QA Bot with S3 and Lambda: examples/serverless_lancedb_with_s3_and_lambda.md - Serverless QA Bot with Modal: examples/serverless_qa_bot_with_modal_and_langchain.md - Javascript examples: - Overview: examples/examples_js.md - YouTube Transcript Search: examples/youtube_transcript_bot_with_nodejs.md - Serverless Chatbot from any website: examples/serverless_website_chatbot.md - TransformersJS Embedding Search: examples/transformerjs_embedding_search_nodejs.md - API reference: - Python: python/python.md - Javascript: javascript/modules.md - LanceDB Cloud: - Overview: cloud/index.md - API reference: - 🐍 Python: python/saas-python.md - 👾 JavaScript: javascript/saas-modules.md extra_css: - styles/global.css - styles/extra.css extra_javascript: - "extra_js/init_ask_ai_widget.js" extra: analytics: provider: google property: G-B7NFM40W74