mirror of
https://github.com/lancedb/lancedb.git
synced 2026-01-08 21:02:58 +00:00
48f46d4751
`indexStats` still referenced UUID even though in https://github.com/lancedb/lancedb/pull/1702 we changed it to take name instead.
106 lines
2.3 KiB
Markdown
106 lines
2.3 KiB
Markdown
[vectordb](../README.md) / [Exports](../modules.md) / OpenAIEmbeddingFunction
|
|
|
|
# Class: OpenAIEmbeddingFunction
|
|
|
|
An embedding function that automatically creates vector representation for a given column.
|
|
|
|
## Implements
|
|
|
|
- [`EmbeddingFunction`](../interfaces/EmbeddingFunction.md)\<`string`\>
|
|
|
|
## Table of contents
|
|
|
|
### Constructors
|
|
|
|
- [constructor](OpenAIEmbeddingFunction.md#constructor)
|
|
|
|
### Properties
|
|
|
|
- [\_modelName](OpenAIEmbeddingFunction.md#_modelname)
|
|
- [\_openai](OpenAIEmbeddingFunction.md#_openai)
|
|
- [sourceColumn](OpenAIEmbeddingFunction.md#sourcecolumn)
|
|
|
|
### Methods
|
|
|
|
- [embed](OpenAIEmbeddingFunction.md#embed)
|
|
|
|
## Constructors
|
|
|
|
### constructor
|
|
|
|
• **new OpenAIEmbeddingFunction**(`sourceColumn`, `openAIKey`, `modelName?`)
|
|
|
|
#### Parameters
|
|
|
|
| Name | Type | Default value |
|
|
| :------ | :------ | :------ |
|
|
| `sourceColumn` | `string` | `undefined` |
|
|
| `openAIKey` | `string` | `undefined` |
|
|
| `modelName` | `string` | `'text-embedding-ada-002'` |
|
|
|
|
#### Defined in
|
|
|
|
[embedding/openai.ts:22](https://github.com/lancedb/lancedb/blob/92179835/node/src/embedding/openai.ts#L22)
|
|
|
|
## Properties
|
|
|
|
### \_modelName
|
|
|
|
• `Private` `Readonly` **\_modelName**: `string`
|
|
|
|
#### Defined in
|
|
|
|
[embedding/openai.ts:20](https://github.com/lancedb/lancedb/blob/92179835/node/src/embedding/openai.ts#L20)
|
|
|
|
___
|
|
|
|
### \_openai
|
|
|
|
• `Private` `Readonly` **\_openai**: `OpenAI`
|
|
|
|
#### Defined in
|
|
|
|
[embedding/openai.ts:19](https://github.com/lancedb/lancedb/blob/92179835/node/src/embedding/openai.ts#L19)
|
|
|
|
___
|
|
|
|
### sourceColumn
|
|
|
|
• **sourceColumn**: `string`
|
|
|
|
The name of the column that will be used as input for the Embedding Function.
|
|
|
|
#### Implementation of
|
|
|
|
[EmbeddingFunction](../interfaces/EmbeddingFunction.md).[sourceColumn](../interfaces/EmbeddingFunction.md#sourcecolumn)
|
|
|
|
#### Defined in
|
|
|
|
[embedding/openai.ts:56](https://github.com/lancedb/lancedb/blob/92179835/node/src/embedding/openai.ts#L56)
|
|
|
|
## Methods
|
|
|
|
### embed
|
|
|
|
▸ **embed**(`data`): `Promise`\<`number`[][]\>
|
|
|
|
Creates a vector representation for the given values.
|
|
|
|
#### Parameters
|
|
|
|
| Name | Type |
|
|
| :------ | :------ |
|
|
| `data` | `string`[] |
|
|
|
|
#### Returns
|
|
|
|
`Promise`\<`number`[][]\>
|
|
|
|
#### Implementation of
|
|
|
|
[EmbeddingFunction](../interfaces/EmbeddingFunction.md).[embed](../interfaces/EmbeddingFunction.md#embed)
|
|
|
|
#### Defined in
|
|
|
|
[embedding/openai.ts:43](https://github.com/lancedb/lancedb/blob/92179835/node/src/embedding/openai.ts#L43)
|