lancedb/docs/src/javascript/classes/OpenAIEmbeddingFunction.md

vectordb / Exports / OpenAIEmbeddingFunction

Class: OpenAIEmbeddingFunction

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

Implements

• EmbeddingFunction<string>

Table of contents

Constructors

• constructor

Properties

• _modelName
• _openai
• sourceColumn

Methods

• 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:21

Properties

_modelName

• Private Readonly _modelName: string

Defined in

embedding/openai.ts:19

---

_openai

• Private Readonly _openai: any

Defined in

embedding/openai.ts:18

---

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:50

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:38