rust/lancedb
1
0
Fork 0
mirror of https://github.com/lancedb/lancedb.git synced 2026-01-14 15:52:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

ci(node): check docs in CI (#2084)

Browse Source 
* Make `npm run docs` fail if there are any warnings. This will catch
items missing from the API reference.
* Add a check in our CI to make sure `npm run dos` runs without warnings
and doesn't generate any new files (indicating it might be out-of-date.
* Hide constructors that aren't user facing.
* Remove unused enum `WriteMode`.

Closes #2068
This commit is contained in:
Will Jones
2025-01-30 16:06:06 -08:00
committed by GitHub
parent 25c17ebf4e
commit e05c0cd87e
59 changed files with 1287 additions and 597 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
docs/src/js/namespaces/embedding/classes/TextEmbeddingFunction.md
View File

@@ -14,7 +14,7 @@ an abstract class for implementing embedding functions that take text as input
## Type Parameters
• **M** *extends* `FunctionOptions` = `FunctionOptions`
• **M** *extends* [`FunctionOptions`](../interfaces/FunctionOptions.md) = [`FunctionOptions`](../interfaces/FunctionOptions.md)
## Constructors
@@ -158,11 +158,11 @@ sourceField is used in combination with `LanceSchema` to provide a declarative d
#### Returns
[`DataType`<`Type`, `any`>, `Map`<`string`, [`EmbeddingFunction`](EmbeddingFunction.md)<`any`, `FunctionOptions`>>]
[`DataType`<`Type`, `any`>, `Map`<`string`, [`EmbeddingFunction`](EmbeddingFunction.md)<`any`, [`FunctionOptions`](../interfaces/FunctionOptions.md)>>]
#### See
lancedb.LanceSchema
[LanceSchema](../functions/LanceSchema.md)
#### Overrides
@@ -221,15 +221,16 @@ vectorField is used in combination with `LanceSchema` to provide a declarative d
#### Parameters
* **optionsOrDatatype?**: `DataType`<`Type`, `any`> \| `Partial`<`FieldOptions`<`DataType`<`Type`, `any`>>>
* **optionsOrDatatype?**: `DataType`<`Type`, `any`> \| `Partial`<[`FieldOptions`](../interfaces/FieldOptions.md)<`DataType`<`Type`, `any`>>>
The options for the field
#### Returns
[`DataType`<`Type`, `any`>, `Map`<`string`, [`EmbeddingFunction`](EmbeddingFunction.md)<`any`, `FunctionOptions`>>]
[`DataType`<`Type`, `any`>, `Map`<`string`, [`EmbeddingFunction`](EmbeddingFunction.md)<`any`, [`FunctionOptions`](../interfaces/FunctionOptions.md)>>]
#### See
lancedb.LanceSchema
[LanceSchema](../functions/LanceSchema.md)
#### Inherited from