Class: OpenAIEmbedding

Extends

• BaseEmbedding

Extended by

• FireworksEmbedding
• TogetherEmbedding
• JinaAIEmbedding

Constructors

new OpenAIEmbedding()

new OpenAIEmbedding(init?): OpenAIEmbedding

OpenAI Embedding

Parameters

• init?: Partial <OpenAIEmbedding> & object

initial parameters

Returns

OpenAIEmbedding

Overrides

BaseEmbedding . constructor

Source

packages/core/src/embeddings/OpenAIEmbedding.ts:57

Properties

additionalSessionOptions?

optional additionalSessionOptions: Omit<Partial<ClientOptions>, "apiKey" | "timeout" | "maxRetries">

other session options for OpenAI

Source

packages/core/src/embeddings/OpenAIEmbedding.ts:45

---

apiKey?

optional apiKey: string = undefined

api key

Source

packages/core/src/embeddings/OpenAIEmbedding.ts:39

---

dimensions

dimensions: undefined | number

number of dimensions of the resulting vector, for models that support choosing fewer dimensions. undefined will default to model default

Source

packages/core/src/embeddings/OpenAIEmbedding.ts:34

---

embedBatchSize

embedBatchSize: number = DEFAULT_EMBED_BATCH_SIZE

Inherited from

BaseEmbedding . embedBatchSize

Source

packages/core/src/embeddings/types.ts:13

---

maxRetries

maxRetries: number

maximum number of retries, default 10

Source

packages/core/src/embeddings/OpenAIEmbedding.ts:41

---

model

model: string

embeddding model. defaults to "text-embedding-ada-002"

Source

packages/core/src/embeddings/OpenAIEmbedding.ts:32

---

session

session: OpenAISession

session object

Source

packages/core/src/embeddings/OpenAIEmbedding.ts:51

---

timeout?

optional timeout: number

timeout in ms, default 60 seconds

Source

packages/core/src/embeddings/OpenAIEmbedding.ts:43

Methods

getOpenAIEmbedding()

private getOpenAIEmbedding(input): Promise<number[][]>

Get embeddings for a batch of texts

Parameters

• input: string[]

Returns

Promise<number[][]>

Source

packages/core/src/embeddings/OpenAIEmbedding.ts:111

---

getQueryEmbedding()

getQueryEmbedding(query): Promise<null | number[]>

Parameters

• query: MessageContentDetail

Returns

Promise<null | number[]>

Inherited from

BaseEmbedding . getQueryEmbedding

Source

packages/core/src/embeddings/types.ts:25

---

getTextEmbedding()

getTextEmbedding(text): Promise<number[]>

Get embeddings for a single text

Parameters

• text: string

Returns

Promise<number[]>

Overrides

BaseEmbedding . getTextEmbedding

Source

packages/core/src/embeddings/OpenAIEmbedding.ts:133

---

getTextEmbeddings()

getTextEmbeddings(texts): Promise<number[][]>

Get embeddings for a batch of texts

Parameters

• texts: string[]

Returns

Promise<number[][]>

Overrides

BaseEmbedding . getTextEmbeddings

Source

packages/core/src/embeddings/OpenAIEmbedding.ts:125

---

getTextEmbeddingsBatch()

getTextEmbeddingsBatch(texts, options?): Promise<number[][]>

Get embeddings for a batch of texts

Parameters

• texts: string[]

• options?

• options.logProgress?: boolean

Returns

Promise<number[][]>

Inherited from

BaseEmbedding . getTextEmbeddingsBatch

Source

packages/core/src/embeddings/types.ts:55

---

similarity()

similarity(embedding1, embedding2, mode): number

Parameters

• embedding1: number[]

• embedding2: number[]

• mode: SimilarityType= SimilarityType.DEFAULT

Returns

number

Inherited from

BaseEmbedding . similarity

Source

packages/core/src/embeddings/types.ts:15

---

transform()

transform(nodes, _options?): Promise <BaseNode <Metadata>[]>

Parameters

• nodes: BaseNode <Metadata>[]

• _options?: any

Returns

Promise <BaseNode <Metadata>[]>

Inherited from

BaseEmbedding . transform

Source

packages/core/src/embeddings/types.ts:69