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`
This commit is contained in:
Weston Pace
2024-03-29 06:55:03 -05:00
parent 1b0aaf9ec3
commit e21b56293c
34 changed files with 3561 additions and 7 deletions

View File

@@ -0,0 +1,45 @@
[@lancedb/lancedb](../README.md) / [Exports](../modules.md) / embedding
# Namespace: embedding
## Table of contents
### Classes
- [OpenAIEmbeddingFunction](../classes/embedding.OpenAIEmbeddingFunction.md)
### Interfaces
- [EmbeddingFunction](../interfaces/embedding.EmbeddingFunction.md)
### Functions
- [isEmbeddingFunction](embedding.md#isembeddingfunction)
## Functions
### isEmbeddingFunction
**isEmbeddingFunction**\<`T`\>(`value`): value is EmbeddingFunction\<T\>
Test if the input seems to be an embedding function
#### Type parameters
| Name |
| :------ |
| `T` |
#### Parameters
| Name | Type |
| :------ | :------ |
| `value` | `unknown` |
#### Returns
value is EmbeddingFunction\<T\>
#### Defined in
[embedding/embedding_function.ts:66](https://github.com/lancedb/lancedb/blob/9d178c7/nodejs/lancedb/embedding/embedding_function.ts#L66)