OpenAIEmbedding

Defined in: packages/providers/openai/src/embedding.ts:44

Extends

• BaseEmbedding

OpenAIEmbedding<Options>(nodes, options?): Promise

Defined in: packages/providers/openai/src/embedding.ts:44

Type Parameters

Options

Options extends Record<string, unknown>

Parameters

nodes

BaseNode<Metadata>[]

options?

Options

Returns

Promise

Constructors

Constructor

new OpenAIEmbedding(init?): OpenAIEmbedding

Defined in: packages/providers/openai/src/embedding.ts:79

OpenAI Embedding

Parameters

init?

Omit<Partial<OpenAIEmbedding>, "lazySession"> & object

initial parameters

Returns

OpenAIEmbedding

Overrides

BaseEmbedding.constructor

Properties

model

model: string

Defined in: packages/providers/openai/src/embedding.ts:46

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

---

dimensions?

optional dimensions: number

Defined in: packages/providers/openai/src/embedding.ts:48

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

---

apiKey?

optional apiKey: string = undefined

Defined in: packages/providers/openai/src/embedding.ts:53

api key

---

baseURL?

optional baseURL: string = undefined

Defined in: packages/providers/openai/src/embedding.ts:55

base url

---

maxRetries

maxRetries: number

Defined in: packages/providers/openai/src/embedding.ts:57

maximum number of retries, default 10

---

timeout?

optional timeout: number

Defined in: packages/providers/openai/src/embedding.ts:59

timeout in ms, default 60 seconds

---

additionalSessionOptions?

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

Defined in: packages/providers/openai/src/embedding.ts:61

other session options for OpenAI

---

lazySession()

lazySession: () => Promise<LLMInstance>

Defined in: packages/providers/openai/src/embedding.ts:66

Returns

Promise<LLMInstance>

Accessors

session

Get Signature

get session(): Promise<LLMInstance>

Defined in: packages/providers/openai/src/embedding.ts:68

Returns

Promise<LLMInstance>

Methods

getTextEmbeddings()

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

Defined in: packages/providers/openai/src/embedding.ts:182

Get embeddings for a batch of texts

Parameters

texts

string[]

Returns

Promise<number[][]>

Overrides

BaseEmbedding.getTextEmbeddings

---

getTextEmbedding()

getTextEmbedding(text): Promise<number[]>

Defined in: packages/providers/openai/src/embedding.ts:190

Get embeddings for a single text

Parameters

text

string

Returns

Promise<number[]>

Overrides

BaseEmbedding.getTextEmbedding