mirror of
https://github.com/lancedb/lancedb.git
synced 2026-01-08 21:02:58 +00:00
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.
This commit is contained in:
@@ -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`<`string`, `any`>
|
||||
```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**<`T`, `Name`>(`name`): `Name` *extends* `"openai"` ? `EmbeddingFunctionCreate`<[`OpenAIEmbeddingFunction`](OpenAIEmbeddingFunction.md)> : `undefined` \| `EmbeddingFunctionCreate`<`T`>
|
||||
```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)<`unknown`, `FunctionOptions`>
|
||||
|
||||
• **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`<[`OpenAIEmbeddingFunction`](OpenAIEmbeddingFunction.md)> : `undefined` \| `EmbeddingFunctionCreate`<`T`>
|
||||
`undefined` \| `EmbeddingFunctionCreate`<`T`>
|
||||
|
||||
***
|
||||
|
||||
### getTableMetadata()
|
||||
|
||||
> **getTableMetadata**(`functions`): `Map`<`string`, `string`>
|
||||
```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**<`T`>(`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
|
||||
|
||||
|
||||
Reference in New Issue
Block a user