Class: abstract BaseEmbedding

Extended by

• HuggingFaceEmbedding
• DeepInfraEmbedding
• GeminiEmbedding
• MistralAIEmbedding
• MultiModalEmbedding
• OpenAIEmbedding
• Ollama

Implements

• TransformComponent

Constructors

new BaseEmbedding()

new BaseEmbedding(): BaseEmbedding

Returns

BaseEmbedding

Properties

embedBatchSize

embedBatchSize: number = DEFAULT_EMBED_BATCH_SIZE

Source

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

---

embedInfo?

optional embedInfo: EmbeddingInfo

Source

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

Methods

getQueryEmbedding()

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

Parameters

• query: MessageContentDetail

Returns

Promise<null | number[]>

Source

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

---

getTextEmbedding()

abstract getTextEmbedding(text): Promise<number[]>

Parameters

• text: string

Returns

Promise<number[]>

Source

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

---

getTextEmbeddings()

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

Optionally override this method to retrieve multiple embeddings in a single request

Parameters

• texts: string[]

Returns

Promise<number[][]>

Source

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

---

getTextEmbeddingsBatch()

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

Get embeddings for a batch of texts

Parameters

• texts: string[]

• options?

• options.logProgress?: boolean

Returns

Promise<number[][]>

Source

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

---

similarity()

similarity(embedding1, embedding2, mode): number

Parameters

• embedding1: number[]

• embedding2: number[]

• mode: SimilarityType= SimilarityType.DEFAULT

Returns

number

Source

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

---

transform()

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

Parameters

• nodes: BaseNode <Metadata>[]

• _options?: any

Returns

Promise <BaseNode <Metadata>[]>

Implementation of

TransformComponent . transform

Source

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