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-05-22 06:20:39 +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/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)