docs: add a reference to @lancedb/lance in the docs (#1166)

We aren't yet ready to switch over the examples since almost all JS
examples rely on embeddings and we haven't yet ported those over.
However, this makes it possible for those that are interested to start
using `@lancedb/lancedb`

docs/src/js/interfaces/AddColumnsSql.md

@@ -0,0 +1,37 @@
+[@lancedb/lancedb](../README.md) / [Exports](../modules.md) / AddColumnsSql
+
+# Interface: AddColumnsSql
+
+A definition of a new column to add to a table.
+
+## Table of contents
+
+### Properties
+
+- [name](AddColumnsSql.md#name)
+- [valueSql](AddColumnsSql.md#valuesql)
+
+## Properties
+
+### name
+
+• **name**: `string`
+
+The name of the new column.
+
+#### Defined in
+
+native.d.ts:43
+
+___
+
+### valueSql
+
+• **valueSql**: `string`
+
+The values to populate the new column with, as a SQL expression.
+The expression can reference other columns in the table.
+
+#### Defined in
+
+native.d.ts:48

docs/src/js/interfaces/AddDataOptions.md

@@ -0,0 +1,25 @@
+[@lancedb/lancedb](../README.md) / [Exports](../modules.md) / AddDataOptions
+
+# Interface: AddDataOptions
+
+Options for adding data to a table.
+
+## Table of contents
+
+### Properties
+
+- [mode](AddDataOptions.md#mode)
+
+## Properties
+
+### mode
+
+• **mode**: ``"append"`` \| ``"overwrite"``
+
+If "append" (the default) then the new data will be added to the table
+
+If "overwrite" then the new data will replace the existing data in the table.
+
+#### Defined in
+
+[table.ts:36](https://github.com/lancedb/lancedb/blob/9d178c7/nodejs/lancedb/table.ts#L36)

docs/src/js/interfaces/ColumnAlteration.md

@@ -0,0 +1,56 @@
+[@lancedb/lancedb](../README.md) / [Exports](../modules.md) / ColumnAlteration
+
+# Interface: ColumnAlteration
+
+A definition of a column alteration. The alteration changes the column at
+`path` to have the new name `name`, to be nullable if `nullable` is true,
+and to have the data type `data_type`. At least one of `rename` or `nullable`
+must be provided.
+
+## Table of contents
+
+### Properties
+
+- [nullable](ColumnAlteration.md#nullable)
+- [path](ColumnAlteration.md#path)
+- [rename](ColumnAlteration.md#rename)
+
+## Properties
+
+### nullable
+
+• `Optional` **nullable**: `boolean`
+
+Set the new nullability. Note that a nullable column cannot be made non-nullable.
+
+#### Defined in
+
+native.d.ts:38
+
+___
+
+### path
+
+• **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
+a nested column then it is the path to the column, e.g. "a.b.c" for a column
+`c` nested inside a column `b` nested inside a column `a`.
+
+#### Defined in
+
+native.d.ts:31
+
+___
+
+### rename
+
+• `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.
+
+#### Defined in
+
+native.d.ts:36

docs/src/js/interfaces/ConnectionOptions.md

@@ -0,0 +1,51 @@
+[@lancedb/lancedb](../README.md) / [Exports](../modules.md) / ConnectionOptions
+
+# Interface: ConnectionOptions
+
+## Table of contents
+
+### Properties
+
+- [apiKey](ConnectionOptions.md#apikey)
+- [hostOverride](ConnectionOptions.md#hostoverride)
+- [readConsistencyInterval](ConnectionOptions.md#readconsistencyinterval)
+
+## Properties
+
+### apiKey
+
+• `Optional` **apiKey**: `string`
+
+#### Defined in
+
+native.d.ts:51
+
+___
+
+### hostOverride
+
+• `Optional` **hostOverride**: `string`
+
+#### Defined in
+
+native.d.ts:52
+
+___
+
+### readConsistencyInterval
+
+• `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
+checked. For performance reasons, this is the default. For strong
+consistency, set this to zero seconds. Then every read will check for
+updates from other processes. As a compromise, you can set this to a
+non-zero value for eventual consistency. If more than that interval
+has passed since the last check, then the table will be checked for updates.
+Note: this consistency only applies to read operations. Write operations are
+always consistent.
+
+#### Defined in
+
+native.d.ts:64

docs/src/js/interfaces/CreateTableOptions.md

@@ -0,0 +1,41 @@
+[@lancedb/lancedb](../README.md) / [Exports](../modules.md) / CreateTableOptions
+
+# Interface: CreateTableOptions
+
+## Table of contents
+
+### Properties
+
+- [existOk](CreateTableOptions.md#existok)
+- [mode](CreateTableOptions.md#mode)
+
+## Properties
+
+### existOk
+
+• **existOk**: `boolean`
+
+If this is true and the table already exists and the mode is "create"
+then no error will be raised.
+
+#### Defined in
+
+[connection.ts:35](https://github.com/lancedb/lancedb/blob/9d178c7/nodejs/lancedb/connection.ts#L35)
+
+___
+
+### mode
+
+• **mode**: ``"overwrite"`` \| ``"create"``
+
+The mode to use when creating the table.
+
+If this is set to "create" and the table already exists then either
+an error will be thrown or, if existOk is true, then nothing will
+happen.  Any provided data will be ignored.
+
+If this is set to "overwrite" then any existing table will be replaced.
+
+#### Defined in
+
+[connection.ts:30](https://github.com/lancedb/lancedb/blob/9d178c7/nodejs/lancedb/connection.ts#L30)

docs/src/js/interfaces/ExecutableQuery.md

@@ -0,0 +1,7 @@
+[@lancedb/lancedb](../README.md) / [Exports](../modules.md) / ExecutableQuery
+
+# Interface: ExecutableQuery
+
+An interface for a query that can be executed
+
+Supported by all query types

docs/src/js/interfaces/IndexConfig.md

@@ -0,0 +1,39 @@
+[@lancedb/lancedb](../README.md) / [Exports](../modules.md) / IndexConfig
+
+# Interface: IndexConfig
+
+A description of an index currently configured on a column
+
+## Table of contents
+
+### Properties
+
+- [columns](IndexConfig.md#columns)
+- [indexType](IndexConfig.md#indextype)
+
+## Properties
+
+### columns
+
+• **columns**: `string`[]
+
+The columns in the index
+
+Currently this is always an array of size 1.  In the future there may
+be more columns to represent composite indices.
+
+#### Defined in
+
+native.d.ts:16
+
+___
+
+### indexType
+
+• **indexType**: `string`
+
+The type of the index
+
+#### Defined in
+
+native.d.ts:9

docs/src/js/interfaces/IndexOptions.md

@@ -0,0 +1,48 @@
+[@lancedb/lancedb](../README.md) / [Exports](../modules.md) / IndexOptions
+
+# Interface: IndexOptions
+
+## Table of contents
+
+### Properties
+
+- [config](IndexOptions.md#config)
+- [replace](IndexOptions.md#replace)
+
+## Properties
+
+### config
+
+• `Optional` **config**: [`Index`](../classes/Index.md)
+
+Advanced index configuration
+
+This option allows you to specify a specfic index to create and also
+allows you to pass in configuration for training the index.
+
+See the static methods on Index for details on the various index types.
+
+If this is not supplied then column data type(s) and column statistics
+will be used to determine the most useful kind of index to create.
+
+#### Defined in
+
+[indices.ts:192](https://github.com/lancedb/lancedb/blob/9d178c7/nodejs/lancedb/indices.ts#L192)
+
+___
+
+### replace
+
+• `Optional` **replace**: `boolean`
+
+Whether to replace the existing index
+
+If this is false, and another index already exists on the same columns
+and the same name, then an error will be returned.  This is true even if
+that index is out of date.
+
+The default is true
+
+#### Defined in
+
+[indices.ts:202](https://github.com/lancedb/lancedb/blob/9d178c7/nodejs/lancedb/indices.ts#L202)

docs/src/js/interfaces/IvfPqOptions.md

@@ -0,0 +1,144 @@
+[@lancedb/lancedb](../README.md) / [Exports](../modules.md) / IvfPqOptions
+
+# Interface: IvfPqOptions
+
+Options to create an `IVF_PQ` index
+
+## Table of contents
+
+### Properties
+
+- [distanceType](IvfPqOptions.md#distancetype)
+- [maxIterations](IvfPqOptions.md#maxiterations)
+- [numPartitions](IvfPqOptions.md#numpartitions)
+- [numSubVectors](IvfPqOptions.md#numsubvectors)
+- [sampleRate](IvfPqOptions.md#samplerate)
+
+## Properties
+
+### distanceType
+
+• `Optional` **distanceType**: ``"l2"`` \| ``"cosine"`` \| ``"dot"``
+
+Distance type to use to build the index.
+
+Default value is "l2".
+
+This is used when training the index to calculate the IVF partitions
+(vectors are grouped in partitions with similar vectors according to this
+distance type) and to calculate a subvector's code during quantization.
+
+The distance type used to train an index MUST match the distance type used
+to search the index.  Failure to do so will yield inaccurate results.
+
+The following distance types are available:
+
+"l2" - Euclidean distance. This is a very common distance metric that
+accounts for both magnitude and direction when determining the distance
+between vectors. L2 distance has a range of [0, ∞).
+
+"cosine" - Cosine distance.  Cosine distance is a distance metric
+calculated from the cosine similarity between two vectors. Cosine
+similarity is a measure of similarity between two non-zero vectors of an
+inner product space. It is defined to equal the cosine of the angle
+between them.  Unlike L2, the cosine distance is not affected by the
+magnitude of the vectors.  Cosine distance has a range of [0, 2].
+
+Note: the cosine distance is undefined when one (or both) of the vectors
+are all zeros (there is no direction).  These vectors are invalid and may
+never be returned from a vector search.
+
+"dot" - Dot product. Dot distance is the dot product of two vectors. Dot
+distance has a range of (-∞, ∞). If the vectors are normalized (i.e. their
+L2 norm is 1), then dot distance is equivalent to the cosine distance.
+
+#### Defined in
+
+[indices.ts:83](https://github.com/lancedb/lancedb/blob/9d178c7/nodejs/lancedb/indices.ts#L83)
+
+___
+
+### maxIterations
+
+• `Optional` **maxIterations**: `number`
+
+Max iteration to train IVF kmeans.
+
+When training an IVF PQ index we use kmeans to calculate the partitions.  This parameter
+controls how many iterations of kmeans to run.
+
+Increasing this might improve the quality of the index but in most cases these extra
+iterations have diminishing returns.
+
+The default value is 50.
+
+#### Defined in
+
+[indices.ts:96](https://github.com/lancedb/lancedb/blob/9d178c7/nodejs/lancedb/indices.ts#L96)
+
+___
+
+### numPartitions
+
+• `Optional` **numPartitions**: `number`
+
+The number of IVF partitions to create.
+
+This value should generally scale with the number of rows in the dataset.
+By default the number of partitions is the square root of the number of
+rows.
+
+If this value is too large then the first part of the search (picking the
+right partition) will be slow.  If this value is too small then the second
+part of the search (searching within a partition) will be slow.
+
+#### Defined in
+
+[indices.ts:32](https://github.com/lancedb/lancedb/blob/9d178c7/nodejs/lancedb/indices.ts#L32)
+
+___
+
+### numSubVectors
+
+• `Optional` **numSubVectors**: `number`
+
+Number of sub-vectors of PQ.
+
+This value controls how much the vector is compressed during the quantization step.
+The more sub vectors there are the less the vector is compressed.  The default is
+the dimension of the vector divided by 16.  If the dimension is not evenly divisible
+by 16 we use the dimension divded by 8.
+
+The above two cases are highly preferred.  Having 8 or 16 values per subvector allows
+us to use efficient SIMD instructions.
+
+If the dimension is not visible by 8 then we use 1 subvector.  This is not ideal and
+will likely result in poor performance.
+
+#### Defined in
+
+[indices.ts:48](https://github.com/lancedb/lancedb/blob/9d178c7/nodejs/lancedb/indices.ts#L48)
+
+___
+
+### sampleRate
+
+• `Optional` **sampleRate**: `number`
+
+The number of vectors, per partition, to sample when training IVF kmeans.
+
+When an IVF PQ index is trained, we need to calculate partitions.  These are groups
+of vectors that are similar to each other.  To do this we use an algorithm called kmeans.
+
+Running kmeans on a large dataset can be slow.  To speed this up we run kmeans on a
+random sample of the data.  This parameter controls the size of the sample.  The total
+number of vectors used to train the index is `sample_rate * num_partitions`.
+
+Increasing this value might improve the quality of the index but in most cases the
+default should be sufficient.
+
+The default value is 256.
+
+#### Defined in
+
+[indices.ts:113](https://github.com/lancedb/lancedb/blob/9d178c7/nodejs/lancedb/indices.ts#L113)

docs/src/js/interfaces/TableNamesOptions.md

@@ -0,0 +1,38 @@
+[@lancedb/lancedb](../README.md) / [Exports](../modules.md) / TableNamesOptions
+
+# Interface: TableNamesOptions
+
+## Table of contents
+
+### Properties
+
+- [limit](TableNamesOptions.md#limit)
+- [startAfter](TableNamesOptions.md#startafter)
+
+## Properties
+
+### limit
+
+• `Optional` **limit**: `number`
+
+An optional limit to the number of results to return.
+
+#### Defined in
+
+[connection.ts:48](https://github.com/lancedb/lancedb/blob/9d178c7/nodejs/lancedb/connection.ts#L48)
+
+___
+
+### startAfter
+
+• `Optional` **startAfter**: `string`
+
+If present, only return names that come lexicographically after the
+supplied value.
+
+This can be combined with limit to implement pagination by setting this to
+the last table name from the previous page.
+
+#### Defined in
+
+[connection.ts:46](https://github.com/lancedb/lancedb/blob/9d178c7/nodejs/lancedb/connection.ts#L46)

docs/src/js/interfaces/UpdateOptions.md

@@ -0,0 +1,28 @@
+[@lancedb/lancedb](../README.md) / [Exports](../modules.md) / UpdateOptions
+
+# Interface: UpdateOptions
+
+## Table of contents
+
+### Properties
+
+- [where](UpdateOptions.md#where)
+
+## Properties
+
+### where
+
+• **where**: `string`
+
+A filter that limits the scope of the update.
+
+This should be an SQL filter expression.
+
+Only rows that satisfy the expression will be updated.
+
+For example, this could be 'my_col == 0' to replace all instances
+of 0 in a column with some other default value.
+
+#### Defined in
+
+[table.ts:50](https://github.com/lancedb/lancedb/blob/9d178c7/nodejs/lancedb/table.ts#L50)

docs/src/js/interfaces/WriteOptions.md

@@ -0,0 +1,21 @@
+[@lancedb/lancedb](../README.md) / [Exports](../modules.md) / WriteOptions
+
+# Interface: WriteOptions
+
+Write options when creating a Table.
+
+## Table of contents
+
+### Properties
+
+- [mode](WriteOptions.md#mode)
+
+## Properties
+
+### mode
+
+• `Optional` **mode**: [`WriteMode`](../enums/WriteMode.md)
+
+#### Defined in
+
+native.d.ts:74

docs/src/js/interfaces/embedding.EmbeddingFunction.md

@@ -0,0 +1,129 @@
+[@lancedb/lancedb](../README.md) / [Exports](../modules.md) / [embedding](../modules/embedding.md) / EmbeddingFunction
+
+# Interface: EmbeddingFunction\<T\>
+
+[embedding](../modules/embedding.md).EmbeddingFunction
+
+An embedding function that automatically creates vector representation for a given column.
+
+## Type parameters
+
+| Name |
+| :------ |
+| `T` |
+
+## Implemented by
+
+- [`OpenAIEmbeddingFunction`](../classes/embedding.OpenAIEmbeddingFunction.md)
+
+## Table of contents
+
+### Properties
+
+- [destColumn](embedding.EmbeddingFunction.md#destcolumn)
+- [embed](embedding.EmbeddingFunction.md#embed)
+- [embeddingDataType](embedding.EmbeddingFunction.md#embeddingdatatype)
+- [embeddingDimension](embedding.EmbeddingFunction.md#embeddingdimension)
+- [excludeSource](embedding.EmbeddingFunction.md#excludesource)
+- [sourceColumn](embedding.EmbeddingFunction.md#sourcecolumn)
+
+## Properties
+
+### destColumn
+
+• `Optional` **destColumn**: `string`
+
+The name of the column that will contain the embedding
+
+By default this is "vector"
+
+#### Defined in
+
+[embedding/embedding_function.ts:49](https://github.com/lancedb/lancedb/blob/9d178c7/nodejs/lancedb/embedding/embedding_function.ts#L49)
+
+___
+
+### embed
+
+• **embed**: (`data`: `T`[]) => `Promise`\<`number`[][]\>
+
+Creates a vector representation for the given values.
+
+#### Type declaration
+
+▸ (`data`): `Promise`\<`number`[][]\>
+
+Creates a vector representation for the given values.
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `data` | `T`[] |
+
+##### Returns
+
+`Promise`\<`number`[][]\>
+
+#### Defined in
+
+[embedding/embedding_function.ts:62](https://github.com/lancedb/lancedb/blob/9d178c7/nodejs/lancedb/embedding/embedding_function.ts#L62)
+
+___
+
+### embeddingDataType
+
+• `Optional` **embeddingDataType**: `Float`\<`Floats`\>
+
+The data type of the embedding
+
+The embedding function should return `number`.  This will be converted into
+an Arrow float array.  By default this will be Float32 but this property can
+be used to control the conversion.
+
+#### Defined in
+
+[embedding/embedding_function.ts:33](https://github.com/lancedb/lancedb/blob/9d178c7/nodejs/lancedb/embedding/embedding_function.ts#L33)
+
+___
+
+### embeddingDimension
+
+• `Optional` **embeddingDimension**: `number`
+
+The dimension of the embedding
+
+This is optional, normally this can be determined by looking at the results of
+`embed`.  If this is not specified, and there is an attempt to apply the embedding
+to an empty table, then that process will fail.
+
+#### Defined in
+
+[embedding/embedding_function.ts:42](https://github.com/lancedb/lancedb/blob/9d178c7/nodejs/lancedb/embedding/embedding_function.ts#L42)
+
+___
+
+### excludeSource
+
+• `Optional` **excludeSource**: `boolean`
+
+Should the source column be excluded from the resulting table
+
+By default the source column is included.  Set this to true and
+only the embedding will be stored.
+
+#### Defined in
+
+[embedding/embedding_function.ts:57](https://github.com/lancedb/lancedb/blob/9d178c7/nodejs/lancedb/embedding/embedding_function.ts#L57)
+
+___
+
+### sourceColumn
+
+• **sourceColumn**: `string`
+
+The name of the column that will be used as input for the Embedding Function.
+
+#### Defined in
+
+[embedding/embedding_function.ts:24](https://github.com/lancedb/lancedb/blob/9d178c7/nodejs/lancedb/embedding/embedding_function.ts#L24)