mirror of
https://github.com/lancedb/lancedb.git
synced 2025-12-25 22:29:58 +00:00
fed33a51d5
Adds: * Make `mkdocstrings` aware we are using numpy-style docstrings * Fixes broken link on `index.md` to Python API docs (and added link to node ones) * Added examples to various classes. * Added doctest to verify examples work.
44 lines
572 B
Markdown
44 lines
572 B
Markdown
# LanceDB Python API Reference
|
|
|
|
## Installation
|
|
|
|
```shell
|
|
pip install lancedb
|
|
```
|
|
|
|
## Connection
|
|
|
|
::: lancedb.connect
|
|
|
|
::: lancedb.LanceDBConnection
|
|
|
|
## Table
|
|
|
|
::: lancedb.table.LanceTable
|
|
|
|
## Querying
|
|
|
|
::: lancedb.query.LanceQueryBuilder
|
|
|
|
::: lancedb.query.LanceFtsQueryBuilder
|
|
|
|
## Embeddings
|
|
|
|
::: lancedb.embeddings.with_embeddings
|
|
|
|
::: lancedb.embeddings.EmbeddingFunction
|
|
|
|
## Context
|
|
|
|
::: lancedb.context.contextualize
|
|
|
|
::: lancedb.context.Contextualizer
|
|
|
|
## Full text search
|
|
|
|
::: lancedb.fts.create_index
|
|
|
|
::: lancedb.fts.populate_index
|
|
|
|
::: lancedb.fts.search_index
|