docs: better formatting for Node API docs (#1892)

* Sets `"useCodeBlocks": true` * Adds a post-processing script `nodejs/typedoc_post_process.js` that puts the parameter description on the same line as the parameter name, like it is in our Python docs. This makes the text hierarchy clearer in those sections and also makes the sections shorter.
2026-01-04 19:02:58 +00:00 · 2024-12-09 17:04:09 -08:00
parent a43193c99b
commit db125013fc
45 changed files with 1538 additions and 488 deletions
--- a/docs/src/js/.nojekyll
+++ b/docs/src/js/.nojekyll
@@ -1 +0,0 @@
-TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.
--- a/docs/src/js/classes/Connection.md
+++ b/docs/src/js/classes/Connection.md
@@ -27,7 +27,9 @@ the underlying connection has been closed.

 ### new Connection()

-> **new Connection**(): [`Connection`](Connection.md)
+```ts
+new Connection(): Connection
+```

 #### Returns

@@ -37,7 +39,9 @@ the underlying connection has been closed.

 ### close()

-> `abstract` **close**(): `void`
+```ts
+abstract close(): void
+```

 Close the connection, releasing any underlying resources.

@@ -53,21 +57,24 @@ Any attempt to use the connection after it is closed will result in an error.

 ### createEmptyTable()

-> `abstract` **createEmptyTable**(`name`, `schema`, `options`?): `Promise`&lt;[`Table`](Table.md)&gt;
+```ts
+abstract createEmptyTable(
+   name,
+   schema,
+   options?): Promise<Table>
+```

 Creates a new empty Table

 #### Parameters

-• **name**: `string`
+* **name**: `string`
+    The name of the table.

-The name of the table.
+* **schema**: `SchemaLike`
+    The schema of the table

-• **schema**: `SchemaLike`
-
-The schema of the table
-
-• **options?**: `Partial`&lt;[`CreateTableOptions`](../interfaces/CreateTableOptions.md)&gt;
+* **options?**: `Partial`&lt;[`CreateTableOptions`](../interfaces/CreateTableOptions.md)&gt;

 #### Returns

@@ -79,15 +86,16 @@ The schema of the table

 #### createTable(options)

-> `abstract` **createTable**(`options`): `Promise`&lt;[`Table`](Table.md)&gt;
+```ts
+abstract createTable(options): Promise<Table>
+```

 Creates a new Table and initialize it with new data.

 ##### Parameters

-• **options**: `object` & `Partial`&lt;[`CreateTableOptions`](../interfaces/CreateTableOptions.md)&gt;
-
-The options object.
+* **options**: `object` & `Partial`&lt;[`CreateTableOptions`](../interfaces/CreateTableOptions.md)&gt;
+    The options object.

 ##### Returns

@@ -95,22 +103,25 @@ The options object.

 #### createTable(name, data, options)

-> `abstract` **createTable**(`name`, `data`, `options`?): `Promise`&lt;[`Table`](Table.md)&gt;
+```ts
+abstract createTable(
+   name,
+   data,
+   options?): Promise<Table>
+```

 Creates a new Table and initialize it with new data.

 ##### Parameters

-• **name**: `string`
+* **name**: `string`
+    The name of the table.

-The name of the table.
+* **data**: `TableLike` \| `Record`&lt;`string`, `unknown`&gt;[]
+    Non-empty Array of Records
+    to be inserted into the table

-• **data**: `TableLike` \| `Record`&lt;`string`, `unknown`&gt;[]
-
-Non-empty Array of Records
-to be inserted into the table
-
-• **options?**: `Partial`&lt;[`CreateTableOptions`](../interfaces/CreateTableOptions.md)&gt;
+* **options?**: `Partial`&lt;[`CreateTableOptions`](../interfaces/CreateTableOptions.md)&gt;

 ##### Returns

@@ -120,7 +131,9 @@ to be inserted into the table

 ### display()

-> `abstract` **display**(): `string`
+```ts
+abstract display(): string
+```

 Return a brief description of the connection

@@ -132,15 +145,16 @@ Return a brief description of the connection

 ### dropTable()

-> `abstract` **dropTable**(`name`): `Promise`&lt;`void`&gt;
+```ts
+abstract dropTable(name): Promise<void>
+```

 Drop an existing table.

 #### Parameters

-• **name**: `string`
-
-The name of the table to drop.
+* **name**: `string`
+    The name of the table to drop.

 #### Returns

@@ -150,7 +164,9 @@ The name of the table to drop.

 ### isOpen()

-> `abstract` **isOpen**(): `boolean`
+```ts
+abstract isOpen(): boolean
+```

 Return true if the connection has not been closed

@@ -162,17 +178,18 @@ Return true if the connection has not been closed

 ### openTable()

-> `abstract` **openTable**(`name`, `options`?): `Promise`&lt;[`Table`](Table.md)&gt;
+```ts
+abstract openTable(name, options?): Promise<Table>
+```

 Open a table in the database.

 #### Parameters

-• **name**: `string`
+* **name**: `string`
+    The name of the table

-The name of the table
-
-• **options?**: `Partial`&lt;`OpenTableOptions`&gt;
+* **options?**: `Partial`&lt;`OpenTableOptions`&gt;

 #### Returns

@@ -182,7 +199,9 @@ The name of the table

 ### tableNames()

-> `abstract` **tableNames**(`options`?): `Promise`&lt;`string`[]&gt;
+```ts
+abstract tableNames(options?): Promise<string[]>
+```

 List all the table names in this database.

@@ -190,10 +209,9 @@ Tables will be returned in lexicographical order.

 #### Parameters

-• **options?**: `Partial`&lt;[`TableNamesOptions`](../interfaces/TableNamesOptions.md)&gt;
-
-options to control the
-paging / start point
+* **options?**: `Partial`&lt;[`TableNamesOptions`](../interfaces/TableNamesOptions.md)&gt;
+    options to control the
+    paging / start point

 #### Returns

--- a/docs/src/js/classes/Index.md
+++ b/docs/src/js/classes/Index.md
@@ -8,9 +8,30 @@

 ## Methods

+### bitmap()
+
+```ts
+static bitmap(): Index
+```
+
+Create a bitmap index.
+
+A `Bitmap` index stores a bitmap for each distinct value in the column for every row.
+
+This index works best for low-cardinality columns, where the number of unique values
+is small (i.e., less than a few hundreds).
+
+#### Returns
+
+[`Index`](Index.md)
+
+***
+
 ### btree()

-> `static` **btree**(): [`Index`](Index.md)
+```ts
+static btree(): Index
+```

 Create a btree index

@@ -36,9 +57,82 @@ block size may be added in the future.

 ***

+### fts()
+
+```ts
+static fts(options?): Index
+```
+
+Create a full text search index
+
+A full text search index is an index on a string column, so that you can conduct full
+text searches on the column.
+
+The results of a full text search are ordered by relevance measured by BM25.
+
+You can combine filters with full text search.
+
+For now, the full text search index only supports English, and doesn't support phrase search.
+
+#### Parameters
+
+* **options?**: `Partial`&lt;`FtsOptions`&gt;
+
+#### Returns
+
+[`Index`](Index.md)
+
+***
+
+### hnswPq()
+
+```ts
+static hnswPq(options?): Index
+```
+
+Create a hnswPq index
+
+HNSW-PQ stands for Hierarchical Navigable Small World - Product Quantization.
+It is a variant of the HNSW algorithm that uses product quantization to compress
+the vectors.
+
+#### Parameters
+
+* **options?**: `Partial`&lt;`HnswPqOptions`&gt;
+
+#### Returns
+
+[`Index`](Index.md)
+
+***
+
+### hnswSq()
+
+```ts
+static hnswSq(options?): Index
+```
+
+Create a hnswSq index
+
+HNSW-SQ stands for Hierarchical Navigable Small World - Scalar Quantization.
+It is a variant of the HNSW algorithm that uses scalar quantization to compress
+the vectors.
+
+#### Parameters
+
+* **options?**: `Partial`&lt;`HnswSqOptions`&gt;
+
+#### Returns
+
+[`Index`](Index.md)
+
+***
+
 ### ivfPq()

-> `static` **ivfPq**(`options`?): [`Index`](Index.md)
+```ts
+static ivfPq(options?): Index
+```

 Create an IvfPq index

@@ -63,29 +157,25 @@ currently is also a memory intensive operation.

 #### Parameters

-• **options?**: `Partial`&lt;[`IvfPqOptions`](../interfaces/IvfPqOptions.md)&gt;
+* **options?**: `Partial`&lt;[`IvfPqOptions`](../interfaces/IvfPqOptions.md)&gt;

 #### Returns

 [`Index`](Index.md)

-### fts()
+***

-> `static` **fts**(`options`?): [`Index`](Index.md)
+### labelList()

-Create a full text search index
+```ts
+static labelList(): Index
+```

-This index is used to search for text data.  The index is created by tokenizing the text
-into words and then storing occurrences of these words in a data structure called inverted index
-that allows for fast search.
+Create a label list index.

-During a search the query is tokenized and the inverted index is used to find the rows that
-contain the query words.  The rows are then scored based on BM25 and the top scoring rows are
-sorted and returned.
-
-#### Parameters
-
-• **options?**: `Partial`&lt;[`FtsOptions`](../interfaces/FtsOptions.md)&gt;
+LabelList index is a scalar index that can be used on `List<T>` columns to
+support queries with `array_contains_all` and `array_contains_any`
+using an underlying bitmap index.

 #### Returns

--- a/docs/src/js/classes/MakeArrowTableOptions.md
+++ b/docs/src/js/classes/MakeArrowTableOptions.md
@@ -12,11 +12,13 @@ Options to control the makeArrowTable call.

 ### new MakeArrowTableOptions()

-> **new MakeArrowTableOptions**(`values`?): [`MakeArrowTableOptions`](MakeArrowTableOptions.md)
+```ts
+new MakeArrowTableOptions(values?): MakeArrowTableOptions
+```

 #### Parameters

-• **values?**: `Partial`&lt;[`MakeArrowTableOptions`](MakeArrowTableOptions.md)&gt;
+* **values?**: `Partial`&lt;[`MakeArrowTableOptions`](MakeArrowTableOptions.md)&gt;

 #### Returns

@@ -26,7 +28,9 @@ Options to control the makeArrowTable call.

 ### dictionaryEncodeStrings

-> **dictionaryEncodeStrings**: `boolean` = `false`
+```ts
+dictionaryEncodeStrings: boolean = false;
+```

 If true then string columns will be encoded with dictionary encoding

@@ -40,22 +44,30 @@ If `schema` is provided then this property is ignored.

 ### embeddingFunction?

-> `optional` **embeddingFunction**: [`EmbeddingFunctionConfig`](../namespaces/embedding/interfaces/EmbeddingFunctionConfig.md)
+```ts
+optional embeddingFunction: EmbeddingFunctionConfig;
+```

 ***

 ### embeddings?

-> `optional` **embeddings**: [`EmbeddingFunction`](../namespaces/embedding/classes/EmbeddingFunction.md)&lt;`unknown`, `FunctionOptions`&gt;
+```ts
+optional embeddings: EmbeddingFunction<unknown, FunctionOptions>;
+```

 ***

 ### schema?

-> `optional` **schema**: `SchemaLike`
+```ts
+optional schema: SchemaLike;
+```

 ***

 ### vectorColumns

-> **vectorColumns**: `Record`&lt;`string`, [`VectorColumnOptions`](VectorColumnOptions.md)&gt;
+```ts
+vectorColumns: Record<string, VectorColumnOptions>;
+```
--- a/docs/src/js/classes/Query.md
+++ b/docs/src/js/classes/Query.md
@@ -16,11 +16,13 @@ A builder for LanceDB queries.

 ### new Query()

-> **new Query**(`tbl`): [`Query`](Query.md)
+```ts
+new Query(tbl): Query
+```

 #### Parameters

-• **tbl**: `Table`
+* **tbl**: `Table`

 #### Returns

@@ -34,7 +36,9 @@ A builder for LanceDB queries.

 ### inner

-> `protected` **inner**: `Query` \| `Promise`&lt;`Query`&gt;
+```ts
+protected inner: Query | Promise<Query>;
+```

 #### Inherited from

@@ -44,7 +48,9 @@ A builder for LanceDB queries.

 ### \[asyncIterator\]()

-> **\[asyncIterator\]**(): `AsyncIterator`&lt;`RecordBatch`&lt;`any`&gt;, `any`, `undefined`&gt;
+```ts
+asyncIterator: AsyncIterator<RecordBatch<any>, any, undefined>
+```

 #### Returns

@@ -58,11 +64,13 @@ A builder for LanceDB queries.

 ### doCall()

-> `protected` **doCall**(`fn`): `void`
+```ts
+protected doCall(fn): void
+```

 #### Parameters

-• **fn**
+* **fn**

 #### Returns

@@ -76,13 +84,15 @@ A builder for LanceDB queries.

 ### execute()

-> `protected` **execute**(`options`?): [`RecordBatchIterator`](RecordBatchIterator.md)
+```ts
+protected execute(options?): RecordBatchIterator
+```

 Execute the query and return the results as an

 #### Parameters

-• **options?**: `Partial`&lt;`QueryExecutionOptions`&gt;
+* **options?**: `Partial`&lt;`QueryExecutionOptions`&gt;

 #### Returns

@@ -108,15 +118,16 @@ single query)

 ### explainPlan()

-> **explainPlan**(`verbose`): `Promise`&lt;`string`&gt;
+```ts
+explainPlan(verbose): Promise<string>
+```

 Generates an explanation of the query execution plan.

 #### Parameters

-• **verbose**: `boolean` = `false`
-
-If true, provides a more detailed explanation. Defaults to false.
+* **verbose**: `boolean` = `false`
+    If true, provides a more detailed explanation. Defaults to false.

 #### Returns

@@ -141,15 +152,38 @@ const plan = await table.query().nearestTo([0.5, 0.2]).explainPlan();

 ***

+### fastSearch()
+
+```ts
+fastSearch(): this
+```
+
+Skip searching un-indexed data. This can make search faster, but will miss
+any data that is not yet indexed.
+
+Use lancedb.Table#optimize to index all un-indexed data.
+
+#### Returns
+
+`this`
+
+#### Inherited from
+
+[`QueryBase`](QueryBase.md).[`fastSearch`](QueryBase.md#fastsearch)
+
+***
+
 ### ~~filter()~~

-> **filter**(`predicate`): `this`
+```ts
+filter(predicate): this
+```

 A filter statement to be applied to this query.

 #### Parameters

-• **predicate**: `string`
+* **predicate**: `string`

 #### Returns

@@ -169,9 +203,33 @@ Use `where` instead

 ***

+### fullTextSearch()
+
+```ts
+fullTextSearch(query, options?): this
+```
+
+#### Parameters
+
+* **query**: `string`
+
+* **options?**: `Partial`&lt;`FullTextSearchOptions`&gt;
+
+#### Returns
+
+`this`
+
+#### Inherited from
+
+[`QueryBase`](QueryBase.md).[`fullTextSearch`](QueryBase.md#fulltextsearch)
+
+***
+
 ### limit()

-> **limit**(`limit`): `this`
+```ts
+limit(limit): this
+```

 Set the maximum number of results to return.

@@ -180,7 +238,7 @@ called then every valid row from the table will be returned.

 #### Parameters

-• **limit**: `number`
+* **limit**: `number`

 #### Returns

@@ -194,11 +252,13 @@ called then every valid row from the table will be returned.

 ### nativeExecute()

-> `protected` **nativeExecute**(`options`?): `Promise`&lt;`RecordBatchIterator`&gt;
+```ts
+protected nativeExecute(options?): Promise<RecordBatchIterator>
+```

 #### Parameters

-• **options?**: `Partial`&lt;`QueryExecutionOptions`&gt;
+* **options?**: `Partial`&lt;`QueryExecutionOptions`&gt;

 #### Returns

@@ -212,7 +272,9 @@ called then every valid row from the table will be returned.

 ### nearestTo()

-> **nearestTo**(`vector`): [`VectorQuery`](VectorQuery.md)
+```ts
+nearestTo(vector): VectorQuery
+```

 Find the nearest vectors to the given query vector.

@@ -232,7 +294,7 @@ If there is more than one vector column you must use

 #### Parameters

-• **vector**: `IntoVector`
+* **vector**: `IntoVector`

 #### Returns

@@ -264,9 +326,49 @@ a default `limit` of 10 will be used.

 ***

+### nearestToText()
+
+```ts
+nearestToText(query, columns?): Query
+```
+
+#### Parameters
+
+* **query**: `string`
+
+* **columns?**: `string`[]
+
+#### Returns
+
+[`Query`](Query.md)
+
+***
+
+### offset()
+
+```ts
+offset(offset): this
+```
+
+#### Parameters
+
+* **offset**: `number`
+
+#### Returns
+
+`this`
+
+#### Inherited from
+
+[`QueryBase`](QueryBase.md).[`offset`](QueryBase.md#offset)
+
+***
+
 ### select()

-> **select**(`columns`): `this`
+```ts
+select(columns): this
+```

 Return only the specified columns.

@@ -290,7 +392,7 @@ input to this method would be:

 #### Parameters

-• **columns**: `string` \| `string`[] \| `Record`&lt;`string`, `string`&gt; \| `Map`&lt;`string`, `string`&gt;
+* **columns**: `string` \| `string`[] \| `Record`&lt;`string`, `string`&gt; \| `Map`&lt;`string`, `string`&gt;

 #### Returns

@@ -317,13 +419,15 @@ object insertion order is easy to get wrong and `Map` is more foolproof.

 ### toArray()

-> **toArray**(`options`?): `Promise`&lt;`any`[]&gt;
+```ts
+toArray(options?): Promise<any[]>
+```

 Collect the results as an array of objects.

 #### Parameters

-• **options?**: `Partial`&lt;`QueryExecutionOptions`&gt;
+* **options?**: `Partial`&lt;`QueryExecutionOptions`&gt;

 #### Returns

@@ -337,13 +441,15 @@ Collect the results as an array of objects.

 ### toArrow()

-> **toArrow**(`options`?): `Promise`&lt;`Table`&lt;`any`&gt;&gt;
+```ts
+toArrow(options?): Promise<Table<any>>
+```

 Collect the results as an Arrow

 #### Parameters

-• **options?**: `Partial`&lt;`QueryExecutionOptions`&gt;
+* **options?**: `Partial`&lt;`QueryExecutionOptions`&gt;

 #### Returns

@@ -361,7 +467,9 @@ ArrowTable.

 ### where()

-> **where**(`predicate`): `this`
+```ts
+where(predicate): this
+```

 A filter statement to be applied to this query.

@@ -369,7 +477,7 @@ The filter should be supplied as an SQL query string.  For example:

 #### Parameters

-• **predicate**: `string`
+* **predicate**: `string`

 #### Returns

@@ -389,3 +497,25 @@ on the filter column(s).
 #### Inherited from

 [`QueryBase`](QueryBase.md).[`where`](QueryBase.md#where)
+
+***
+
+### withRowId()
+
+```ts
+withRowId(): this
+```
+
+Whether to return the row id in the results.
+
+This column can be used to match results between different queries. For
+example, to match results from a full text search and a vector search in
+order to perform hybrid search.
+
+#### Returns
+
+`this`
+
+#### Inherited from
+
+[`QueryBase`](QueryBase.md).[`withRowId`](QueryBase.md#withrowid)
--- a/docs/src/js/classes/QueryBase.md
+++ b/docs/src/js/classes/QueryBase.md
@@ -25,11 +25,13 @@ Common methods supported by all query types

 ### new QueryBase()

-> `protected` **new QueryBase**&lt;`NativeQueryType`&gt;(`inner`): [`QueryBase`](QueryBase.md)&lt;`NativeQueryType`&gt;
+```ts
+protected new QueryBase<NativeQueryType>(inner): QueryBase<NativeQueryType>
+```

 #### Parameters

-• **inner**: `NativeQueryType` \| `Promise`&lt;`NativeQueryType`&gt;
+* **inner**: `NativeQueryType` \| `Promise`&lt;`NativeQueryType`&gt;

 #### Returns

@@ -39,13 +41,17 @@ Common methods supported by all query types

 ### inner

-> `protected` **inner**: `NativeQueryType` \| `Promise`&lt;`NativeQueryType`&gt;
+```ts
+protected inner: NativeQueryType | Promise<NativeQueryType>;
+```

 ## Methods

 ### \[asyncIterator\]()

-> **\[asyncIterator\]**(): `AsyncIterator`&lt;`RecordBatch`&lt;`any`&gt;, `any`, `undefined`&gt;
+```ts
+asyncIterator: AsyncIterator<RecordBatch<any>, any, undefined>
+```

 #### Returns

@@ -59,11 +65,13 @@ Common methods supported by all query types

 ### doCall()

-> `protected` **doCall**(`fn`): `void`
+```ts
+protected doCall(fn): void
+```

 #### Parameters

-• **fn**
+* **fn**

 #### Returns

@@ -73,13 +81,15 @@ Common methods supported by all query types

 ### execute()

-> `protected` **execute**(`options`?): [`RecordBatchIterator`](RecordBatchIterator.md)
+```ts
+protected execute(options?): RecordBatchIterator
+```

 Execute the query and return the results as an

 #### Parameters

-• **options?**: `Partial`&lt;`QueryExecutionOptions`&gt;
+* **options?**: `Partial`&lt;`QueryExecutionOptions`&gt;

 #### Returns

@@ -101,15 +111,16 @@ single query)

 ### explainPlan()

-> **explainPlan**(`verbose`): `Promise`&lt;`string`&gt;
+```ts
+explainPlan(verbose): Promise<string>
+```

 Generates an explanation of the query execution plan.

 #### Parameters

-• **verbose**: `boolean` = `false`
-
-If true, provides a more detailed explanation. Defaults to false.
+* **verbose**: `boolean` = `false`
+    If true, provides a more detailed explanation. Defaults to false.

 #### Returns

@@ -130,15 +141,34 @@ const plan = await table.query().nearestTo([0.5, 0.2]).explainPlan();

 ***

+### fastSearch()
+
+```ts
+fastSearch(): this
+```
+
+Skip searching un-indexed data. This can make search faster, but will miss
+any data that is not yet indexed.
+
+Use lancedb.Table#optimize to index all un-indexed data.
+
+#### Returns
+
+`this`
+
+***
+
 ### ~~filter()~~

-> **filter**(`predicate`): `this`
+```ts
+filter(predicate): this
+```

 A filter statement to be applied to this query.

 #### Parameters

-• **predicate**: `string`
+* **predicate**: `string`

 #### Returns

@@ -154,9 +184,29 @@ Use `where` instead

 ***

+### fullTextSearch()
+
+```ts
+fullTextSearch(query, options?): this
+```
+
+#### Parameters
+
+* **query**: `string`
+
+* **options?**: `Partial`&lt;`FullTextSearchOptions`&gt;
+
+#### Returns
+
+`this`
+
+***
+
 ### limit()

-> **limit**(`limit`): `this`
+```ts
+limit(limit): this
+```

 Set the maximum number of results to return.

@@ -165,7 +215,7 @@ called then every valid row from the table will be returned.

 #### Parameters

-• **limit**: `number`
+* **limit**: `number`

 #### Returns

@@ -175,11 +225,13 @@ called then every valid row from the table will be returned.

 ### nativeExecute()

-> `protected` **nativeExecute**(`options`?): `Promise`&lt;`RecordBatchIterator`&gt;
+```ts
+protected nativeExecute(options?): Promise<RecordBatchIterator>
+```

 #### Parameters

-• **options?**: `Partial`&lt;`QueryExecutionOptions`&gt;
+* **options?**: `Partial`&lt;`QueryExecutionOptions`&gt;

 #### Returns

@@ -187,9 +239,27 @@ called then every valid row from the table will be returned.

 ***

+### offset()
+
+```ts
+offset(offset): this
+```
+
+#### Parameters
+
+* **offset**: `number`
+
+#### Returns
+
+`this`
+
+***
+
 ### select()

-> **select**(`columns`): `this`
+```ts
+select(columns): this
+```

 Return only the specified columns.

@@ -213,7 +283,7 @@ input to this method would be:

 #### Parameters

-• **columns**: `string` \| `string`[] \| `Record`&lt;`string`, `string`&gt; \| `Map`&lt;`string`, `string`&gt;
+* **columns**: `string` \| `string`[] \| `Record`&lt;`string`, `string`&gt; \| `Map`&lt;`string`, `string`&gt;

 #### Returns

@@ -236,13 +306,15 @@ object insertion order is easy to get wrong and `Map` is more foolproof.

 ### toArray()

-> **toArray**(`options`?): `Promise`&lt;`any`[]&gt;
+```ts
+toArray(options?): Promise<any[]>
+```

 Collect the results as an array of objects.

 #### Parameters

-• **options?**: `Partial`&lt;`QueryExecutionOptions`&gt;
+* **options?**: `Partial`&lt;`QueryExecutionOptions`&gt;

 #### Returns

@@ -252,13 +324,15 @@ Collect the results as an array of objects.

 ### toArrow()

-> **toArrow**(`options`?): `Promise`&lt;`Table`&lt;`any`&gt;&gt;
+```ts
+toArrow(options?): Promise<Table<any>>
+```

 Collect the results as an Arrow

 #### Parameters

-• **options?**: `Partial`&lt;`QueryExecutionOptions`&gt;
+* **options?**: `Partial`&lt;`QueryExecutionOptions`&gt;

 #### Returns

@@ -272,7 +346,9 @@ ArrowTable.

 ### where()

-> **where**(`predicate`): `this`
+```ts
+where(predicate): this
+```

 A filter statement to be applied to this query.

@@ -280,7 +356,7 @@ The filter should be supplied as an SQL query string.  For example:

 #### Parameters

-• **predicate**: `string`
+* **predicate**: `string`

 #### Returns

@@ -296,3 +372,21 @@ x > 5 OR y = 'test'
 Filtering performance can often be improved by creating a scalar index
 on the filter column(s).
 ```
+
+***
+
+### withRowId()
+
+```ts
+withRowId(): this
+```
+
+Whether to return the row id in the results.
+
+This column can be used to match results between different queries. For
+example, to match results from a full text search and a vector search in
+order to perform hybrid search.
+
+#### Returns
+
+`this`
--- a/docs/src/js/classes/RecordBatchIterator.md
+++ b/docs/src/js/classes/RecordBatchIterator.md
@@ -14,11 +14,13 @@

 ### new RecordBatchIterator()

-> **new RecordBatchIterator**(`promise`?): [`RecordBatchIterator`](RecordBatchIterator.md)
+```ts
+new RecordBatchIterator(promise?): RecordBatchIterator
+```

 #### Parameters

-• **promise?**: `Promise`&lt;`RecordBatchIterator`&gt;
+* **promise?**: `Promise`&lt;`RecordBatchIterator`&gt;

 #### Returns

@@ -28,7 +30,9 @@

 ### next()

-> **next**(): `Promise`&lt;`IteratorResult`&lt;`RecordBatch`&lt;`any`&gt;, `any`&gt;&gt;
+```ts
+next(): Promise<IteratorResult<RecordBatch<any>, any>>
+```

 #### Returns

--- a/docs/src/js/classes/Table.md
+++ b/docs/src/js/classes/Table.md
@@ -21,7 +21,9 @@ collected.

 ### new Table()

-> **new Table**(): [`Table`](Table.md)
+```ts
+new Table(): Table
+```

 #### Returns

@@ -31,7 +33,9 @@ collected.

 ### name

-> `get` `abstract` **name**(): `string`
+```ts
+get abstract name(): string
+```

 Returns the name of the table

@@ -43,17 +47,18 @@ Returns the name of the table

 ### add()

-> `abstract` **add**(`data`, `options`?): `Promise`&lt;`void`&gt;
+```ts
+abstract add(data, options?): Promise<void>
+```

 Insert records into this Table.

 #### Parameters

-• **data**: [`Data`](../type-aliases/Data.md)
+* **data**: [`Data`](../type-aliases/Data.md)
+    Records to be inserted into the Table

-Records to be inserted into the Table
-
-• **options?**: `Partial`&lt;[`AddDataOptions`](../interfaces/AddDataOptions.md)&gt;
+* **options?**: `Partial`&lt;[`AddDataOptions`](../interfaces/AddDataOptions.md)&gt;

 #### Returns

@@ -63,18 +68,19 @@ Records to be inserted into the Table

 ### addColumns()

-> `abstract` **addColumns**(`newColumnTransforms`): `Promise`&lt;`void`&gt;
+```ts
+abstract addColumns(newColumnTransforms): Promise<void>
+```

 Add new columns with defined values.

 #### Parameters

-• **newColumnTransforms**: [`AddColumnsSql`](../interfaces/AddColumnsSql.md)[]
-
-pairs of column names and
-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
-reference existing columns in the table.
+* **newColumnTransforms**: [`AddColumnsSql`](../interfaces/AddColumnsSql.md)[]
+    pairs of column names and
+    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
+    reference existing columns in the table.

 #### Returns

@@ -84,16 +90,17 @@ reference existing columns in the table.

 ### alterColumns()

-> `abstract` **alterColumns**(`columnAlterations`): `Promise`&lt;`void`&gt;
+```ts
+abstract alterColumns(columnAlterations): Promise<void>
+```

 Alter the name or nullability of columns.

 #### Parameters

-• **columnAlterations**: [`ColumnAlteration`](../interfaces/ColumnAlteration.md)[]
-
-One or more alterations to
-apply to columns.
+* **columnAlterations**: [`ColumnAlteration`](../interfaces/ColumnAlteration.md)[]
+    One or more alterations to
+    apply to columns.

 #### Returns

@@ -103,7 +110,9 @@ apply to columns.

 ### checkout()

-> `abstract` **checkout**(`version`): `Promise`&lt;`void`&gt;
+```ts
+abstract checkout(version): Promise<void>
+```

 Checks out a specific version of the table _This is an in-place operation._

@@ -116,9 +125,8 @@ wish to return to standard mode, call `checkoutLatest`.

 #### Parameters

-• **version**: `number`
-
-The version to checkout
+* **version**: `number`
+    The version to checkout

 #### Returns

@@ -144,7 +152,9 @@ console.log(await table.version()); // 2

 ### checkoutLatest()

-> `abstract` **checkoutLatest**(): `Promise`&lt;`void`&gt;
+```ts
+abstract checkoutLatest(): Promise<void>
+```

 Checkout the latest version of the table. _This is an in-place operation._

@@ -159,7 +169,9 @@ version of the table.

 ### close()

-> `abstract` **close**(): `void`
+```ts
+abstract close(): void
+```

 Close the table, releasing any underlying resources.

@@ -175,13 +187,15 @@ Any attempt to use the table after it is closed will result in an error.

 ### countRows()

-> `abstract` **countRows**(`filter`?): `Promise`&lt;`number`&gt;
+```ts
+abstract countRows(filter?): Promise<number>
+```

 Count the total number of rows in the dataset.

 #### Parameters

-• **filter?**: `string`
+* **filter?**: `string`

 #### Returns

@@ -191,7 +205,9 @@ Count the total number of rows in the dataset.

 ### createIndex()

-> `abstract` **createIndex**(`column`, `options`?): `Promise`&lt;`void`&gt;
+```ts
+abstract createIndex(column, options?): Promise<void>
+```

 Create an index to speed up queries.

@@ -202,9 +218,9 @@ vector and non-vector searches)

 #### Parameters

-• **column**: `string`
+* **column**: `string`

-• **options?**: `Partial`&lt;[`IndexOptions`](../interfaces/IndexOptions.md)&gt;
+* **options?**: `Partial`&lt;[`IndexOptions`](../interfaces/IndexOptions.md)&gt;

 #### Returns

@@ -245,13 +261,15 @@ await table.createIndex("my_float_col");

 ### delete()

-> `abstract` **delete**(`predicate`): `Promise`&lt;`void`&gt;
+```ts
+abstract delete(predicate): Promise<void>
+```

 Delete the rows that satisfy the predicate.

 #### Parameters

-• **predicate**: `string`
+* **predicate**: `string`

 #### Returns

@@ -261,7 +279,9 @@ Delete the rows that satisfy the predicate.

 ### display()

-> `abstract` **display**(): `string`
+```ts
+abstract display(): string
+```

 Return a brief description of the table

@@ -273,7 +293,9 @@ Return a brief description of the table

 ### dropColumns()

-> `abstract` **dropColumns**(`columnNames`): `Promise`&lt;`void`&gt;
+```ts
+abstract dropColumns(columnNames): Promise<void>
+```

 Drop one or more columns from the dataset

@@ -284,11 +306,10 @@ then call ``cleanup_files`` to remove the old files.

 #### Parameters

-• **columnNames**: `string`[]
-
-The names of the columns to drop. These can
-be nested column references (e.g. "a.b.c") or top-level column names
-(e.g. "a").
+* **columnNames**: `string`[]
+    The names of the columns to drop. These can
+    be nested column references (e.g. "a.b.c") or top-level column names
+    (e.g. "a").

 #### Returns

@@ -298,15 +319,16 @@ be nested column references (e.g. "a.b.c") or top-level column names

 ### indexStats()

-> `abstract` **indexStats**(`name`): `Promise`&lt;`undefined` \| [`IndexStatistics`](../interfaces/IndexStatistics.md)&gt;
+```ts
+abstract indexStats(name): Promise<undefined | IndexStatistics>
+```

 List all the stats of a specified index

 #### Parameters

-• **name**: `string`
-
-The name of the index.
+* **name**: `string`
+    The name of the index.

 #### Returns

@@ -318,7 +340,9 @@ The stats of the index. If the index does not exist, it will return undefined

 ### isOpen()

-> `abstract` **isOpen**(): `boolean`
+```ts
+abstract isOpen(): boolean
+```

 Return true if the table has not been closed

@@ -330,7 +354,9 @@ Return true if the table has not been closed

 ### listIndices()

-> `abstract` **listIndices**(): `Promise`&lt;[`IndexConfig`](../interfaces/IndexConfig.md)[]&gt;
+```ts
+abstract listIndices(): Promise<IndexConfig[]>
+```

 List all indices that have been created with [Table.createIndex](Table.md#createindex)

@@ -340,13 +366,29 @@ List all indices that have been created with [Table.createIndex](Table.md#create

 ***

+### listVersions()
+
+```ts
+abstract listVersions(): Promise<Version[]>
+```
+
+List all the versions of the table
+
+#### Returns
+
+`Promise`&lt;`Version`[]&gt;
+
+***
+
 ### mergeInsert()

-> `abstract` **mergeInsert**(`on`): `MergeInsertBuilder`
+```ts
+abstract mergeInsert(on): MergeInsertBuilder
+```

 #### Parameters

-• **on**: `string` \| `string`[]
+* **on**: `string` \| `string`[]

 #### Returns

@@ -356,7 +398,9 @@ List all indices that have been created with [Table.createIndex](Table.md#create

 ### optimize()

-> `abstract` **optimize**(`options`?): `Promise`&lt;`OptimizeStats`&gt;
+```ts
+abstract optimize(options?): Promise<OptimizeStats>
+```

 Optimize the on-disk data and indices for better performance.

@@ -388,7 +432,7 @@ Modeled after ``VACUUM`` in PostgreSQL.

 #### Parameters

-• **options?**: `Partial`&lt;`OptimizeOptions`&gt;
+* **options?**: `Partial`&lt;[`OptimizeOptions`](../interfaces/OptimizeOptions.md)&gt;

 #### Returns

@@ -398,7 +442,9 @@ Modeled after ``VACUUM`` in PostgreSQL.

 ### query()

-> `abstract` **query**(): [`Query`](Query.md)
+```ts
+abstract query(): Query
+```

 Create a [Query](Query.md) Builder.

@@ -466,7 +512,9 @@ for await (const batch of table.query()) {

 ### restore()

-> `abstract` **restore**(): `Promise`&lt;`void`&gt;
+```ts
+abstract restore(): Promise<void>
+```

 Restore the table to the currently checked out version

@@ -487,7 +535,9 @@ out state and the read_consistency_interval, if any, will apply.

 ### schema()

-> `abstract` **schema**(): `Promise`&lt;`Schema`&lt;`any`&gt;&gt;
+```ts
+abstract schema(): Promise<Schema<any>>
+```

 Get the schema of the table.

@@ -499,61 +549,41 @@ Get the schema of the table.

 ### search()

-#### search(query)
-
-> `abstract` **search**(`query`, `queryType`, `ftsColumns`): [`VectorQuery`](VectorQuery.md)
+```ts
+abstract search(
+   query,
+   queryType?,
+   ftsColumns?): VectorQuery | Query
+```

 Create a search query to find the nearest neighbors
-of the given query vector, or the documents
-with the highest relevance to the query string.
+of the given query

-##### Parameters
+#### Parameters

-• **query**: `string`
+* **query**: `string` \| `IntoVector`
+    the query, a vector or string

-the query. This will be converted to a vector using the table's provided embedding function,
-or the query string for full-text search if `queryType` is "fts".
+* **queryType?**: `string`
+    the type of the query, "vector", "fts", or "auto"

-• **queryType**: `string` =  `"auto"` \| `"fts"`
+* **ftsColumns?**: `string` \| `string`[]
+    the columns to search in for full text search
+    for now, only one column can be searched at a time.
+    when "auto" is used, if the query is a string and an embedding function is defined, it will be treated as a vector query
+    if the query is a string and no embedding function is defined, it will be treated as a full text search query

-the type of query to run. If "auto", the query type will be determined based on the query.
+#### Returns

-• **ftsColumns**: `string[] | str` =  undefined
-
-the columns to search in. If not provided, all indexed columns will be searched.
-
-For now, this can support to search only one column.
-
-##### Returns
-
-[`VectorQuery`](VectorQuery.md)
-
-##### Note
-
-If no embedding functions are defined in the table, this will error when collecting the results.
-
-#### search(query)
-
-> `abstract` **search**(`query`): [`VectorQuery`](VectorQuery.md)
-
-Create a search query to find the nearest neighbors
-of the given query vector
-
-##### Parameters
-
-• **query**: `IntoVector`
-
-the query vector
-
-##### Returns
-
-[`VectorQuery`](VectorQuery.md)
+[`VectorQuery`](VectorQuery.md) \| [`Query`](Query.md)

 ***

 ### toArrow()

-> `abstract` **toArrow**(): `Promise`&lt;`Table`&lt;`any`&gt;&gt;
+```ts
+abstract toArrow(): Promise<Table<any>>
+```

 Return the table as an arrow table

@@ -567,13 +597,15 @@ Return the table as an arrow table

 #### update(opts)

-> `abstract` **update**(`opts`): `Promise`&lt;`void`&gt;
+```ts
+abstract update(opts): Promise<void>
+```

 Update existing records in the Table

 ##### Parameters

-• **opts**: `object` & `Partial`&lt;[`UpdateOptions`](../interfaces/UpdateOptions.md)&gt;
+* **opts**: `object` & `Partial`&lt;[`UpdateOptions`](../interfaces/UpdateOptions.md)&gt;

 ##### Returns

@@ -587,13 +619,15 @@ table.update({where:"x = 2", values:{"vector": [10, 10]}})

 #### update(opts)

-> `abstract` **update**(`opts`): `Promise`&lt;`void`&gt;
+```ts
+abstract update(opts): Promise<void>
+```

 Update existing records in the Table

 ##### Parameters

-• **opts**: `object` & `Partial`&lt;[`UpdateOptions`](../interfaces/UpdateOptions.md)&gt;
+* **opts**: `object` & `Partial`&lt;[`UpdateOptions`](../interfaces/UpdateOptions.md)&gt;

 ##### Returns

@@ -607,7 +641,9 @@ table.update({where:"x = 2", valuesSql:{"x": "x + 1"}})

 #### update(updates, options)

-> `abstract` **update**(`updates`, `options`?): `Promise`&lt;`void`&gt;
+```ts
+abstract update(updates, options?): Promise<void>
+```

 Update existing records in the Table

@@ -626,20 +662,17 @@ repeatedly calilng this method.

 ##### Parameters

-• **updates**: `Record`&lt;`string`, `string`&gt; \| `Map`&lt;`string`, `string`&gt;
+* **updates**: `Record`&lt;`string`, `string`&gt; \| `Map`&lt;`string`, `string`&gt;
+    the
+    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")

-the
-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`&lt;[`UpdateOptions`](../interfaces/UpdateOptions.md)&gt;
-
-additional options to control
-the update behavior
+* **options?**: `Partial`&lt;[`UpdateOptions`](../interfaces/UpdateOptions.md)&gt;
+    additional options to control
+    the update behavior

 ##### Returns

@@ -649,7 +682,9 @@ the update behavior

 ### vectorSearch()

-> `abstract` **vectorSearch**(`vector`): [`VectorQuery`](VectorQuery.md)
+```ts
+abstract vectorSearch(vector): VectorQuery
+```

 Search the table with a given query vector.

@@ -659,7 +694,7 @@ by `query`.

 #### Parameters

-• **vector**: `IntoVector`
+* **vector**: `IntoVector`

 #### Returns

@@ -673,7 +708,9 @@ by `query`.

 ### version()

-> `abstract` **version**(): `Promise`&lt;`number`&gt;
+```ts
+abstract version(): Promise<number>
+```

 Retrieve the version of the table

@@ -685,15 +722,20 @@ Retrieve the version of the table

 ### parseTableData()

-> `static` **parseTableData**(`data`, `options`?, `streaming`?): `Promise`&lt;`object`&gt;
+```ts
+static parseTableData(
+   data,
+   options?,
+   streaming?): Promise<object>
+```

 #### Parameters

-• **data**: `TableLike` \| `Record`&lt;`string`, `unknown`&gt;[]
+* **data**: `TableLike` \| `Record`&lt;`string`, `unknown`&gt;[]

-• **options?**: `Partial`&lt;[`CreateTableOptions`](../interfaces/CreateTableOptions.md)&gt;
+* **options?**: `Partial`&lt;[`CreateTableOptions`](../interfaces/CreateTableOptions.md)&gt;

-• **streaming?**: `boolean` = `false`
+* **streaming?**: `boolean` = `false`

 #### Returns

@@ -701,8 +743,12 @@ Retrieve the version of the table

 ##### buf

-> **buf**: `Buffer`
+```ts
+buf: Buffer;
+```

 ##### mode

-> **mode**: `string`
+```ts
+mode: string;
+```
--- a/docs/src/js/classes/VectorColumnOptions.md
+++ b/docs/src/js/classes/VectorColumnOptions.md
@@ -10,11 +10,13 @@

 ### new VectorColumnOptions()

-> **new VectorColumnOptions**(`values`?): [`VectorColumnOptions`](VectorColumnOptions.md)
+```ts
+new VectorColumnOptions(values?): VectorColumnOptions
+```

 #### Parameters

-• **values?**: `Partial`&lt;[`VectorColumnOptions`](VectorColumnOptions.md)&gt;
+* **values?**: `Partial`&lt;[`VectorColumnOptions`](VectorColumnOptions.md)&gt;

 #### Returns

@@ -24,6 +26,8 @@

 ### type

-> **type**: `Float`&lt;`Floats`&gt;
+```ts
+type: Float<Floats>;
+```

 Vector column type.
--- a/docs/src/js/classes/VectorQuery.md
+++ b/docs/src/js/classes/VectorQuery.md
@@ -18,11 +18,13 @@ This builder can be reused to execute the query many times.

 ### new VectorQuery()

-> **new VectorQuery**(`inner`): [`VectorQuery`](VectorQuery.md)
+```ts
+new VectorQuery(inner): VectorQuery
+```

 #### Parameters

-• **inner**: `VectorQuery` \| `Promise`&lt;`VectorQuery`&gt;
+* **inner**: `VectorQuery` \| `Promise`&lt;`VectorQuery`&gt;

 #### Returns

@@ -36,7 +38,9 @@ This builder can be reused to execute the query many times.

 ### inner

-> `protected` **inner**: `VectorQuery` \| `Promise`&lt;`VectorQuery`&gt;
+```ts
+protected inner: VectorQuery | Promise<VectorQuery>;
+```

 #### Inherited from

@@ -46,7 +50,9 @@ This builder can be reused to execute the query many times.

 ### \[asyncIterator\]()

-> **\[asyncIterator\]**(): `AsyncIterator`&lt;`RecordBatch`&lt;`any`&gt;, `any`, `undefined`&gt;
+```ts
+asyncIterator: AsyncIterator<RecordBatch<any>, any, undefined>
+```

 #### Returns

@@ -58,9 +64,27 @@ This builder can be reused to execute the query many times.

 ***

+### addQueryVector()
+
+```ts
+addQueryVector(vector): VectorQuery
+```
+
+#### Parameters
+
+* **vector**: `IntoVector`
+
+#### Returns
+
+[`VectorQuery`](VectorQuery.md)
+
+***
+
 ### bypassVectorIndex()

-> **bypassVectorIndex**(): [`VectorQuery`](VectorQuery.md)
+```ts
+bypassVectorIndex(): VectorQuery
+```

 If this is called then any vector index is skipped

@@ -78,7 +102,9 @@ calculate your recall to select an appropriate value for nprobes.

 ### column()

-> **column**(`column`): [`VectorQuery`](VectorQuery.md)
+```ts
+column(column): VectorQuery
+```

 Set the vector column to query

@@ -87,7 +113,7 @@ the call to

 #### Parameters

-• **column**: `string`
+* **column**: `string`

 #### Returns

@@ -104,7 +130,9 @@ whose data type is a fixed-size-list of floats.

 ### distanceType()

-> **distanceType**(`distanceType`): [`VectorQuery`](VectorQuery.md)
+```ts
+distanceType(distanceType): VectorQuery
+```

 Set the distance metric to use

@@ -114,7 +142,7 @@ use.  See

 #### Parameters

-• **distanceType**: `"l2"` \| `"cosine"` \| `"dot"`
+* **distanceType**: `"l2"` \| `"cosine"` \| `"dot"`

 #### Returns

@@ -135,11 +163,13 @@ By default "l2" is used.

 ### doCall()

-> `protected` **doCall**(`fn`): `void`
+```ts
+protected doCall(fn): void
+```

 #### Parameters

-• **fn**
+* **fn**

 #### Returns

@@ -151,15 +181,41 @@ By default "l2" is used.

 ***

+### ef()
+
+```ts
+ef(ef): VectorQuery
+```
+
+Set the number of candidates to consider during the search
+
+This argument is only used when the vector column has an HNSW index.
+If there is no index then this value is ignored.
+
+Increasing this value will increase the recall of your query but will
+also increase the latency of your query. The default value is 1.5*limit.
+
+#### Parameters
+
+* **ef**: `number`
+
+#### Returns
+
+[`VectorQuery`](VectorQuery.md)
+
+***
+
 ### execute()

-> `protected` **execute**(`options`?): [`RecordBatchIterator`](RecordBatchIterator.md)
+```ts
+protected execute(options?): RecordBatchIterator
+```

 Execute the query and return the results as an

 #### Parameters

-• **options?**: `Partial`&lt;`QueryExecutionOptions`&gt;
+* **options?**: `Partial`&lt;`QueryExecutionOptions`&gt;

 #### Returns

@@ -185,15 +241,16 @@ single query)

 ### explainPlan()

-> **explainPlan**(`verbose`): `Promise`&lt;`string`&gt;
+```ts
+explainPlan(verbose): Promise<string>
+```

 Generates an explanation of the query execution plan.

 #### Parameters

-• **verbose**: `boolean` = `false`
-
-If true, provides a more detailed explanation. Defaults to false.
+* **verbose**: `boolean` = `false`
+    If true, provides a more detailed explanation. Defaults to false.

 #### Returns

@@ -218,15 +275,38 @@ const plan = await table.query().nearestTo([0.5, 0.2]).explainPlan();

 ***

+### fastSearch()
+
+```ts
+fastSearch(): this
+```
+
+Skip searching un-indexed data. This can make search faster, but will miss
+any data that is not yet indexed.
+
+Use lancedb.Table#optimize to index all un-indexed data.
+
+#### Returns
+
+`this`
+
+#### Inherited from
+
+[`QueryBase`](QueryBase.md).[`fastSearch`](QueryBase.md#fastsearch)
+
+***
+
 ### ~~filter()~~

-> **filter**(`predicate`): `this`
+```ts
+filter(predicate): this
+```

 A filter statement to be applied to this query.

 #### Parameters

-• **predicate**: `string`
+* **predicate**: `string`

 #### Returns

@@ -246,9 +326,33 @@ Use `where` instead

 ***

+### fullTextSearch()
+
+```ts
+fullTextSearch(query, options?): this
+```
+
+#### Parameters
+
+* **query**: `string`
+
+* **options?**: `Partial`&lt;`FullTextSearchOptions`&gt;
+
+#### Returns
+
+`this`
+
+#### Inherited from
+
+[`QueryBase`](QueryBase.md).[`fullTextSearch`](QueryBase.md#fulltextsearch)
+
+***
+
 ### limit()

-> **limit**(`limit`): `this`
+```ts
+limit(limit): this
+```

 Set the maximum number of results to return.

@@ -257,7 +361,7 @@ called then every valid row from the table will be returned.

 #### Parameters

-• **limit**: `number`
+* **limit**: `number`

 #### Returns

@@ -271,11 +375,13 @@ called then every valid row from the table will be returned.

 ### nativeExecute()

-> `protected` **nativeExecute**(`options`?): `Promise`&lt;`RecordBatchIterator`&gt;
+```ts
+protected nativeExecute(options?): Promise<RecordBatchIterator>
+```

 #### Parameters

-• **options?**: `Partial`&lt;`QueryExecutionOptions`&gt;
+* **options?**: `Partial`&lt;`QueryExecutionOptions`&gt;

 #### Returns

@@ -289,7 +395,9 @@ called then every valid row from the table will be returned.

 ### nprobes()

-> **nprobes**(`nprobes`): [`VectorQuery`](VectorQuery.md)
+```ts
+nprobes(nprobes): VectorQuery
+```

 Set the number of partitions to search (probe)

@@ -314,7 +422,7 @@ you the desired recall.

 #### Parameters

-• **nprobes**: `number`
+* **nprobes**: `number`

 #### Returns

@@ -322,9 +430,31 @@ you the desired recall.

 ***

+### offset()
+
+```ts
+offset(offset): this
+```
+
+#### Parameters
+
+* **offset**: `number`
+
+#### Returns
+
+`this`
+
+#### Inherited from
+
+[`QueryBase`](QueryBase.md).[`offset`](QueryBase.md#offset)
+
+***
+
 ### postfilter()

-> **postfilter**(): [`VectorQuery`](VectorQuery.md)
+```ts
+postfilter(): VectorQuery
+```

 If this is called then filtering will happen after the vector search instead of
 before.
@@ -356,7 +486,9 @@ factor can often help restore some of the results lost by post filtering.

 ### refineFactor()

-> **refineFactor**(`refineFactor`): [`VectorQuery`](VectorQuery.md)
+```ts
+refineFactor(refineFactor): VectorQuery
+```

 A multiplier to control how many additional rows are taken during the refine step

@@ -388,7 +520,7 @@ distance between the query vector and the actual uncompressed vector.

 #### Parameters

-• **refineFactor**: `number`
+* **refineFactor**: `number`

 #### Returns

@@ -398,7 +530,9 @@ distance between the query vector and the actual uncompressed vector.

 ### select()

-> **select**(`columns`): `this`
+```ts
+select(columns): this
+```

 Return only the specified columns.

@@ -422,7 +556,7 @@ input to this method would be:

 #### Parameters

-• **columns**: `string` \| `string`[] \| `Record`&lt;`string`, `string`&gt; \| `Map`&lt;`string`, `string`&gt;
+* **columns**: `string` \| `string`[] \| `Record`&lt;`string`, `string`&gt; \| `Map`&lt;`string`, `string`&gt;

 #### Returns

@@ -449,13 +583,15 @@ object insertion order is easy to get wrong and `Map` is more foolproof.

 ### toArray()

-> **toArray**(`options`?): `Promise`&lt;`any`[]&gt;
+```ts
+toArray(options?): Promise<any[]>
+```

 Collect the results as an array of objects.

 #### Parameters

-• **options?**: `Partial`&lt;`QueryExecutionOptions`&gt;
+* **options?**: `Partial`&lt;`QueryExecutionOptions`&gt;

 #### Returns

@@ -469,13 +605,15 @@ Collect the results as an array of objects.

 ### toArrow()

-> **toArrow**(`options`?): `Promise`&lt;`Table`&lt;`any`&gt;&gt;
+```ts
+toArrow(options?): Promise<Table<any>>
+```

 Collect the results as an Arrow

 #### Parameters

-• **options?**: `Partial`&lt;`QueryExecutionOptions`&gt;
+* **options?**: `Partial`&lt;`QueryExecutionOptions`&gt;

 #### Returns

@@ -493,7 +631,9 @@ ArrowTable.

 ### where()

-> **where**(`predicate`): `this`
+```ts
+where(predicate): this
+```

 A filter statement to be applied to this query.

@@ -501,7 +641,7 @@ The filter should be supplied as an SQL query string.  For example:

 #### Parameters

-• **predicate**: `string`
+* **predicate**: `string`

 #### Returns

@@ -521,3 +661,25 @@ on the filter column(s).
 #### Inherited from

 [`QueryBase`](QueryBase.md).[`where`](QueryBase.md#where)
+
+***
+
+### withRowId()
+
+```ts
+withRowId(): this
+```
+
+Whether to return the row id in the results.
+
+This column can be used to match results between different queries. For
+example, to match results from a full text search and a vector search in
+order to perform hybrid search.
+
+#### Returns
+
+`this`
+
+#### Inherited from
+
+[`QueryBase`](QueryBase.md).[`withRowId`](QueryBase.md#withrowid)
--- a/docs/src/js/enumerations/WriteMode.md
+++ b/docs/src/js/enumerations/WriteMode.md
@@ -12,16 +12,22 @@ Write mode for writing a table.

 ### Append

-> **Append**: `"Append"`
+```ts
+Append: "Append";
+```

 ***

 ### Create

-> **Create**: `"Create"`
+```ts
+Create: "Create";
+```

 ***

 ### Overwrite

-> **Overwrite**: `"Overwrite"`
+```ts
+Overwrite: "Overwrite";
+```
--- a/docs/src/js/functions/connect.md
+++ b/docs/src/js/functions/connect.md
@@ -8,7 +8,9 @@

 ## connect(uri, opts)

-> **connect**(`uri`, `opts`?): `Promise`&lt;[`Connection`](../classes/Connection.md)&gt;
+```ts
+function connect(uri, opts?): Promise<Connection>
+```

 Connect to a LanceDB instance at the given URI.

@@ -20,12 +22,11 @@ Accepted formats:

 ### Parameters

-• **uri**: `string`
+* **uri**: `string`
+    The uri of the database. If the database uri starts
+    with `db://` then it connects to a remote database.

-The uri of the database. If the database uri starts
-with `db://` then it connects to a remote database.
-
-• **opts?**: `Partial`&lt;[`ConnectionOptions`](../interfaces/ConnectionOptions.md) \| `RemoteConnectionOptions`&gt;
+* **opts?**: `Partial`&lt;[`ConnectionOptions`](../interfaces/ConnectionOptions.md)&gt;

 ### Returns

@@ -50,7 +51,9 @@ const conn = await connect(

 ## connect(opts)

-> **connect**(`opts`): `Promise`&lt;[`Connection`](../classes/Connection.md)&gt;
+```ts
+function connect(opts): Promise<Connection>
+```

 Connect to a LanceDB instance at the given URI.

@@ -62,7 +65,7 @@ Accepted formats:

 ### Parameters

-• **opts**: `Partial`&lt;[`ConnectionOptions`](../interfaces/ConnectionOptions.md) \| `RemoteConnectionOptions`&gt; & `object`
+* **opts**: `Partial`&lt;[`ConnectionOptions`](../interfaces/ConnectionOptions.md)&gt; & `object`

 ### Returns

--- a/docs/src/js/functions/makeArrowTable.md
+++ b/docs/src/js/functions/makeArrowTable.md
@@ -6,7 +6,12 @@

 # Function: makeArrowTable()

-> **makeArrowTable**(`data`, `options`?, `metadata`?): `ArrowTable`
+```ts
+function makeArrowTable(
+   data,
+   options?,
+   metadata?): ArrowTable
+```

 An enhanced version of the makeTable function from Apache Arrow
 that supports nested fields and embeddings columns.
@@ -40,11 +45,11 @@ rules are as follows:

 ## Parameters

-• **data**: `Record`&lt;`string`, `unknown`&gt;[]
+* **data**: `Record`&lt;`string`, `unknown`&gt;[]

-• **options?**: `Partial`&lt;[`MakeArrowTableOptions`](../classes/MakeArrowTableOptions.md)&gt;
+* **options?**: `Partial`&lt;[`MakeArrowTableOptions`](../classes/MakeArrowTableOptions.md)&gt;

-• **metadata?**: `Map`&lt;`string`, `string`&gt;
+* **metadata?**: `Map`&lt;`string`, `string`&gt;

 ## Returns

--- a/docs/src/js/globals.md
+++ b/docs/src/js/globals.md
@@ -28,17 +28,19 @@

 - [AddColumnsSql](interfaces/AddColumnsSql.md)
 - [AddDataOptions](interfaces/AddDataOptions.md)
+- [ClientConfig](interfaces/ClientConfig.md)
 - [ColumnAlteration](interfaces/ColumnAlteration.md)
 - [ConnectionOptions](interfaces/ConnectionOptions.md)
 - [CreateTableOptions](interfaces/CreateTableOptions.md)
 - [ExecutableQuery](interfaces/ExecutableQuery.md)
 - [IndexConfig](interfaces/IndexConfig.md)
- [IndexMetadata](interfaces/IndexMetadata.md)
 - [IndexOptions](interfaces/IndexOptions.md)
 - [IndexStatistics](interfaces/IndexStatistics.md)
 - [IvfPqOptions](interfaces/IvfPqOptions.md)
- [FtsOptions](interfaces/FtsOptions.md)
+- [OptimizeOptions](interfaces/OptimizeOptions.md)
+- [RetryConfig](interfaces/RetryConfig.md)
 - [TableNamesOptions](interfaces/TableNamesOptions.md)
+- [TimeoutConfig](interfaces/TimeoutConfig.md)
 - [UpdateOptions](interfaces/UpdateOptions.md)
 - [WriteOptions](interfaces/WriteOptions.md)

--- a/docs/src/js/interfaces/AddColumnsSql.md
+++ b/docs/src/js/interfaces/AddColumnsSql.md
@@ -12,7 +12,9 @@ A definition of a new column to add to a table.

 ### name

-> **name**: `string`
+```ts
+name: string;
+```

 The name of the new column.

@@ -20,7 +22,9 @@ The name of the new column.

 ### valueSql

-> **valueSql**: `string`
+```ts
+valueSql: string;
+```

 The values to populate the new column with, as a SQL expression.
 The expression can reference other columns in the table.
--- a/docs/src/js/interfaces/AddDataOptions.md
+++ b/docs/src/js/interfaces/AddDataOptions.md
@@ -12,7 +12,9 @@ Options for adding data to a table.

 ### mode

-> **mode**: `"append"` \| `"overwrite"`
+```ts
+mode: "append" | "overwrite";
+```

 If "append" (the default) then the new data will be added to the table

--- a/docs/src/js/interfaces/ClientConfig.md
+++ b/docs/src/js/interfaces/ClientConfig.md
@@ -0,0 +1,31 @@
+[**@lancedb/lancedb**](../README.md) • **Docs**
+
+***
+
+[@lancedb/lancedb](../globals.md) / ClientConfig
+
+# Interface: ClientConfig
+
+## Properties
+
+### retryConfig?
+
+```ts
+optional retryConfig: RetryConfig;
+```
+
+***
+
+### timeoutConfig?
+
+```ts
+optional timeoutConfig: TimeoutConfig;
+```
+
+***
+
+### userAgent?
+
+```ts
+optional userAgent: string;
+```
--- a/docs/src/js/interfaces/ColumnAlteration.md
+++ b/docs/src/js/interfaces/ColumnAlteration.md
@@ -13,9 +13,29 @@ must be provided.

 ## Properties

+### dataType?
+
+```ts
+optional dataType: string;
+```
+
+A new data type for the column. If not provided then the data type will not be changed.
+Changing data types is limited to casting to the same general type. For example, these
+changes are valid:
+* `int32` -> `int64` (integers)
+* `double` -> `float` (floats)
+* `string` -> `large_string` (strings)
+But these changes are not:
+* `int32` -> `double` (mix integers and floats)
+* `string` -> `int32` (mix strings and integers)
+
+***
+
 ### nullable?

-> `optional` **nullable**: `boolean`
+```ts
+optional nullable: boolean;
+```

 Set the new nullability. Note that a nullable column cannot be made non-nullable.

@@ -23,7 +43,9 @@ Set the new nullability. Note that a nullable column cannot be made non-nullable

 ### path

-> **path**: `string`
+```ts
+path: string;
+```

 The path to the column to alter. This is a dot-separated path to the column.
 If it is a top-level column then it is just the name of the column. If it is
@@ -34,7 +56,9 @@ a nested column then it is the path to the column, e.g. "a.b.c" for a column

 ### rename?

-> `optional` **rename**: `string`
+```ts
+optional rename: string;
+```

 The new name of the column. If not provided then the name will not be changed.
 This must be distinct from the names of all other columns in the table.
--- a/docs/src/js/interfaces/ConnectionOptions.md
+++ b/docs/src/js/interfaces/ConnectionOptions.md
@@ -8,9 +8,44 @@

 ## Properties

+### apiKey?
+
+```ts
+optional apiKey: string;
+```
+
+(For LanceDB cloud only): the API key to use with LanceDB Cloud.
+
+Can also be set via the environment variable `LANCEDB_API_KEY`.
+
+***
+
+### clientConfig?
+
+```ts
+optional clientConfig: ClientConfig;
+```
+
+(For LanceDB cloud only): configuration for the remote HTTP client.
+
+***
+
+### hostOverride?
+
+```ts
+optional hostOverride: string;
+```
+
+(For LanceDB cloud only): the host to use for LanceDB cloud. Used
+for testing purposes.
+
+***
+
 ### readConsistencyInterval?

-> `optional` **readConsistencyInterval**: `number`
+```ts
+optional readConsistencyInterval: number;
+```

 (For LanceDB OSS only): The interval, in seconds, at which to check for
 updates to the table from other processes. If None, then consistency is not
@@ -24,9 +59,22 @@ always consistent.

 ***

+### region?
+
+```ts
+optional region: string;
+```
+
+(For LanceDB cloud only): the region to use for LanceDB cloud.
+Defaults to 'us-east-1'.
+
+***
+
 ### storageOptions?

-> `optional` **storageOptions**: `Record`&lt;`string`, `string`&gt;
+```ts
+optional storageOptions: Record<string, string>;
+```

 (For LanceDB OSS only): configuration for object storage.

--- a/docs/src/js/interfaces/CreateTableOptions.md
+++ b/docs/src/js/interfaces/CreateTableOptions.md
@@ -8,15 +8,46 @@

 ## Properties

+### dataStorageVersion?
+
+```ts
+optional dataStorageVersion: string;
+```
+
+The version of the data storage format to use.
+
+The default is `stable`.
+Set to "legacy" to use the old format.
+
+***
+
 ### embeddingFunction?

-> `optional` **embeddingFunction**: [`EmbeddingFunctionConfig`](../namespaces/embedding/interfaces/EmbeddingFunctionConfig.md)
+```ts
+optional embeddingFunction: EmbeddingFunctionConfig;
+```
+
+***
+
+### enableV2ManifestPaths?
+
+```ts
+optional enableV2ManifestPaths: boolean;
+```
+
+Use the new V2 manifest paths. These paths provide more efficient
+opening of datasets with many versions on object stores.  WARNING:
+turning this on will make the dataset unreadable for older versions
+of LanceDB (prior to 0.10.0). To migrate an existing dataset, instead
+use the LocalTable#migrateManifestPathsV2 method.

 ***

 ### existOk

-> **existOk**: `boolean`
+```ts
+existOk: boolean;
+```

 If this is true and the table already exists and the mode is "create"
 then no error will be raised.
@@ -25,7 +56,9 @@ then no error will be raised.

 ### mode

-> **mode**: `"overwrite"` \| `"create"`
+```ts
+mode: "overwrite" | "create";
+```

 The mode to use when creating the table.

@@ -39,13 +72,17 @@ If this is set to "overwrite" then any existing table will be replaced.

 ### schema?

-> `optional` **schema**: `SchemaLike`
+```ts
+optional schema: SchemaLike;
+```

 ***

 ### storageOptions?

-> `optional` **storageOptions**: `Record`&lt;`string`, `string`&gt;
+```ts
+optional storageOptions: Record<string, string>;
+```

 Configuration for object storage.

@@ -58,8 +95,12 @@ The available options are described at https://lancedb.github.io/lancedb/guides/

 ### useLegacyFormat?

-> `optional` **useLegacyFormat**: `boolean`
+```ts
+optional useLegacyFormat: boolean;
+```

 If true then data files will be written with the legacy format

-The default is true while the new format is in beta
+The default is false.
+
+Deprecated. Use data storage version instead.
--- a/docs/src/js/interfaces/FtsOptions.md
+++ b/docs/src/js/interfaces/FtsOptions.md
@@ -1,25 +0,0 @@
-[**@lancedb/lancedb**](../README.md) • **Docs**
-
-***
-
-[@lancedb/lancedb](../globals.md) / FtsOptions
-
-# Interface: FtsOptions
-
-Options to create an `FTS` index
-
-## Properties
-
-### withPosition?
-
-> `optional` **withPosition**: `boolean`
-
-Whether to store the positions of the term in the document.
-
-If this is true then the index will store the positions of the term in the document.
-This allows phrase queries to be run. But it also increases the size of the index,
-and the time to build the index.
-
-The default value is true.
-
-***
--- a/docs/src/js/interfaces/IndexConfig.md
+++ b/docs/src/js/interfaces/IndexConfig.md
@@ -12,7 +12,9 @@ A description of an index currently configured on a column

 ### columns

-> **columns**: `string`[]
+```ts
+columns: string[];
+```

 The columns in the index

@@ -23,7 +25,9 @@ be more columns to represent composite indices.

 ### indexType

-> **indexType**: `string`
+```ts
+indexType: string;
+```

 The type of the index

@@ -31,6 +35,8 @@ The type of the index

 ### name

-> **name**: `string`
+```ts
+name: string;
+```

 The name of the index
--- a/docs/src/js/interfaces/IndexMetadata.md
+++ b/docs/src/js/interfaces/IndexMetadata.md
@@ -1,19 +0,0 @@
-[**@lancedb/lancedb**](../README.md) • **Docs**
-
-***
-
-[@lancedb/lancedb](../globals.md) / IndexMetadata
-
-# Interface: IndexMetadata
-
-## Properties
-
-### indexType?
-
-> `optional` **indexType**: `string`
-
-***
-
-### metricType?
-
-> `optional` **metricType**: `string`
--- a/docs/src/js/interfaces/IndexOptions.md
+++ b/docs/src/js/interfaces/IndexOptions.md
@@ -10,7 +10,9 @@

 ### config?

-> `optional` **config**: [`Index`](../classes/Index.md)
+```ts
+optional config: Index;
+```

 Advanced index configuration

@@ -26,7 +28,9 @@ will be used to determine the most useful kind of index to create.

 ### replace?

-> `optional` **replace**: `boolean`
+```ts
+optional replace: boolean;
+```

 Whether to replace the existing index

--- a/docs/src/js/interfaces/IndexStatistics.md
+++ b/docs/src/js/interfaces/IndexStatistics.md
@@ -8,32 +8,52 @@

 ## Properties

-### indexType?
+### distanceType?

-> `optional` **indexType**: `string`
+```ts
+optional distanceType: string;
+```
+
+The type of the distance function used by the index. This is only
+present for vector indices. Scalar and full text search indices do
+not have a distance function.
+
+***
+
+### indexType
+
+```ts
+indexType: string;
+```

 The type of the index

 ***

-### indices
-
-> **indices**: [`IndexMetadata`](IndexMetadata.md)[]
-
-The metadata for each index
-
-***
-
 ### numIndexedRows

-> **numIndexedRows**: `number`
+```ts
+numIndexedRows: number;
+```

 The number of rows indexed by the index

 ***

+### numIndices?
+
+```ts
+optional numIndices: number;
+```
+
+The number of parts this index is split into.
+
+***
+
 ### numUnindexedRows

-> **numUnindexedRows**: `number`
+```ts
+numUnindexedRows: number;
+```

 The number of rows not indexed
--- a/docs/src/js/interfaces/IvfPqOptions.md
+++ b/docs/src/js/interfaces/IvfPqOptions.md
@@ -12,7 +12,9 @@ Options to create an `IVF_PQ` index

 ### distanceType?

-> `optional` **distanceType**: `"l2"` \| `"cosine"` \| `"dot"`
+```ts
+optional distanceType: "l2" | "cosine" | "dot";
+```

 Distance type to use to build the index.

@@ -50,7 +52,9 @@ L2 norm is 1), then dot distance is equivalent to the cosine distance.

 ### maxIterations?

-> `optional` **maxIterations**: `number`
+```ts
+optional maxIterations: number;
+```

 Max iteration to train IVF kmeans.

@@ -66,7 +70,9 @@ The default value is 50.

 ### numPartitions?

-> `optional` **numPartitions**: `number`
+```ts
+optional numPartitions: number;
+```

 The number of IVF partitions to create.

@@ -82,7 +88,9 @@ part of the search (searching within a partition) will be slow.

 ### numSubVectors?

-> `optional` **numSubVectors**: `number`
+```ts
+optional numSubVectors: number;
+```

 Number of sub-vectors of PQ.

@@ -101,7 +109,9 @@ will likely result in poor performance.

 ### sampleRate?

-> `optional` **sampleRate**: `number`
+```ts
+optional sampleRate: number;
+```

 The number of vectors, per partition, to sample when training IVF kmeans.

--- a/docs/src/js/interfaces/OptimizeOptions.md
+++ b/docs/src/js/interfaces/OptimizeOptions.md
@@ -0,0 +1,39 @@
+[**@lancedb/lancedb**](../README.md) • **Docs**
+
+***
+
+[@lancedb/lancedb](../globals.md) / OptimizeOptions
+
+# Interface: OptimizeOptions
+
+## Properties
+
+### cleanupOlderThan
+
+```ts
+cleanupOlderThan: Date;
+```
+
+If set then all versions older than the given date
+be removed.  The current version will never be removed.
+The default is 7 days
+
+#### Example
+
+```ts
+// Delete all versions older than 1 day
+const olderThan = new Date();
+olderThan.setDate(olderThan.getDate() - 1));
+tbl.cleanupOlderVersions(olderThan);
+
+// Delete all versions except the current version
+tbl.cleanupOlderVersions(new Date());
+```
+
+***
+
+### deleteUnverified
+
+```ts
+deleteUnverified: boolean;
+```
--- a/docs/src/js/interfaces/RetryConfig.md
+++ b/docs/src/js/interfaces/RetryConfig.md
@@ -0,0 +1,90 @@
+[**@lancedb/lancedb**](../README.md) • **Docs**
+
+***
+
+[@lancedb/lancedb](../globals.md) / RetryConfig
+
+# Interface: RetryConfig
+
+Retry configuration for the remote HTTP client.
+
+## Properties
+
+### backoffFactor?
+
+```ts
+optional backoffFactor: number;
+```
+
+The backoff factor to apply between retries. Default is 0.25. Between each retry
+the client will wait for the amount of seconds:
+`{backoff factor} * (2 ** ({number of previous retries}))`. So for the default
+of 0.25, the first retry will wait 0.25 seconds, the second retry will wait 0.5
+seconds, the third retry will wait 1 second, etc.
+
+You can also set this via the environment variable
+`LANCE_CLIENT_RETRY_BACKOFF_FACTOR`.
+
+***
+
+### backoffJitter?
+
+```ts
+optional backoffJitter: number;
+```
+
+The jitter to apply to the backoff factor, in seconds. Default is 0.25.
+
+A random value between 0 and `backoff_jitter` will be added to the backoff
+factor in seconds. So for the default of 0.25 seconds, between 0 and 250
+milliseconds will be added to the sleep between each retry.
+
+You can also set this via the environment variable
+`LANCE_CLIENT_RETRY_BACKOFF_JITTER`.
+
+***
+
+### connectRetries?
+
+```ts
+optional connectRetries: number;
+```
+
+The maximum number of retries for connection errors. Default is 3. You
+can also set this via the environment variable `LANCE_CLIENT_CONNECT_RETRIES`.
+
+***
+
+### readRetries?
+
+```ts
+optional readRetries: number;
+```
+
+The maximum number of retries for read errors. Default is 3. You can also
+set this via the environment variable `LANCE_CLIENT_READ_RETRIES`.
+
+***
+
+### retries?
+
+```ts
+optional retries: number;
+```
+
+The maximum number of retries for a request. Default is 3. You can also
+set this via the environment variable `LANCE_CLIENT_MAX_RETRIES`.
+
+***
+
+### statuses?
+
+```ts
+optional statuses: number[];
+```
+
+The HTTP status codes for which to retry the request. Default is
+[429, 500, 502, 503].
+
+You can also set this via the environment variable
+`LANCE_CLIENT_RETRY_STATUSES`. Use a comma-separated list of integers.
--- a/docs/src/js/interfaces/TableNamesOptions.md
+++ b/docs/src/js/interfaces/TableNamesOptions.md
@@ -10,7 +10,9 @@

 ### limit?

-> `optional` **limit**: `number`
+```ts
+optional limit: number;
+```

 An optional limit to the number of results to return.

@@ -18,7 +20,9 @@ An optional limit to the number of results to return.

 ### startAfter?

-> `optional` **startAfter**: `string`
+```ts
+optional startAfter: string;
+```

 If present, only return names that come lexicographically after the
 supplied value.
--- a/docs/src/js/interfaces/TimeoutConfig.md
+++ b/docs/src/js/interfaces/TimeoutConfig.md
@@ -0,0 +1,46 @@
+[**@lancedb/lancedb**](../README.md) • **Docs**
+
+***
+
+[@lancedb/lancedb](../globals.md) / TimeoutConfig
+
+# Interface: TimeoutConfig
+
+Timeout configuration for remote HTTP client.
+
+## Properties
+
+### connectTimeout?
+
+```ts
+optional connectTimeout: number;
+```
+
+The timeout for establishing a connection in seconds. Default is 120
+seconds (2 minutes). This can also be set via the environment variable
+`LANCE_CLIENT_CONNECT_TIMEOUT`, as an integer number of seconds.
+
+***
+
+### poolIdleTimeout?
+
+```ts
+optional poolIdleTimeout: number;
+```
+
+The timeout for keeping idle connections in the connection pool in seconds.
+Default is 300 seconds (5 minutes). This can also be set via the
+environment variable `LANCE_CLIENT_CONNECTION_TIMEOUT`, as an integer
+number of seconds.
+
+***
+
+### readTimeout?
+
+```ts
+optional readTimeout: number;
+```
+
+The timeout for reading data from the server in seconds. Default is 300
+seconds (5 minutes). This can also be set via the environment variable
+`LANCE_CLIENT_READ_TIMEOUT`, as an integer number of seconds.
--- a/docs/src/js/interfaces/UpdateOptions.md
+++ b/docs/src/js/interfaces/UpdateOptions.md
@@ -10,7 +10,9 @@

 ### where

-> **where**: `string`
+```ts
+where: string;
+```

 A filter that limits the scope of the update.

--- a/docs/src/js/interfaces/WriteOptions.md
+++ b/docs/src/js/interfaces/WriteOptions.md
@@ -12,6 +12,8 @@ Write options when creating a Table.

 ### mode?

-> `optional` **mode**: [`WriteMode`](../enumerations/WriteMode.md)
+```ts
+optional mode: WriteMode;
+```

 Write mode for writing to a table.
--- a/docs/src/js/namespaces/embedding/README.md
+++ b/docs/src/js/namespaces/embedding/README.md
@@ -12,16 +12,12 @@

 - [EmbeddingFunction](classes/EmbeddingFunction.md)
 - [EmbeddingFunctionRegistry](classes/EmbeddingFunctionRegistry.md)
- [OpenAIEmbeddingFunction](classes/OpenAIEmbeddingFunction.md)
+- [TextEmbeddingFunction](classes/TextEmbeddingFunction.md)

 ### Interfaces

 - [EmbeddingFunctionConfig](interfaces/EmbeddingFunctionConfig.md)

-### Type Aliases
-
- [OpenAIOptions](type-aliases/OpenAIOptions.md)
-
 ### Functions

 - [LanceSchema](functions/LanceSchema.md)
--- a/docs/src/js/namespaces/embedding/classes/EmbeddingFunction.md
+++ b/docs/src/js/namespaces/embedding/classes/EmbeddingFunction.md
@@ -10,7 +10,7 @@ An embedding function that automatically creates vector representation for a giv

 ## Extended by

- [`OpenAIEmbeddingFunction`](OpenAIEmbeddingFunction.md)
+- [`TextEmbeddingFunction`](TextEmbeddingFunction.md)

 ## Type Parameters

@@ -22,7 +22,9 @@ An embedding function that automatically creates vector representation for a giv

 ### new EmbeddingFunction()

-> **new EmbeddingFunction**&lt;`T`, `M`&gt;(): [`EmbeddingFunction`](EmbeddingFunction.md)&lt;`T`, `M`&gt;
+```ts
+new EmbeddingFunction<T, M>(): EmbeddingFunction<T, M>
+```

 #### Returns

@@ -32,13 +34,15 @@ An embedding function that automatically creates vector representation for a giv

 ### computeQueryEmbeddings()

-> **computeQueryEmbeddings**(`data`): `Promise`&lt;`number`[] \| `Float32Array` \| `Float64Array`&gt;
+```ts
+computeQueryEmbeddings(data): Promise<number[] | Float32Array | Float64Array>
+```

 Compute the embeddings for a single query

 #### Parameters

-• **data**: `T`
+* **data**: `T`

 #### Returns

@@ -48,13 +52,15 @@ Compute the embeddings for a single query

 ### computeSourceEmbeddings()

-> `abstract` **computeSourceEmbeddings**(`data`): `Promise`&lt;`number`[][] \| `Float32Array`[] \| `Float64Array`[]&gt;
+```ts
+abstract computeSourceEmbeddings(data): Promise<number[][] | Float32Array[] | Float64Array[]>
+```

 Creates a vector representation for the given values.

 #### Parameters

-• **data**: `T`[]
+* **data**: `T`[]

 #### Returns

@@ -64,7 +70,9 @@ Creates a vector representation for the given values.

 ### embeddingDataType()

-> `abstract` **embeddingDataType**(): `Float`&lt;`Floats`&gt;
+```ts
+abstract embeddingDataType(): Float<Floats>
+```

 The datatype of the embeddings

@@ -74,9 +82,23 @@ The datatype of the embeddings

 ***

+### init()?
+
+```ts
+optional init(): Promise<void>
+```
+
+#### Returns
+
+`Promise`&lt;`void`&gt;
+
+***
+
 ### ndims()

-> **ndims**(): `undefined` \| `number`
+```ts
+ndims(): undefined | number
+```

 The number of dimensions of the embeddings

@@ -88,15 +110,16 @@ The number of dimensions of the embeddings

 ### sourceField()

-> **sourceField**(`optionsOrDatatype`): [`DataType`&lt;`Type`, `any`&gt;, `Map`&lt;`string`, [`EmbeddingFunction`](EmbeddingFunction.md)&lt;`any`, `FunctionOptions`&gt;&gt;]
+```ts
+sourceField(optionsOrDatatype): [DataType<Type, any>, Map<string, EmbeddingFunction<any, FunctionOptions>>]
+```

 sourceField is used in combination with `LanceSchema` to provide a declarative data model

 #### Parameters

-• **optionsOrDatatype**: `DataType`&lt;`Type`, `any`&gt; \| `Partial`&lt;`FieldOptions`&lt;`DataType`&lt;`Type`, `any`&gt;&gt;&gt;
-
-The options for the field or the datatype
+* **optionsOrDatatype**: `DataType`&lt;`Type`, `any`&gt; \| `Partial`&lt;`FieldOptions`&lt;`DataType`&lt;`Type`, `any`&gt;&gt;&gt;
+    The options for the field or the datatype

 #### Returns

@@ -110,7 +133,9 @@ lancedb.LanceSchema

 ### toJSON()

-> `abstract` **toJSON**(): `Partial`&lt;`M`&gt;
+```ts
+abstract toJSON(): Partial<M>
+```

 Convert the embedding function to a JSON object
 It is used to serialize the embedding function to the schema
@@ -145,13 +170,15 @@ class MyEmbeddingFunction extends EmbeddingFunction {

 ### vectorField()

-> **vectorField**(`optionsOrDatatype`?): [`DataType`&lt;`Type`, `any`&gt;, `Map`&lt;`string`, [`EmbeddingFunction`](EmbeddingFunction.md)&lt;`any`, `FunctionOptions`&gt;&gt;]
+```ts
+vectorField(optionsOrDatatype?): [DataType<Type, any>, Map<string, EmbeddingFunction<any, FunctionOptions>>]
+```

 vectorField is used in combination with `LanceSchema` to provide a declarative data model

 #### Parameters

-• **optionsOrDatatype?**: `DataType`&lt;`Type`, `any`&gt; \| `Partial`&lt;`FieldOptions`&lt;`DataType`&lt;`Type`, `any`&gt;&gt;&gt;
+* **optionsOrDatatype?**: `DataType`&lt;`Type`, `any`&gt; \| `Partial`&lt;`FieldOptions`&lt;`DataType`&lt;`Type`, `any`&gt;&gt;&gt;

 #### Returns

--- a/docs/src/js/namespaces/embedding/classes/EmbeddingFunctionRegistry.md
+++ b/docs/src/js/namespaces/embedding/classes/EmbeddingFunctionRegistry.md
@@ -15,7 +15,9 @@ or TextEmbeddingFunction and registering it with the registry

 ### new EmbeddingFunctionRegistry()

-> **new EmbeddingFunctionRegistry**(): [`EmbeddingFunctionRegistry`](EmbeddingFunctionRegistry.md)
+```ts
+new EmbeddingFunctionRegistry(): EmbeddingFunctionRegistry
+```

 #### Returns

@@ -25,11 +27,13 @@ or TextEmbeddingFunction and registering it with the registry

 ### functionToMetadata()

-> **functionToMetadata**(`conf`): `Record`&lt;`string`, `any`&gt;
+```ts
+functionToMetadata(conf): Record<string, any>
+```

 #### Parameters

-• **conf**: [`EmbeddingFunctionConfig`](../interfaces/EmbeddingFunctionConfig.md)
+* **conf**: [`EmbeddingFunctionConfig`](../interfaces/EmbeddingFunctionConfig.md)

 #### Returns

@@ -39,7 +43,9 @@ or TextEmbeddingFunction and registering it with the registry

 ### get()

-> **get**&lt;`T`, `Name`&gt;(`name`): `Name` *extends* `"openai"` ? `EmbeddingFunctionCreate`&lt;[`OpenAIEmbeddingFunction`](OpenAIEmbeddingFunction.md)&gt; : `undefined` \| `EmbeddingFunctionCreate`&lt;`T`&gt;
+```ts
+get<T>(name): undefined | EmbeddingFunctionCreate<T>
+```

 Fetch an embedding function by name

@@ -47,27 +53,26 @@ Fetch an embedding function by name

 • **T** *extends* [`EmbeddingFunction`](EmbeddingFunction.md)&lt;`unknown`, `FunctionOptions`&gt;

-• **Name** *extends* `string` = `""`
-
 #### Parameters

-• **name**: `Name` *extends* `"openai"` ? `"openai"` : `string`
-
-The name of the function
+* **name**: `string`
+    The name of the function

 #### Returns

-`Name` *extends* `"openai"` ? `EmbeddingFunctionCreate`&lt;[`OpenAIEmbeddingFunction`](OpenAIEmbeddingFunction.md)&gt; : `undefined` \| `EmbeddingFunctionCreate`&lt;`T`&gt;
+`undefined` \| `EmbeddingFunctionCreate`&lt;`T`&gt;

 ***

 ### getTableMetadata()

-> **getTableMetadata**(`functions`): `Map`&lt;`string`, `string`&gt;
+```ts
+getTableMetadata(functions): Map<string, string>
+```

 #### Parameters

-• **functions**: [`EmbeddingFunctionConfig`](../interfaces/EmbeddingFunctionConfig.md)[]
+* **functions**: [`EmbeddingFunctionConfig`](../interfaces/EmbeddingFunctionConfig.md)[]

 #### Returns

@@ -75,9 +80,25 @@ The name of the function

 ***

+### length()
+
+```ts
+length(): number
+```
+
+Get the number of registered functions
+
+#### Returns
+
+`number`
+
+***
+
 ### register()

-> **register**&lt;`T`&gt;(`this`, `alias`?): (`ctor`) => `any`
+```ts
+register<T>(this, alias?): (ctor) => any
+```

 Register an embedding function

@@ -87,9 +108,9 @@ Register an embedding function

 #### Parameters

-• **this**: [`EmbeddingFunctionRegistry`](EmbeddingFunctionRegistry.md)
+* **this**: [`EmbeddingFunctionRegistry`](EmbeddingFunctionRegistry.md)

-• **alias?**: `string`
+* **alias?**: `string`

 #### Returns

@@ -97,7 +118,7 @@ Register an embedding function

 ##### Parameters

-• **ctor**: `T`
+* **ctor**: `T`

 ##### Returns

@@ -111,13 +132,15 @@ Error if the function is already registered

 ### reset()

-> **reset**(`this`): `void`
+```ts
+reset(this): void
+```

 reset the registry to the initial state

 #### Parameters

-• **this**: [`EmbeddingFunctionRegistry`](EmbeddingFunctionRegistry.md)
+* **this**: [`EmbeddingFunctionRegistry`](EmbeddingFunctionRegistry.md)

 #### Returns

--- a/docs/src/js/namespaces/embedding/classes/OpenAIEmbeddingFunction.md
+++ b/docs/src/js/namespaces/embedding/classes/OpenAIEmbeddingFunction.md
@@ -2,31 +2,33 @@

 ***

-[@lancedb/lancedb](../../../globals.md) / [embedding](../README.md) / OpenAIEmbeddingFunction
+[@lancedb/lancedb](../../../globals.md) / [embedding](../README.md) / TextEmbeddingFunction

-# Class: OpenAIEmbeddingFunction
+# Class: `abstract` TextEmbeddingFunction&lt;M&gt;

-An embedding function that automatically creates vector representation for a given column.
+an abstract class for implementing embedding functions that take text as input

 ## Extends

- [`EmbeddingFunction`](EmbeddingFunction.md)&lt;`string`, `Partial`&lt;[`OpenAIOptions`](../type-aliases/OpenAIOptions.md)&gt;&gt;
+- [`EmbeddingFunction`](EmbeddingFunction.md)&lt;`string`, `M`&gt;
+
+## Type Parameters
+
+• **M** *extends* `FunctionOptions` = `FunctionOptions`

 ## Constructors

-### new OpenAIEmbeddingFunction()
+### new TextEmbeddingFunction()

-> **new OpenAIEmbeddingFunction**(`options`): [`OpenAIEmbeddingFunction`](OpenAIEmbeddingFunction.md)
-
-#### Parameters
-
-• **options**: `Partial`&lt;[`OpenAIOptions`](../type-aliases/OpenAIOptions.md)&gt; = `...`
+```ts
+new TextEmbeddingFunction<M>(): TextEmbeddingFunction<M>
+```

 #### Returns

-[`OpenAIEmbeddingFunction`](OpenAIEmbeddingFunction.md)
+[`TextEmbeddingFunction`](TextEmbeddingFunction.md)&lt;`M`&gt;

-#### Overrides
+#### Inherited from

 [`EmbeddingFunction`](EmbeddingFunction.md).[`constructor`](EmbeddingFunction.md#constructors)

@@ -34,17 +36,19 @@ An embedding function that automatically creates vector representation for a giv

 ### computeQueryEmbeddings()

-> **computeQueryEmbeddings**(`data`): `Promise`&lt;`number`[]&gt;
+```ts
+computeQueryEmbeddings(data): Promise<number[] | Float32Array | Float64Array>
+```

 Compute the embeddings for a single query

 #### Parameters

-• **data**: `string`
+* **data**: `string`

 #### Returns

-`Promise`&lt;`number`[]&gt;
+`Promise`&lt;`number`[] \| `Float32Array` \| `Float64Array`&gt;

 #### Overrides

@@ -54,17 +58,19 @@ Compute the embeddings for a single query

 ### computeSourceEmbeddings()

-> **computeSourceEmbeddings**(`data`): `Promise`&lt;`number`[][]&gt;
+```ts
+computeSourceEmbeddings(data): Promise<number[][] | Float32Array[] | Float64Array[]>
+```

 Creates a vector representation for the given values.

 #### Parameters

-• **data**: `string`[]
+* **data**: `string`[]

 #### Returns

-`Promise`&lt;`number`[][]&gt;
+`Promise`&lt;`number`[][] \| `Float32Array`[] \| `Float64Array`[]&gt;

 #### Overrides

@@ -74,7 +80,9 @@ Creates a vector representation for the given values.

 ### embeddingDataType()

-> **embeddingDataType**(): `Float`&lt;`Floats`&gt;
+```ts
+embeddingDataType(): Float<Floats>
+```

 The datatype of the embeddings

@@ -88,17 +96,53 @@ The datatype of the embeddings

 ***

+### generateEmbeddings()
+
+```ts
+abstract generateEmbeddings(texts, ...args): Promise<number[][] | Float32Array[] | Float64Array[]>
+```
+
+#### Parameters
+
+* **texts**: `string`[]
+
+* ...**args**: `any`[]
+
+#### Returns
+
+`Promise`&lt;`number`[][] \| `Float32Array`[] \| `Float64Array`[]&gt;
+
+***
+
+### init()?
+
+```ts
+optional init(): Promise<void>
+```
+
+#### Returns
+
+`Promise`&lt;`void`&gt;
+
+#### Inherited from
+
+[`EmbeddingFunction`](EmbeddingFunction.md).[`init`](EmbeddingFunction.md#init)
+
+***
+
 ### ndims()

-> **ndims**(): `number`
+```ts
+ndims(): undefined | number
+```

 The number of dimensions of the embeddings

 #### Returns

-`number`
+`undefined` \| `number`

-#### Overrides
+#### Inherited from

 [`EmbeddingFunction`](EmbeddingFunction.md).[`ndims`](EmbeddingFunction.md#ndims)

@@ -106,16 +150,12 @@ The number of dimensions of the embeddings

 ### sourceField()

-> **sourceField**(`optionsOrDatatype`): [`DataType`&lt;`Type`, `any`&gt;, `Map`&lt;`string`, [`EmbeddingFunction`](EmbeddingFunction.md)&lt;`any`, `FunctionOptions`&gt;&gt;]
+```ts
+sourceField(): [DataType<Type, any>, Map<string, EmbeddingFunction<any, FunctionOptions>>]
+```

 sourceField is used in combination with `LanceSchema` to provide a declarative data model

-#### Parameters
-
-• **optionsOrDatatype**: `DataType`&lt;`Type`, `any`&gt; \| `Partial`&lt;`FieldOptions`&lt;`DataType`&lt;`Type`, `any`&gt;&gt;&gt;
-
-The options for the field or the datatype
-
 #### Returns

 [`DataType`&lt;`Type`, `any`&gt;, `Map`&lt;`string`, [`EmbeddingFunction`](EmbeddingFunction.md)&lt;`any`, `FunctionOptions`&gt;&gt;]
@@ -124,7 +164,7 @@ The options for the field or the datatype

 lancedb.LanceSchema

-#### Inherited from
+#### Overrides

 [`EmbeddingFunction`](EmbeddingFunction.md).[`sourceField`](EmbeddingFunction.md#sourcefield)

@@ -132,7 +172,9 @@ lancedb.LanceSchema

 ### toJSON()

-> **toJSON**(): `object`
+```ts
+abstract toJSON(): Partial<M>
+```

 Convert the embedding function to a JSON object
 It is used to serialize the embedding function to the schema
@@ -144,11 +186,7 @@ If it does not, the embedding function will not be able to be recreated, or coul

 #### Returns

-`object`
-
-##### model
-
-> **model**: `string` & `object` \| `"text-embedding-ada-002"` \| `"text-embedding-3-small"` \| `"text-embedding-3-large"`
+`Partial`&lt;`M`&gt;

 #### Example

@@ -167,7 +205,7 @@ class MyEmbeddingFunction extends EmbeddingFunction {
 }
 ```

-#### Overrides
+#### Inherited from

 [`EmbeddingFunction`](EmbeddingFunction.md).[`toJSON`](EmbeddingFunction.md#tojson)

@@ -175,13 +213,15 @@ class MyEmbeddingFunction extends EmbeddingFunction {

 ### vectorField()

-> **vectorField**(`optionsOrDatatype`?): [`DataType`&lt;`Type`, `any`&gt;, `Map`&lt;`string`, [`EmbeddingFunction`](EmbeddingFunction.md)&lt;`any`, `FunctionOptions`&gt;&gt;]
+```ts
+vectorField(optionsOrDatatype?): [DataType<Type, any>, Map<string, EmbeddingFunction<any, FunctionOptions>>]
+```

 vectorField is used in combination with `LanceSchema` to provide a declarative data model

 #### Parameters

-• **optionsOrDatatype?**: `DataType`&lt;`Type`, `any`&gt; \| `Partial`&lt;`FieldOptions`&lt;`DataType`&lt;`Type`, `any`&gt;&gt;&gt;
+* **optionsOrDatatype?**: `DataType`&lt;`Type`, `any`&gt; \| `Partial`&lt;`FieldOptions`&lt;`DataType`&lt;`Type`, `any`&gt;&gt;&gt;

 #### Returns

--- a/docs/src/js/namespaces/embedding/functions/LanceSchema.md
+++ b/docs/src/js/namespaces/embedding/functions/LanceSchema.md
@@ -6,13 +6,15 @@

 # Function: LanceSchema()

-> **LanceSchema**(`fields`): `Schema`
+```ts
+function LanceSchema(fields): Schema
+```

 Create a schema with embedding functions.

 ## Parameters

-• **fields**: `Record`&lt;`string`, `object` \| [`object`, `Map`&lt;`string`, [`EmbeddingFunction`](../classes/EmbeddingFunction.md)&lt;`any`, `FunctionOptions`&gt;&gt;]&gt;
+* **fields**: `Record`&lt;`string`, `object` \| [`object`, `Map`&lt;`string`, [`EmbeddingFunction`](../classes/EmbeddingFunction.md)&lt;`any`, `FunctionOptions`&gt;&gt;]&gt;

 ## Returns

--- a/docs/src/js/namespaces/embedding/functions/getRegistry.md
+++ b/docs/src/js/namespaces/embedding/functions/getRegistry.md
@@ -6,7 +6,9 @@

 # Function: getRegistry()

-> **getRegistry**(): [`EmbeddingFunctionRegistry`](../classes/EmbeddingFunctionRegistry.md)
+```ts
+function getRegistry(): EmbeddingFunctionRegistry
+```

 Utility function to get the global instance of the registry

--- a/docs/src/js/namespaces/embedding/functions/register.md
+++ b/docs/src/js/namespaces/embedding/functions/register.md
@@ -6,11 +6,13 @@

 # Function: register()

-> **register**(`name`?): (`ctor`) => `any`
+```ts
+function register(name?): (ctor) => any
+```

 ## Parameters

-• **name?**: `string`
+* **name?**: `string`

 ## Returns

@@ -18,7 +20,7 @@

 ### Parameters

-• **ctor**: `EmbeddingFunctionConstructor`&lt;[`EmbeddingFunction`](../classes/EmbeddingFunction.md)&lt;`any`, `FunctionOptions`&gt;&gt;
+* **ctor**: `EmbeddingFunctionConstructor`&lt;[`EmbeddingFunction`](../classes/EmbeddingFunction.md)&lt;`any`, `FunctionOptions`&gt;&gt;

 ### Returns

--- a/docs/src/js/namespaces/embedding/interfaces/EmbeddingFunctionConfig.md
+++ b/docs/src/js/namespaces/embedding/interfaces/EmbeddingFunctionConfig.md
@@ -10,16 +10,22 @@

 ### function

-> **function**: [`EmbeddingFunction`](../classes/EmbeddingFunction.md)&lt;`any`, `FunctionOptions`&gt;
+```ts
+function: EmbeddingFunction<any, FunctionOptions>;
+```

 ***

 ### sourceColumn

-> **sourceColumn**: `string`
+```ts
+sourceColumn: string;
+```

 ***

 ### vectorColumn?

-> `optional` **vectorColumn**: `string`
+```ts
+optional vectorColumn: string;
+```
--- a/docs/src/js/namespaces/embedding/type-aliases/OpenAIOptions.md
+++ b/docs/src/js/namespaces/embedding/type-aliases/OpenAIOptions.md
@@ -1,19 +0,0 @@
-[**@lancedb/lancedb**](../../../README.md) • **Docs**
-
-***
-
-[@lancedb/lancedb](../../../globals.md) / [embedding](../README.md) / OpenAIOptions
-
-# Type Alias: OpenAIOptions
-
-> **OpenAIOptions**: `object`
-
-## Type declaration
-
-### apiKey
-
-> **apiKey**: `string`
-
-### model
-
-> **model**: `EmbeddingCreateParams`\[`"model"`\]
--- a/docs/src/js/type-aliases/Data.md
+++ b/docs/src/js/type-aliases/Data.md
@@ -6,6 +6,8 @@

 # Type Alias: Data

-> **Data**: `Record`&lt;`string`, `unknown`&gt;[] \| `TableLike`
+```ts
+type Data: Record<string, unknown>[] | TableLike;
+```

 Data type accepted by NodeJS SDK
				`@@ -1 +0,0 @@`
				TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.