rust/lancedb
1
0
Fork 0
mirror of https://github.com/lancedb/lancedb.git synced 2025-12-25 22:29:58 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
dacd13edb44a770b22ba30dfbf5cfff78dedfa78
lancedb/docs/src/javascript/classes/OpenAIEmbeddingFunction.md
Will Jones 48f46d4751 docs(node): update indexStats signature and regenerate docs (#1742) 
`indexStats` still referenced UUID even though in
https://github.com/lancedb/lancedb/pull/1702 we changed it to take name
instead.
2024-10-18 10:53:28 -07:00

2.3 KiB
Raw Blame History

vectordb / Exports / OpenAIEmbeddingFunction

Class: OpenAIEmbeddingFunction

An embedding function that automatically creates vector representation for a given column.

Implements

Table of contents

Constructors

Properties

Methods

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

Properties

_modelName

• Private Readonly _modelName: string

Defined in

embedding/openai.ts:20

_openai

• Private Readonly _openai: OpenAI

Defined in

embedding/openai.ts:19

sourceColumn

• sourceColumn: string

The name of the column that will be used as input for the Embedding Function.

Implementation of

EmbeddingFunction.sourceColumn

Defined in

embedding/openai.ts:56

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.embed

Defined in

embedding/openai.ts:43