Skip to main content

Class: OpenAIEmbedding

Extends​

Extended by​

Constructors​

new OpenAIEmbedding()​

new OpenAIEmbedding(init?): OpenAIEmbedding

OpenAI Embedding

Parameters​

• init?: Partial<OpenAIEmbedding> & object

initial parameters

Returns​

OpenAIEmbedding

Overrides​

BaseEmbedding.constructor

Defined in​

packages/llamaindex/src/embeddings/OpenAIEmbedding.ts:62

Properties​

additionalSessionOptions?​

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

other session options for OpenAI

Defined in​

packages/llamaindex/src/embeddings/OpenAIEmbedding.ts:50

apiKey?​

optional apiKey: string = undefined

api key

Defined in​

packages/llamaindex/src/embeddings/OpenAIEmbedding.ts:44

dimensions​

dimensions: undefined | number

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

Defined in​

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

embedBatchSize​

embedBatchSize: number

Inherited from​

BaseEmbedding.embedBatchSize

Defined in​

packages/core/dist/embeddings/index.d.ts:34

embedInfo?​

optional embedInfo: EmbeddingInfo

Inherited from​

BaseEmbedding.embedInfo

Defined in​

packages/core/dist/embeddings/index.d.ts:35

maxRetries​

maxRetries: number

maximum number of retries, default 10

Defined in​

packages/llamaindex/src/embeddings/OpenAIEmbedding.ts:46

model​

model: string

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

Defined in​

packages/llamaindex/src/embeddings/OpenAIEmbedding.ts:37

session​

session: OpenAISession

session object

Defined in​

packages/llamaindex/src/embeddings/OpenAIEmbedding.ts:56

timeout?​

optional timeout: number

timeout in ms, default 60 seconds

Defined in​

packages/llamaindex/src/embeddings/OpenAIEmbedding.ts:48

Methods​

getQueryEmbedding()​

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

Parameters​

• query: MessageContentDetail

Returns​

Promise<null | number[]>

Inherited from​

BaseEmbedding.getQueryEmbedding

Defined in​

packages/core/dist/embeddings/index.d.ts:38

getTextEmbedding()​

getTextEmbedding(text): Promise<number[]>

Get embeddings for a single text

Parameters​

• text: string

Returns​

Promise<number[]>

Overrides​

BaseEmbedding.getTextEmbedding

Defined in​

packages/llamaindex/src/embeddings/OpenAIEmbedding.ts:143

getTextEmbeddings()​

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

Get embeddings for a batch of texts

Parameters​

• texts: string[]

Returns​

Promise<number[][]>

Overrides​

BaseEmbedding.getTextEmbeddings

Defined in​

packages/llamaindex/src/embeddings/OpenAIEmbedding.ts:135

getTextEmbeddingsBatch()​

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

Get embeddings for a batch of texts

Parameters​

• texts: string[]

• options?: BaseEmbeddingOptions

Returns​

Promise<number[][]>

Inherited from​

BaseEmbedding.getTextEmbeddingsBatch

Defined in​

packages/core/dist/embeddings/index.d.ts:49

similarity()​

similarity(embedding1, embedding2, mode?): number

Parameters​

• embedding1: number[]

• embedding2: number[]

• mode?: SimilarityType

Returns​

number

Inherited from​

BaseEmbedding.similarity

Defined in​

packages/core/dist/embeddings/index.d.ts:36

transform()​

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

Parameters​

• nodes: BaseNode<Metadata>[]

• options?: BaseEmbeddingOptions

Returns​

Promise<BaseNode<Metadata>[]>

Inherited from​

BaseEmbedding.transform

Defined in​

packages/core/dist/embeddings/index.d.ts:50

truncateMaxTokens()​

truncateMaxTokens(input): string[]

Parameters​

• input: string[]

Returns​

string[]

Inherited from​

BaseEmbedding.truncateMaxTokens

Defined in​

packages/core/dist/embeddings/index.d.ts:51